• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2014 Google Inc.
3  *
4  * Use of this source code is governed by a BSD-style license that can be
5  * found in the LICENSE file.
6  */
7 
8 // EXPERIMENTAL EXPERIMENTAL EXPERIMENTAL EXPERIMENTAL
9 // DO NOT USE -- FOR INTERNAL TESTING ONLY
10 
11 #ifndef sk_image_DEFINED
12 #define sk_image_DEFINED
13 
14 #include "sk_types.h"
15 
16 SK_C_PLUS_PLUS_BEGIN_GUARD
17 
18 /**
19  *  Return a new image that has made a copy of the provided pixels, or NULL on failure.
20  *  Balance with a call to sk_image_unref().
21  */
22 SK_API sk_image_t* sk_image_new_raster_copy(const sk_imageinfo_t*, const void* pixels, size_t rowBytes);
23 
24 /**
25  *  If the specified data can be interpreted as a compressed image (e.g. PNG or JPEG) then this
26  *  returns an image. If the encoded data is not supported, returns NULL.
27  *
28  *  On success, the encoded data may be processed immediately, or it may be ref()'d for later
29  *  use.
30  */
31 SK_API sk_image_t* sk_image_new_from_encoded(const sk_data_t* encoded, const sk_irect_t* subset);
32 
33 /**
34  *  Encode the image's pixels and return the result as a new PNG in a
35  *  sk_data_t, which the caller must manage: call sk_data_unref() when
36  *  they are done.
37  *
38  *  If the image type cannot be encoded, this will return NULL.
39  */
40 SK_API sk_data_t* sk_image_encode(const sk_image_t*);
41 
42 /**
43  *  Increment the reference count on the given sk_image_t. Must be
44  *  balanced by a call to sk_image_unref().
45 */
46 SK_API void sk_image_ref(const sk_image_t*);
47 /**
48  *  Decrement the reference count. If the reference count is 1 before
49  *  the decrement, then release both the memory holding the sk_image_t
50  *  and the memory it is managing.  New sk_image_t are created with a
51     reference count of 1.
52 */
53 SK_API void sk_image_unref(const sk_image_t*);
54 
55 /**
56  *  Return the width of the sk_image_t/
57  */
58 SK_API int sk_image_get_width(const sk_image_t*);
59 /**
60  *  Return the height of the sk_image_t/
61  */
62 SK_API int sk_image_get_height(const sk_image_t*);
63 
64 /**
65  *  Returns a non-zero value unique among all images.
66  */
67 SK_API uint32_t sk_image_get_unique_id(const sk_image_t*);
68 
69 SK_C_PLUS_PLUS_END_GUARD
70 
71 #endif
72