Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1 | #Topic Image |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 2 | #Alias Image_Reference ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 3 | |
| 4 | #Class SkImage |
| 5 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 6 | #Code |
| 7 | #Populate |
| 8 | ## |
| 9 | |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 10 | Image describes a two dimensional array of pixels to draw. The pixels may be |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 11 | decoded in a Raster_Bitmap, encoded in a Picture or compressed data stream, |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 12 | or located in GPU memory as a GPU_Texture. |
| 13 | |
| 14 | Image cannot be modified after it is created. Image may allocate additional |
| 15 | storage as needed; for instance, an encoded Image may decode when drawn. |
| 16 | |
| 17 | Image width and height are greater than zero. Creating an Image with zero width |
| 18 | or height returns Image equal to nullptr. |
| 19 | |
| 20 | Image may be created from Bitmap, Pixmap, Surface, Picture, encoded streams, |
| 21 | GPU_Texture, YUV_ColorSpace data, or hardware buffer. Encoded streams supported |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 22 | include BMP, GIF, HEIF, ICO, JPEG, PNG, WBMP, WebP. Supported encoding details |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 23 | vary with platform. |
| 24 | |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 25 | #Subtopic Raster_Image |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 26 | #Alias Raster_Image ## |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 27 | #Line # pixels decoded in Raster_Bitmap ## |
| 28 | Raster_Image pixels are decoded in a Raster_Bitmap. These pixels may be read |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 29 | directly and in most cases written to, although edited pixels may not be drawn |
| 30 | if Image has been copied internally. |
| 31 | ## |
| 32 | |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 33 | #Subtopic Texture_Image |
| 34 | #Line # pixels located on GPU ## |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 35 | Texture_Image are located on GPU and pixels are not accessible. Texture_Image |
| 36 | are allocated optimally for best performance. Raster_Image may |
| 37 | be drawn to GPU_Surface, but pixels are uploaded from CPU to GPU downgrading |
| 38 | performance. |
| 39 | ## |
| 40 | |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 41 | #Subtopic Lazy_Image |
| 42 | #Line # deferred pixel buffer ## |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 43 | Lazy_Image defer allocating buffer for Image pixels and decoding stream until |
| 44 | Image is drawn. Lazy_Image caches result if possible to speed up repeated |
| 45 | drawing. |
| 46 | ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 47 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 48 | # ------------------------------------------------------------------------------ |
| 49 | |
| 50 | #Method static sk_sp<SkImage> MakeRasterCopy(const SkPixmap& pixmap) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 51 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 52 | #Line # creates Image from Pixmap and copied pixels ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 53 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 54 | |
| 55 | #Example |
Cary Clark | 2f46624 | 2017-12-11 16:03:17 -0500 | [diff] [blame] | 56 | #Height 50 |
| 57 | #Description |
| 58 | Draw a five by five bitmap, and draw a copy in an Image. Editing the pixmap |
| 59 | alters the bitmap draw, but does not alter the Image draw since the Image |
| 60 | contains a copy of the pixels. |
| 61 | ## |
| 62 | uint8_t storage[][5] = {{ 0xCA, 0xDA, 0xCA, 0xC9, 0xA3 }, |
| 63 | { 0xAC, 0xA8, 0x89, 0xA7, 0x87 }, |
| 64 | { 0x9B, 0xB5, 0xE5, 0x95, 0x46 }, |
| 65 | { 0x90, 0x81, 0xC5, 0x71, 0x33 }, |
| 66 | { 0x75, 0x55, 0x44, 0x40, 0x30 }}; |
| 67 | SkImageInfo imageInfo = SkImageInfo::Make(5, 5, kGray_8_SkColorType, kOpaque_SkAlphaType); |
| 68 | SkPixmap pixmap(imageInfo, storage[0], sizeof(storage) / 5); |
| 69 | SkBitmap bitmap; |
| 70 | bitmap.installPixels(pixmap); |
| 71 | sk_sp<SkImage> image = SkImage::MakeRasterCopy(pixmap); |
| 72 | *pixmap.writable_addr8(2, 2) = 0x00; |
| 73 | canvas->scale(10, 10); |
| 74 | canvas->drawBitmap(bitmap, 0, 0); |
| 75 | canvas->drawImage(image, 10, 0); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 76 | ## |
| 77 | |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 78 | #SeeAlso MakeRasterData MakeFromGenerator |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 79 | |
| 80 | #Method ## |
| 81 | |
| 82 | # ------------------------------------------------------------------------------ |
| 83 | |
Cary Clark | cc45cc7 | 2018-05-15 16:06:12 -0400 | [diff] [blame] | 84 | #Method static sk_sp<SkImage> MakeRasterData(const SkImageInfo& info, sk_sp<SkData> pixels, size_t rowBytes) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 85 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 86 | #Line # creates Image from Image_Info and shared pixels ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 87 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 88 | |
| 89 | #Example |
Cary Clark | 0c5f546 | 2017-12-15 11:21:51 -0500 | [diff] [blame] | 90 | #Image 3 |
| 91 | size_t rowBytes = image->width() * SkColorTypeBytesPerPixel(kRGBA_8888_SkColorType); |
| 92 | sk_sp<SkData> data = SkData::MakeUninitialized(rowBytes * image->height()); |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 93 | SkImageInfo dstInfo = SkImageInfo::MakeN32(image->width(), image->height(), |
Cary Clark | 0c5f546 | 2017-12-15 11:21:51 -0500 | [diff] [blame] | 94 | kPremul_SkAlphaType); |
| 95 | image->readPixels(dstInfo, data->writable_data(), rowBytes, 0, 0, SkImage::kAllow_CachingHint); |
| 96 | sk_sp<SkImage> raw = SkImage::MakeRasterData(dstInfo.makeColorType(kRGBA_8888_SkColorType), |
| 97 | data, rowBytes); |
| 98 | canvas->drawImage(image, 0, 0); |
| 99 | canvas->drawImage(raw.get(), 128, 0); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 100 | ## |
| 101 | |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 102 | #SeeAlso MakeRasterCopy MakeFromGenerator |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 103 | |
| 104 | #Method ## |
| 105 | |
| 106 | # ------------------------------------------------------------------------------ |
| 107 | |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 108 | #Typedef void* ReleaseContext |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 109 | #Line # parameter type for MakeFromRaster ## |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 110 | |
| 111 | #Code |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 112 | #Populate |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 113 | ## |
| 114 | |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 115 | Caller data passed to RasterReleaseProc; may be nullptr. |
| 116 | |
| 117 | #SeeAlso MakeFromRaster RasterReleaseProc |
| 118 | |
| 119 | ## |
| 120 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 121 | #Typedef void (*RasterReleaseProc)(const void* pixels, ReleaseContext) |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 122 | #Line # parameter type for MakeFromRaster ## |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 123 | |
| 124 | #Code |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 125 | #Populate |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 126 | ## |
| 127 | |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 128 | Function called when Image no longer shares pixels. ReleaseContext is |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 129 | provided by caller when Image is created, and may be nullptr. |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 130 | |
| 131 | #SeeAlso ReleaseContext MakeFromRaster |
| 132 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 133 | ## |
| 134 | |
| 135 | #Method static sk_sp<SkImage> MakeFromRaster(const SkPixmap& pixmap, |
| 136 | RasterReleaseProc rasterReleaseProc, |
| 137 | ReleaseContext releaseContext) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 138 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 139 | #Line # creates Image from Pixmap, with release ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 140 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 141 | |
| 142 | #Example |
Cary Clark | 0c5f546 | 2017-12-15 11:21:51 -0500 | [diff] [blame] | 143 | #Function |
| 144 | static void releaseProc(const void* pixels, SkImage::ReleaseContext context) { |
| 145 | int* countPtr = static_cast<int*>(context); |
| 146 | *countPtr += 1; |
| 147 | } |
| 148 | ## |
| 149 | |
| 150 | void draw(SkCanvas* canvas) { |
| 151 | SkColor color = 0; |
| 152 | SkPixmap pixmap(SkImageInfo::MakeN32(1, 1, kPremul_SkAlphaType), &color, 4); |
| 153 | int releaseCount = 0; |
| 154 | sk_sp<SkImage> image(SkImage::MakeFromRaster(pixmap, releaseProc, &releaseCount)); |
| 155 | SkDebugf("before reset: %d\n", releaseCount); |
| 156 | image.reset(); |
| 157 | SkDebugf("after reset: %d\n", releaseCount); |
| 158 | } |
| 159 | #StdOut |
| 160 | before reset: 0 |
| 161 | after reset: 1 |
| 162 | ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 163 | ## |
| 164 | |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 165 | #SeeAlso MakeRasterCopy MakeRasterData MakeFromGenerator RasterReleaseProc ReleaseContext |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 166 | |
| 167 | #Method ## |
| 168 | |
| 169 | # ------------------------------------------------------------------------------ |
| 170 | |
| 171 | #Method static sk_sp<SkImage> MakeFromBitmap(const SkBitmap& bitmap) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 172 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 173 | #Line # creates Image from Bitmap, sharing or copying pixels ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 174 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 175 | |
| 176 | #Example |
Cary Clark | 0c5f546 | 2017-12-15 11:21:51 -0500 | [diff] [blame] | 177 | #Description |
| 178 | The first Bitmap is shared; writing to the pixel memory changes the first |
| 179 | Image. |
| 180 | The second Bitmap is marked immutable, and is copied; writing to the pixel |
| 181 | memory does not alter the second Image. |
| 182 | ## |
| 183 | #Height 50 |
| 184 | uint8_t storage[][5] = {{ 0xCA, 0xDA, 0xCA, 0xC9, 0xA3 }, |
| 185 | { 0xAC, 0xA8, 0x89, 0xA7, 0x87 }, |
| 186 | { 0x9B, 0xB5, 0xE5, 0x95, 0x46 }, |
| 187 | { 0x90, 0x81, 0xC5, 0x71, 0x33 }, |
| 188 | { 0x75, 0x55, 0x44, 0x40, 0x30 }}; |
| 189 | SkImageInfo imageInfo = SkImageInfo::Make(5, 5, kGray_8_SkColorType, kOpaque_SkAlphaType); |
| 190 | SkPixmap pixmap(imageInfo, storage[0], sizeof(storage) / 5); |
| 191 | SkBitmap bitmap; |
| 192 | bitmap.installPixels(pixmap); |
| 193 | sk_sp<SkImage> image1 = SkImage::MakeFromBitmap(bitmap); |
| 194 | bitmap.setImmutable(); |
| 195 | sk_sp<SkImage> image2 = SkImage::MakeFromBitmap(bitmap); |
| 196 | *pixmap.writable_addr8(2, 2) = 0x00; |
| 197 | canvas->scale(10, 10); |
| 198 | canvas->drawImage(image1, 0, 0); |
| 199 | canvas->drawImage(image2, 10, 0); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 200 | ## |
| 201 | |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 202 | #SeeAlso MakeFromRaster MakeRasterCopy MakeFromGenerator MakeRasterData |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 203 | |
| 204 | #Method ## |
| 205 | |
| 206 | # ------------------------------------------------------------------------------ |
| 207 | |
| 208 | #Method static sk_sp<SkImage> MakeFromGenerator(std::unique_ptr<SkImageGenerator> imageGenerator, |
| 209 | const SkIRect* subset = nullptr) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 210 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 211 | #Line # creates Image from a stream of data ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 212 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 213 | |
| 214 | #Example |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 215 | #Height 128 |
Cary Clark | 0c5f546 | 2017-12-15 11:21:51 -0500 | [diff] [blame] | 216 | #Description |
| 217 | The generator returning Picture cannot be shared; std::move transfers ownership to generated Image. |
| 218 | ## |
| 219 | SkPictureRecorder recorder; |
| 220 | recorder.beginRecording(100, 100)->drawColor(SK_ColorRED); |
| 221 | auto picture = recorder.finishRecordingAsPicture(); |
| 222 | auto gen = SkImageGenerator::MakeFromPicture({100, 100}, picture, nullptr, nullptr, |
| 223 | SkImage::BitDepth::kU8, SkColorSpace::MakeSRGB()); |
| 224 | sk_sp<SkImage> image = SkImage::MakeFromGenerator(std::move(gen)); |
| 225 | canvas->drawImage(image, 0, 0); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 226 | ## |
| 227 | |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 228 | #SeeAlso MakeFromEncoded |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 229 | |
| 230 | #Method ## |
| 231 | |
| 232 | # ------------------------------------------------------------------------------ |
| 233 | |
| 234 | #Method static sk_sp<SkImage> MakeFromEncoded(sk_sp<SkData> encoded, const SkIRect* subset = nullptr) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 235 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 236 | #Line # creates Image from encoded data ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 237 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 238 | |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 239 | #Example |
| 240 | #Image 3 |
| 241 | int x = 0; |
| 242 | for (int quality : { 100, 50, 10, 1} ) { |
| 243 | sk_sp<SkData> encodedData = image->encodeToData(SkEncodedImageFormat::kJPEG, quality); |
| 244 | sk_sp<SkImage> image = SkImage::MakeFromEncoded(encodedData); |
| 245 | canvas->drawImage(image, x, 0); |
| 246 | x += 64; |
| 247 | } |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 248 | ## |
| 249 | |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 250 | #SeeAlso MakeFromGenerator |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 251 | |
| 252 | #Method ## |
| 253 | |
| 254 | # ------------------------------------------------------------------------------ |
| 255 | |
| 256 | #Typedef void (*TextureReleaseProc)(ReleaseContext releaseContext) |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 257 | #Line # parameter type for MakeFromTexture ## |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 258 | |
| 259 | #Code |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 260 | #Populate |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 261 | ## |
| 262 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 263 | User function called when supplied texture may be deleted. |
| 264 | #SeeAlso MakeFromTexture |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 265 | ## |
| 266 | |
| 267 | #Method static sk_sp<SkImage> MakeFromTexture(GrContext* context, |
| 268 | const GrBackendTexture& backendTexture, |
| 269 | GrSurfaceOrigin origin, |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 270 | SkColorType colorType, |
| 271 | SkAlphaType alphaType, |
| 272 | sk_sp<SkColorSpace> colorSpace) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 273 | #In Constructors |
Cary Clark | f895a42 | 2018-02-27 09:54:21 -0500 | [diff] [blame] | 274 | #Line # creates Image from GPU_Texture ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 275 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 276 | |
| 277 | #Example |
Cary Clark | 0c5f546 | 2017-12-15 11:21:51 -0500 | [diff] [blame] | 278 | #Image 3 |
| 279 | #Platform gpu |
| 280 | #Height 128 |
| 281 | #Description |
| 282 | A back-end texture has been created and uploaded to the GPU outside of this example. |
| 283 | ## |
| 284 | GrContext* context = canvas->getGrContext(); |
| 285 | if (!context) { |
| 286 | return; |
| 287 | } |
| 288 | canvas->scale(.25f, .25f); |
| 289 | int x = 0; |
| 290 | for (auto origin : { kBottomLeft_GrSurfaceOrigin, kTopLeft_GrSurfaceOrigin } ) { |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 291 | sk_sp<SkImage> image = SkImage::MakeFromTexture(context, backEndTexture, |
Cary Clark | ae957c4 | 2018-06-07 17:07:17 -0400 | [diff] [blame] | 292 | origin, kRGBA_8888_SkColorType, kOpaque_SkAlphaType, nullptr); |
Cary Clark | 0c5f546 | 2017-12-15 11:21:51 -0500 | [diff] [blame] | 293 | canvas->drawImage(image, x, 0); |
| 294 | x += 512; |
| 295 | } |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 296 | ## |
| 297 | |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 298 | #SeeAlso MakeFromAdoptedTexture SkSurface::MakeFromBackendTexture |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 299 | |
| 300 | #Method ## |
| 301 | |
| 302 | # ------------------------------------------------------------------------------ |
| 303 | |
| 304 | #Method static sk_sp<SkImage> MakeFromTexture(GrContext* context, |
| 305 | const GrBackendTexture& backendTexture, |
| 306 | GrSurfaceOrigin origin, |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 307 | SkColorType colorType, |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 308 | SkAlphaType alphaType, |
| 309 | sk_sp<SkColorSpace> colorSpace, |
| 310 | TextureReleaseProc textureReleaseProc, |
| 311 | ReleaseContext releaseContext) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 312 | #Populate |
Cary Clark | 0c5f546 | 2017-12-15 11:21:51 -0500 | [diff] [blame] | 313 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 314 | #Example |
Cary Clark | 14f49f0 | 2018-12-13 09:10:49 -0500 | [diff] [blame] | 315 | #Description |
| 316 | textureReleaseProc may be called at some later point in time. In this example, |
| 317 | textureReleaseProc has no effect on the drawing. |
| 318 | ## |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 319 | #Platform gpu |
| 320 | #Image 4 |
Cary Clark | 0c5f546 | 2017-12-15 11:21:51 -0500 | [diff] [blame] | 321 | GrContext* context = canvas->getGrContext(); |
| 322 | if (!context) { |
| 323 | return; |
| 324 | } |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 325 | auto debugster = [](SkImage::ReleaseContext releaseContext) -> void { |
Cary Clark | 14f49f0 | 2018-12-13 09:10:49 -0500 | [diff] [blame] | 326 | *((int *) releaseContext) += 128; |
Cary Clark | 0c5f546 | 2017-12-15 11:21:51 -0500 | [diff] [blame] | 327 | }; |
Cary Clark | 14f49f0 | 2018-12-13 09:10:49 -0500 | [diff] [blame] | 328 | int x = 0, y = 0; |
Cary Clark | 0c5f546 | 2017-12-15 11:21:51 -0500 | [diff] [blame] | 329 | for (auto origin : { kBottomLeft_GrSurfaceOrigin, kTopLeft_GrSurfaceOrigin } ) { |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 330 | sk_sp<SkImage> image = SkImage::MakeFromTexture(context, backEndTexture, |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 331 | origin, kRGBA_8888_SkColorType, kOpaque_SkAlphaType, nullptr, debugster, &x); |
Cary Clark | 14f49f0 | 2018-12-13 09:10:49 -0500 | [diff] [blame] | 332 | canvas->drawImage(image, x, y); |
| 333 | y += 128; |
Cary Clark | 0c5f546 | 2017-12-15 11:21:51 -0500 | [diff] [blame] | 334 | } |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 335 | ## |
| 336 | |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 337 | #SeeAlso MakeFromAdoptedTexture SkSurface::MakeFromBackendTexture |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 338 | |
| 339 | #Method ## |
| 340 | |
| 341 | # ------------------------------------------------------------------------------ |
| 342 | |
| 343 | #Method static sk_sp<SkImage> MakeCrossContextFromEncoded(GrContext* context, sk_sp<SkData> data, |
| 344 | bool buildMips, |
Brian Osman | 584b501 | 2018-04-13 15:48:26 -0400 | [diff] [blame] | 345 | SkColorSpace* dstColorSpace, |
| 346 | bool limitToMaxTextureSize = false) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 347 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 348 | #Line # creates Image from encoded data, and uploads to GPU ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 349 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 350 | |
| 351 | #Example |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 352 | #Image 4 |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 353 | #Height 64 |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 354 | GrContext* context = canvas->getGrContext(); |
| 355 | sk_sp<SkData> encodedData = image->encodeToData(SkEncodedImageFormat::kJPEG, 100); |
| 356 | sk_sp<SkImage> image = SkImage::MakeCrossContextFromEncoded(context, |
| 357 | encodedData, false, nullptr); |
| 358 | canvas->drawImage(image, 0, 0); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 359 | ## |
| 360 | |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 361 | #SeeAlso MakeCrossContextFromPixmap |
| 362 | |
| 363 | #Method ## |
| 364 | |
| 365 | # ------------------------------------------------------------------------------ |
| 366 | |
| 367 | #Method static sk_sp<SkImage> MakeCrossContextFromPixmap(GrContext* context, const SkPixmap& pixmap, |
| 368 | bool buildMips, |
Brian Osman | 584b501 | 2018-04-13 15:48:26 -0400 | [diff] [blame] | 369 | SkColorSpace* dstColorSpace, |
| 370 | bool limitToMaxTextureSize = false) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 371 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 372 | #Line # creates Image from Pixmap, and uploads to GPU ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 373 | #Populate |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 374 | |
| 375 | #Example |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 376 | #Image 4 |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 377 | #Height 64 |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 378 | GrContext* context = canvas->getGrContext(); |
| 379 | SkPixmap pixmap; |
| 380 | if (source.peekPixels(&pixmap)) { |
| 381 | sk_sp<SkImage> image = SkImage::MakeCrossContextFromPixmap(context, pixmap, |
| 382 | false, nullptr); |
| 383 | canvas->drawImage(image, 0, 0); |
| 384 | } |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 385 | ## |
| 386 | |
| 387 | #SeeAlso MakeCrossContextFromEncoded |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 388 | |
| 389 | #Method ## |
| 390 | |
| 391 | # ------------------------------------------------------------------------------ |
| 392 | |
| 393 | #Method static sk_sp<SkImage> MakeFromAdoptedTexture(GrContext* context, |
| 394 | const GrBackendTexture& backendTexture, |
| 395 | GrSurfaceOrigin surfaceOrigin, |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 396 | SkColorType colorType, |
| 397 | SkAlphaType alphaType = kPremul_SkAlphaType, |
| 398 | sk_sp<SkColorSpace> colorSpace = nullptr) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 399 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 400 | #Line # creates Image from GPU_Texture, managed internally ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 401 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 402 | |
| 403 | #Example |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 404 | #Image 5 |
| 405 | #Platform gpu |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 406 | if (!canvas->getGrContext()) { |
| 407 | return; |
| 408 | } |
| 409 | canvas->scale(.5f, .5f); |
| 410 | canvas->clear(0x7f3f5f7f); |
| 411 | int x = 0, y = 0; |
| 412 | for (auto origin : { kBottomLeft_GrSurfaceOrigin, kTopLeft_GrSurfaceOrigin } ) { |
| 413 | for (auto alpha : { kOpaque_SkAlphaType, kPremul_SkAlphaType, kUnpremul_SkAlphaType } ) { |
| 414 | sk_sp<SkImage> image = SkImage::MakeFromAdoptedTexture(canvas->getGrContext(), |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 415 | backEndTexture, origin, |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 416 | kRGBA_8888_SkColorType, alpha); |
| 417 | canvas->drawImage(image, x, y); |
| 418 | x += 160; |
| 419 | } |
| 420 | x -= 160 * 3; |
| 421 | y += 256; |
| 422 | } |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 423 | ## |
| 424 | |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 425 | #SeeAlso MakeFromTexture MakeFromYUVTexturesCopy |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 426 | |
| 427 | #Method ## |
| 428 | |
| 429 | # ------------------------------------------------------------------------------ |
| 430 | |
Robert Phillips | b6df1c1 | 2018-10-05 10:31:34 -0400 | [diff] [blame] | 431 | #Method static sk_sp<SkImage> MakeFromYUVATexturesCopy(GrContext* context, |
| 432 | SkYUVColorSpace yuvColorSpace, |
| 433 | const GrBackendTexture yuvaTextures[], |
| 434 | const SkYUVAIndex yuvaIndices[4], |
| 435 | SkISize imageSize, |
| 436 | GrSurfaceOrigin imageOrigin, |
| 437 | sk_sp<SkColorSpace> imageColorSpace = nullptr) |
| 438 | #In Constructor |
| 439 | #Line # creates Image from YUV_ColorSpace data ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 440 | #Populate |
Robert Phillips | b6df1c1 | 2018-10-05 10:31:34 -0400 | [diff] [blame] | 441 | |
| 442 | #NoExample |
| 443 | ## |
| 444 | |
Cary Clark | 1801b94 | 2018-10-30 21:10:03 -0400 | [diff] [blame] | 445 | #SeeAlso MakeFromYUVATexturesCopyWithExternalBackend MakeFromYUVATextures |
Robert Phillips | b6df1c1 | 2018-10-05 10:31:34 -0400 | [diff] [blame] | 446 | |
| 447 | #Method ## |
| 448 | |
Cary Clark | 1801b94 | 2018-10-30 21:10:03 -0400 | [diff] [blame] | 449 | #Method static sk_sp<SkImage> MakeFromYUVATextures(GrContext* context, |
| 450 | SkYUVColorSpace yuvColorSpace, |
| 451 | const GrBackendTexture yuvaTextures[], |
| 452 | const SkYUVAIndex yuvaIndices[4], |
| 453 | SkISize imageSize, |
| 454 | GrSurfaceOrigin imageOrigin, |
| 455 | sk_sp<SkColorSpace> imageColorSpace = nullptr); |
| 456 | |
| 457 | #In Constructor |
| 458 | #Line # creates Image from YUV_ColorSpace data ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 459 | #Populate |
Cary Clark | 1801b94 | 2018-10-30 21:10:03 -0400 | [diff] [blame] | 460 | |
| 461 | #NoExample |
| 462 | ## |
| 463 | |
| 464 | #SeeAlso MakeFromYUVATexturesCopy MakeFromYUVATexturesCopyWithExternalBackend |
| 465 | |
| 466 | #Method ## |
| 467 | |
Jim Van Verth | c8429ad | 2018-11-20 11:12:37 -0500 | [diff] [blame] | 468 | #Method static sk_sp<SkImage> MakeFromYUVAPixmaps( |
| 469 | GrContext* context, |
| 470 | SkYUVColorSpace yuvColorSpace, |
| 471 | const SkPixmap yuvaPixmaps[], |
| 472 | const SkYUVAIndex yuvaIndices[4], |
| 473 | SkISize imageSize, |
| 474 | GrSurfaceOrigin imageOrigin, |
| 475 | bool buildMips, |
| 476 | bool limitToMaxTextureSize = false, |
| 477 | sk_sp<SkColorSpace> imageColorSpace = nullptr); |
| 478 | |
| 479 | #In Constructor |
| 480 | #Line # creates Image from YUV_ColorSpace data ## |
| 481 | #Populate |
| 482 | |
| 483 | #NoExample |
| 484 | ## |
| 485 | |
| 486 | #SeeAlso MakeFromYUVATextures |
| 487 | |
| 488 | #Method ## |
Cary Clark | 1801b94 | 2018-10-30 21:10:03 -0400 | [diff] [blame] | 489 | |
Robert Phillips | b6df1c1 | 2018-10-05 10:31:34 -0400 | [diff] [blame] | 490 | # ------------------------------------------------------------------------------ |
| 491 | |
| 492 | #Method static sk_sp<SkImage> MakeFromYUVATexturesCopyWithExternalBackend( |
| 493 | GrContext* context, |
| 494 | SkYUVColorSpace yuvColorSpace, |
| 495 | const GrBackendTexture yuvaTextures[], |
| 496 | const SkYUVAIndex yuvaIndices[4], |
| 497 | SkISize imageSize, |
| 498 | GrSurfaceOrigin imageOrigin, |
| 499 | const GrBackendTexture& backendTexture, |
| 500 | sk_sp<SkColorSpace> imageColorSpace = nullptr) |
| 501 | #In Constructor |
| 502 | #Line # creates Image from planar YUV_ColorSpace, stored in texture ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 503 | #Populate |
Robert Phillips | b6df1c1 | 2018-10-05 10:31:34 -0400 | [diff] [blame] | 504 | |
| 505 | #NoExample |
| 506 | ## |
| 507 | |
Cary Clark | 1801b94 | 2018-10-30 21:10:03 -0400 | [diff] [blame] | 508 | #SeeAlso MakeFromYUVATexturesCopy MakeFromYUVATextures |
Robert Phillips | b6df1c1 | 2018-10-05 10:31:34 -0400 | [diff] [blame] | 509 | |
| 510 | #Method ## |
| 511 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 512 | #Method static sk_sp<SkImage> MakeFromYUVTexturesCopy(GrContext* context, SkYUVColorSpace yuvColorSpace, |
Brian Salomon | 6a426c1 | 2018-03-15 12:16:02 -0400 | [diff] [blame] | 513 | const GrBackendTexture yuvTextures[3], |
Robert Phillips | b6df1c1 | 2018-10-05 10:31:34 -0400 | [diff] [blame] | 514 | GrSurfaceOrigin imageOrigin, |
| 515 | sk_sp<SkColorSpace> imageColorSpace = nullptr) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 516 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 517 | #Line # creates Image from YUV_ColorSpace data in three planes ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 518 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 519 | |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 520 | #NoExample |
| 521 | ## |
| 522 | |
Robert Phillips | b6df1c1 | 2018-10-05 10:31:34 -0400 | [diff] [blame] | 523 | #SeeAlso MakeFromYUVTexturesCopyWithExternalBackend MakeFromNV12TexturesCopy MakeFromYUVATexturesCopy |
Cary Clark | cdc371a | 2018-09-18 07:31:37 -0400 | [diff] [blame] | 524 | |
| 525 | #Method ## |
| 526 | |
Robert Phillips | b6df1c1 | 2018-10-05 10:31:34 -0400 | [diff] [blame] | 527 | # ------------------------------------------------------------------------------ |
| 528 | |
Cary Clark | cdc371a | 2018-09-18 07:31:37 -0400 | [diff] [blame] | 529 | #Method static sk_sp<SkImage> MakeFromYUVTexturesCopyWithExternalBackend( |
| 530 | GrContext* context, SkYUVColorSpace yuvColorSpace, |
Robert Phillips | b6df1c1 | 2018-10-05 10:31:34 -0400 | [diff] [blame] | 531 | const GrBackendTexture yuvTextures[3], GrSurfaceOrigin imageOrigin, |
| 532 | const GrBackendTexture& backendTexture, sk_sp<SkColorSpace> imageColorSpace = nullptr); |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 533 | #In Constructors |
Cary Clark | cdc371a | 2018-09-18 07:31:37 -0400 | [diff] [blame] | 534 | #Line # creates Image from planar YUV_ColorSpace, stored in texture ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 535 | #Populate |
Cary Clark | cdc371a | 2018-09-18 07:31:37 -0400 | [diff] [blame] | 536 | |
| 537 | #NoExample |
| 538 | ## |
| 539 | |
Robert Phillips | b6df1c1 | 2018-10-05 10:31:34 -0400 | [diff] [blame] | 540 | #SeeAlso MakeFromYUVTexturesCopy MakeFromNV12TexturesCopy MakeFromYUVATexturesCopyWithExternalBackend |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 541 | |
| 542 | #Method ## |
| 543 | |
| 544 | # ------------------------------------------------------------------------------ |
| 545 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 546 | #Method static sk_sp<SkImage> MakeFromNV12TexturesCopy(GrContext* context, |
| 547 | SkYUVColorSpace yuvColorSpace, |
Brian Salomon | 6a426c1 | 2018-03-15 12:16:02 -0400 | [diff] [blame] | 548 | const GrBackendTexture nv12Textures[2], |
Robert Phillips | b6df1c1 | 2018-10-05 10:31:34 -0400 | [diff] [blame] | 549 | GrSurfaceOrigin imageOrigin, |
| 550 | sk_sp<SkColorSpace> imageColorSpace = nullptr) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 551 | #In Constructors |
Brian Salomon | 6a426c1 | 2018-03-15 12:16:02 -0400 | [diff] [blame] | 552 | #Line # creates Image from YUV_ColorSpace data in three planes ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 553 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 554 | |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 555 | #NoExample |
| 556 | ## |
| 557 | |
Robert Phillips | b6df1c1 | 2018-10-05 10:31:34 -0400 | [diff] [blame] | 558 | #SeeAlso MakeFromNV12TexturesCopyWithExternalBackend MakeFromYUVTexturesCopy MakeFromYUVATexturesCopy |
Cary Clark | cdc371a | 2018-09-18 07:31:37 -0400 | [diff] [blame] | 559 | |
| 560 | #Method ## |
| 561 | |
| 562 | #Method static sk_sp<SkImage> MakeFromNV12TexturesCopyWithExternalBackend( |
| 563 | GrContext* context, |
| 564 | SkYUVColorSpace yuvColorSpace, |
| 565 | const GrBackendTexture nv12Textures[2], |
Robert Phillips | b6df1c1 | 2018-10-05 10:31:34 -0400 | [diff] [blame] | 566 | GrSurfaceOrigin imageOrigin, |
| 567 | const GrBackendTexture& backendTexture, |
| 568 | sk_sp<SkColorSpace> imageColorSpace = nullptr); |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 569 | #In Constructors |
Cary Clark | cdc371a | 2018-09-18 07:31:37 -0400 | [diff] [blame] | 570 | #Line # creates Image from planar YUV_ColorSpace, stored in texture ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 571 | #Populate |
Cary Clark | cdc371a | 2018-09-18 07:31:37 -0400 | [diff] [blame] | 572 | |
| 573 | #NoExample |
| 574 | ## |
| 575 | |
Robert Phillips | b6df1c1 | 2018-10-05 10:31:34 -0400 | [diff] [blame] | 576 | #SeeAlso MakeFromNV12TexturesCopy MakeFromYUVTexturesCopy MakeFromYUVATexturesCopyWithExternalBackend |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 577 | |
| 578 | #Method ## |
| 579 | |
| 580 | # ------------------------------------------------------------------------------ |
| 581 | |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 582 | # currently uncalled by any test or client ## |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 583 | #Bug 7424 |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 584 | |
Cary Clark | 5635631 | 2018-02-08 14:45:18 -0500 | [diff] [blame] | 585 | #EnumClass BitDepth |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 586 | #Line # options for MakeFromPicture ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 587 | #Code |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 588 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 589 | ## |
| 590 | |
| 591 | #Const kU8 0 |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 592 | #Line # uses 8-bit unsigned int per Color component ## |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 593 | Use 8 bits per ARGB component using unsigned integer format. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 594 | ## |
| 595 | #Const kF16 1 |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 596 | #Line # uses 16-bit float per Color component ## |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 597 | Use 16 bits per ARGB component using half-precision floating point format. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 598 | ## |
| 599 | |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 600 | #NoExample |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 601 | ## |
| 602 | |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 603 | #SeeAlso MakeFromPicture |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 604 | |
Cary Clark | 5635631 | 2018-02-08 14:45:18 -0500 | [diff] [blame] | 605 | #EnumClass ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 606 | |
| 607 | # ------------------------------------------------------------------------------ |
| 608 | |
| 609 | #Method static sk_sp<SkImage> MakeFromPicture(sk_sp<SkPicture> picture, const SkISize& dimensions, |
| 610 | const SkMatrix* matrix, const SkPaint* paint, |
| 611 | BitDepth bitDepth, |
| 612 | sk_sp<SkColorSpace> colorSpace) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 613 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 614 | #Line # creates Image from Picture ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 615 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 616 | |
| 617 | #Example |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 618 | SkPaint paint; |
| 619 | SkPictureRecorder recorder; |
| 620 | SkCanvas* recordingCanvas = recorder.beginRecording(50, 50); |
| 621 | for (auto color : { SK_ColorRED, SK_ColorBLUE, 0xff007f00 } ) { |
| 622 | paint.setColor(color); |
| 623 | recordingCanvas->drawRect({10, 10, 30, 40}, paint); |
| 624 | recordingCanvas->translate(10, 10); |
| 625 | recordingCanvas->scale(1.2f, 1.4f); |
| 626 | } |
| 627 | sk_sp<SkPicture> playback = recorder.finishRecordingAsPicture(); |
| 628 | int x = 0, y = 0; |
| 629 | for (auto alpha : { 70, 140, 210 } ) { |
| 630 | paint.setAlpha(alpha); |
| 631 | auto srgbColorSpace = SkColorSpace::MakeSRGB(); |
| 632 | sk_sp<SkImage> image = SkImage::MakeFromPicture(playback, {50, 50}, nullptr, &paint, |
| 633 | SkImage::BitDepth::kU8, srgbColorSpace); |
| 634 | canvas->drawImage(image, x, y); |
| 635 | x += 70; y += 70; |
| 636 | } |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 637 | ## |
| 638 | |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 639 | #SeeAlso SkCanvas::drawPicture |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 640 | |
| 641 | #Method ## |
| 642 | |
| 643 | # ------------------------------------------------------------------------------ |
| 644 | |
Cary Clark | 9548ea9 | 2018-09-13 15:26:33 -0400 | [diff] [blame] | 645 | #Method static sk_sp<SkImage> MakeFromAHardwareBuffer( |
| 646 | AHardwareBuffer* hardwareBuffer, |
| 647 | SkAlphaType alphaType = kPremul_SkAlphaType, |
| 648 | sk_sp<SkColorSpace> colorSpace = nullptr, |
| 649 | GrSurfaceOrigin surfaceOrigin = kTopLeft_GrSurfaceOrigin) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 650 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 651 | #Line # creates Image from Android hardware buffer ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 652 | #Populate |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 653 | |
| 654 | #NoExample |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 655 | ## |
| 656 | |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 657 | #SeeAlso MakeFromRaster |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 658 | |
| 659 | #Method ## |
| 660 | |
| 661 | # ------------------------------------------------------------------------------ |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 662 | #Subtopic Property |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 663 | #Line # values and attributes ## |
| 664 | ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 665 | |
| 666 | #Method int width() const |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 667 | #In Property |
| 668 | #Line # returns pixel column count ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 669 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 670 | |
| 671 | #Example |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 672 | #Image 4 |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 673 | #Height 96 |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 674 | canvas->translate(10, 10); |
| 675 | canvas->drawImage(image, 0, 0); |
| 676 | canvas->translate(0, image->height()); |
| 677 | SkPaint paint; |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 678 | canvas->drawLine(0, 10, image->width(), 10, paint); |
Cary Clark | 14768f6 | 2018-10-29 20:33:51 -0400 | [diff] [blame] | 679 | canvas->drawString("width", image->width() / 2 - 15, 25, paint); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 680 | ## |
| 681 | |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 682 | #SeeAlso dimensions() height() |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 683 | |
| 684 | #Method ## |
| 685 | |
| 686 | # ------------------------------------------------------------------------------ |
| 687 | |
| 688 | #Method int height() const |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 689 | #In Property |
| 690 | #Line # returns pixel row count ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 691 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 692 | |
| 693 | #Example |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 694 | #Image 4 |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 695 | #Height 96 |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 696 | canvas->translate(10, 10); |
| 697 | canvas->drawImage(image, 0, 0); |
| 698 | canvas->translate(image->width(), 0); |
| 699 | SkPaint paint; |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 700 | canvas->drawLine(10, 0, 10, image->height(), paint); |
Cary Clark | 92694be | 2018-10-25 08:15:36 -0400 | [diff] [blame] | 701 | canvas->drawString("height", 34, image->height() / 2, paint); |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 702 | ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 703 | |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 704 | #SeeAlso dimensions() width() |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 705 | |
| 706 | #Method ## |
| 707 | |
| 708 | # ------------------------------------------------------------------------------ |
| 709 | |
| 710 | #Method SkISize dimensions() const |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 711 | #In Property |
| 712 | #Line # returns width() and height() ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 713 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 714 | |
| 715 | #Example |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 716 | #Image 4 |
| 717 | SkISize dimensions = image->dimensions(); |
| 718 | SkIRect bounds = image->bounds(); |
| 719 | SkIRect dimensionsAsBounds = SkIRect::MakeSize(dimensions); |
| 720 | SkDebugf("dimensionsAsBounds %c= bounds\n", dimensionsAsBounds == bounds ? '=' : '!'); |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 721 | #StdOut |
| 722 | dimensionsAsBounds == bounds |
| 723 | ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 724 | ## |
| 725 | |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 726 | #SeeAlso height() width() bounds() |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 727 | |
| 728 | #Method ## |
| 729 | |
| 730 | # ------------------------------------------------------------------------------ |
| 731 | |
| 732 | #Method SkIRect bounds() const |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 733 | #In Property |
| 734 | #Line # returns width() and height() as Rectangle ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 735 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 736 | |
| 737 | #Example |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 738 | #Height 128 |
| 739 | #Image 4 |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 740 | SkIRect bounds = image->bounds(); |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 741 | for (int x : { 0, bounds.width() } ) { |
| 742 | for (int y : { 0, bounds.height() } ) { |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 743 | canvas->drawImage(image, x, y); |
| 744 | } |
| 745 | } |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 746 | ## |
| 747 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 748 | #SeeAlso dimensions() |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 749 | |
| 750 | #Method ## |
| 751 | |
| 752 | # ------------------------------------------------------------------------------ |
| 753 | |
| 754 | #Method uint32_t uniqueID() const |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 755 | #In Property |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 756 | #Line # returns identifier for Image ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 757 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 758 | |
| 759 | #Example |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 760 | #Image 5 |
| 761 | #Height 156 |
| 762 | sk_sp<SkImage> subset = image->makeSubset({10, 20, 90, 100}); |
| 763 | canvas->drawImage(image, 0, 0); |
| 764 | canvas->drawImage(subset, 128, 0); |
| 765 | SkPaint paint; |
| 766 | SkString s; |
| 767 | s.printf("original id: %d", image->uniqueID()); |
| 768 | canvas->drawString(s, 20, image->height() + 20, paint); |
| 769 | s.printf("subset id: %d", subset->uniqueID()); |
| 770 | canvas->drawString(s, 148, subset->height() + 20, paint); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 771 | ## |
| 772 | |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 773 | #SeeAlso isLazyGenerated |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 774 | |
| 775 | #Method ## |
| 776 | |
| 777 | # ------------------------------------------------------------------------------ |
| 778 | |
| 779 | #Method SkAlphaType alphaType() const |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 780 | #In Property |
| 781 | #Line # returns Alpha_Type ## |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 782 | Returns Alpha_Type, one of: #list_of_alpha_types#. |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 783 | |
| 784 | Alpha_Type returned was a parameter to an Image constructor, |
| 785 | or was parsed from encoded data. |
| 786 | |
| 787 | #Return Alpha_Type in Image ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 788 | |
| 789 | #Example |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 790 | #Image 4 |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 791 | #Height 96 |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 792 | const char* alphaTypeStr[] = { "Unknown", "Opaque", "Premul", "Unpremul" }; |
| 793 | SkAlphaType alphaType = image->alphaType(); |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 794 | canvas->drawImage(image, 16, 0); |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 795 | canvas->drawString(alphaTypeStr[(int) alphaType], 20, image->height() + 20, SkPaint()); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 796 | ## |
| 797 | |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 798 | #SeeAlso SkImageInfo::alphaType |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 799 | |
| 800 | #Method ## |
| 801 | |
| 802 | # ------------------------------------------------------------------------------ |
| 803 | |
Greg Daniel | 56008aa | 2018-03-14 15:33:42 -0400 | [diff] [blame] | 804 | #Method SkColorType colorType() const |
| 805 | #In Property |
| 806 | #Line # returns Color_Type ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 807 | #Populate |
Greg Daniel | 56008aa | 2018-03-14 15:33:42 -0400 | [diff] [blame] | 808 | |
| 809 | #Example |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 810 | #Image 4 |
| 811 | #Height 96 |
| 812 | const char* colors[] = { "Unknown", "Alpha_8", "RGB_565", "ARGB_4444", "RGBA_8888", "RGB_888x", |
| 813 | "BGRA_8888", "RGBA_1010102", "RGB_101010x", "Gray_8", "RGBA_F16" }; |
| 814 | SkColorType colorType = image->colorType(); |
| 815 | canvas->drawImage(image, 16, 0); |
| 816 | canvas->drawString(colors[(int) colorType], 20, image->height() + 20, SkPaint()); |
Greg Daniel | 56008aa | 2018-03-14 15:33:42 -0400 | [diff] [blame] | 817 | ## |
| 818 | |
| 819 | #SeeAlso SkImageInfo::colorType |
| 820 | |
| 821 | #Method ## |
| 822 | |
| 823 | # ------------------------------------------------------------------------------ |
| 824 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 825 | #Method SkColorSpace* colorSpace() const |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 826 | #In Property |
| 827 | #Line # returns Color_Space ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 828 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 829 | |
| 830 | #Example |
Cary Clark | 61dfc3a | 2018-01-03 08:37:53 -0500 | [diff] [blame] | 831 | #Image 3 |
| 832 | #Set sRGB |
| 833 | SkPixmap pixmap; |
| 834 | source.peekPixels(&pixmap); |
| 835 | canvas->scale(.25f, .25f); |
| 836 | int y = 0; |
| 837 | for (auto gamma : { SkColorSpace::kLinear_RenderTargetGamma, |
| 838 | SkColorSpace::kSRGB_RenderTargetGamma } ) { |
| 839 | int x = 0; |
| 840 | sk_sp<SkColorSpace> colorSpace = SkColorSpace::MakeRGB(gamma, SkColorSpace::kSRGB_Gamut); |
| 841 | for (int index = 0; index < 2; ++index) { |
| 842 | pixmap.setColorSpace(colorSpace); |
| 843 | sk_sp<SkImage> image = SkImage::MakeRasterCopy(pixmap); |
| 844 | canvas->drawImage(image, x, y); |
| 845 | colorSpace = image->colorSpace()->makeColorSpin(); |
| 846 | x += 512; |
| 847 | } |
| 848 | y += 512; |
| 849 | } |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 850 | ## |
| 851 | |
Cary Clark | 61dfc3a | 2018-01-03 08:37:53 -0500 | [diff] [blame] | 852 | #SeeAlso refColorSpace makeColorSpace |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 853 | |
| 854 | #Method ## |
| 855 | |
| 856 | # ------------------------------------------------------------------------------ |
| 857 | |
| 858 | #Method sk_sp<SkColorSpace> refColorSpace() const |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 859 | #In Property |
| 860 | #Line # returns Image_Info Color_Space ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 861 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 862 | |
| 863 | #Example |
Cary Clark | 61dfc3a | 2018-01-03 08:37:53 -0500 | [diff] [blame] | 864 | #Image 3 |
| 865 | #Set sRGB |
| 866 | SkPixmap pixmap; |
| 867 | source.peekPixels(&pixmap); |
| 868 | canvas->scale(.25f, .25f); |
| 869 | int y = 0; |
| 870 | for (auto gamma : { SkColorSpace::kLinear_RenderTargetGamma, |
| 871 | SkColorSpace::kSRGB_RenderTargetGamma } ) { |
| 872 | int x = 0; |
| 873 | sk_sp<SkColorSpace> colorSpace = SkColorSpace::MakeRGB(gamma, SkColorSpace::kSRGB_Gamut); |
| 874 | for (int index = 0; index < 2; ++index) { |
| 875 | pixmap.setColorSpace(colorSpace); |
| 876 | sk_sp<SkImage> image = SkImage::MakeRasterCopy(pixmap); |
| 877 | canvas->drawImage(image, x, y); |
| 878 | colorSpace = image->refColorSpace()->makeColorSpin(); |
| 879 | x += 512; |
| 880 | } |
| 881 | y += 512; |
| 882 | } |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 883 | ## |
| 884 | |
Cary Clark | 61dfc3a | 2018-01-03 08:37:53 -0500 | [diff] [blame] | 885 | #SeeAlso colorSpace makeColorSpace |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 886 | |
| 887 | #Method ## |
| 888 | |
| 889 | # ------------------------------------------------------------------------------ |
| 890 | |
| 891 | #Method bool isAlphaOnly() const |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 892 | #In Property |
| 893 | #Line # returns if pixels represent a transparency mask ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 894 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 895 | |
| 896 | #Example |
Cary Clark | 61dfc3a | 2018-01-03 08:37:53 -0500 | [diff] [blame] | 897 | uint8_t pmColors = 0; |
| 898 | sk_sp<SkImage> image = SkImage::MakeRasterCopy({SkImageInfo::MakeA8(1, 1), &pmColors, 1}); |
| 899 | SkDebugf("alphaOnly = %s\n", image->isAlphaOnly() ? "true" : "false"); |
| 900 | #StdOut |
| 901 | alphaOnly = true |
| 902 | ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 903 | ## |
| 904 | |
Cary Clark | 61dfc3a | 2018-01-03 08:37:53 -0500 | [diff] [blame] | 905 | #SeeAlso alphaType isOpaque |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 906 | |
| 907 | #Method ## |
| 908 | |
| 909 | # ------------------------------------------------------------------------------ |
| 910 | |
| 911 | #Method bool isOpaque() const |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 912 | #In Property |
| 913 | #Line # returns if Alpha_Type is kOpaque_SkAlphaType ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 914 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 915 | |
| 916 | #Example |
Cary Clark | 61dfc3a | 2018-01-03 08:37:53 -0500 | [diff] [blame] | 917 | auto check_isopaque = [](const SkImageInfo& imageInfo) -> void { |
| 918 | auto surface(SkSurface::MakeRaster(imageInfo)); |
| 919 | auto image(surface->makeImageSnapshot()); |
| 920 | SkDebugf("isOpaque = %s\n", image->isOpaque() ? "true" : "false"); |
| 921 | }; |
| 922 | |
| 923 | check_isopaque(SkImageInfo::MakeN32Premul(5, 5)); |
| 924 | check_isopaque(SkImageInfo::MakeN32(5, 5, kOpaque_SkAlphaType)); |
| 925 | #StdOut |
| 926 | isOpaque = false |
| 927 | isOpaque = true |
| 928 | ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 929 | ## |
| 930 | |
Cary Clark | 61dfc3a | 2018-01-03 08:37:53 -0500 | [diff] [blame] | 931 | #SeeAlso alphaType isAlphaOnly |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 932 | |
| 933 | #Method ## |
| 934 | |
| 935 | # ------------------------------------------------------------------------------ |
| 936 | |
| 937 | #Method sk_sp<SkShader> makeShader(SkShader::TileMode tileMode1, SkShader::TileMode tileMode2, |
| 938 | const SkMatrix* localMatrix = nullptr) const |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 939 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 940 | #Line # creates Shader, Paint element that can tile Image ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 941 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 942 | |
| 943 | #Example |
Cary Clark | 61dfc3a | 2018-01-03 08:37:53 -0500 | [diff] [blame] | 944 | #Image 4 |
| 945 | SkMatrix matrix; |
| 946 | matrix.setRotate(45); |
| 947 | SkPaint paint; |
| 948 | paint.setShader(image->makeShader(SkShader::kRepeat_TileMode, SkShader::kMirror_TileMode, |
| 949 | &matrix)); |
| 950 | canvas->drawPaint(paint); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 951 | ## |
| 952 | |
Cary Clark | 61dfc3a | 2018-01-03 08:37:53 -0500 | [diff] [blame] | 953 | #SeeAlso scalePixels |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 954 | |
| 955 | #Method ## |
| 956 | |
| 957 | # ------------------------------------------------------------------------------ |
| 958 | |
| 959 | #Method sk_sp<SkShader> makeShader(const SkMatrix* localMatrix = nullptr) const |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 960 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 961 | |
| 962 | #Example |
Cary Clark | 61dfc3a | 2018-01-03 08:37:53 -0500 | [diff] [blame] | 963 | #Image 5 |
| 964 | SkMatrix matrix; |
| 965 | matrix.setRotate(45); |
| 966 | matrix.postTranslate(125, 30); |
| 967 | SkPaint paint; |
| 968 | paint.setShader(image->makeShader(&matrix)); |
| 969 | canvas->drawPaint(paint); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 970 | ## |
| 971 | |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 972 | #SeeAlso scalePixels |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 973 | |
| 974 | #Method ## |
| 975 | |
| 976 | # ------------------------------------------------------------------------------ |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 977 | #Subtopic Pixels |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 978 | #Line # read and write pixel values ## |
| 979 | ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 980 | |
| 981 | #Method bool peekPixels(SkPixmap* pixmap) const |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 982 | #In Pixels |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 983 | #Line # returns Pixmap if possible ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 984 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 985 | |
| 986 | #Example |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 987 | SkBitmap bitmap; |
| 988 | bitmap.allocPixels(SkImageInfo::MakeN32Premul(12, 11)); |
| 989 | SkCanvas offscreen(bitmap); |
| 990 | offscreen.clear(SK_ColorWHITE); |
| 991 | SkPaint paint; |
| 992 | offscreen.drawString("%", 1, 10, paint); |
| 993 | sk_sp<SkImage> image = SkImage::MakeFromBitmap(bitmap); |
| 994 | SkPixmap pixmap; |
| 995 | if (image->peekPixels(&pixmap)) { |
| 996 | const SkPMColor* pixels = pixmap.addr32(); |
| 997 | SkPMColor pmWhite = pixels[0]; |
| 998 | for (int y = 0; y < image->height(); ++y) { |
| 999 | for (int x = 0; x < image->width(); ++x) { |
| 1000 | SkDebugf("%c", *pixels++ == pmWhite ? '-' : 'x'); |
| 1001 | } |
| 1002 | SkDebugf("\n"); |
| 1003 | } |
| 1004 | } |
| 1005 | #StdOut |
| 1006 | ------------ |
| 1007 | --xx----x--- |
| 1008 | -x--x--x---- |
| 1009 | -x--x--x---- |
| 1010 | -x--x-x----- |
| 1011 | --xx-xx-xx-- |
| 1012 | -----x-x--x- |
| 1013 | ----x--x--x- |
| 1014 | ----x--x--x- |
| 1015 | ---x----xx-- |
| 1016 | ------------ |
| 1017 | ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1018 | ## |
| 1019 | |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1020 | #SeeAlso readPixels |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1021 | |
| 1022 | #Method ## |
| 1023 | |
| 1024 | # ------------------------------------------------------------------------------ |
| 1025 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1026 | #Method bool isTextureBacked() const |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 1027 | #In Property |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 1028 | #Line # returns if Image was created from GPU_Texture ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1029 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1030 | |
| 1031 | #Example |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1032 | #Image 5 |
| 1033 | #Platform gpu |
| 1034 | auto drawImage = [=](sk_sp<SkImage> image, const char* label) -> void { |
| 1035 | if (nullptr == image) { |
| 1036 | return; |
| 1037 | } |
| 1038 | SkPaint paint; |
| 1039 | paint.setAntiAlias(true); |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1040 | canvas->drawImage(image, 0, 0); |
Cary Clark | 14768f6 | 2018-10-29 20:33:51 -0400 | [diff] [blame] | 1041 | canvas->drawString(label, 30, image->height() / 4, paint); |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1042 | canvas->drawString(image->isTextureBacked() ? "is GPU texture" : "not GPU texture", |
Cary Clark | 14768f6 | 2018-10-29 20:33:51 -0400 | [diff] [blame] | 1043 | 20, image->height() * 3 / 4, paint); |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1044 | }; |
| 1045 | sk_sp<SkImage> bitmapImage(SkImage::MakeFromBitmap(source)); |
| 1046 | sk_sp<SkImage> textureImage(SkImage::MakeFromTexture(canvas->getGrContext(), backEndTexture, |
Cary Clark | ae957c4 | 2018-06-07 17:07:17 -0400 | [diff] [blame] | 1047 | kTopLeft_GrSurfaceOrigin, kRGBA_8888_SkColorType, |
| 1048 | kOpaque_SkAlphaType, nullptr)); |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1049 | drawImage(image, "image"); |
| 1050 | canvas->translate(image->width(), 0); |
| 1051 | drawImage(bitmapImage, "source"); |
| 1052 | canvas->translate(-image->width(), image->height()); |
| 1053 | drawImage(textureImage, "backEndTexture"); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1054 | ## |
| 1055 | |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1056 | #SeeAlso MakeFromTexture isValid |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1057 | |
| 1058 | #Method ## |
| 1059 | |
| 1060 | # ------------------------------------------------------------------------------ |
| 1061 | |
| 1062 | #Method bool isValid(GrContext* context) const |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 1063 | #In Property |
| 1064 | #Line # returns if Image can draw to Raster_Surface or GPU_Context ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1065 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1066 | |
| 1067 | #Example |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1068 | #Image 5 |
| 1069 | #Platform gpu |
| 1070 | auto drawImage = [=](sk_sp<SkImage> image, const char* label) -> void { |
| 1071 | if (nullptr == image) { |
| 1072 | return; |
| 1073 | } |
| 1074 | SkPaint paint; |
| 1075 | paint.setAntiAlias(true); |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1076 | canvas->drawImage(image, 0, 0); |
| 1077 | canvas->drawString(label, image->width() / 2, image->height() / 4, paint); |
| 1078 | if (canvas->getGrContext()) { |
| 1079 | canvas->drawString(image->isValid(canvas->getGrContext()) ? "is valid on GPU" : |
Cary Clark | 14768f6 | 2018-10-29 20:33:51 -0400 | [diff] [blame] | 1080 | "not valid on GPU", 20, image->height() * 5 / 8, paint); |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1081 | } |
| 1082 | canvas->drawString(image->isValid(nullptr) ? "is valid on CPU" : |
Cary Clark | 14768f6 | 2018-10-29 20:33:51 -0400 | [diff] [blame] | 1083 | "not valid on CPU", 20, image->height() * 7 / 8, paint); |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1084 | }; |
| 1085 | sk_sp<SkImage> bitmapImage(SkImage::MakeFromBitmap(source)); |
| 1086 | sk_sp<SkImage> textureImage(SkImage::MakeFromTexture(canvas->getGrContext(), backEndTexture, |
Cary Clark | ae957c4 | 2018-06-07 17:07:17 -0400 | [diff] [blame] | 1087 | kTopLeft_GrSurfaceOrigin, kRGBA_8888_SkColorType, |
| 1088 | kOpaque_SkAlphaType, nullptr)); |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1089 | drawImage(image, "image"); |
| 1090 | canvas->translate(image->width(), 0); |
| 1091 | drawImage(bitmapImage, "source"); |
| 1092 | canvas->translate(-image->width(), image->height()); |
| 1093 | drawImage(textureImage, "backEndTexture"); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1094 | ## |
| 1095 | |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1096 | #SeeAlso isTextureBacked isLazyGenerated |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1097 | |
| 1098 | #Method ## |
| 1099 | |
| 1100 | # ------------------------------------------------------------------------------ |
| 1101 | |
Robert Phillips | c550995 | 2018-04-04 15:54:55 -0400 | [diff] [blame] | 1102 | #Method GrBackendTexture getBackendTexture(bool flushPendingGrContextIO, |
| 1103 | GrSurfaceOrigin* origin = nullptr) const |
| 1104 | #In Property |
| 1105 | #Line # returns GPU reference to Image as texture ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1106 | #Populate |
Robert Phillips | c550995 | 2018-04-04 15:54:55 -0400 | [diff] [blame] | 1107 | |
Cary Clark | ba75aee | 2018-04-05 08:18:41 -0400 | [diff] [blame] | 1108 | #Example |
| 1109 | #Image 3 |
| 1110 | #Platform gpu |
Brian Osman | 584b501 | 2018-04-13 15:48:26 -0400 | [diff] [blame] | 1111 | GrContext* grContext = canvas->getGrContext(); |
| 1112 | if (!grContext) { |
| 1113 | canvas->drawString("GPU only!", 20, 40, SkPaint()); |
| 1114 | return; |
| 1115 | } |
| 1116 | sk_sp<SkImage> imageFromBackend = SkImage::MakeFromAdoptedTexture(grContext, backEndTexture, |
| 1117 | kBottomLeft_GrSurfaceOrigin, kRGBA_8888_SkColorType, kOpaque_SkAlphaType); |
| 1118 | GrBackendTexture textureFromImage = imageFromBackend->getBackendTexture(false); |
| 1119 | if (!textureFromImage.isValid()) { |
| 1120 | return; |
| 1121 | } |
| 1122 | sk_sp<SkImage> imageFromTexture = SkImage::MakeFromAdoptedTexture(grContext, textureFromImage, |
| 1123 | kTopLeft_GrSurfaceOrigin, kRGBA_8888_SkColorType, kOpaque_SkAlphaType); |
| 1124 | canvas->drawImage(imageFromTexture, 0, 0); |
Cary Clark | ba75aee | 2018-04-05 08:18:41 -0400 | [diff] [blame] | 1125 | canvas->drawImage(imageFromBackend, 128, 128); |
Robert Phillips | c550995 | 2018-04-04 15:54:55 -0400 | [diff] [blame] | 1126 | ## |
| 1127 | |
| 1128 | #SeeAlso MakeFromTexture isTextureBacked |
| 1129 | |
| 1130 | #Method ## |
| 1131 | |
| 1132 | # ------------------------------------------------------------------------------ |
| 1133 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1134 | #Enum CachingHint |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1135 | #Line # options for readPixels and scalePixels ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1136 | #Code |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1137 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1138 | ## |
| 1139 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1140 | CachingHint selects whether Skia may internally cache Bitmaps generated by |
| 1141 | decoding Image, or by copying Image from GPU to CPU. The default behavior |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1142 | allows caching Bitmaps. |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1143 | |
| 1144 | Choose kDisallow_CachingHint if Image pixels are to be used only once, or |
| 1145 | if Image pixels reside in a cache outside of Skia, or to reduce memory pressure. |
| 1146 | |
| 1147 | Choosing kAllow_CachingHint does not ensure that pixels will be cached. |
| 1148 | Image pixels may not be cached if memory requirements are too large or |
| 1149 | pixels are not accessible. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1150 | |
| 1151 | #Const kAllow_CachingHint 0 |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1152 | #Line # allows internally caching decoded and copied pixels ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1153 | ## |
| 1154 | #Const kDisallow_CachingHint 1 |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1155 | #Line # disallows internally caching decoded and copied pixels ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1156 | ## |
| 1157 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1158 | #NoExample |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1159 | ## |
| 1160 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1161 | #SeeAlso readPixels scalePixels |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1162 | |
| 1163 | #Enum ## |
| 1164 | |
| 1165 | # ------------------------------------------------------------------------------ |
| 1166 | |
| 1167 | #Method bool readPixels(const SkImageInfo& dstInfo, void* dstPixels, size_t dstRowBytes, |
| 1168 | int srcX, int srcY, CachingHint cachingHint = kAllow_CachingHint) const |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 1169 | #In Pixels |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 1170 | #Line # copies and converts pixels ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1171 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1172 | Copies Rect of pixels from Image to dstPixels. Copy starts at offset (srcX, srcY), |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1173 | and does not exceed Image (width(), height()). |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1174 | |
| 1175 | dstInfo specifies width, height, Color_Type, Alpha_Type, and Color_Space of |
| 1176 | destination. dstRowBytes specifics the gap from one destination row to the next. |
| 1177 | Returns true if pixels are copied. Returns false if: |
| 1178 | #List |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1179 | # dstInfo has no address ## |
| 1180 | # dstRowBytes is less than dstInfo.minRowBytes() ## |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1181 | # Pixel_Ref is nullptr ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1182 | ## |
| 1183 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1184 | Pixels are copied only if pixel conversion is possible. If Image Color_Type is |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1185 | kGray_8_SkColorType, or kAlpha_8_SkColorType; dstInfo.colorType() must match. |
| 1186 | If Image Color_Type is kGray_8_SkColorType, dstInfo.colorSpace() must match. |
| 1187 | If Image Alpha_Type is kOpaque_SkAlphaType, dstInfo.alphaType() must |
| 1188 | match. If Image Color_Space is nullptr, dstInfo.colorSpace() must match. Returns |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1189 | false if pixel conversion is not possible. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1190 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1191 | srcX and srcY may be negative to copy only top or left of source. Returns |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1192 | false if width() or height() is zero or negative. |
Cary Clark | 2be81cf | 2018-09-13 12:04:30 -0400 | [diff] [blame] | 1193 | Returns false if #Formula # abs(srcX) >= Image width() ##, or if #Formula # abs(srcY) >= Image height() ##. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1194 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1195 | If cachingHint is kAllow_CachingHint, pixels may be retained locally. |
| 1196 | If cachingHint is kDisallow_CachingHint, pixels are not added to the local cache. |
| 1197 | |
| 1198 | #Param dstInfo destination width, height, Color_Type, Alpha_Type, Color_Space ## |
| 1199 | #Param dstPixels destination pixel storage ## |
| 1200 | #Param dstRowBytes destination row length ## |
| 1201 | #Param srcX column index whose absolute value is less than width() ## |
| 1202 | #Param srcY row index whose absolute value is less than height() ## |
| 1203 | #Param cachingHint one of: kAllow_CachingHint, kDisallow_CachingHint ## |
| 1204 | |
| 1205 | #Return true if pixels are copied to dstPixels ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1206 | |
| 1207 | #Example |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1208 | #Image 3 |
| 1209 | canvas->scale(.5f, .5f); |
| 1210 | const int width = 32; |
| 1211 | const int height = 32; |
| 1212 | std::vector<int32_t> dstPixels; |
| 1213 | dstPixels.resize(height * width * 4); |
| 1214 | SkImageInfo info = SkImageInfo::MakeN32Premul(width, height); |
| 1215 | for (int y = 0; y < 512; y += height ) { |
| 1216 | for (int x = 0; x < 512; x += width ) { |
| 1217 | if (image->readPixels(info, &dstPixels.front(), width * 4, x, y)) { |
| 1218 | SkPixmap dstPixmap(info, &dstPixels.front(), width * 4); |
| 1219 | SkBitmap bitmap; |
| 1220 | bitmap.installPixels(dstPixmap); |
| 1221 | canvas->drawBitmap(bitmap, 0, 0); |
| 1222 | } |
| 1223 | canvas->translate(48, 0); |
| 1224 | } |
| 1225 | canvas->translate(-16 * 48, 48); |
| 1226 | } |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1227 | ## |
| 1228 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1229 | #SeeAlso scalePixels SkBitmap::readPixels SkPixmap::readPixels SkCanvas::readPixels SkSurface::readPixels |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1230 | |
| 1231 | #Method ## |
| 1232 | |
| 1233 | # ------------------------------------------------------------------------------ |
| 1234 | |
| 1235 | #Method bool readPixels(const SkPixmap& dst, int srcX, int srcY, |
| 1236 | CachingHint cachingHint = kAllow_CachingHint) const |
| 1237 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1238 | Copies a Rect of pixels from Image to dst. Copy starts at (srcX, srcY), and |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1239 | does not exceed Image (width(), height()). |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1240 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1241 | dst specifies width, height, Color_Type, Alpha_Type, Color_Space, pixel storage, |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1242 | and row bytes of destination. dst.rowBytes() specifics the gap from one destination |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1243 | row to the next. Returns true if pixels are copied. Returns false if: |
| 1244 | #List |
| 1245 | # dst pixel storage equals nullptr ## |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1246 | # dst.rowBytes() is less than SkImageInfo::minRowBytes ## |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1247 | # Pixel_Ref is nullptr ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1248 | ## |
| 1249 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1250 | Pixels are copied only if pixel conversion is possible. If Image Color_Type is |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1251 | kGray_8_SkColorType, or kAlpha_8_SkColorType; dst.colorType() must match. |
| 1252 | If Image Color_Type is kGray_8_SkColorType, dst.colorSpace() must match. |
| 1253 | If Image Alpha_Type is kOpaque_SkAlphaType, dst.alphaType() must |
| 1254 | match. If Image Color_Space is nullptr, dst.colorSpace() must match. Returns |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1255 | false if pixel conversion is not possible. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1256 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1257 | srcX and srcY may be negative to copy only top or left of source. Returns |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1258 | false if width() or height() is zero or negative. |
Cary Clark | 2be81cf | 2018-09-13 12:04:30 -0400 | [diff] [blame] | 1259 | Returns false if #Formula # abs(srcX) >= Image width() ##, or if #Formula # abs(srcY) >= Image height() ##. |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1260 | |
| 1261 | If cachingHint is kAllow_CachingHint, pixels may be retained locally. |
| 1262 | If cachingHint is kDisallow_CachingHint, pixels are not added to the local cache. |
| 1263 | |
| 1264 | #Param dst destination Pixmap: Image_Info, pixels, row bytes ## |
| 1265 | #Param srcX column index whose absolute value is less than width() ## |
| 1266 | #Param srcY row index whose absolute value is less than height() ## |
| 1267 | #Param cachingHint one of: kAllow_CachingHint, kDisallow_CachingHint ## |
| 1268 | |
| 1269 | #Return true if pixels are copied to dst ## |
| 1270 | |
| 1271 | #Example |
| 1272 | #Image 3 |
| 1273 | std::vector<int32_t> srcPixels; |
| 1274 | int rowBytes = image->width() * 4; |
| 1275 | int quarterWidth = image->width() / 4; |
| 1276 | int quarterHeight = image->height() / 4; |
| 1277 | srcPixels.resize(image->height() * rowBytes); |
| 1278 | for (int y = 0; y < 4; ++y) { |
| 1279 | for (int x = 0; x < 4; ++x) { |
| 1280 | SkPixmap pixmap(SkImageInfo::MakeN32Premul(quarterWidth, quarterHeight), |
| 1281 | &srcPixels.front() + x * image->height() * quarterWidth + |
| 1282 | y * quarterWidth, rowBytes); |
| 1283 | image->readPixels(pixmap, x * quarterWidth, y * quarterHeight); |
| 1284 | } |
| 1285 | } |
| 1286 | canvas->scale(.5f, .5f); |
| 1287 | SkBitmap bitmap; |
| 1288 | bitmap.installPixels(SkImageInfo::MakeN32Premul(image->width(), image->height()), |
| 1289 | &srcPixels.front(), rowBytes); |
| 1290 | canvas->drawBitmap(bitmap, 0, 0); |
| 1291 | ## |
| 1292 | |
| 1293 | #SeeAlso scalePixels SkBitmap::readPixels SkPixmap::readPixels SkCanvas::readPixels SkSurface::readPixels |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1294 | |
| 1295 | #Method ## |
| 1296 | |
| 1297 | # ------------------------------------------------------------------------------ |
| 1298 | |
| 1299 | #Method bool scalePixels(const SkPixmap& dst, SkFilterQuality filterQuality, |
| 1300 | CachingHint cachingHint = kAllow_CachingHint) const |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 1301 | #In Pixels |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 1302 | #Line # scales and converts one Image to another ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1303 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1304 | |
| 1305 | #Example |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1306 | #Image 3 |
| 1307 | #Height 128 |
| 1308 | std::vector<int32_t> srcPixels; |
| 1309 | int quarterWidth = image->width() / 16; |
| 1310 | int rowBytes = quarterWidth * 4; |
| 1311 | int quarterHeight = image->height() / 16; |
| 1312 | srcPixels.resize(quarterHeight * rowBytes); |
| 1313 | SkPixmap pixmap(SkImageInfo::MakeN32Premul(quarterWidth, quarterHeight), |
| 1314 | &srcPixels.front(), rowBytes); |
| 1315 | canvas->scale(4, 4); |
| 1316 | SkFilterQuality qualities[] = { kNone_SkFilterQuality, kLow_SkFilterQuality, |
| 1317 | kMedium_SkFilterQuality, kHigh_SkFilterQuality }; |
| 1318 | for (unsigned index = 0; index < SK_ARRAY_COUNT(qualities); ++index) { |
| 1319 | image->scalePixels(pixmap, qualities[index]); |
| 1320 | sk_sp<SkImage> filtered = SkImage::MakeFromRaster(pixmap, nullptr, nullptr); |
| 1321 | canvas->drawImage(filtered, 16 * index, 0); |
| 1322 | } |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1323 | ## |
| 1324 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1325 | #SeeAlso SkCanvas::drawImage readPixels SkPixmap::scalePixels |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1326 | |
| 1327 | #Method ## |
| 1328 | |
| 1329 | # ------------------------------------------------------------------------------ |
| 1330 | |
| 1331 | #Method sk_sp<SkData> encodeToData(SkEncodedImageFormat encodedImageFormat, int quality) const |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 1332 | #In Utility |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 1333 | #Line # returns encoded Image as SkData ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1334 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1335 | |
| 1336 | #Example |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1337 | #Image 3 |
| 1338 | canvas->scale(4, 4); |
| 1339 | SkIRect subset = {0, 0, 16, 64}; |
| 1340 | int x = 0; |
| 1341 | for (int quality : { 0, 10, 50, 100 } ) { |
| 1342 | sk_sp<SkData> data(image->encodeToData(SkEncodedImageFormat::kJPEG, quality)); |
| 1343 | sk_sp<SkImage> filtered = SkImage::MakeFromEncoded(data, &subset); |
| 1344 | canvas->drawImage(filtered, x, 0); |
| 1345 | x += 16; |
| 1346 | } |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1347 | ## |
| 1348 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1349 | #SeeAlso refEncodedData MakeFromEncoded |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1350 | |
| 1351 | #Method ## |
| 1352 | |
| 1353 | # ------------------------------------------------------------------------------ |
| 1354 | |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 1355 | #Method sk_sp<SkData> encodeToData() const |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1356 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1357 | |
| 1358 | #Example |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1359 | #Image 3 |
| 1360 | canvas->scale(4, 4); |
| 1361 | SkIRect subset = {136, 32, 200, 96}; |
| 1362 | sk_sp<SkData> data(image->encodeToData()); |
| 1363 | sk_sp<SkImage> eye = SkImage::MakeFromEncoded(data, &subset); |
| 1364 | canvas->drawImage(eye, 0, 0); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1365 | ## |
| 1366 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1367 | #SeeAlso refEncodedData MakeFromEncoded |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1368 | |
| 1369 | #Method ## |
| 1370 | |
| 1371 | # ------------------------------------------------------------------------------ |
| 1372 | |
| 1373 | #Method sk_sp<SkData> refEncodedData() const |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 1374 | #In Utility |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 1375 | #Line # returns Image encoded in SkData if present ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1376 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1377 | |
| 1378 | #Example |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1379 | #Image 3 |
| 1380 | #Platform gpu |
| 1381 | struct { |
| 1382 | const char* name; |
| 1383 | sk_sp<SkImage> image; |
| 1384 | } tests[] = { { "image", image }, { "bitmap", SkImage::MakeFromBitmap(source) }, |
| 1385 | { "texture", SkImage::MakeFromTexture(canvas->getGrContext(), backEndTexture, |
Cary Clark | ae957c4 | 2018-06-07 17:07:17 -0400 | [diff] [blame] | 1386 | kTopLeft_GrSurfaceOrigin, kRGBA_8888_SkColorType, |
| 1387 | kOpaque_SkAlphaType, nullptr) } }; |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1388 | SkString string; |
| 1389 | SkPaint paint; |
| 1390 | for (const auto& test : tests ) { |
| 1391 | if (!test.image) { |
| 1392 | string.printf("no %s", test.name); |
| 1393 | } else { |
| 1394 | string.printf("%s" "encoded %s", test.image->refEncodedData() ? "" : "no ", test.name); |
| 1395 | } |
| 1396 | canvas->drawString(string, 10, 20, paint); |
| 1397 | canvas->translate(0, 20); |
| 1398 | } |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1399 | ## |
| 1400 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1401 | #SeeAlso encodeToData MakeFromEncoded |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1402 | |
| 1403 | #Method ## |
| 1404 | |
| 1405 | # ------------------------------------------------------------------------------ |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 1406 | #Subtopic Utility |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 1407 | #Line # rarely called management functions ## |
| 1408 | ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1409 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1410 | #Method sk_sp<SkImage> makeSubset(const SkIRect& subset) const |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 1411 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 1412 | #Line # creates Image containing part of original ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1413 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1414 | |
| 1415 | #Example |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1416 | #Image 3 |
| 1417 | canvas->scale(.5f, .5f); |
Cary Clark | c30382f | 2018-07-24 08:09:27 -0400 | [diff] [blame] | 1418 | const int width = 64; |
| 1419 | const int height = 64; |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1420 | for (int y = 0; y < 512; y += height ) { |
| 1421 | for (int x = 0; x < 512; x += width ) { |
| 1422 | sk_sp<SkImage> subset(image->makeSubset({x, y, x + width, y + height})); |
| 1423 | canvas->drawImage(subset, x * 3 / 2, y * 3 / 2); |
| 1424 | } |
| 1425 | } |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1426 | ## |
| 1427 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1428 | #SeeAlso MakeFromEncoded |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1429 | |
| 1430 | #Method ## |
| 1431 | |
| 1432 | # ------------------------------------------------------------------------------ |
| 1433 | |
Greg Daniel | 5f4b09d | 2018-06-12 16:39:59 -0400 | [diff] [blame] | 1434 | #Method sk_sp<SkImage> makeTextureImage(GrContext* context, SkColorSpace* dstColorSpace, |
| 1435 | GrMipMapped mipMapped = GrMipMapped::kNo) const |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 1436 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 1437 | #Line # creates Image matching Color_Space if possible ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1438 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1439 | |
| 1440 | #Example |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1441 | #Platform gpu |
| 1442 | #Image 5 |
| 1443 | auto drawImage = [=](sk_sp<SkImage> image, GrContext* context, const char* label) -> void { |
| 1444 | if (nullptr == image || nullptr == context) { |
| 1445 | return; |
| 1446 | } |
| 1447 | SkPaint paint; |
| 1448 | paint.setAntiAlias(true); |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1449 | sk_sp<SkImage> texture(image->makeTextureImage(context, nullptr)); |
| 1450 | canvas->drawImage(texture, 0, 0); |
Cary Clark | 14768f6 | 2018-10-29 20:33:51 -0400 | [diff] [blame] | 1451 | canvas->drawString(label, 20, texture->height() / 4, paint); |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1452 | }; |
| 1453 | sk_sp<SkImage> bitmapImage(SkImage::MakeFromBitmap(source)); |
| 1454 | GrContext* context = canvas->getGrContext(); |
| 1455 | sk_sp<SkImage> textureImage(SkImage::MakeFromTexture(context, backEndTexture, |
Cary Clark | ae957c4 | 2018-06-07 17:07:17 -0400 | [diff] [blame] | 1456 | kTopLeft_GrSurfaceOrigin, kRGBA_8888_SkColorType, |
| 1457 | kOpaque_SkAlphaType, nullptr)); |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1458 | drawImage(image, context, "image"); |
| 1459 | canvas->translate(image->width(), 0); |
| 1460 | drawImage(bitmapImage, context, "source"); |
| 1461 | canvas->translate(-image->width(), image->height()); |
| 1462 | drawImage(textureImage, context, "backEndTexture"); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1463 | ## |
| 1464 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1465 | #SeeAlso MakeFromTexture |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1466 | |
| 1467 | #Method ## |
| 1468 | |
| 1469 | # ------------------------------------------------------------------------------ |
| 1470 | |
| 1471 | #Method sk_sp<SkImage> makeNonTextureImage() const |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 1472 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 1473 | #Line # creates Image without dependency on GPU_Texture ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1474 | #Populate |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 1475 | |
| 1476 | #Example |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1477 | #Image 5 |
| 1478 | #Platform gpu |
| 1479 | auto drawImage = [=](sk_sp<SkImage> image, const char* label) -> void { |
| 1480 | if (nullptr == image) { |
| 1481 | return; |
| 1482 | } |
| 1483 | SkPaint paint; |
| 1484 | paint.setAntiAlias(true); |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1485 | sk_sp<SkImage> nonTexture(image->makeNonTextureImage()); |
| 1486 | canvas->drawImage(nonTexture, 0, 0); |
Cary Clark | 14768f6 | 2018-10-29 20:33:51 -0400 | [diff] [blame] | 1487 | canvas->drawString(label, 20, nonTexture->height() / 4, paint); |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1488 | }; |
| 1489 | sk_sp<SkImage> bitmapImage(SkImage::MakeFromBitmap(source)); |
| 1490 | sk_sp<SkImage> textureImage(SkImage::MakeFromTexture(canvas->getGrContext(), backEndTexture, |
Cary Clark | ae957c4 | 2018-06-07 17:07:17 -0400 | [diff] [blame] | 1491 | kTopLeft_GrSurfaceOrigin, kRGBA_8888_SkColorType, |
| 1492 | kOpaque_SkAlphaType, nullptr)); |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1493 | drawImage(image, "image"); |
| 1494 | canvas->translate(image->width(), 0); |
| 1495 | drawImage(bitmapImage, "source"); |
| 1496 | canvas->translate(-image->width(), image->height()); |
| 1497 | drawImage(textureImage, "backEndTexture"); |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 1498 | ## |
| 1499 | |
Cary Clark | 5635631 | 2018-02-08 14:45:18 -0500 | [diff] [blame] | 1500 | #SeeAlso makeTextureImage makeRasterImage MakeBackendTextureFromSkImage |
Cary Clark | 61ca7c5 | 2018-01-02 11:34:14 -0500 | [diff] [blame] | 1501 | |
| 1502 | #Method ## |
| 1503 | |
| 1504 | # ------------------------------------------------------------------------------ |
| 1505 | |
| 1506 | #Method sk_sp<SkImage> makeRasterImage() const |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 1507 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 1508 | #Line # creates Image compatible with Raster_Surface if possible ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1509 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1510 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1511 | #Example |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1512 | #Image 5 |
| 1513 | #Platform gpu |
| 1514 | auto drawImage = [=](sk_sp<SkImage> image, const char* label) -> void { |
| 1515 | if (nullptr == image) { |
| 1516 | return; |
| 1517 | } |
| 1518 | SkPaint paint; |
| 1519 | paint.setAntiAlias(true); |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1520 | sk_sp<SkImage> raster(image->makeRasterImage()); |
| 1521 | canvas->drawImage(raster, 0, 0); |
Cary Clark | 14768f6 | 2018-10-29 20:33:51 -0400 | [diff] [blame] | 1522 | canvas->drawString(label, 20, raster->height() / 4, paint); |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1523 | }; |
| 1524 | sk_sp<SkImage> bitmapImage(SkImage::MakeFromBitmap(source)); |
| 1525 | sk_sp<SkImage> textureImage(SkImage::MakeFromTexture(canvas->getGrContext(), backEndTexture, |
Cary Clark | ae957c4 | 2018-06-07 17:07:17 -0400 | [diff] [blame] | 1526 | kTopLeft_GrSurfaceOrigin, kRGBA_8888_SkColorType, |
| 1527 | kOpaque_SkAlphaType, nullptr)); |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1528 | drawImage(image, "image"); |
| 1529 | canvas->translate(image->width(), 0); |
| 1530 | drawImage(bitmapImage, "source"); |
| 1531 | canvas->translate(-image->width(), image->height()); |
| 1532 | drawImage(textureImage, "backEndTexture"); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1533 | ## |
| 1534 | |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1535 | #SeeAlso isTextureBacked isLazyGenerated MakeFromRaster |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1536 | |
| 1537 | #Method ## |
| 1538 | |
| 1539 | # ------------------------------------------------------------------------------ |
| 1540 | |
| 1541 | #Method sk_sp<SkImage> makeWithFilter(const SkImageFilter* filter, const SkIRect& subset, |
| 1542 | const SkIRect& clipBounds, SkIRect* outSubset, |
| 1543 | SkIPoint* offset) const |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 1544 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 1545 | #Line # creates filtered, clipped Image ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1546 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1547 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1548 | #Example |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1549 | #Description |
| 1550 | In each frame of the animation, filtered Image is drawn in a different location. |
| 1551 | By translating canvas by returned offset, Image appears stationary. |
| 1552 | ## |
| 1553 | #Image 5 |
| 1554 | #Platform gpu |
Cary Clark | 5717e82 | 2018-09-21 11:36:41 -0400 | [diff] [blame] | 1555 | #Duration 1 |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1556 | sk_sp<SkImageFilter> shadowFilter = SkDropShadowImageFilter::Make( |
| 1557 | -10.0f * frame, 5.0f * frame, 3.0f, 3.0f, SK_ColorBLUE, |
| 1558 | SkDropShadowImageFilter::kDrawShadowAndForeground_ShadowMode, |
| 1559 | nullptr); |
| 1560 | sk_sp<SkImageFilter> offsetFilter = SkOffsetImageFilter::Make(40, 40, shadowFilter, nullptr); |
| 1561 | SkIRect subset = image->bounds(); |
| 1562 | SkIRect clipBounds = image->bounds(); |
| 1563 | clipBounds.outset(60, 60); |
| 1564 | SkIRect outSubset; |
| 1565 | SkIPoint offset; |
| 1566 | sk_sp<SkImage> filtered(image->makeWithFilter(offsetFilter.get(), subset, clipBounds, |
| 1567 | &outSubset, &offset)); |
| 1568 | SkPaint paint; |
| 1569 | paint.setAntiAlias(true); |
| 1570 | paint.setStyle(SkPaint::kStroke_Style); |
| 1571 | canvas->drawLine(0, 0, offset.fX, offset.fY, paint); |
| 1572 | canvas->translate(offset.fX, offset.fY); |
| 1573 | canvas->drawImage(filtered, 0, 0); |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 1574 | canvas->drawRect(SkRect::Make(outSubset), paint); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1575 | ## |
| 1576 | |
Cary Clark | 5635631 | 2018-02-08 14:45:18 -0500 | [diff] [blame] | 1577 | #SeeAlso makeShader SkPaint::setImageFilter |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1578 | |
| 1579 | #Method ## |
| 1580 | |
| 1581 | # ------------------------------------------------------------------------------ |
| 1582 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1583 | #Typedef std::function<void(GrBackendTexture)> BackendTextureReleaseProc |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1584 | #Line # parameter type for MakeBackendTextureFromSkImage ## |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1585 | |
| 1586 | #Code |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1587 | #Populate |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1588 | ## |
| 1589 | |
Cary Clark | 0d22539 | 2018-06-07 09:59:07 -0400 | [diff] [blame] | 1590 | Defines a callback function, taking one parameter of type GrBackendTexture with |
| 1591 | no return value. Function is called when back-end texture is to be released. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1592 | ## |
| 1593 | |
| 1594 | # ------------------------------------------------------------------------------ |
| 1595 | |
| 1596 | #Method static bool MakeBackendTextureFromSkImage(GrContext* context, |
| 1597 | sk_sp<SkImage> image, |
| 1598 | GrBackendTexture* backendTexture, |
| 1599 | BackendTextureReleaseProc* backendTextureReleaseProc) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 1600 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 1601 | #Line # creates GPU_Texture from Image ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1602 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1603 | |
| 1604 | #Example |
Cary Clark | 5635631 | 2018-02-08 14:45:18 -0500 | [diff] [blame] | 1605 | #Platform gpu |
| 1606 | #Height 64 |
| 1607 | #Function |
Brian Salomon | 67f8584 | 2018-02-09 08:50:22 -0500 | [diff] [blame] | 1608 | static sk_sp<SkImage> create_gpu_image(GrContext* grContext) { |
| 1609 | const SkImageInfo info = SkImageInfo::MakeN32(20, 20, kOpaque_SkAlphaType); |
| 1610 | auto surface(SkSurface::MakeRenderTarget(grContext, SkBudgeted::kNo, info)); |
| 1611 | SkCanvas* canvas = surface->getCanvas(); |
| 1612 | canvas->clear(SK_ColorWHITE); |
| 1613 | SkPaint paint; |
| 1614 | paint.setColor(SK_ColorBLACK); |
| 1615 | canvas->drawRect(SkRect::MakeXYWH(5, 5, 10, 10), paint); |
| 1616 | return surface->makeImageSnapshot(); |
| 1617 | } |
| 1618 | ## |
| 1619 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1620 | void draw(SkCanvas* canvas) { |
Brian Salomon | 67f8584 | 2018-02-09 08:50:22 -0500 | [diff] [blame] | 1621 | GrContext* grContext = canvas->getGrContext(); |
| 1622 | if (!grContext) { |
| 1623 | return; |
| 1624 | } |
| 1625 | sk_sp<SkImage> backEndImage = create_gpu_image(grContext); |
| 1626 | canvas->drawImage(backEndImage, 0, 0); |
| 1627 | GrBackendTexture texture; |
| 1628 | SkImage::BackendTextureReleaseProc proc; |
| 1629 | if (!SkImage::MakeBackendTextureFromSkImage(grContext, std::move(backEndImage), |
| 1630 | &texture, &proc)) { |
| 1631 | return; |
| 1632 | } |
| 1633 | sk_sp<SkImage> i2 = SkImage::MakeFromTexture(grContext, texture, kTopLeft_GrSurfaceOrigin, |
| 1634 | kN32_SkColorType, kOpaque_SkAlphaType, nullptr); |
| 1635 | canvas->drawImage(i2, 30, 30); |
Cary Clark | 5635631 | 2018-02-08 14:45:18 -0500 | [diff] [blame] | 1636 | } |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1637 | ## |
| 1638 | |
Cary Clark | 5635631 | 2018-02-08 14:45:18 -0500 | [diff] [blame] | 1639 | #SeeAlso MakeFromTexture makeTextureImage |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1640 | |
| 1641 | #Method ## |
| 1642 | |
| 1643 | # ------------------------------------------------------------------------------ |
| 1644 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1645 | #Method bool isLazyGenerated() const |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 1646 | #In Property |
| 1647 | #Line # returns if Image is created as needed ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1648 | #Populate |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1649 | |
| 1650 | #Example |
Cary Clark | 2f46624 | 2017-12-11 16:03:17 -0500 | [diff] [blame] | 1651 | #Height 80 |
| 1652 | #Function |
| 1653 | class TestImageGenerator : public SkImageGenerator { |
| 1654 | public: |
| 1655 | TestImageGenerator() : SkImageGenerator(SkImageInfo::MakeN32Premul(10, 10)) {} |
| 1656 | ~TestImageGenerator() override {} |
| 1657 | protected: |
| 1658 | bool onGetPixels(const SkImageInfo& info, void* pixelPtr, size_t rowBytes, |
| 1659 | const Options& options) override { |
| 1660 | SkPMColor* pixels = static_cast<SkPMColor*>(pixelPtr); |
| 1661 | for (int y = 0; y < info.height(); ++y) { |
| 1662 | for (int x = 0; x < info.width(); ++x) { |
| 1663 | pixels[y * info.width() + x] = 0xff223344 + y * 0x000C0811; |
| 1664 | } |
| 1665 | } |
| 1666 | return true; |
| 1667 | } |
| 1668 | }; |
| 1669 | ## |
| 1670 | void draw(SkCanvas* canvas) { |
| 1671 | auto gen = std::unique_ptr<TestImageGenerator>(new TestImageGenerator()); |
| 1672 | sk_sp<SkImage> image(SkImage::MakeFromGenerator(std::move(gen))); |
| 1673 | SkString lazy(image->isLazyGenerated() ? "is lazy" : "not lazy"); |
| 1674 | canvas->scale(8, 8); |
| 1675 | canvas->drawImage(image, 0, 0, nullptr); |
| 1676 | SkPaint paint; |
| 1677 | paint.setTextSize(4); |
| 1678 | canvas->drawString(lazy, 2, 5, paint); |
| 1679 | } |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1680 | ## |
| 1681 | |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1682 | #Example |
| 1683 | #Image 5 |
| 1684 | #Platform gpu |
| 1685 | void draw(SkCanvas* canvas) { |
| 1686 | auto drawImage = [=](sk_sp<SkImage> image, const char* label) -> void { |
| 1687 | if (nullptr == image) { |
| 1688 | return; |
| 1689 | } |
| 1690 | SkPaint paint; |
| 1691 | paint.setAntiAlias(true); |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1692 | canvas->drawImage(image, 0, 0); |
Cary Clark | 14768f6 | 2018-10-29 20:33:51 -0400 | [diff] [blame] | 1693 | canvas->drawString(label, 30, image->height() / 4, paint); |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1694 | canvas->drawString( |
| 1695 | image->isLazyGenerated() ? "is lazily generated" : "not lazily generated", |
Cary Clark | 14768f6 | 2018-10-29 20:33:51 -0400 | [diff] [blame] | 1696 | 20, image->height() * 3 / 4, paint); |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1697 | }; |
| 1698 | sk_sp<SkImage> bitmapImage(SkImage::MakeFromBitmap(source)); |
| 1699 | sk_sp<SkImage> textureImage(SkImage::MakeFromTexture(canvas->getGrContext(), backEndTexture, |
Cary Clark | ae957c4 | 2018-06-07 17:07:17 -0400 | [diff] [blame] | 1700 | kTopLeft_GrSurfaceOrigin, kRGBA_8888_SkColorType, |
| 1701 | kOpaque_SkAlphaType, nullptr)); |
Cary Clark | f5404bb | 2018-01-05 12:10:09 -0500 | [diff] [blame] | 1702 | drawImage(image, "image"); |
| 1703 | canvas->translate(image->width(), 0); |
| 1704 | drawImage(bitmapImage, "source"); |
| 1705 | canvas->translate(-image->width(), image->height()); |
| 1706 | drawImage(textureImage, "backEndTexture"); |
| 1707 | } |
| 1708 | ## |
| 1709 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1710 | #SeeAlso isTextureBacked makeNonTextureImage |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1711 | |
| 1712 | #Method ## |
| 1713 | |
| 1714 | # ------------------------------------------------------------------------------ |
| 1715 | |
Cary Clark | e80cd44 | 2018-07-17 13:19:56 -0400 | [diff] [blame] | 1716 | #Method sk_sp<SkImage> makeColorSpace(sk_sp<SkColorSpace> target) const |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 1717 | #In Constructors |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 1718 | #Line # creates Image matching Color_Space if possible ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1719 | #Populate |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1720 | |
| 1721 | #Example |
| 1722 | #Image 5 |
| 1723 | #Set sRGB |
| 1724 | sk_sp<SkColorSpace> normalColorSpace = SkColorSpace::MakeRGB( |
| 1725 | SkColorSpace::kSRGB_RenderTargetGamma, SkColorSpace::kSRGB_Gamut); |
| 1726 | sk_sp<SkColorSpace> wackyColorSpace = normalColorSpace->makeColorSpin(); |
| 1727 | for (auto colorSpace : { normalColorSpace, wackyColorSpace } ) { |
Cary Clark | c3c1c31 | 2018-07-18 09:25:15 -0400 | [diff] [blame] | 1728 | sk_sp<SkImage> colorSpaced = image->makeColorSpace(colorSpace); |
| 1729 | canvas->drawImage(colorSpaced, 0, 0); |
| 1730 | canvas->translate(128, 0); |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 1731 | } |
| 1732 | ## |
| 1733 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 1734 | #SeeAlso MakeFromPicture MakeFromTexture |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1735 | |
| 1736 | #Method ## |
| 1737 | |
| 1738 | #Class SkImage ## |
| 1739 | |
| 1740 | #Topic Image ## |