2 * Copyright 2006 The Android Open Source Project
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
8 #ifndef SkBitmap_DEFINED
9 #define SkBitmap_DEFINED
12 #include "SkColorTable.h"
13 #include "SkImageInfo.h"
22 class SkPixelRefFactory;
29 The SkBitmap class specifies a raster bitmap. A bitmap has an integer width
30 and height, and a format (config), and a pointer to the actual pixels.
31 Bitmaps can be drawn into a SkCanvas, but they are also used to specify the
32 target of a SkCanvas' drawing operations.
33 A const SkBitmap exposes getAddr(), which lets a caller write its pixels;
34 the constness is considered to apply to the bitmap's configuration, not
37 class SK_API SkBitmap {
39 class SK_API Allocator;
42 kNo_Config, //!< bitmap has not been configured
43 kA8_Config, //!< 8-bits per pixel, with only alpha specified (0 is transparent, 0xFF is opaque)
44 kIndex8_Config, //!< 8-bits per pixel, using SkColorTable to specify the colors
45 kRGB_565_Config, //!< 16-bits per pixel, (see SkColorPriv.h for packing)
46 kARGB_4444_Config, //!< 16-bits per pixel, (see SkColorPriv.h for packing)
47 kARGB_8888_Config, //!< 32-bits per pixel, (see SkColorPriv.h for packing)
50 // do not add this to the Config enum, otherwise the compiler will let us
51 // pass this as a valid parameter for Config.
53 kConfigCount = kARGB_8888_Config + 1
57 * Default construct creates a bitmap with zero width and height, and no pixels.
58 * Its config is set to kNo_Config.
63 * Copy the settings from the src into this bitmap. If the src has pixels
64 * allocated, they will be shared, not copied, so that the two bitmaps will
65 * reference the same memory for the pixels. If a deep copy is needed,
66 * where the new bitmap has its own separate copy of the pixels, use
69 SkBitmap(const SkBitmap& src);
73 /** Copies the src bitmap into this bitmap. Ownership of the src bitmap's pixels remains
76 SkBitmap& operator=(const SkBitmap& src);
77 /** Swap the fields of the two bitmaps. This routine is guaranteed to never fail or throw.
79 // This method is not exported to java.
80 void swap(SkBitmap& other);
82 ///////////////////////////////////////////////////////////////////////////
84 const SkImageInfo& info() const { return fInfo; }
86 int width() const { return fInfo.fWidth; }
87 int height() const { return fInfo.fHeight; }
88 SkColorType colorType() const { return fInfo.fColorType; }
89 SkAlphaType alphaType() const { return fInfo.fAlphaType; }
91 /** Return the number of bytes per pixel based on the config. If the config
92 does not have at least 1 byte per (e.g. kA1_Config) then 0 is returned.
94 int bytesPerPixel() const { return fInfo.bytesPerPixel(); }
96 /** Return the rowbytes expressed as a number of pixels (like width and
97 height). Note, for 1-byte per pixel configs like kA8_Config, this will
98 return the same as rowBytes(). Is undefined for configs that are less
99 than 1-byte per pixel (e.g. kA1_Config)
101 int rowBytesAsPixels() const {
102 return fRowBytes >> this->shiftPerPixel();
105 /** Return the shift amount per pixel (i.e. 0 for 1-byte per pixel, 1 for
106 2-bytes per pixel configs, 2 for 4-bytes per pixel configs). Return 0
107 for configs that are not at least 1-byte per pixel (e.g. kA1_Config
110 int shiftPerPixel() const { return this->bytesPerPixel() >> 1; }
112 ///////////////////////////////////////////////////////////////////////////
114 /** Return true iff the bitmap has empty dimensions.
115 * Hey! Before you use this, see if you really want to know drawsNothing() instead.
117 bool empty() const { return fInfo.isEmpty(); }
119 /** Return true iff the bitmap has no pixelref. Note: this can return true even if the
120 * dimensions of the bitmap are > 0 (see empty()).
121 * Hey! Before you use this, see if you really want to know drawsNothing() instead.
123 bool isNull() const { return NULL == fPixelRef; }
125 /** Return true iff drawing this bitmap has no effect.
127 bool drawsNothing() const { return this->empty() || this->isNull(); }
129 /** Return the config for the bitmap. */
130 Config config() const;
132 SK_ATTR_DEPRECATED("use config()")
133 Config getConfig() const { return this->config(); }
135 /** Return the number of bytes between subsequent rows of the bitmap. */
136 size_t rowBytes() const { return fRowBytes; }
139 * Set the bitmap's alphaType, returning true on success. If false is
140 * returned, then the specified new alphaType is incompatible with the
141 * Config, and the current alphaType is unchanged.
143 * Note: this changes the alphatype for the underlying pixels, which means
144 * that all bitmaps that might be sharing (subsets of) the pixels will
147 bool setAlphaType(SkAlphaType);
149 /** Return the address of the pixels for this SkBitmap.
151 void* getPixels() const { return fPixels; }
153 /** Return the byte size of the pixels, based on the height and rowBytes.
154 Note this truncates the result to 32bits. Call getSize64() to detect
155 if the real size exceeds 32bits.
157 size_t getSize() const { return fInfo.fHeight * fRowBytes; }
159 /** Return the number of bytes from the pointer returned by getPixels()
160 to the end of the allocated space in the buffer. Required in
161 cases where extractSubset has been called.
163 size_t getSafeSize() const { return fInfo.getSafeSize(fRowBytes); }
166 * Return the full size of the bitmap, in bytes.
168 int64_t computeSize64() const {
169 return sk_64_mul(fInfo.fHeight, fRowBytes);
173 * Return the number of bytes from the pointer returned by getPixels()
174 * to the end of the allocated space in the buffer. This may be smaller
175 * than computeSize64() if there is any rowbytes padding beyond the width.
177 int64_t computeSafeSize64() const {
178 return fInfo.getSafeSize64(fRowBytes);
181 /** Returns true if this bitmap is marked as immutable, meaning that the
182 contents of its pixels will not change for the lifetime of the bitmap.
184 bool isImmutable() const;
186 /** Marks this bitmap as immutable, meaning that the contents of its
187 pixels will not change for the lifetime of the bitmap and of the
188 underlying pixelref. This state can be set, but it cannot be
189 cleared once it is set. This state propagates to all other bitmaps
190 that share the same pixelref.
194 /** Returns true if the bitmap is opaque (has no translucent/transparent pixels).
196 bool isOpaque() const {
197 return SkAlphaTypeIsOpaque(this->alphaType());
200 /** Returns true if the bitmap is volatile (i.e. should not be cached by devices.)
202 bool isVolatile() const;
204 /** Specify whether this bitmap is volatile. Bitmaps are not volatile by
205 default. Temporary bitmaps that are discarded after use should be
206 marked as volatile. This provides a hint to the device that the bitmap
207 should not be cached. Providing this hint when appropriate can
208 improve performance by avoiding unnecessary overhead and resource
209 consumption on the device.
211 void setIsVolatile(bool);
213 /** Reset the bitmap to its initial state (see default constructor). If we are a (shared)
214 owner of the pixels, that ownership is decremented.
218 /** Given a config and a width, this computes the optimal rowBytes value. This is called automatically
219 if you pass 0 for rowBytes to setConfig().
221 static size_t ComputeRowBytes(Config c, int width);
223 /** Return the bytes-per-pixel for the specified config. If the config is
224 not at least 1-byte per pixel, return 0, including for kNo_Config.
226 static int ComputeBytesPerPixel(Config c);
228 /** Return the shift-per-pixel for the specified config. If the config is
229 not at least 1-byte per pixel, return 0, including for kNo_Config.
231 static int ComputeShiftPerPixel(Config c) {
232 return ComputeBytesPerPixel(c) >> 1;
235 static int64_t ComputeSize64(Config, int width, int height);
236 static size_t ComputeSize(Config, int width, int height);
239 * This will brute-force return true if all of the pixels in the bitmap
240 * are opaque. If it fails to read the pixels, or encounters an error,
241 * it will return false.
243 * Since this can be an expensive operation, the bitmap stores a flag for
244 * this (isOpaque). Only call this if you need to compute this value from
247 static bool ComputeIsOpaque(const SkBitmap&);
250 * Return the bitmap's bounds [0, 0, width, height] as an SkRect
252 void getBounds(SkRect* bounds) const;
253 void getBounds(SkIRect* bounds) const;
255 /** Set the bitmap's config and dimensions. If rowBytes is 0, then
256 ComputeRowBytes() is called to compute the optimal value. This resets
257 any pixel/colortable ownership, just like reset().
259 bool setConfig(Config, int width, int height, size_t rowBytes, SkAlphaType);
261 bool setConfig(Config config, int width, int height, size_t rowBytes = 0) {
262 return this->setConfig(config, width, height, rowBytes,
263 kPremul_SkAlphaType);
266 bool setConfig(const SkImageInfo& info, size_t rowBytes = 0);
269 * Allocate a pixelref to match the specified image info. If the Factory
270 * is non-null, call it to allcoate the pixelref. If the ImageInfo requires
271 * a colortable, then ColorTable must be non-null, and will be ref'd.
272 * On failure, the bitmap will be set to empty and return false.
274 bool allocPixels(const SkImageInfo&, SkPixelRefFactory*, SkColorTable*);
277 * Allocate a pixelref to match the specified image info, using the default
279 * On success, the bitmap's pixels will be "locked", and return true.
280 * On failure, the bitmap will be set to empty and return false.
282 bool allocPixels(const SkImageInfo& info) {
283 return this->allocPixels(info, NULL, NULL);
287 * Legacy helper function, which creates an SkImageInfo from the specified
288 * config and then calls allocPixels(info).
290 bool allocConfigPixels(Config, int width, int height, bool isOpaque = false);
292 bool allocN32Pixels(int width, int height, bool isOpaque = false) {
293 SkImageInfo info = SkImageInfo::MakeN32Premul(width, height);
295 info.fAlphaType = kOpaque_SkAlphaType;
297 return this->allocPixels(info);
301 * Install a pixelref that wraps the specified pixels and rowBytes, and
302 * optional ReleaseProc and context. When the pixels are no longer
303 * referenced, if ReleaseProc is not null, it will be called with the
304 * pixels and context as parameters.
305 * On failure, the bitmap will be set to empty and return false.
307 bool installPixels(const SkImageInfo&, void* pixels, size_t rowBytes,
308 void (*ReleaseProc)(void* addr, void* context),
312 * Call installPixels with no ReleaseProc specified. This means that the
313 * caller must ensure that the specified pixels are valid for the lifetime
314 * of the created bitmap (and its pixelRef).
316 bool installPixels(const SkImageInfo& info, void* pixels, size_t rowBytes) {
317 return this->installPixels(info, pixels, rowBytes, NULL, NULL);
321 * Calls installPixels() with the value in the SkMask. The caller must
322 * ensure that the specified mask pixels are valid for the lifetime
323 * of the created bitmap (and its pixelRef).
325 bool installMaskPixels(const SkMask&);
328 * DEPRECATED: call info().
330 bool asImageInfo(SkImageInfo* info) const {
331 // compatibility: return false for kUnknown
332 if (kUnknown_SkColorType == this->colorType()) {
336 *info = this->info();
341 /** Use this to assign a new pixel address for an existing bitmap. This
342 will automatically release any pixelref previously installed. Only call
343 this if you are handling ownership/lifetime of the pixel memory.
345 If the bitmap retains a reference to the colortable (assuming it is
346 not null) it will take care of incrementing the reference count.
348 @param pixels Address for the pixels, managed by the caller.
349 @param ctable ColorTable (or null) that matches the specified pixels
351 void setPixels(void* p, SkColorTable* ctable = NULL);
353 /** Copies the bitmap's pixels to the location pointed at by dst and returns
354 true if possible, returns false otherwise.
356 In the case when the dstRowBytes matches the bitmap's rowBytes, the copy
357 may be made faster by copying over the dst's per-row padding (for all
358 rows but the last). By setting preserveDstPad to true the caller can
359 disable this optimization and ensure that pixels in the padding are not
362 Always returns false for RLE formats.
364 @param dst Location of destination buffer.
365 @param dstSize Size of destination buffer. Must be large enough to hold
366 pixels using indicated stride.
367 @param dstRowBytes Width of each line in the buffer. If 0, uses
368 bitmap's internal stride.
369 @param preserveDstPad Must we preserve padding in the dst
371 bool copyPixelsTo(void* const dst, size_t dstSize, size_t dstRowBytes = 0,
372 bool preserveDstPad = false) const;
374 /** Use the standard HeapAllocator to create the pixelref that manages the
375 pixel memory. It will be sized based on the current width/height/config.
376 If this is called multiple times, a new pixelref object will be created
379 If the bitmap retains a reference to the colortable (assuming it is
380 not null) it will take care of incrementing the reference count.
382 @param ctable ColorTable (or null) to use with the pixels that will
383 be allocated. Only used if config == Index8_Config
384 @return true if the allocation succeeds. If not the pixelref field of
385 the bitmap will be unchanged.
387 bool allocPixels(SkColorTable* ctable = NULL) {
388 return this->allocPixels(NULL, ctable);
391 /** Use the specified Allocator to create the pixelref that manages the
392 pixel memory. It will be sized based on the current width/height/config.
393 If this is called multiple times, a new pixelref object will be created
396 If the bitmap retains a reference to the colortable (assuming it is
397 not null) it will take care of incrementing the reference count.
399 @param allocator The Allocator to use to create a pixelref that can
400 manage the pixel memory for the current
401 width/height/config. If allocator is NULL, the standard
402 HeapAllocator will be used.
403 @param ctable ColorTable (or null) to use with the pixels that will
404 be allocated. Only used if config == Index8_Config.
405 If it is non-null and the config is not Index8, it will
407 @return true if the allocation succeeds. If not the pixelref field of
408 the bitmap will be unchanged.
410 bool allocPixels(Allocator* allocator, SkColorTable* ctable);
413 * Return the current pixelref object or NULL if there is none. This does
414 * not affect the refcount of the pixelref.
416 SkPixelRef* pixelRef() const { return fPixelRef; }
419 * A bitmap can reference a subset of a pixelref's pixels. That means the
420 * bitmap's width/height can be <= the dimensions of the pixelref. The
421 * pixelref origin is the x,y location within the pixelref's pixels for
422 * the bitmap's top/left corner. To be valid the following must be true:
424 * origin_x + bitmap_width <= pixelref_width
425 * origin_y + bitmap_height <= pixelref_height
427 * pixelRefOrigin() returns this origin, or (0,0) if there is no pixelRef.
429 SkIPoint pixelRefOrigin() const { return fPixelRefOrigin; }
432 * Assign a pixelref and origin to the bitmap. Pixelrefs are reference,
433 * so the existing one (if any) will be unref'd and the new one will be
434 * ref'd. (x,y) specify the offset within the pixelref's pixels for the
435 * top/left corner of the bitmap. For a bitmap that encompases the entire
436 * pixels of the pixelref, these will be (0,0).
438 SkPixelRef* setPixelRef(SkPixelRef* pr, int dx, int dy);
440 SkPixelRef* setPixelRef(SkPixelRef* pr, const SkIPoint& origin) {
441 return this->setPixelRef(pr, origin.fX, origin.fY);
444 SkPixelRef* setPixelRef(SkPixelRef* pr) {
445 return this->setPixelRef(pr, 0, 0);
448 /** Call this to ensure that the bitmap points to the current pixel address
449 in the pixelref. Balance it with a call to unlockPixels(). These calls
450 are harmless if there is no pixelref.
452 void lockPixels() const;
453 /** When you are finished access the pixel memory, call this to balance a
454 previous call to lockPixels(). This allows pixelrefs that implement
455 cached/deferred image decoding to know when there are active clients of
458 void unlockPixels() const;
461 * Some bitmaps can return a copy of their pixels for lockPixels(), but
462 * that copy, if modified, will not be pushed back. These bitmaps should
463 * not be used as targets for a raster device/canvas (since all pixels
464 * modifications will be lost when unlockPixels() is called.)
466 bool lockPixelsAreWritable() const;
468 /** Call this to be sure that the bitmap is valid enough to be drawn (i.e.
469 it has non-null pixels, and if required by its config, it has a
470 non-null colortable. Returns true if all of the above are met.
472 bool readyToDraw() const {
473 return this->getPixels() != NULL &&
474 (this->colorType() != kIndex_8_SkColorType || NULL != fColorTable);
477 /** Returns the pixelRef's texture, or NULL
479 GrTexture* getTexture() const;
481 /** Return the bitmap's colortable, if it uses one (i.e. colorType is
482 Index_8) and the pixels are locked.
483 Otherwise returns NULL. Does not affect the colortable's
486 SkColorTable* getColorTable() const { return fColorTable; }
488 /** Returns a non-zero, unique value corresponding to the pixels in our
489 pixelref. Each time the pixels are changed (and notifyPixelsChanged
490 is called), a different generation ID will be returned. Finally, if
491 their is no pixelRef then zero is returned.
493 uint32_t getGenerationID() const;
495 /** Call this if you have changed the contents of the pixels. This will in-
496 turn cause a different generation ID value to be returned from
499 void notifyPixelsChanged() const;
502 * Fill the entire bitmap with the specified color.
503 * If the bitmap's config does not support alpha (e.g. 565) then the alpha
504 * of the color is ignored (treated as opaque). If the config only supports
505 * alpha (e.g. A1 or A8) then the color's r,g,b components are ignored.
507 void eraseColor(SkColor c) const {
508 this->eraseARGB(SkColorGetA(c), SkColorGetR(c), SkColorGetG(c),
513 * Fill the entire bitmap with the specified color.
514 * If the bitmap's config does not support alpha (e.g. 565) then the alpha
515 * of the color is ignored (treated as opaque). If the config only supports
516 * alpha (e.g. A1 or A8) then the color's r,g,b components are ignored.
518 void eraseARGB(U8CPU a, U8CPU r, U8CPU g, U8CPU b) const;
520 SK_ATTR_DEPRECATED("use eraseARGB or eraseColor")
521 void eraseRGB(U8CPU r, U8CPU g, U8CPU b) const {
522 this->eraseARGB(0xFF, r, g, b);
526 * Fill the specified area of this bitmap with the specified color.
527 * If the bitmap's config does not support alpha (e.g. 565) then the alpha
528 * of the color is ignored (treated as opaque). If the config only supports
529 * alpha (e.g. A1 or A8) then the color's r,g,b components are ignored.
531 void eraseArea(const SkIRect& area, SkColor c) const;
533 /** Scroll (a subset of) the contents of this bitmap by dx/dy. If there are
534 no pixels allocated (i.e. getPixels() returns null) the method will
535 still update the inval region (if present). If the bitmap is immutable,
536 do nothing and return false.
538 @param subset The subset of the bitmap to scroll/move. To scroll the
539 entire contents, specify [0, 0, width, height] or just
541 @param dx The amount to scroll in X
542 @param dy The amount to scroll in Y
543 @param inval Optional (may be null). Returns the area of the bitmap that
544 was scrolled away. E.g. if dx = dy = 0, then inval would
545 be set to empty. If dx >= width or dy >= height, then
546 inval would be set to the entire bounds of the bitmap.
547 @return true if the scroll was doable. Will return false if the bitmap
548 uses an unsupported config for scrolling (only kA8,
549 kIndex8, kRGB_565, kARGB_4444, kARGB_8888 are supported).
550 If no pixels are present (i.e. getPixels() returns false)
551 inval will still be updated, and true will be returned.
553 bool scrollRect(const SkIRect* subset, int dx, int dy,
554 SkRegion* inval = NULL) const;
557 * Return the SkColor of the specified pixel. In most cases this will
558 * require un-premultiplying the color. Alpha only configs (A1 and A8)
559 * return black with the appropriate alpha set. The value is undefined
560 * for kNone_Config or if x or y are out of bounds, or if the bitmap
561 * does not have any pixels (or has not be locked with lockPixels()).
563 SkColor getColor(int x, int y) const;
565 /** Returns the address of the specified pixel. This performs a runtime
566 check to know the size of the pixels, and will return the same answer
567 as the corresponding size-specific method (e.g. getAddr16). Since the
568 check happens at runtime, it is much slower than using a size-specific
569 version. Unlike the size-specific methods, this routine also checks if
570 getPixels() returns null, and returns that. The size-specific routines
571 perform a debugging assert that getPixels() is not null, but they do
572 not do any runtime checks.
574 void* getAddr(int x, int y) const;
576 /** Returns the address of the pixel specified by x,y for 32bit pixels.
577 * In debug build, this asserts that the pixels are allocated and locked,
578 * and that the config is 32-bit, however none of these checks are performed
579 * in the release build.
581 inline uint32_t* getAddr32(int x, int y) const;
583 /** Returns the address of the pixel specified by x,y for 16bit pixels.
584 * In debug build, this asserts that the pixels are allocated and locked,
585 * and that the config is 16-bit, however none of these checks are performed
586 * in the release build.
588 inline uint16_t* getAddr16(int x, int y) const;
590 /** Returns the address of the pixel specified by x,y for 8bit pixels.
591 * In debug build, this asserts that the pixels are allocated and locked,
592 * and that the config is 8-bit, however none of these checks are performed
593 * in the release build.
595 inline uint8_t* getAddr8(int x, int y) const;
597 /** Returns the color corresponding to the pixel specified by x,y for
598 * colortable based bitmaps.
599 * In debug build, this asserts that the pixels are allocated and locked,
600 * that the config is kIndex8, and that the colortable is allocated,
601 * however none of these checks are performed in the release build.
603 inline SkPMColor getIndex8Color(int x, int y) const;
605 /** Set dst to be a setset of this bitmap. If possible, it will share the
606 pixel memory, and just point into a subset of it. However, if the config
607 does not support this, a local copy will be made and associated with
608 the dst bitmap. If the subset rectangle, intersected with the bitmap's
609 dimensions is empty, or if there is an unsupported config, false will be
610 returned and dst will be untouched.
611 @param dst The bitmap that will be set to a subset of this bitmap
612 @param subset The rectangle of pixels in this bitmap that dst will
614 @return true if the subset copy was successfully made.
616 bool extractSubset(SkBitmap* dst, const SkIRect& subset) const;
618 /** Makes a deep copy of this bitmap, respecting the requested colorType,
619 * and allocating the dst pixels on the cpu.
620 * Returns false if either there is an error (i.e. the src does not have
621 * pixels) or the request cannot be satisfied (e.g. the src has per-pixel
622 * alpha, and the requested config does not support alpha).
623 * @param dst The bitmap to be sized and allocated
624 * @param ct The desired colorType for dst
625 * @param allocator Allocator used to allocate the pixelref for the dst
626 * bitmap. If this is null, the standard HeapAllocator
628 * @return true if the copy was made.
630 bool copyTo(SkBitmap* dst, SkColorType ct, Allocator* = NULL) const;
632 bool copyTo(SkBitmap* dst, Allocator* allocator = NULL) const {
633 return this->copyTo(dst, this->colorType(), allocator);
637 * Returns true if this bitmap's pixels can be converted into the requested
638 * colorType, such that copyTo() could succeed.
640 bool canCopyTo(SkColorType colorType) const;
642 /** Makes a deep copy of this bitmap, keeping the copied pixels
643 * in the same domain as the source: If the src pixels are allocated for
644 * the cpu, then so will the dst. If the src pixels are allocated on the
645 * gpu (typically as a texture), the it will do the same for the dst.
646 * If the request cannot be fulfilled, returns false and dst is unmodified.
648 bool deepCopyTo(SkBitmap* dst) const;
650 SK_ATTR_DEPRECATED("use setFilterLevel on SkPaint")
651 void buildMipMap(bool forceRebuild = false);
653 #ifdef SK_BUILD_FOR_ANDROID
654 bool hasHardwareMipMap() const {
655 return (fFlags & kHasHardwareMipMap_Flag) != 0;
658 void setHasHardwareMipMap(bool hasHardwareMipMap) {
659 if (hasHardwareMipMap) {
660 fFlags |= kHasHardwareMipMap_Flag;
662 fFlags &= ~kHasHardwareMipMap_Flag;
667 bool extractAlpha(SkBitmap* dst) const {
668 return this->extractAlpha(dst, NULL, NULL, NULL);
671 bool extractAlpha(SkBitmap* dst, const SkPaint* paint,
672 SkIPoint* offset) const {
673 return this->extractAlpha(dst, paint, NULL, offset);
676 /** Set dst to contain alpha layer of this bitmap. If destination bitmap
677 fails to be initialized, e.g. because allocator can't allocate pixels
678 for it, dst will not be modified and false will be returned.
680 @param dst The bitmap to be filled with alpha layer
681 @param paint The paint to draw with
682 @param allocator Allocator used to allocate the pixelref for the dst
683 bitmap. If this is null, the standard HeapAllocator
685 @param offset If not null, it is set to top-left coordinate to position
686 the returned bitmap so that it visually lines up with the
689 bool extractAlpha(SkBitmap* dst, const SkPaint* paint, Allocator* allocator,
690 SkIPoint* offset) const;
692 /** The following two functions provide the means to both flatten and
693 unflatten the bitmap AND its pixels into the provided buffer.
694 It is recommended that you do not call these functions directly,
695 but instead call the write/readBitmap functions on the respective
696 buffers as they can optimize the recording process and avoid recording
697 duplicate bitmaps and pixelRefs.
699 void flatten(SkWriteBuffer&) const;
700 void unflatten(SkReadBuffer&);
702 SkDEBUGCODE(void validate() const;)
704 class Allocator : public SkRefCnt {
706 SK_DECLARE_INST_COUNT(Allocator)
708 /** Allocate the pixel memory for the bitmap, given its dimensions and
709 config. Return true on success, where success means either setPixels
710 or setPixelRef was called. The pixels need not be locked when this
711 returns. If the config requires a colortable, it also must be
712 installed via setColorTable. If false is returned, the bitmap and
713 colortable should be left unchanged.
715 virtual bool allocPixelRef(SkBitmap*, SkColorTable*) = 0;
717 typedef SkRefCnt INHERITED;
720 /** Subclass of Allocator that returns a pixelref that allocates its pixel
721 memory from the heap. This is the default Allocator invoked by
724 class HeapAllocator : public Allocator {
726 virtual bool allocPixelRef(SkBitmap*, SkColorTable*) SK_OVERRIDE;
731 RLEPixels(int width, int height);
732 virtual ~RLEPixels();
734 uint8_t* packedAtY(int y) const {
735 SkASSERT((unsigned)y < (unsigned)fHeight);
739 // called by subclasses during creation
740 void setPackedAtY(int y, uint8_t* addr) {
741 SkASSERT((unsigned)y < (unsigned)fHeight);
750 SK_TO_STRING_NONVIRT()
754 mutable MipMap* fMipMap;
756 mutable SkPixelRef* fPixelRef;
757 mutable int fPixelLockCount;
758 // These are just caches from the locked pixelref
759 mutable void* fPixels;
760 mutable SkColorTable* fColorTable; // only meaningful for kIndex8
762 SkIPoint fPixelRefOrigin;
765 kImageIsOpaque_Flag = 0x01,
766 kImageIsVolatile_Flag = 0x02,
767 kImageIsImmutable_Flag = 0x04,
768 #ifdef SK_BUILD_FOR_ANDROID
769 /* A hint for the renderer responsible for drawing this bitmap
770 * indicating that it should attempt to use mipmaps when this bitmap
771 * is drawn scaled down.
773 kHasHardwareMipMap_Flag = 0x08,
783 void internalErase(const SkIRect&, U8CPU a, U8CPU r, U8CPU g, U8CPU b)const;
785 /* Internal computations for safe size.
787 static int64_t ComputeSafeSize64(Config config,
791 static size_t ComputeSafeSize(Config config,
796 /* Unreference any pixelrefs or colortables
799 void updatePixelsFromRef() const;
801 static SkFixed ComputeMipLevel(SkFixed sx, SkFixed dy);
803 /** Given scale factors sx, sy, determine the miplevel available in the
804 bitmap, and return it (this is the amount to shift matrix iterators
805 by). If dst is not null, it is set to the correct level.
807 int extractMipLevel(SkBitmap* dst, SkFixed sx, SkFixed sy);
808 bool hasMipMap() const;
811 friend struct SkBitmapProcState;
814 class SkAutoLockPixels : SkNoncopyable {
816 SkAutoLockPixels(const SkBitmap& bm, bool doLock = true) : fBitmap(bm) {
822 ~SkAutoLockPixels() {
824 fBitmap.unlockPixels();
829 const SkBitmap& fBitmap;
832 //TODO(mtklein): uncomment when 71713004 lands and Chromium's fixed.
833 //#define SkAutoLockPixels(...) SK_REQUIRE_LOCAL_VAR(SkAutoLockPixels)
835 /** Helper class that performs the lock/unlockColors calls on a colortable.
836 The destructor will call unlockColors(false) if it has a bitmap's colortable
838 class SkAutoLockColors : SkNoncopyable {
840 /** Initialize with no bitmap. Call lockColors(bitmap) to lock bitmap's
843 SkAutoLockColors() : fCTable(NULL), fColors(NULL) {}
844 /** Initialize with bitmap, locking its colortable if present
846 explicit SkAutoLockColors(const SkBitmap& bm) {
847 fCTable = bm.getColorTable();
848 fColors = fCTable ? fCTable->lockColors() : NULL;
850 /** Initialize with a colortable (may be null)
852 explicit SkAutoLockColors(SkColorTable* ctable) {
854 fColors = ctable ? ctable->lockColors() : NULL;
856 ~SkAutoLockColors() {
858 fCTable->unlockColors();
862 /** Return the currently locked colors, or NULL if no bitmap's colortable
865 const SkPMColor* colors() const { return fColors; }
867 /** Locks the table and returns is colors (assuming ctable is not null) and
868 unlocks the previous table if one was present
870 const SkPMColor* lockColors(SkColorTable* ctable) {
872 fCTable->unlockColors();
875 fColors = ctable ? ctable->lockColors() : NULL;
879 const SkPMColor* lockColors(const SkBitmap& bm) {
880 return this->lockColors(bm.getColorTable());
884 SkColorTable* fCTable;
885 const SkPMColor* fColors;
887 #define SkAutoLockColors(...) SK_REQUIRE_LOCAL_VAR(SkAutoLockColors)
889 ///////////////////////////////////////////////////////////////////////////////
891 inline uint32_t* SkBitmap::getAddr32(int x, int y) const {
893 SkASSERT(4 == this->bytesPerPixel());
894 SkASSERT((unsigned)x < (unsigned)this->width() && (unsigned)y < (unsigned)this->height());
895 return (uint32_t*)((char*)fPixels + y * fRowBytes + (x << 2));
898 inline uint16_t* SkBitmap::getAddr16(int x, int y) const {
900 SkASSERT(2 == this->bytesPerPixel());
901 SkASSERT((unsigned)x < (unsigned)this->width() && (unsigned)y < (unsigned)this->height());
902 return (uint16_t*)((char*)fPixels + y * fRowBytes + (x << 1));
905 inline uint8_t* SkBitmap::getAddr8(int x, int y) const {
907 SkASSERT(1 == this->bytesPerPixel());
908 SkASSERT((unsigned)x < (unsigned)this->width() && (unsigned)y < (unsigned)this->height());
909 return (uint8_t*)fPixels + y * fRowBytes + x;
912 inline SkPMColor SkBitmap::getIndex8Color(int x, int y) const {
914 SkASSERT(kIndex_8_SkColorType == this->colorType());
915 SkASSERT((unsigned)x < (unsigned)this->width() && (unsigned)y < (unsigned)this->height());
916 SkASSERT(fColorTable);
917 return (*fColorTable)[*((const uint8_t*)fPixels + y * fRowBytes + x)];
920 ///////////////////////////////////////////////////////////////////////////////
922 // Helpers until we can fully deprecate SkBitmap::Config
924 extern SkBitmap::Config SkColorTypeToBitmapConfig(SkColorType);
925 extern SkColorType SkBitmapConfigToColorType(SkBitmap::Config);