2017-10-04 18:31:33 +00:00
SkBitmap Reference
===
2018-05-16 11:07:07 +00:00
# <a name='Bitmap'>Bitmap</a>
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
# <a name='SkBitmap'>Class SkBitmap</a>
< a href = '#Bitmap' > Bitmap< / a > describes a two-dimensional raster pixel array. < a href = '#Bitmap' > Bitmap< / a > is built on
< a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , containing integer width and height, < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > and < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a >
describing the pixel format, and < a href = 'undocumented#Color_Space' > Color Space< / a > describing the range of colors.
< a href = '#Bitmap' > Bitmap< / a > points to < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > , which describes the physical array of pixels.
< a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > bounds may be located anywhere fully inside < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > bounds.
2018-02-01 14:37:32 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Bitmap' > Bitmap< / a > can be drawn using < a href = 'SkCanvas_Reference#Canvas' > Canvas< / a > . < a href = '#Bitmap' > Bitmap< / a > can be a drawing destination for < a href = 'SkCanvas_Reference#Canvas' > Canvas< / a >
2018-05-30 13:21:49 +00:00
draw member functions. < a href = '#Bitmap' > Bitmap< / a > flexibility as a pixel container limits some
2018-05-16 11:07:07 +00:00
optimizations available to the target platform.
2018-02-01 14:37:32 +00:00
2018-05-16 11:07:07 +00:00
If pixel array is primarily read-only, use < a href = 'SkImage_Reference#Image' > Image< / a > for better performance.
If pixel array is primarily written to, use < a href = 'SkSurface_Reference#Surface' > Surface< / a > for better performance.
2018-02-01 14:37:32 +00:00
2018-05-16 11:07:07 +00:00
Declaring < a href = '#SkBitmap' > SkBitmap< / a > const prevents altering < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > : the < a href = '#Bitmap' > Bitmap< / a > height, width,
and so on cannot change. It does not affect < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > : a caller may write its
pixels. Declaring < a href = '#SkBitmap' > SkBitmap< / a > const affects < a href = '#Bitmap' > Bitmap< / a > configuration, not its contents.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Bitmap' > Bitmap< / a > is not thread safe. Each thread must have its own copy of < a href = '#Bitmap' > Bitmap< / a > fields,
although threads may share the underlying pixel array.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
## <a name='Row_Bytes'>Row Bytes</a>
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Bitmap' > Bitmap< / a > pixels may be contiguous, or may have a gap at the end of each row.
< a href = '#Row_Bytes' > Row Bytes< / a > is the interval from one row to the next. < a href = '#Row_Bytes' > Row Bytes< / a > may be specified;
sometimes passing zero will compute the < a href = '#Row_Bytes' > Row Bytes< / a > from the row width and the
number of bytes in a pixel. < a href = '#Row_Bytes' > Row Bytes< / a > may be larger than the row requires. This
is useful to position one or more < a href = '#Bitmap' > Bitmaps< / a > within a shared pixel array.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
## Overview
< table style = 'border-collapse: collapse; width: 62.5em' >
< tr >< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Topic</ th >
< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Description</ th ></ tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#Class' > Class Declarations</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > embedded class members</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#Constant' > Constants</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > enum and enum class, and their const values</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#Constructor' > Constructors</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > functions that construct < a href = '#SkBitmap' > SkBitmap</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#Member_Function' > Functions</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > global and class member functions</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#Operator' > Operators</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > operator overloading methods</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#Related_Function' > Related Functions</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > similar member functions grouped together</ td >
< / tr >
< / table >
## <a name='Related_Function'>Related Function</a>
SkBitmap global, < code > struct< / code > , and < code > class< / code > related member functions share a topic.
< table style = 'border-collapse: collapse; width: 62.5em' >
< tr >< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Topic</ th >
< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Description</ th ></ tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#Allocate' > Allocate</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > allocates storage for pixels</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#Draw' > Draw</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > sets pixels to < a href = 'SkColor_Reference#Color' > Color</ a ></ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#Pixels' > Pixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > read and write pixel values</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#Property' > Property</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > metrics and attributes</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#Row_Bytes' > Row Bytes</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > interval from one row to the next</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#Set' > Set</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > updates values and attributes</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#Utility' > Utility</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > rarely called management functions</ td >
< / tr >
< / table >
## <a name='Constant'>Constant</a>
SkBitmap related constants are defined by < code > enum< / code > , < code > enum class< / code > , < code > #define< / code > , < code > const< / code > , and < code > constexpr< / code > .
< table style = 'border-collapse: collapse; width: 62.5em' >
< tr >< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Topic</ th >
< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Description</ th ></ tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_AllocFlags' > AllocFlags</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > zero pixel memory</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_kZeroPixels_AllocFlag' > kZeroPixels AllocFlag</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > zero pixel memory</ td >
< / tr >
< / table >
## <a name='Class'>Class</a>
SkBitmap uses C++ classes to declare the public data structures and interfaces.
< table style = 'border-collapse: collapse; width: 62.5em' >
< tr >< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Topic</ th >
< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Description</ th ></ tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_Allocator' > Allocator</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > abstract subclass of < a href = '#SkBitmap_HeapAllocator' > HeapAllocator</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_HeapAllocator' > HeapAllocator</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > allocates pixel memory from heap</ td >
< / tr >
< / table >
## <a name='Constructor'>Constructor</a>
SkBitmap can be constructed or initialized by these functions, including C++ class constructors.
< table style = 'border-collapse: collapse; width: 62.5em' >
< tr >< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Topic</ th >
< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Description</ th ></ tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_empty_constructor' > SkBitmap()</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > constructs with default values</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_move_SkBitmap' > SkBitmap(SkBitmap&& src)</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > takes ownership of pixels</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_copy_const_SkBitmap' > SkBitmap(const SkBitmap& src)</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > shares ownership of pixels</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_extractAlpha' > extractAlpha</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > creates < a href = '#Bitmap' > Bitmap</ a > containing < a href = 'SkColor_Reference#Alpha' > Alpha</ a > of pixels</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_extractAlpha' > extractAlpha(SkBitmap* dst)</ a > const</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_extractAlpha_2' > extractAlpha(SkBitmap* dst, const SkPaint* paint, SkIPoint* offset)</ a > const</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_extractAlpha_3' > extractAlpha(SkBitmap* dst, const SkPaint* paint, Allocator* allocator, SkIPoint* offset)</ a > const</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_extractSubset' > extractSubset</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > creates < a href = '#Bitmap' > Bitmap</ a > , sharing pixels if possible</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_reset' > reset</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > sets to default values, releases pixel ownership</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_destructor' > ~SkBitmap()</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > releases ownership of pixels</ td >
< / tr >
< / table >
## <a name='Operator'>Operator</a>
SkBitmap operators inline class member functions with arithmetic equivalents.
< table style = 'border-collapse: collapse; width: 62.5em' >
< tr >< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Topic</ th >
< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Description</ th ></ tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_move_operator' > operator=(SkBitmap&& src)</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > takes ownership of pixels</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_copy_operator' > operator=(const SkBitmap& src)</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > shares ownership of pixels</ td >
< / tr >
< / table >
## <a name='Member_Function'>Member Function</a>
SkBitmap member functions read and modify the structure properties.
< table style = 'border-collapse: collapse; width: 62.5em' >
< tr >< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Topic</ th >
< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Description</ th ></ tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_ComputeIsOpaque' > ComputeIsOpaque</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns true if all pixels are opaque</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_allocN32Pixels' > allocN32Pixels</ a ></ td >
2018-05-17 16:17:28 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > allocates compatible ARGB pixels, or aborts</ td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_allocPixels' > allocPixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > allocates pixels from < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > , or aborts</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_allocPixelsFlags' > allocPixelsFlags</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > allocates pixels from < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > with options, or aborts</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_alphaType' > alphaType</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_bounds' > bounds</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = '#SkBitmap_width' > width</ a > and < a href = '#SkBitmap_height' > height</ a > as Rectangle</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_bytesPerPixel' > bytesPerPixel</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns number of bytes in pixel based on < a href = 'SkImageInfo_Reference#Color_Type' > Color Type</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_colorSpace' > colorSpace</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > < a href = 'undocumented#Color_Space' > Color Space</ a ></ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_colorType' > colorType</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > < a href = 'SkImageInfo_Reference#Color_Type' > Color Type</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_computeByteSize' > computeByteSize</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns size required for pixels</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_dimensions' > dimensions</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = '#SkBitmap_width' > width</ a > and < a href = '#SkBitmap_height' > height</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_drawsNothing' > drawsNothing</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns true if no < a href = '#SkBitmap_width' > width</ a > , no < a href = '#SkBitmap_height' > height</ a > , or no < a href = 'undocumented#Pixel_Ref' > Pixel Ref</ a ></ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_empty' > empty</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns true if < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > has zero < a href = '#SkBitmap_width' > width</ a > or < a href = '#SkBitmap_height' > height</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_erase' > erase</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > writes < a href = 'SkColor_Reference#Color' > Color</ a > to rectangle of pixels</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_eraseARGB' > eraseARGB</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > writes < a href = 'SkColor_Reference#Color' > Color</ a > to pixels</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_eraseColor' > eraseColor</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > writes < a href = 'SkColor_Reference#Color' > Color</ a > to pixels</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_extractAlpha' > extractAlpha</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > creates < a href = '#Bitmap' > Bitmap</ a > containing < a href = 'SkColor_Reference#Alpha' > Alpha</ a > of pixels</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_extractSubset' > extractSubset</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > creates < a href = '#Bitmap' > Bitmap</ a > , sharing pixels if possible</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getAddr' > getAddr</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns readable pixel address as void pointer</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getAddr16' > getAddr16</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns readable pixel address as 16-bit pointer</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getAddr32' > getAddr32</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns readable pixel address as 32-bit pointer</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getAddr8' > getAddr8</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns readable pixel address as 8-bit pointer</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getBounds' > getBounds</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = '#SkBitmap_width' > width</ a > and < a href = '#SkBitmap_height' > height</ a > as Rectangle</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getColor' > getColor</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns one pixel as < a href = 'undocumented#Unpremultiply' > Unpremultiplied</ a > < a href = 'SkColor_Reference#Color' > Color</ a ></ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getGenerationID' > getGenerationID</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns unique ID</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getPixels' > getPixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns address of pixels</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getSubset' > getSubset</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns bounds offset by origin</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_hasHardwareMipMap' > hasHardwareMipMap</ a ></ td >
2018-06-14 16:28:14 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'undocumented#Mip_Map' > Mip Map</ a > support present; Android only</ td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_height' > height</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns pixel row count</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_info' > info</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a ></ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_installPixels' > installPixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > creates < a href = 'undocumented#Pixel_Ref' > Pixel Ref</ a > , with optional release function</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_isImmutable' > isImmutable</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns true if pixels will not change</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_isNull' > isNull</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns true if < a href = 'undocumented#Pixel_Ref' > Pixel Ref</ a > is nullptr</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_isOpaque' > isOpaque</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns true if < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > describes opaque pixels</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_isVolatile' > isVolatile</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns true if pixels should not be cached</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_notifyPixelsChanged' > notifyPixelsChanged</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > marks pixels as changed, altering the unique ID</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_peekPixels' > peekPixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'SkPixmap_Reference#Pixmap' > Pixmap</ a > if possible</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_pixelRef' > pixelRef</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'undocumented#Pixel_Ref' > Pixel Ref</ a > , or nullptr</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_pixelRefOrigin' > pixelRefOrigin</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns offset within < a href = 'undocumented#Pixel_Ref' > Pixel Ref</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_pixmap' > pixmap</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'SkPixmap_Reference#Pixmap' > Pixmap</ a ></ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_readPixels' > readPixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > copies and converts pixels</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_readyToDraw' > readyToDraw</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns true if address of pixels is not nullptr</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_refColorSpace' > refColorSpace</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > < a href = 'undocumented#Color_Space' > Color Space</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_reset' > reset</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > sets to default values, releases pixel ownership</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_rowBytes' > rowBytes</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns interval between rows in bytes</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_rowBytesAsPixels' > rowBytesAsPixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns interval between rows in pixels</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_setAlphaType' > setAlphaType</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > sets < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type</ a > of shared pixels</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_setHasHardwareMipMap' > setHasHardwareMipMap</ a ></ td >
2018-06-14 16:28:14 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > sets < a href = 'undocumented#Mip_Map' > Mip Map</ a > support present; Android only</ td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_setImmutable' > setImmutable</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > marks that pixels will not change</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_setInfo' > setInfo</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > sets height, width, < a href = 'SkImageInfo_Reference#Color_Type' > Color Type</ a > , and so on, releasing pixels</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_setIsVolatile' > setIsVolatile</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > marks if pixels should not be cached</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_setPixelRef' > setPixelRef</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > sets < a href = 'undocumented#Pixel_Ref' > Pixel Ref</ a > and offset</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_setPixels' > setPixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > sets < a href = 'undocumented#Pixel_Ref' > Pixel Ref</ a > without an offset</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_shiftPerPixel' > shiftPerPixel</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns bit shift from pixels to bytes</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_swap' > swap</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > exchanges < a href = '#Bitmap' > Bitmap</ a > pair</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_tryAllocN32Pixels' > tryAllocN32Pixels</ a ></ td >
2018-05-17 16:17:28 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > allocates compatible ARGB pixels if possible</ td >
2018-05-16 11:07:07 +00:00
< / tr >
2018-06-08 19:57:37 +00:00
< tr style = 'background-color: #f0f0f0 ; ' >
2018-05-16 11:07:07 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_tryAllocPixels' > tryAllocPixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > allocates pixels from < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > if possible</ td >
< / tr >
2018-06-08 19:57:37 +00:00
< tr >
2018-05-16 11:07:07 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_tryAllocPixelsFlags' > tryAllocPixelsFlags</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > allocates pixels from < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > with options if possible</ td >
< / tr >
2018-06-08 19:57:37 +00:00
< tr style = 'background-color: #f0f0f0 ; ' >
2018-05-16 11:07:07 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_validate' > validate</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > asserts if < a href = '#Bitmap' > Bitmap</ a > is invalid (debug only)</ td >
< / tr >
2018-06-08 19:57:37 +00:00
< tr >
2018-05-16 11:07:07 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_width' > width</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns pixel column count</ td >
< / tr >
2018-06-08 19:57:37 +00:00
< tr style = 'background-color: #f0f0f0 ; ' >
2018-05-16 11:07:07 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_writePixels' > writePixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > copies and converts pixels</ td >
< / tr >
< / table >
# <a name='SkBitmap_Allocator'>Class SkBitmap::Allocator</a>
## <a name='Member_Function'>Member_Function</a>
2018-08-10 17:09:13 +00:00
SkBitmap::Allocator member functions read and modify the structure properties.
2018-05-16 11:07:07 +00:00
< table style = 'border-collapse: collapse; width: 62.5em' >
< tr >< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Topic</ th >
< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Description</ th ></ tr >
2018-08-10 17:09:13 +00:00
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_Allocator_allocPixelRef' > allocPixelRef</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > allocates pixel memory</ td >
< / tr >
2018-05-16 11:07:07 +00:00
< / table >
2017-10-04 18:31:33 +00:00
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2018-05-16 11:07:07 +00:00
class < a href = '#SkBitmap_Allocator' > Allocator< / a > : public < a href = 'undocumented#SkRefCnt' > SkRefCnt< / a > {
2018-04-03 12:43:27 +00:00
public:
2018-05-16 11:07:07 +00:00
virtual bool < a href = '#SkBitmap_Allocator_allocPixelRef' > allocPixelRef(SkBitmap* bitmap)< / a > = 0;
2018-04-03 12:43:27 +00:00
};
2018-03-05 18:26:16 +00:00
< / pre >
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Abstract subclass of < a href = '#SkBitmap_HeapAllocator' > HeapAllocator< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_Allocator_allocPixelRef' > < / a >
2017-10-04 18:31:33 +00:00
## allocPixelRef
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
virtual bool < a href = '#SkBitmap_Allocator_allocPixelRef' > allocPixelRef< / a > (< a href = '#SkBitmap' > SkBitmap< / a > * bitmap) = 0
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Allocates the pixel memory for the < a href = '#SkBitmap_Allocator_allocPixelRef_bitmap' > bitmap< / a > , given its dimensions and
< a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > . Returns true on success, where success means either < a href = '#SkBitmap_setPixels' > setPixels< / a >
or < a href = '#SkBitmap_setPixelRef' > setPixelRef< / a > was called.
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_Allocator_allocPixelRef_bitmap' > < code > < strong > bitmap< / strong > < / code > < / a > < / td >
< td > < a href = '#Bitmap' > Bitmap< / a > containing < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > as input, and < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > as output< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > was allocated
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_HeapAllocator' > HeapAllocator< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
# <a name='SkBitmap_HeapAllocator'>Class SkBitmap::HeapAllocator</a>
## <a name='Member_Function'>Member_Function</a>
2018-08-10 17:09:13 +00:00
SkBitmap::HeapAllocator member functions read and modify the structure properties.
2018-05-16 11:07:07 +00:00
< table style = 'border-collapse: collapse; width: 62.5em' >
< tr >< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Topic</ th >
< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Description</ th ></ tr >
2018-08-10 17:09:13 +00:00
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_HeapAllocator_allocPixelRef' > allocPixelRef</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > allocates pixel memory</ td >
< / tr >
2018-05-16 11:07:07 +00:00
< / table >
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2018-05-16 11:07:07 +00:00
class < a href = '#SkBitmap_HeapAllocator' > HeapAllocator< / a > : public < a href = '#SkBitmap_Allocator' > Allocator< / a > {
2018-04-03 12:43:27 +00:00
public:
2018-05-16 11:07:07 +00:00
bool < a href = '#SkBitmap_HeapAllocator_allocPixelRef' > allocPixelRef(SkBitmap* bitmap)< / a > override;
2018-04-03 12:43:27 +00:00
};
2018-03-05 18:26:16 +00:00
< / pre >
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Subclass of < a href = '#SkBitmap_Allocator' > SkBitmap::Allocator< / a > that returns a < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > that allocates its pixel
memory from the heap. This is the default < a href = '#SkBitmap_Allocator' > SkBitmap::Allocator< / a > invoked by
< a href = '#SkBitmap_allocPixels' > allocPixels< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_HeapAllocator_allocPixelRef' > < / a >
2017-10-04 18:31:33 +00:00
## allocPixelRef
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_HeapAllocator_allocPixelRef' > allocPixelRef< / a > (< a href = '#SkBitmap' > SkBitmap< / a > * bitmap) override
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Allocates the pixel memory for the < a href = '#SkBitmap_HeapAllocator_allocPixelRef_bitmap' > bitmap< / a > , given its dimensions and
< a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > . Returns true on success, where success means either < a href = '#SkBitmap_setPixels' > setPixels< / a >
or < a href = '#SkBitmap_setPixelRef' > setPixelRef< / a > was called.
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_HeapAllocator_allocPixelRef_bitmap' > < code > < strong > bitmap< / strong > < / code > < / a > < / td >
< td > < a href = '#Bitmap' > Bitmap< / a > containing < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > as input, and < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > as output< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
true if pixels are allocated
### Example
< div > < fiddle-embed name = "fe79a9c1ec350264eb9c7b2509dd3638" >
#### Example Output
~~~~
2017-10-11 14:37:52 +00:00
#Volatile
2017-10-04 18:31:33 +00:00
pixel address = (nil)
pixel address = 0x560ddd0ac670
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_Allocator' > SkBitmap::Allocator< / a > < a href = '#SkBitmap_tryAllocPixels' > tryAllocPixels< / a > < sup > < a href = '#SkBitmap_tryAllocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_tryAllocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_tryAllocPixels_4' > [4]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_empty_constructor' > < / a >
2017-10-04 18:31:33 +00:00
## SkBitmap
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = '#SkBitmap' > SkBitmap< / a > ()
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates an empty < a href = '#Bitmap' > Bitmap< / a > without pixels, with < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > ,
< a href = 'SkImageInfo_Reference#kUnknown_SkAlphaType' > kUnknown_SkAlphaType< / a > , and with a width and height of zero. < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > origin is
set to (0, 0). < a href = '#Bitmap' > Bitmap< / a > is not volatile.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Use < a href = '#SkBitmap_setInfo' > setInfo< / a > to associate < a href = 'SkImageInfo_Reference#SkColorType' > SkColorType< / a > , < a href = 'SkImageInfo_Reference#SkAlphaType' > SkAlphaType< / a > , width, and height
after < a href = '#Bitmap' > Bitmap< / a > has been created.
2017-10-04 18:31:33 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
empty < a href = '#Bitmap' > Bitmap< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-01-30 15:08:57 +00:00
< div > < fiddle-embed name = "6739d14ec0d6a373f2fcadc6b3077fd4" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
width: 0 height: 0 color: kUnknown_SkColorType alpha: kUnknown_SkAlphaType
width: 25 height: 35 color: kRGBA_8888_SkColorType alpha: kOpaque_SkAlphaType
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_setInfo' > setInfo< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_copy_const_SkBitmap' > < / a >
2017-10-04 18:31:33 +00:00
## SkBitmap
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = '#SkBitmap' > SkBitmap< / a > (const < a href = '#SkBitmap' > SkBitmap< / a > & src)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Copies settings from < a href = '#SkBitmap_copy_const_SkBitmap_src' > src< / a > to returned < a href = '#Bitmap' > Bitmap< / a > . Shares pixels if < a href = '#SkBitmap_copy_const_SkBitmap_src' > src< / a > has pixels
2017-10-04 18:31:33 +00:00
allocated, so both bitmaps reference the same pixels.
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_copy_const_SkBitmap_src' > < code > < strong > src< / strong > < / code > < / a > < / td >
< td > < a href = '#Bitmap' > Bitmap< / a > to copy < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , and share < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > < / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
copy of < a href = '#SkBitmap_copy_const_SkBitmap_src' > src< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "bbbae7a181bfd128a4484e8e9f454db1" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
original has pixels before copy: true
original has pixels after copy: true
copy has pixels: true
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_setInfo' > setInfo< / a > < a href = '#SkBitmap_setPixelRef' > setPixelRef< / a > < a href = '#SkBitmap_setPixels' > setPixels< / a > < a href = '#SkBitmap_swap' > swap< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_move_SkBitmap' > < / a >
2017-10-04 18:31:33 +00:00
## SkBitmap
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = '#SkBitmap' > SkBitmap< / a > (< a href = '#SkBitmap' > SkBitmap< / a > & & src)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Copies settings from < a href = '#SkBitmap_move_SkBitmap_src' > src< / a > to returned < a href = '#Bitmap' > Bitmap< / a > . Moves ownership of < a href = '#SkBitmap_move_SkBitmap_src' > src< / a > pixels to
< a href = '#Bitmap' > Bitmap< / a > .
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_move_SkBitmap_src' > < code > < strong > src< / strong > < / code > < / a > < / td >
< td > < a href = '#Bitmap' > Bitmap< / a > to copy < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , and reassign < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > < / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
copy of < a href = '#SkBitmap_move_SkBitmap_src' > src< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "40afd4f1fa69e02d69d92b38252088ef" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
original has pixels before move: true
original has pixels after move: false
copy has pixels: true
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_setInfo' > setInfo< / a > < a href = '#SkBitmap_setPixelRef' > setPixelRef< / a > < a href = '#SkBitmap_setPixels' > setPixels< / a > < a href = '#SkBitmap_swap' > swap< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_destructor' > < / a >
2017-10-04 18:31:33 +00:00
## ~SkBitmap
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = '#SkBitmap_destructor' > ~SkBitmap< / a > ()
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Decrements < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > reference count, if < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is not nullptr.
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_copy_operator' > < / a >
2017-10-04 18:31:33 +00:00
## operator=
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = '#SkBitmap' > SkBitmap< / a > & < a href = '#SkBitmap_copy_operator' > operator=(const SkBitmap& src)< / a >
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Copies settings from < a href = '#SkBitmap_copy_operator_src' > src< / a > to returned < a href = '#Bitmap' > Bitmap< / a > . Shares pixels if < a href = '#SkBitmap_copy_operator_src' > src< / a > has pixels
2017-10-04 18:31:33 +00:00
allocated, so both bitmaps reference the same pixels.
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_copy_operator_src' > < code > < strong > src< / strong > < / code > < / a > < / td >
< td > < a href = '#Bitmap' > Bitmap< / a > to copy < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , and share < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > < / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
copy of < a href = '#SkBitmap_copy_operator_src' > src< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "45279c519ae808f78bd30e9d84bdfdde" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
original has pixels before copy: true
original has pixels after copy: true
copy has pixels: true
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_setInfo' > setInfo< / a > < a href = '#SkBitmap_setPixelRef' > setPixelRef< / a > < a href = '#SkBitmap_setPixels' > setPixels< / a > < a href = '#SkBitmap_swap' > swap< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_move_operator' > < / a >
2017-10-04 18:31:33 +00:00
## operator=
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = '#SkBitmap' > SkBitmap< / a > & < a href = '#SkBitmap_move_operator' > operator=(SkBitmap& & src)< / a >
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Copies settings from < a href = '#SkBitmap_move_operator_src' > src< / a > to returned < a href = '#Bitmap' > Bitmap< / a > . Moves ownership of < a href = '#SkBitmap_move_operator_src' > src< / a > pixels to
< a href = '#Bitmap' > Bitmap< / a > .
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_move_operator_src' > < code > < strong > src< / strong > < / code > < / a > < / td >
< td > < a href = '#Bitmap' > Bitmap< / a > to copy < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , and reassign < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > < / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
copy of < a href = '#SkBitmap_move_operator_src' > src< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-07-11 05:28:17 +00:00
< div > < fiddle-embed name = "35ea3fed27d8db22dc00f48670de64de" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
original has pixels before move: true
original has pixels after move: false
copy has pixels: true
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_setInfo' > setInfo< / a > < a href = '#SkBitmap_setPixelRef' > setPixelRef< / a > < a href = '#SkBitmap_setPixels' > setPixels< / a > < a href = '#SkBitmap_swap' > swap< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_swap' > < / a >
2017-10-04 18:31:33 +00:00
## swap
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_swap' > swap< / a > (< a href = '#SkBitmap' > SkBitmap< / a > & other)
2017-10-04 18:31:33 +00:00
< / pre >
Swaps the fields of the two bitmaps.
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_swap_other' > < code > < strong > other< / strong > < / code > < / a > < / td >
< td > < a href = '#Bitmap' > Bitmap< / a > exchanged with original< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Example
2018-03-16 15:34:15 +00:00
< div > < fiddle-embed name = "de9be45255e48fae445c916a41063abc" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
one width:1 height:1 colorType:kRGBA_8888_SkColorType alphaType:kOpaque_SkAlphaType
two width:2 height:2 colorType:kBGRA_8888_SkColorType alphaType:kPremul_SkAlphaType
one width:2 height:2 colorType:kBGRA_8888_SkColorType alphaType:kPremul_SkAlphaType
two width:1 height:1 colorType:kRGBA_8888_SkColorType alphaType:kOpaque_SkAlphaType
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_move_SkBitmap' > SkBitmap(SkBitmap& & src)< / a > < a href = '#SkBitmap_move_operator' > operator=(SkBitmap& & src)< / a >
---
## <a name='Property'>Property</a>
< table style = 'border-collapse: collapse; width: 62.5em' >
< tr >< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Topic</ th >
< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Description</ th ></ tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_alphaType' > alphaType</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_bounds' > bounds</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = '#SkBitmap_width' > width</ a > and < a href = '#SkBitmap_height' > height</ a > as Rectangle</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_bytesPerPixel' > bytesPerPixel</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns number of bytes in pixel based on < a href = 'SkImageInfo_Reference#Color_Type' > Color Type</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_colorSpace' > colorSpace</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > < a href = 'undocumented#Color_Space' > Color Space</ a ></ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_colorType' > colorType</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > < a href = 'SkImageInfo_Reference#Color_Type' > Color Type</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_dimensions' > dimensions</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = '#SkBitmap_width' > width</ a > and < a href = '#SkBitmap_height' > height</ a ></ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_drawsNothing' > drawsNothing</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns true if no < a href = '#SkBitmap_width' > width</ a > , no < a href = '#SkBitmap_height' > height</ a > , or no < a href = 'undocumented#Pixel_Ref' > Pixel Ref</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_empty' > empty</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns true if < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > has zero < a href = '#SkBitmap_width' > width</ a > or < a href = '#SkBitmap_height' > height</ a ></ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getAddr' > getAddr</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns readable pixel address as void pointer</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getAddr16' > getAddr16</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns readable pixel address as 16-bit pointer</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getAddr32' > getAddr32</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns readable pixel address as 32-bit pointer</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getAddr8' > getAddr8</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns readable pixel address as 8-bit pointer</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getBounds' > getBounds</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = '#SkBitmap_width' > width</ a > and < a href = '#SkBitmap_height' > height</ a > as Rectangle</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getBounds' > getBounds(SkRect* bounds)</ a > const</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getBounds_2' > getBounds(SkIRect* bounds)</ a > const</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getColor' > getColor</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns one pixel as < a href = 'undocumented#Unpremultiply' > Unpremultiplied</ a > < a href = 'SkColor_Reference#Color' > Color</ a ></ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getPixels' > getPixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns address of pixels</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getSubset' > getSubset</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns bounds offset by origin</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_hasHardwareMipMap' > hasHardwareMipMap</ a ></ td >
2018-06-14 16:28:14 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'undocumented#Mip_Map' > Mip Map</ a > support present; Android only</ td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_height' > height</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns pixel row count</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_info' > info</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_isImmutable' > isImmutable</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns true if pixels will not change</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_isNull' > isNull</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns true if < a href = 'undocumented#Pixel_Ref' > Pixel Ref</ a > is nullptr</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_isOpaque' > isOpaque</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns true if < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > describes opaque pixels</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_isVolatile' > isVolatile</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns true if pixels should not be cached</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_pixelRef' > pixelRef</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'undocumented#Pixel_Ref' > Pixel Ref</ a > , or nullptr</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_pixelRefOrigin' > pixelRefOrigin</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns offset within < a href = 'undocumented#Pixel_Ref' > Pixel Ref</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_pixmap' > pixmap</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'SkPixmap_Reference#Pixmap' > Pixmap</ a ></ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_refColorSpace' > refColorSpace</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > < a href = 'undocumented#Color_Space' > Color Space</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_rowBytes' > rowBytes</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns interval between rows in bytes</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_rowBytesAsPixels' > rowBytesAsPixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns interval between rows in pixels</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_shiftPerPixel' > shiftPerPixel</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns bit shift from pixels to bytes</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_width' > width</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns pixel column count</ td >
< / tr >
< / table >
< a name = 'SkBitmap_pixmap' > < / a >
2017-12-15 16:21:51 +00:00
## pixmap
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
const < a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > & < a href = '#SkBitmap_pixmap' > pixmap< / a > () const
2017-12-15 16:21:51 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns a constant reference to the < a href = 'SkPixmap_Reference#Pixmap' > Pixmap< / a > holding the < a href = '#Bitmap' > Bitmap< / a > pixel
address, row bytes, and < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > .
2017-12-15 16:21:51 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
reference to < a href = 'SkPixmap_Reference#Pixmap' > Pixmap< / a > describing this < a href = '#Bitmap' > Bitmap< / a >
2017-12-15 16:21:51 +00:00
### Example
2018-01-11 15:35:44 +00:00
< div > < fiddle-embed name = "7f972d742dd78d2500034d8867e9ef2f" >
2017-12-15 16:21:51 +00:00
#### Example Output
~~~~
----------
---xx-----
--x--x----
--x-------
--xx------
--x-x---x-
-x---x--x-
-x----xx--
-xx---x---
--xxxx-xx-
----------
~~~~
< / fiddle-embed > < / div >
### See Also
2018-07-17 17:19:56 +00:00
< a href = '#SkBitmap_peekPixels' > peekPixels< / a > < a href = '#SkBitmap_installPixels' > installPixels< / a > < sup > < a href = '#SkBitmap_installPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_installPixels_3' > [3]< / a > < / sup > < a href = '#SkBitmap_readPixels' > readPixels< / a > < sup > < a href = '#SkBitmap_readPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_readPixels_3' > [3]< / a > < / sup > < a href = '#SkBitmap_writePixels' > writePixels< / a > < sup > < a href = '#SkBitmap_writePixels_2' > [2]< / a > < / sup >
2017-12-15 16:21:51 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_info' > < / a >
2017-10-04 18:31:33 +00:00
## info
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
const < a href = 'SkImageInfo_Reference#SkImageInfo' > SkImageInfo< / a > & < a href = '#SkBitmap_info' > info< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns width, height, < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , and < a href = 'undocumented#Color_Space' > Color Space< / a > .
2017-10-04 18:31:33 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
reference to < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-07-09 05:28:19 +00:00
< div > < fiddle-embed name = "ec47c4dc23e2925ad565eaba55a91553" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
width: 56 height: 56 color: BGRA_8888 alpha: Opaque
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_width' > < / a >
2017-10-04 18:31:33 +00:00
## width
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
int < a href = '#SkBitmap_width' > width< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
Condense embedded formulas.
Bookmaker delimits formulas and equations to allow
representing variables and symbols without tripping
up reference lookup, spell checking, and comment
generation.
Before, formulas were represented with:
some text
#Formula
(x + y, 0)
##
, and more text
This made it difficult to know when spacing should
be preserved before and after the formula. Now,
formulas are represented with:
some text #Formula # (x + y, 0) ##, and more text
The presence or absence of a space between ## and ,
is now significant (before it was not).
Also, formulas are bracketed by <code> in markdown
generation, so that variables stand out better.
See:
https://skia.org/user/api/SkBlendMode_Reference?cl=152781#Dst_Out
for an example.
Also fixed 100 column offenders and added a code
check to identify them. For the moment, 100 column
offenders are outed with SkDebugf but their presence
does not cause bookmaker to fail.
TBR=caryclark@google.com
Docs-Preview: https://skia.org/?cl=152781
Bug: skia:6898
Change-Id: If92a65a234f5d616bf4485984a8d219a6f04821a
Reviewed-on: https://skia-review.googlesource.com/152781
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-09-13 16:04:30 +00:00
Returns pixel count in each row. Should be equal or less than < code >< a href = '#SkBitmap_rowBytes' > rowBytes</ a > / < a href = '#SkBitmap_info' > info</ a > \.< a href = '#SkBitmap_bytesPerPixel' > bytesPerPixel</ a ></ code > .
2017-10-04 18:31:33 +00:00
2018-07-11 20:18:41 +00:00
May be less than < a href = '#SkBitmap_pixelRef' > pixelRef< / a > .< a href = '#SkBitmap_width' > width< / a > . Will not exceed < a href = '#SkBitmap_pixelRef' > pixelRef< / a > .< a href = '#SkBitmap_width' > width< / a > less
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_pixelRefOrigin' > pixelRefOrigin< / a > .fX.
2017-10-04 18:31:33 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
pixel width in < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a >
2017-10-04 18:31:33 +00:00
### Example
< div > < fiddle-embed name = "d06880c42f8bb3b4c3b67bd988046049" >
#### Example Output
~~~~
bitmap width: 16 info width: 16
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_height' > height< / a > < a href = 'undocumented#SkPixelRef_width' > SkPixelRef::width()< / a > < a href = 'SkImageInfo_Reference#SkImageInfo_width' > SkImageInfo::width()< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_height' > < / a >
2017-10-04 18:31:33 +00:00
## height
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
int < a href = '#SkBitmap_height' > height< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
Returns pixel row count.
2018-05-16 11:07:07 +00:00
Maybe be less than < a href = '#SkBitmap_pixelRef' > pixelRef< / a > .< a href = '#SkBitmap_height' > height< / a > . Will not exceed < a href = '#SkBitmap_pixelRef' > pixelRef< / a > .< a href = '#SkBitmap_height' > height< / a > less
< a href = '#SkBitmap_pixelRefOrigin' > pixelRefOrigin< / a > .fY.
2017-10-04 18:31:33 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
pixel height in < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a >
2017-10-04 18:31:33 +00:00
### Example
< div > < fiddle-embed name = "c79a196278c58b34cd5f551b0124ecc9" >
#### Example Output
~~~~
bitmap height: 32 info height: 32
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_width' > width< / a > < a href = 'undocumented#SkPixelRef_height' > SkPixelRef::height()< / a > < a href = 'SkImageInfo_Reference#SkImageInfo_height' > SkImageInfo::height()< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_colorType' > < / a >
2017-10-04 18:31:33 +00:00
## colorType
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = 'SkImageInfo_Reference#SkColorType' > SkColorType< / a > < a href = '#SkBitmap_colorType' > colorType< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , one of: < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGB_565_SkColorType' > kRGB_565_SkColorType< / a > ,
< a href = 'SkImageInfo_Reference#kARGB_4444_SkColorType' > kARGB_4444_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGBA_8888_SkColorType' > kRGBA_8888_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGB_888x_SkColorType' > kRGB_888x_SkColorType< / a > ,
< a href = 'SkImageInfo_Reference#kBGRA_8888_SkColorType' > kBGRA_8888_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGBA_1010102_SkColorType' > kRGBA_1010102_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGB_101010x_SkColorType' > kRGB_101010x_SkColorType< / a > ,
< a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGBA_F16_SkColorType' > kRGBA_F16_SkColorType< / a > .
2017-10-04 18:31:33 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
< a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > in < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-07-16 05:29:00 +00:00
< div > < fiddle-embed name = "ceb77fab7326b57822a147b04aa0960e" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
2018-01-30 15:08:57 +00:00
color type: kAlpha_8_SkColorType
2017-10-04 18:31:33 +00:00
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_alphaType' > alphaType< / a > < a href = 'SkImageInfo_Reference#SkImageInfo_colorType' > SkImageInfo::colorType< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_alphaType' > < / a >
2017-10-04 18:31:33 +00:00
## alphaType
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = 'SkImageInfo_Reference#SkAlphaType' > SkAlphaType< / a > < a href = '#SkBitmap_alphaType' > alphaType< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , one of: < a href = 'SkImageInfo_Reference#kUnknown_SkAlphaType' > kUnknown_SkAlphaType< / a > , < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a > , < a href = 'SkImageInfo_Reference#kPremul_SkAlphaType' > kPremul_SkAlphaType< / a > ,
< a href = 'SkImageInfo_Reference#kUnpremul_SkAlphaType' > kUnpremul_SkAlphaType< / a > .
2017-10-04 18:31:33 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
< a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > in < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a >
2017-10-04 18:31:33 +00:00
### Example
< div > < fiddle-embed name = "070b1a60232be499eb10c6ea62371804" >
#### Example Output
~~~~
alpha type: kPremul_SkAlphaType
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_colorType' > colorType< / a > < a href = 'SkImageInfo_Reference#SkImageInfo_alphaType' > SkImageInfo::alphaType< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_colorSpace' > < / a >
2017-10-04 18:31:33 +00:00
## colorSpace
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > * < a href = '#SkBitmap_colorSpace' > colorSpace< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns < a href = 'undocumented#Color_Space' > Color Space< / a > , the range of colors, associated with < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > . The
reference count of < a href = 'undocumented#Color_Space' > Color Space< / a > is unchanged. The returned < a href = 'undocumented#Color_Space' > Color Space< / a > is
2017-10-04 18:31:33 +00:00
immutable.
### Return Value
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#Color_Space' > Color Space< / a > in < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , or nullptr
2017-10-04 18:31:33 +00:00
### Example
2018-07-19 03:49:13 +00:00
< div > < fiddle-embed name = "817f95879fadba44baf87ea60e9b595a" > < div > < a href = 'undocumented#SkColorSpace_MakeSRGBLinear' > SkColorSpace::MakeSRGBLinear< / a > creates < a href = 'undocumented#Color_Space' > Color Space< / a > with linear gamma
2018-05-16 11:07:07 +00:00
and an sRGB gamut. This < a href = 'undocumented#Color_Space' > Color Space< / a > gamma is not close to sRGB gamma.
2018-03-05 18:26:16 +00:00
< / div >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
gammaCloseToSRGB: false gammaIsLinear: true isSRGB: false
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#Color_Space' > Color Space< / a > < a href = 'SkImageInfo_Reference#SkImageInfo_colorSpace' > SkImageInfo::colorSpace< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_refColorSpace' > < / a >
2017-10-04 18:31:33 +00:00
## refColorSpace
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > < a href = '#SkBitmap_refColorSpace' > refColorSpace< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns smart pointer to < a href = 'undocumented#Color_Space' > Color Space< / a > , the range of colors, associated with
< a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > . The smart pointer tracks the number of objects sharing this
< a href = 'undocumented#Color_Space' > Color Space< / a > reference so the memory is released when the owners destruct.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
The returned < a href = 'undocumented#Color_Space' > Color Space< / a > is immutable.
2017-10-04 18:31:33 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#Color_Space' > Color Space< / a > in < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > wrapped in a smart pointer
2017-10-04 18:31:33 +00:00
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "cb028b7931da85b949ad0953b9711f9f" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
gammaCloseToSRGB: false gammaIsLinear: true isSRGB: false
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#Color_Space' > Color Space< / a > < a href = 'SkImageInfo_Reference#SkImageInfo_colorSpace' > SkImageInfo::colorSpace< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_bytesPerPixel' > < / a >
2017-10-04 18:31:33 +00:00
## bytesPerPixel
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
int < a href = '#SkBitmap_bytesPerPixel' > bytesPerPixel< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns number of bytes per pixel required by < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > .
Returns zero if < a href = '#SkBitmap_colorType' > colorType< / a > ( is < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > .
2017-10-04 18:31:33 +00:00
### Return Value
bytes in pixel
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "2a688e6f0a516c0d44a826381e9d637f" > < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGB_565_SkColorType' > kRGB_565_SkColorType< / a > ,
< a href = 'SkImageInfo_Reference#kARGB_4444_SkColorType' > kARGB_4444_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGBA_8888_SkColorType' > kRGBA_8888_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGB_888x_SkColorType' > kRGB_888x_SkColorType< / a > ,
< a href = 'SkImageInfo_Reference#kBGRA_8888_SkColorType' > kBGRA_8888_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGBA_1010102_SkColorType' > kRGBA_1010102_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGB_101010x_SkColorType' > kRGB_101010x_SkColorType< / a > ,
< a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGBA_F16_SkColorType' > kRGBA_F16_SkColorType< / a >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
2018-01-30 15:08:57 +00:00
color: kUnknown_SkColorType bytesPerPixel: 0
color: kAlpha_8_SkColorType bytesPerPixel: 1
color: kRGB_565_SkColorType bytesPerPixel: 2
color: kARGB_4444_SkColorType bytesPerPixel: 2
color: kRGBA_8888_SkColorType bytesPerPixel: 4
2018-03-05 18:26:16 +00:00
color: kRGB_888x_SkColorType bytesPerPixel: 4
2018-01-30 15:08:57 +00:00
color: kBGRA_8888_SkColorType bytesPerPixel: 4
2018-03-05 18:26:16 +00:00
color: kRGBA_1010102_SkColorType bytesPerPixel: 4
color: kRGB_101010x_SkColorType bytesPerPixel: 4
2018-01-30 15:08:57 +00:00
color: kGray_8_SkColorType bytesPerPixel: 1
color: kRGBA_F16_SkColorType bytesPerPixel: 8
2017-10-04 18:31:33 +00:00
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_rowBytes' > rowBytes< / a > < a href = '#SkBitmap_rowBytesAsPixels' > rowBytesAsPixels< / a > < a href = '#SkBitmap_width' > width< / a > < a href = '#SkBitmap_shiftPerPixel' > shiftPerPixel< / a > < a href = 'SkImageInfo_Reference#SkImageInfo_bytesPerPixel' > SkImageInfo::bytesPerPixel< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_rowBytesAsPixels' > < / a >
2017-10-04 18:31:33 +00:00
## rowBytesAsPixels
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
int < a href = '#SkBitmap_rowBytesAsPixels' > rowBytesAsPixels< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
Returns number of pixels that fit on row. Should be greater than or equal to
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_width' > width< / a > .
2017-10-04 18:31:33 +00:00
### Return Value
maximum pixels per row
### Example
2018-07-06 05:23:23 +00:00
< div > < fiddle-embed name = "03a9e08082a23a98de17c3e24871d61a" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
rowBytes: 4 rowBytesAsPixels: 1
rowBytes: 5 rowBytesAsPixels: 1
rowBytes: 6 rowBytesAsPixels: 1
rowBytes: 7 rowBytesAsPixels: 1
rowBytes: 8 rowBytesAsPixels: 2
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_rowBytes' > rowBytes< / a > < a href = '#SkBitmap_shiftPerPixel' > shiftPerPixel< / a > < a href = '#SkBitmap_width' > width< / a > < a href = '#SkBitmap_bytesPerPixel' > bytesPerPixel< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_shiftPerPixel' > < / a >
2017-10-04 18:31:33 +00:00
## shiftPerPixel
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
int < a href = '#SkBitmap_shiftPerPixel' > shiftPerPixel< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
Returns bit shift converting row bytes to row pixels.
2018-05-16 11:07:07 +00:00
Returns zero for < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > .
2017-10-04 18:31:33 +00:00
### Return Value
one of: 0, 1, 2, 3; left shift to convert pixels to bytes
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "56ede4b7d45c15d5936f81ac3d74f070" > < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGB_565_SkColorType' > kRGB_565_SkColorType< / a > ,
< a href = 'SkImageInfo_Reference#kARGB_4444_SkColorType' > kARGB_4444_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGBA_8888_SkColorType' > kRGBA_8888_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGB_888x_SkColorType' > kRGB_888x_SkColorType< / a > ,
< a href = 'SkImageInfo_Reference#kBGRA_8888_SkColorType' > kBGRA_8888_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGBA_1010102_SkColorType' > kRGBA_1010102_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGB_101010x_SkColorType' > kRGB_101010x_SkColorType< / a > ,
< a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGBA_F16_SkColorType' > kRGBA_F16_SkColorType< / a >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
2018-03-05 18:26:16 +00:00
color: kUnknown_SkColorType shiftPerPixel: 0
color: kAlpha_8_SkColorType shiftPerPixel: 0
color: kRGB_565_SkColorType shiftPerPixel: 1
color: kARGB_4444_SkColorType shiftPerPixel: 1
color: kRGBA_8888_SkColorType shiftPerPixel: 2
color: kRGB_888x_SkColorType shiftPerPixel: 2
color: kBGRA_8888_SkColorType shiftPerPixel: 2
color: kRGBA_1010102_SkColorType shiftPerPixel: 2
color: kRGB_101010x_SkColorType shiftPerPixel: 2
color: kGray_8_SkColorType shiftPerPixel: 0
color: kRGBA_F16_SkColorType shiftPerPixel: 3
2017-10-04 18:31:33 +00:00
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_rowBytes' > rowBytes< / a > < a href = '#SkBitmap_rowBytesAsPixels' > rowBytesAsPixels< / a > < a href = '#SkBitmap_width' > width< / a > < a href = '#SkBitmap_bytesPerPixel' > bytesPerPixel< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_empty' > < / a >
2017-10-04 18:31:33 +00:00
## empty
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_empty' > empty< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns true if either < a href = '#SkBitmap_width' > width< / a > or < a href = '#SkBitmap_height' > height< / a > are zero.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Does not check if < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is nullptr; call < a href = '#SkBitmap_drawsNothing' > drawsNothing< / a > to check < a href = '#SkBitmap_width' > width< / a > ,
< a href = '#SkBitmap_height' > height< / a > , and < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > .
2017-10-04 18:31:33 +00:00
### Return Value
2018-01-26 17:56:22 +00:00
true if dimensions do not enclose area
2017-10-04 18:31:33 +00:00
### Example
2018-07-11 05:28:17 +00:00
< div > < fiddle-embed name = "a3762c2722b56ba55e42689c527f146c" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
width: 0 height: 0 empty: true
width: 0 height: 2 empty: true
width: 2 height: 0 empty: true
width: 2 height: 2 empty: false
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_height' > height< / a > < a href = '#SkBitmap_width' > width< / a > < a href = '#SkBitmap_drawsNothing' > drawsNothing< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_isNull' > < / a >
2017-10-04 18:31:33 +00:00
## isNull
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_isNull' > isNull< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-07-11 20:18:41 +00:00
Returns true if < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is nullptr.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Does not check if < a href = '#SkBitmap_width' > width< / a > or < a href = '#SkBitmap_height' > height< / a > are zero; call < a href = '#SkBitmap_drawsNothing' > drawsNothing< / a > to check
< a href = '#SkBitmap_width' > width< / a > , < a href = '#SkBitmap_height' > height< / a > , and < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > .
2017-10-04 18:31:33 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
true if no < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is associated
2017-10-04 18:31:33 +00:00
### Example
2018-07-08 05:32:09 +00:00
< div > < fiddle-embed name = "211ec89418011aa6e54aa2cc9567e003" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
empty bitmap does not have pixels
bitmap with dimensions does not have pixels
allocated bitmap does have pixels
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_empty' > empty< / a > < a href = '#SkBitmap_drawsNothing' > drawsNothing< / a > < a href = '#SkBitmap_pixelRef' > pixelRef< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_drawsNothing' > < / a >
2017-10-04 18:31:33 +00:00
## drawsNothing
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_drawsNothing' > drawsNothing< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-07-11 20:18:41 +00:00
Returns true if < a href = '#SkBitmap_width' > width< / a > or < a href = '#SkBitmap_height' > height< / a > are zero, or if < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is nullptr.
2018-05-16 11:07:07 +00:00
If true, < a href = '#Bitmap' > Bitmap< / a > has no effect when drawn or drawn into.
2017-10-04 18:31:33 +00:00
### Return Value
true if drawing has no effect
### Example
2018-07-05 05:35:27 +00:00
< div > < fiddle-embed name = "daacf43394ce4045a362a48b5774deed" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
empty:true isNull:true drawsNothing:true
empty:true isNull:false drawsNothing:true
empty:false isNull:true drawsNothing:true
empty:false isNull:false drawsNothing:false
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_empty' > empty< / a > < a href = '#SkBitmap_isNull' > isNull< / a > < a href = '#SkBitmap_pixelRef' > pixelRef< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_rowBytes' > < / a >
2017-10-04 18:31:33 +00:00
## rowBytes
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
size_t < a href = '#SkBitmap_rowBytes' > rowBytes< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
Returns row bytes, the interval from one pixel row to the next. Row bytes
Condense embedded formulas.
Bookmaker delimits formulas and equations to allow
representing variables and symbols without tripping
up reference lookup, spell checking, and comment
generation.
Before, formulas were represented with:
some text
#Formula
(x + y, 0)
##
, and more text
This made it difficult to know when spacing should
be preserved before and after the formula. Now,
formulas are represented with:
some text #Formula # (x + y, 0) ##, and more text
The presence or absence of a space between ## and ,
is now significant (before it was not).
Also, formulas are bracketed by <code> in markdown
generation, so that variables stand out better.
See:
https://skia.org/user/api/SkBlendMode_Reference?cl=152781#Dst_Out
for an example.
Also fixed 100 column offenders and added a code
check to identify them. For the moment, 100 column
offenders are outed with SkDebugf but their presence
does not cause bookmaker to fail.
TBR=caryclark@google.com
Docs-Preview: https://skia.org/?cl=152781
Bug: skia:6898
Change-Id: If92a65a234f5d616bf4485984a8d219a6f04821a
Reviewed-on: https://skia-review.googlesource.com/152781
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-09-13 16:04:30 +00:00
is at least as large as: < code >< a href = '#SkBitmap_width' > width</ a > \* < a href = '#SkBitmap_info' > info</ a > \.< a href = '#SkBitmap_bytesPerPixel' > bytesPerPixel</ a ></ code > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Returns zero if < a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > , or if row bytes supplied to
< a href = '#SkBitmap_setInfo' > setInfo< / a > is not large enough to hold a row of pixels.
2017-10-04 18:31:33 +00:00
### Return Value
byte length of pixel row
### Example
< div > < fiddle-embed name = "a654fd0b73f424859ae6c95e03f55099" >
#### Example Output
~~~~
setInfo returned:false rowBytes:0
setInfo returned:true rowBytes:8
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_info' > info< / a > < a href = '#SkBitmap_setInfo' > setInfo< / a > < a href = 'SkImageInfo_Reference#SkImageInfo_minRowBytes' > SkImageInfo::minRowBytes< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_setAlphaType' > < / a >
2017-10-04 18:31:33 +00:00
## setAlphaType
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_setAlphaType' > setAlphaType< / a > (< a href = 'SkImageInfo_Reference#SkAlphaType' > SkAlphaType< / a > < a href = '#SkBitmap_alphaType' > alphaType< / a > )
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , if < a href = '#SkBitmap_alphaType' > alphaType< / a > is compatible with < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > .
Returns true unless < a href = '#SkBitmap_alphaType' > alphaType< / a > is < a href = 'SkImageInfo_Reference#kUnknown_SkAlphaType' > kUnknown_SkAlphaType< / a > and current < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a >
is not < a href = 'SkImageInfo_Reference#kUnknown_SkAlphaType' > kUnknown_SkAlphaType< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Returns true if < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > is < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > . < a href = '#SkBitmap_alphaType' > alphaType< / a > is ignored, and
< a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > remains < a href = 'SkImageInfo_Reference#kUnknown_SkAlphaType' > kUnknown_SkAlphaType< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Returns true if < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > is < a href = 'SkImageInfo_Reference#kRGB_565_SkColorType' > kRGB_565_SkColorType< / a > or < a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > .
< a href = '#SkBitmap_alphaType' > alphaType< / a > is ignored, and < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > remains < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
If < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > is < a href = 'SkImageInfo_Reference#kARGB_4444_SkColorType' > kARGB_4444_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGBA_8888_SkColorType' > kRGBA_8888_SkColorType< / a > ,
< a href = 'SkImageInfo_Reference#kBGRA_8888_SkColorType' > kBGRA_8888_SkColorType< / a > , or < a href = 'SkImageInfo_Reference#kRGBA_F16_SkColorType' > kRGBA_F16_SkColorType< / a > : returns true unless
< a href = '#SkBitmap_alphaType' > alphaType< / a > is < a href = 'SkImageInfo_Reference#kUnknown_SkAlphaType' > kUnknown_SkAlphaType< / a > and < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > is not < a href = 'SkImageInfo_Reference#kUnknown_SkAlphaType' > kUnknown_SkAlphaType< / a > .
If < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > is < a href = 'SkImageInfo_Reference#kUnknown_SkAlphaType' > kUnknown_SkAlphaType< / a > , < a href = '#SkBitmap_alphaType' > alphaType< / a > is ignored.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
If < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > is < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > , returns true unless
< a href = '#SkBitmap_alphaType' > alphaType< / a > is < a href = 'SkImageInfo_Reference#kUnknown_SkAlphaType' > kUnknown_SkAlphaType< / a > and < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > is not < a href = 'SkImageInfo_Reference#kUnknown_SkAlphaType' > kUnknown_SkAlphaType< / a > .
If < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > is < a href = 'SkImageInfo_Reference#kUnknown_SkAlphaType' > kUnknown_SkAlphaType< / a > , < a href = '#SkBitmap_alphaType' > alphaType< / a > is ignored. If < a href = '#SkBitmap_alphaType' > alphaType< / a > is
< a href = 'SkImageInfo_Reference#kUnpremul_SkAlphaType' > kUnpremul_SkAlphaType< / a > , it is treated as < a href = 'SkImageInfo_Reference#kPremul_SkAlphaType' > kPremul_SkAlphaType< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
This changes < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > in < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > ; all bitmaps sharing < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a >
2017-10-04 18:31:33 +00:00
are affected.
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_setAlphaType_alphaType' > < code > < strong > alphaType< / strong > < / code > < / a > < / td >
< td > one of: < a href = 'SkImageInfo_Reference#kUnknown_SkAlphaType' > kUnknown_SkAlphaType< / a > , < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a > , < a href = 'SkImageInfo_Reference#kPremul_SkAlphaType' > kPremul_SkAlphaType< / a > ,
< a href = 'SkImageInfo_Reference#kUnpremul_SkAlphaType' > kUnpremul_SkAlphaType< / a > < / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > is set
2017-10-04 18:31:33 +00:00
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "dd73f0f927a049b17982c8cf06dd2d00" > < a href = 'SkImageInfo_Reference#kUnknown_SkAlphaType' > kUnknown_SkAlphaType< / a > , < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a > , < a href = 'SkImageInfo_Reference#kPremul_SkAlphaType' > kPremul_SkAlphaType< / a > ,
< a href = 'SkImageInfo_Reference#kUnpremul_SkAlphaType' > kUnpremul_SkAlphaType< / a > < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGB_565_SkColorType' > kRGB_565_SkColorType< / a > ,
< a href = 'SkImageInfo_Reference#kARGB_4444_SkColorType' > kARGB_4444_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGBA_8888_SkColorType' > kRGBA_8888_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGB_888x_SkColorType' > kRGB_888x_SkColorType< / a > ,
< a href = 'SkImageInfo_Reference#kBGRA_8888_SkColorType' > kBGRA_8888_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGBA_1010102_SkColorType' > kRGBA_1010102_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGB_101010x_SkColorType' > kRGB_101010x_SkColorType< / a > ,
< a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGBA_F16_SkColorType' > kRGBA_F16_SkColorType< / a > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > < a href = '#SkBitmap_setInfo' > setInfo< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_getPixels' > < / a >
2017-10-04 18:31:33 +00:00
## getPixels
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void* < a href = '#SkBitmap_getPixels' > getPixels< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
Returns pixel address, the base address corresponding to the pixel origin.
### Return Value
pixel address
### Example
< div > < fiddle-embed name = "e006bb05cf74ec8d2b3d6adeb5dba11b" >
#### Example Output
~~~~
bitmap.getColor(0, 1) == 0x00000000
bitmap.getColor(0, 0) == 0xFFFFFFFF
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_isNull' > isNull< / a > < a href = '#SkBitmap_drawsNothing' > drawsNothing< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_computeByteSize' > < / a >
2017-10-04 18:31:33 +00:00
## computeByteSize
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
size_t < a href = '#SkBitmap_computeByteSize' > computeByteSize< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
Returns minimum memory required for pixel storage.
2018-05-16 11:07:07 +00:00
Does not include unused memory on last row when < a href = '#SkBitmap_rowBytesAsPixels' > rowBytesAsPixels< / a > exceeds < a href = '#SkBitmap_width' > width< / a > .
2017-10-04 18:31:33 +00:00
Returns zero if result does not fit in size_t.
2018-05-16 11:07:07 +00:00
Returns zero if < a href = '#SkBitmap_height' > height< / a > or < a href = '#SkBitmap_width' > width< / a > is 0.
Returns < a href = '#SkBitmap_height' > height< / a > times < a href = '#SkBitmap_rowBytes' > rowBytes< / a > if < a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > .
2017-10-04 18:31:33 +00:00
### Return Value
size in bytes of image buffer
### Example
2018-07-18 20:21:51 +00:00
< div > < fiddle-embed name = "165c8f208829fc0908e8a50da60c0076" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
width: 1 height: 1 computeByteSize: 4
width: 1 height: 1000 computeByteSize: 4999
width: 1 height: 1000000 computeByteSize: 4999999
width: 1000 height: 1 computeByteSize: 4000
width: 1000 height: 1000 computeByteSize: 4999000
width: 1000 height: 1000000 computeByteSize: 4999999000
width: 1000000 height: 1 computeByteSize: 4000000
width: 1000000 height: 1000 computeByteSize: 4999000000
width: 1000000 height: 1000000 computeByteSize: 4999999000000
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = 'SkImageInfo_Reference#SkImageInfo_computeByteSize' > SkImageInfo::computeByteSize< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_isImmutable' > < / a >
2017-10-04 18:31:33 +00:00
## isImmutable
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_isImmutable' > isImmutable< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
Returns true if pixels can not change.
2018-05-16 11:07:07 +00:00
Most immutable < a href = '#Bitmap' > Bitmap< / a > checks trigger an assert only on debug builds.
2017-10-04 18:31:33 +00:00
### Return Value
true if pixels are immutable
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "db61fdcd382342ee88ea1b4f27c27b95" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
original is immutable
copy is immutable
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_setImmutable' > setImmutable< / a > < a href = 'undocumented#SkPixelRef_isImmutable' > SkPixelRef::isImmutable< / a > < a href = 'SkImage_Reference#SkImage' > SkImage< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_setImmutable' > < / a >
2017-10-04 18:31:33 +00:00
## setImmutable
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_setImmutable' > setImmutable< / a > ()
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets internal flag to mark < a href = '#Bitmap' > Bitmap< / a > as immutable. Once set, pixels can not change.
Any other bitmap sharing the same < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > are also marked as immutable.
Once < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is marked immutable, the setting cannot be cleared.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Writing to immutable < a href = '#Bitmap' > Bitmap< / a > pixels triggers an assert on debug builds.
2017-10-04 18:31:33 +00:00
### Example
2018-03-05 18:26:16 +00:00
< div > < fiddle-embed name = "9210060d1f4ca46e1375496237902ef3" > < div > Triggers assert if SK_DEBUG is true, runs fine otherwise.
< / div > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_isImmutable' > isImmutable< / a > < a href = 'undocumented#SkPixelRef_setImmutable' > SkPixelRef::setImmutable< / a > < a href = 'SkImage_Reference#SkImage' > SkImage< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_isOpaque' > < / a >
2017-10-04 18:31:33 +00:00
## isOpaque
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_isOpaque' > isOpaque< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns true if < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > is set to hint that all pixels are opaque; their
< a href = 'SkColor_Reference#Alpha' > Color Alpha< / a > value is implicitly or explicitly 1.0. If true, and all pixels are
2018-03-16 15:34:15 +00:00
not opaque, Skia may draw incorrectly.
2018-05-16 11:07:07 +00:00
Does not check if < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > allows < a href = 'SkColor_Reference#Alpha' > Alpha< / a > , or if any pixel value has
2017-10-04 18:31:33 +00:00
transparency.
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > is < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "5e76b68bb46d54315eb0c12d83bd6949" > < div > < a href = '#SkBitmap_isOpaque' > isOpaque< / a > ignores whether all pixels are opaque or not.
2018-03-05 18:26:16 +00:00
< / div >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
isOpaque: false
isOpaque: false
isOpaque: true
isOpaque: true
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_ComputeIsOpaque' > ComputeIsOpaque< / a > < a href = 'SkImageInfo_Reference#SkImageInfo_isOpaque' > SkImageInfo::isOpaque< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_isVolatile' > < / a >
2017-10-04 18:31:33 +00:00
## isVolatile
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_isVolatile' > isVolatile< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-07-11 20:18:41 +00:00
Provides a hint to caller that pixels should not be cached. Only true if
< a href = '#SkBitmap_setIsVolatile' > setIsVolatile< / a > has been called to mark as volatile.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Volatile state is not shared by other bitmaps sharing the same < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > .
2017-10-04 18:31:33 +00:00
### Return Value
true if marked volatile
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "23c4543ac6cdd0e8fe762816a0dc2e03" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
original is volatile
copy is not volatile
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_setIsVolatile' > setIsVolatile< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_setIsVolatile' > < / a >
2017-10-04 18:31:33 +00:00
## setIsVolatile
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_setIsVolatile' > setIsVolatile< / a > (bool < a href = '#SkBitmap_isVolatile' > isVolatile< / a > )
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets if pixels should be read from < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > on every access. < a href = '#Bitmap' > Bitmaps< / a > are not
2018-01-04 21:11:51 +00:00
volatile by default; a GPU back end may upload pixel values expecting them to be
2018-05-16 11:07:07 +00:00
accessed repeatedly. Marking temporary < a href = '#Bitmap' > Bitmaps< / a > as volatile provides a hint to
< a href = 'undocumented#Device' > Device< / a > that the < a href = '#Bitmap' > Bitmap< / a > pixels should not be cached. This can
2017-10-04 18:31:33 +00:00
improve performance by avoiding overhead and reducing resource
2018-05-16 11:07:07 +00:00
consumption on < a href = 'undocumented#Device' > Device< / a > .
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_setIsVolatile_isVolatile' > < code > < strong > isVolatile< / strong > < / code > < / a > < / td >
< td > true if backing pixels are temporary< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "e8627a4df659b896402f89a91326618f" > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_isVolatile' > isVolatile< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_reset' > < / a >
2017-10-04 18:31:33 +00:00
## reset
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_reset' > reset< / a > ()
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Resets to its initial state; all fields are set to zero, as if < a href = '#Bitmap' > Bitmap< / a > had
been initialized by < a href = '#SkBitmap_empty_constructor' > SkBitmap()< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Sets width, height, row bytes to zero; pixel address to nullptr; < a href = 'SkImageInfo_Reference#SkColorType' > SkColorType< / a > to
< a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > ; and < a href = 'SkImageInfo_Reference#SkAlphaType' > SkAlphaType< / a > to < a href = 'SkImageInfo_Reference#kUnknown_SkAlphaType' > kUnknown_SkAlphaType< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
If < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is allocated, its reference count is decreased by one, releasing
its memory if < a href = '#Bitmap' > Bitmap< / a > is the sole owner.
2017-10-04 18:31:33 +00:00
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "52ccaeda67924373c5b55a2b89fe314d" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
width:1 height:1 isNull:false
width:0 height:0 isNull:true
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_empty_constructor' > SkBitmap()< / a > < a href = 'SkImageInfo_Reference#SkAlphaType' > SkAlphaType< / a > < a href = 'SkImageInfo_Reference#SkColorType' > SkColorType< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_ComputeIsOpaque' > < / a >
2017-10-04 18:31:33 +00:00
## ComputeIsOpaque
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
static bool < a href = '#SkBitmap_ComputeIsOpaque' > ComputeIsOpaque< / a > (const < a href = '#SkBitmap' > SkBitmap< / a > & bm)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns true if all pixels are opaque. < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > determines how pixels
are encoded, and whether pixel describes < a href = 'SkColor_Reference#Alpha' > Alpha< / a > . Returns true for < a href = 'SkImageInfo_Reference#Color_Type' > Color Types< / a >
without alpha in each pixel; for other < a href = 'SkImageInfo_Reference#Color_Type' > Color Types< / a > , returns true if all
2017-10-04 18:31:33 +00:00
pixels have alpha values equivalent to 1.0 or greater.
2018-05-16 11:07:07 +00:00
For < a href = 'SkImageInfo_Reference#Color_Type' > Color Types< / a > < a href = 'SkImageInfo_Reference#kRGB_565_SkColorType' > kRGB_565_SkColorType< / a > or < a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > : always
returns true. For < a href = 'SkImageInfo_Reference#Color_Type' > Color Types< / a > < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kBGRA_8888_SkColorType' > kBGRA_8888_SkColorType< / a > ,
< a href = 'SkImageInfo_Reference#kRGBA_8888_SkColorType' > kRGBA_8888_SkColorType< / a > : returns true if all pixel < a href = 'SkColor_Reference#Alpha' > Alpha< / a > values are 255.
For < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > < a href = 'SkImageInfo_Reference#kARGB_4444_SkColorType' > kARGB_4444_SkColorType< / a > : returns true if all pixel < a href = 'SkColor_Reference#Alpha' > Alpha< / a > values are 15.
For < a href = 'SkImageInfo_Reference#kRGBA_F16_SkColorType' > kRGBA_F16_SkColorType< / a > : returns true if all pixel < a href = 'SkColor_Reference#Alpha' > Alpha< / a > values are 1.0 or
2017-10-04 18:31:33 +00:00
greater.
2018-05-16 11:07:07 +00:00
Returns false for < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > .
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_ComputeIsOpaque_bm' > < code > < strong > bm< / strong > < / code > < / a > < / td >
< td > < a href = '#Bitmap' > Bitmap< / a > to check< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if all pixels have opaque values or < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > is opaque
2017-10-04 18:31:33 +00:00
### Example
2018-07-05 05:35:27 +00:00
< div > < fiddle-embed name = "9df1baa17658fbd0c419780f26fd854f" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
computeIsOpaque: false
computeIsOpaque: true
computeIsOpaque: false
computeIsOpaque: true
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_isOpaque' > isOpaque< / a > < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > < a href = 'SkColor_Reference#Alpha' > Alpha< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_getBounds' > < / a >
2017-10-04 18:31:33 +00:00
## getBounds
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_getBounds' > getBounds< / a > (< a href = 'SkRect_Reference#SkRect' > SkRect< / a > * bounds) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns < a href = 'SkRect_Reference#Rect' > Rect< / a > { 0, 0, < a href = '#SkBitmap_width' > width< / a > , < a href = '#SkBitmap_height' > height< / a > }.
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_getBounds_bounds' > < code > < strong > bounds< / strong > < / code > < / a > < / td >
< td > container for floating point rectangle< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "2431ebc7e7d1e91e6d9daafd0f7a478f" > < / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_bounds' > bounds< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_getBounds_2' > < / a >
2018-01-26 17:56:22 +00:00
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_getBounds' > getBounds< / a > (< a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > * bounds) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns < a href = 'SkIRect_Reference#IRect' > IRect< / a > { 0, 0, < a href = '#SkBitmap_width' > width< / a > , < a href = '#SkBitmap_height' > height< / a > }.
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_getBounds_2_bounds' > < code > < strong > bounds< / strong > < / code > < / a > < / td >
< td > container for integral rectangle< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "0c45da35172bc0a529b2faecddae62a2" > < / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_bounds' > bounds< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_bounds' > < / a >
2017-10-04 18:31:33 +00:00
## bounds
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > < a href = '#SkBitmap_bounds' > bounds< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns < a href = 'SkIRect_Reference#IRect' > IRect< / a > { 0, 0, < a href = '#SkBitmap_width' > width< / a > , < a href = '#SkBitmap_height' > height< / a > }.
2017-10-04 18:31:33 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
integral rectangle from origin to < a href = '#SkBitmap_width' > width< / a > and < a href = '#SkBitmap_height' > height< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-07-01 05:25:37 +00:00
< div > < fiddle-embed name = "3e9126152ff1cc592aef6facbcb5fc96" > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_getBounds' > getBounds< / a > < sup > < a href = '#SkBitmap_getBounds_2' > [2]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_dimensions' > < / a >
2017-10-04 18:31:33 +00:00
## dimensions
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = 'undocumented#SkISize' > SkISize< / a > < a href = '#SkBitmap_dimensions' > dimensions< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns < a href = 'undocumented#ISize' > ISize< / a > { < a href = '#SkBitmap_width' > width< / a > , < a href = '#SkBitmap_height' > height< / a > }.
2017-10-04 18:31:33 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
integral size of < a href = '#SkBitmap_width' > width< / a > and < a href = '#SkBitmap_height' > height< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-07-05 05:35:27 +00:00
< div > < fiddle-embed name = "647056bcc12c27fb4413f212f33a2898" > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_height' > height< / a > < a href = '#SkBitmap_width' > width< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_getSubset' > < / a >
2017-10-04 18:31:33 +00:00
## getSubset
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > < a href = '#SkBitmap_getSubset' > getSubset< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns the bounds of this bitmap, offset by its < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > origin.
2017-10-04 18:31:33 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
bounds within < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > bounds
2017-10-04 18:31:33 +00:00
### Example
< div > < fiddle-embed name = "d6dd0b425aa550f21b938a18c2e1a981" >
#### Example Output
~~~~
source: 0, 0, 512, 512
subset: 100, 100, 412, 412
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_extractSubset' > extractSubset< / a > < a href = '#SkBitmap_getBounds' > getBounds< / a > < sup > < a href = '#SkBitmap_getBounds_2' > [2]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_setInfo' > < / a >
2017-10-04 18:31:33 +00:00
## setInfo
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_setInfo' > setInfo< / a > (const < a href = 'SkImageInfo_Reference#SkImageInfo' > SkImageInfo< / a > & imageInfo, size_t < a href = '#SkBitmap_rowBytes' > rowBytes< / a > = 0)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets width, height, < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , < a href = 'undocumented#Color_Space' > Color Space< / a > , and optional
< a href = '#SkBitmap_rowBytes' > rowBytes< / a > . Frees pixels, and returns true if successful.
< a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = '#SkBitmap_alphaType' > alphaType< / a > may be altered to a value permitted by < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = '#SkBitmap_colorSpace' > colorSpace< / a > .
If < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > , < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = '#SkBitmap_alphaType' > alphaType< / a > is
set to < a href = 'SkImageInfo_Reference#kUnknown_SkAlphaType' > kUnknown_SkAlphaType< / a > .
If < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > and < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = '#SkBitmap_alphaType' > alphaType< / a > is
< a href = 'SkImageInfo_Reference#kUnpremul_SkAlphaType' > kUnpremul_SkAlphaType< / a > , < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = '#SkBitmap_alphaType' > alphaType< / a > is replaced by < a href = 'SkImageInfo_Reference#kPremul_SkAlphaType' > kPremul_SkAlphaType< / a > .
If < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kRGB_565_SkColorType' > kRGB_565_SkColorType< / a > or < a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > ,
< a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = '#SkBitmap_alphaType' > alphaType< / a > is set to < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a > .
If < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kARGB_4444_SkColorType' > kARGB_4444_SkColorType< / a > , < a href = 'SkImageInfo_Reference#kRGBA_8888_SkColorType' > kRGBA_8888_SkColorType< / a > ,
< a href = 'SkImageInfo_Reference#kBGRA_8888_SkColorType' > kBGRA_8888_SkColorType< / a > , or < a href = 'SkImageInfo_Reference#kRGBA_F16_SkColorType' > kRGBA_F16_SkColorType< / a > : < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = '#SkBitmap_alphaType' > alphaType< / a > remains
2017-10-04 18:31:33 +00:00
unchanged.
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_rowBytes' > rowBytes< / a > must equal or exceed < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = 'SkImageInfo_Reference#SkImageInfo' > minRowBytes< / a > . If < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = '#SkBitmap_colorSpace' > colorSpace< / a > is
< a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > , < a href = '#SkBitmap_rowBytes' > rowBytes< / a > is ignored and treated as zero; for all other
< a href = 'undocumented#Color_Space' > Color Space< / a > values, < a href = '#SkBitmap_rowBytes' > rowBytes< / a > of zero is treated as < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = 'SkImageInfo_Reference#SkImageInfo' > minRowBytes< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Calls < a href = '#SkBitmap_reset' > reset< / a > and returns false if:
2017-10-04 18:31:33 +00:00
< table > < tr >
2018-05-16 11:07:07 +00:00
< td > < a href = '#SkBitmap_rowBytes' > rowBytes< / a > exceeds 31 bits< / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = '#SkBitmap_width' > width< / a > is negative< / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = '#SkBitmap_height' > height< / a > is negative< / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_rowBytes' > rowBytes< / a > is positive and less than < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = '#SkBitmap_width' > width< / a > times < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = '#SkBitmap_bytesPerPixel' > bytesPerPixel< / a > < / td >
< / tr >
2017-10-04 18:31:33 +00:00
< / table >
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_setInfo_imageInfo' > < code > < strong > imageInfo< / strong > < / code > < / a > < / td >
< td > contains width, height, < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , < a href = 'undocumented#Color_Space' > Color Space< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_setInfo_rowBytes' > < code > < strong > rowBytes< / strong > < / code > < / a > < / td >
< td > < a href = '#SkBitmap_setInfo_imageInfo' > imageInfo< / a > .< a href = 'SkImageInfo_Reference#SkImageInfo' > minRowBytes< / a > or larger; or zero< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > set successfully
2017-10-04 18:31:33 +00:00
### Example
2018-07-16 05:29:00 +00:00
< div > < fiddle-embed name = "599ab64d0aea005498176249bbfb64eb" > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > < a href = '#SkBitmap_height' > height< / a > < a href = '#SkBitmap_rowBytes' > rowBytes< / a > < a href = '#SkBitmap_width' > width< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
## <a name='SkBitmap_AllocFlags'>Enum SkBitmap::AllocFlags</a>
2017-10-04 18:31:33 +00:00
2017-11-27 15:44:06 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
2018-05-16 11:07:07 +00:00
enum < a href = '#SkBitmap_AllocFlags' > AllocFlags< / a > {
< a href = '#SkBitmap_kZeroPixels_AllocFlag' > kZeroPixels AllocFlag< / a > = 1 < < 0 ,
2018-04-03 12:43:27 +00:00
};
2018-03-05 18:26:16 +00:00
< / pre >
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_AllocFlags' > AllocFlags< / a > provides the option to zero pixel memory when allocated.
2017-10-04 18:31:33 +00:00
### Constants
2018-05-16 11:07:07 +00:00
< table style = 'border-collapse: collapse; width: 62.5em' >
< tr >< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Const</ th >
< th style = 'text-align: center; border: 2px solid #dddddd ; padding: 8px; ' > Value</ th >
< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Description</ th ></ tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a name = 'SkBitmap_kZeroPixels_AllocFlag' >< code > SkBitmap::kZeroPixels_AllocFlag</ code ></ a ></ td >
< td style = 'text-align: center; border: 2px solid #dddddd ; padding: 8px; ' > 1</ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >
Instructs < a href = '#SkBitmap_tryAllocPixelsFlags' > tryAllocPixelsFlags< / a > and < a href = '#SkBitmap_allocPixelsFlags' > allocPixelsFlags< / a > to zero pixel memory.
2018-03-05 18:26:16 +00:00
< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_tryAllocPixelsFlags' > tryAllocPixelsFlags< / a > < a href = '#SkBitmap_allocPixelsFlags' > allocPixelsFlags< / a > < a href = '#SkBitmap_erase' > erase< / a > < a href = '#SkBitmap_eraseColor' > eraseColor< / a >
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
## <a name='Allocate'>Allocate</a>
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
< table style = 'border-collapse: collapse; width: 62.5em' >
< tr >< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Topic</ th >
< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Description</ th ></ tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_allocN32Pixels' > allocN32Pixels</ a ></ td >
2018-05-17 16:17:28 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > allocates compatible ARGB pixels, or aborts</ td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_allocPixels' > allocPixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > allocates pixels from < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > , or aborts</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_allocPixels' > allocPixels(const SkImageInfo& info, size t rowBytes)</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_allocPixels_2' > allocPixels(const SkImageInfo& info)</ a ></ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_allocPixels_3' > allocPixels</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_allocPixels_4' > allocPixels(Allocator* allocator)</ a ></ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_allocPixelsFlags' > allocPixelsFlags</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > allocates pixels from < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > with options, or aborts</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_installPixels' > installPixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > creates < a href = 'undocumented#Pixel_Ref' > Pixel Ref</ a > , with optional release function</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_installPixels' > installPixels(const SkImageInfo& info, void* pixels, size t rowBytes, void (*releaseProc)</ a > (void* addr, void* context) , void* context)</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_installPixels_2' > installPixels(const SkImageInfo& info, void* pixels, size t rowBytes)</ a ></ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_installPixels_3' > installPixels(const SkPixmap& pixmap)</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_tryAllocN32Pixels' > tryAllocN32Pixels</ a ></ td >
2018-05-17 16:17:28 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > allocates compatible ARGB pixels if possible</ td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_tryAllocPixels' > tryAllocPixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > allocates pixels from < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > if possible</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_tryAllocPixels' > tryAllocPixels(const SkImageInfo& info, size t rowBytes)</ a ></ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_tryAllocPixels_2' > tryAllocPixels(const SkImageInfo& info)</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_tryAllocPixels_3' > tryAllocPixels</ a ></ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_tryAllocPixels_4' > tryAllocPixels(Allocator* allocator)</ a ></ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_tryAllocPixelsFlags' > tryAllocPixelsFlags</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > allocates pixels from < a href = 'SkImageInfo_Reference#Image_Info' > Image Info</ a > with options if possible</ td >
< / tr >
< / table >
2018-02-07 12:27:09 +00:00
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_tryAllocPixelsFlags' > < / a >
2017-10-04 18:31:33 +00:00
## tryAllocPixelsFlags
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool SK_WARN_UNUSED_RESULT < a href = '#SkBitmap_tryAllocPixelsFlags' > tryAllocPixelsFlags< / a > (const < a href = 'SkImageInfo_Reference#SkImageInfo' > SkImageInfo< / a > & info, uint32_t flags)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > to info following the rules in < a href = '#SkBitmap_setInfo' > setInfo< / a > and allocates pixel
memory. If < a href = '#SkBitmap_tryAllocPixelsFlags_flags' > flags< / a > is < a href = '#SkBitmap_kZeroPixels_AllocFlag' > kZeroPixels AllocFlag< / a > , memory is zeroed.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Returns false and calls < a href = '#SkBitmap_reset' > reset< / a > if < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > could not be set, or memory could
2017-11-27 15:44:06 +00:00
not be allocated, or memory could not optionally be zeroed.
2017-10-04 18:31:33 +00:00
On most platforms, allocating pixel memory may succeed even though there is
not sufficient memory to hold pixels; allocation does not take place
until the pixels are written to. The actual behavior depends on the platform
2018-05-16 11:07:07 +00:00
implementation of malloc(), if < a href = '#SkBitmap_tryAllocPixelsFlags_flags' > flags< / a > is zero, and calloc(), if < a href = '#SkBitmap_tryAllocPixelsFlags_flags' > flags< / a > is
< a href = '#SkBitmap_kZeroPixels_AllocFlag' > kZeroPixels AllocFlag< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_tryAllocPixelsFlags_flags' > flags< / a > set to < a href = '#SkBitmap_kZeroPixels_AllocFlag' > kZeroPixels AllocFlag< / a > offers equal or better performance than
subsequently calling < a href = '#SkBitmap_eraseColor' > eraseColor< / a > with < a href = 'SkColor_Reference#SK_ColorTRANSPARENT' > SK ColorTRANSPARENT< / a > .
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_tryAllocPixelsFlags_info' > < code > < strong > info< / strong > < / code > < / a > < / td >
< td > contains width, height, < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , < a href = 'undocumented#Color_Space' > Color Space< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_tryAllocPixelsFlags_flags' > < code > < strong > flags< / strong > < / code > < / a > < / td >
< td > < a href = '#SkBitmap_kZeroPixels_AllocFlag' > kZeroPixels AllocFlag< / a > , or zero< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
true if pixels allocation is successful
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "f1d1880d38e0aea4cefd3e11745e8a09" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
2017-11-27 15:44:06 +00:00
bitmap allocation succeeded!
2017-10-04 18:31:33 +00:00
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_allocPixelsFlags' > allocPixelsFlags< / a > < a href = '#SkBitmap_tryAllocPixels' > tryAllocPixels< / a > < sup > < a href = '#SkBitmap_tryAllocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_tryAllocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_tryAllocPixels_4' > [4]< / a > < / sup > < a href = 'undocumented#SkMallocPixelRef_MakeZeroed' > SkMallocPixelRef::MakeZeroed< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_allocPixelsFlags' > < / a >
2017-10-04 18:31:33 +00:00
## allocPixelsFlags
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_allocPixelsFlags' > allocPixelsFlags< / a > (const < a href = 'SkImageInfo_Reference#SkImageInfo' > SkImageInfo< / a > & info, uint32_t flags)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > to info following the rules in < a href = '#SkBitmap_setInfo' > setInfo< / a > and allocates pixel
memory. If < a href = '#SkBitmap_allocPixelsFlags_flags' > flags< / a > is < a href = '#SkBitmap_kZeroPixels_AllocFlag' > kZeroPixels AllocFlag< / a > , memory is zeroed.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Aborts execution if < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > could not be set, or memory could
2017-11-27 15:44:06 +00:00
not be allocated, or memory could not optionally
2017-10-04 18:31:33 +00:00
be zeroed. Abort steps may be provided by the user at compile time by defining
2018-01-04 21:11:51 +00:00
SK_ABORT.
2017-10-04 18:31:33 +00:00
On most platforms, allocating pixel memory may succeed even though there is
not sufficient memory to hold pixels; allocation does not take place
until the pixels are written to. The actual behavior depends on the platform
2018-05-16 11:07:07 +00:00
implementation of malloc(), if < a href = '#SkBitmap_allocPixelsFlags_flags' > flags< / a > is zero, and calloc(), if < a href = '#SkBitmap_allocPixelsFlags_flags' > flags< / a > is
< a href = '#SkBitmap_kZeroPixels_AllocFlag' > kZeroPixels AllocFlag< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_allocPixelsFlags_flags' > flags< / a > set to < a href = '#SkBitmap_kZeroPixels_AllocFlag' > kZeroPixels AllocFlag< / a > offers equal or better performance than
subsequently calling < a href = '#SkBitmap_eraseColor' > eraseColor< / a > with < a href = 'SkColor_Reference#SK_ColorTRANSPARENT' > SK ColorTRANSPARENT< / a > .
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_allocPixelsFlags_info' > < code > < strong > info< / strong > < / code > < / a > < / td >
< td > contains width, height, < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , < a href = 'undocumented#Color_Space' > Color Space< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_allocPixelsFlags_flags' > < code > < strong > flags< / strong > < / code > < / a > < / td >
< td > < a href = '#SkBitmap_kZeroPixels_AllocFlag' > kZeroPixels AllocFlag< / a > , or zero< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "737e721c7d9e0f367d25521a1b823b9d" > < div > < a href = 'undocumented#Text' > Text< / a > is drawn on a transparent background; drawing the bitmap a second time
2018-03-05 18:26:16 +00:00
lets the first draw show through.
< / div > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_tryAllocPixelsFlags' > tryAllocPixelsFlags< / a > < a href = '#SkBitmap_allocPixels' > allocPixels< / a > < sup > < a href = '#SkBitmap_allocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_4' > [4]< / a > < / sup > < a href = 'undocumented#SkMallocPixelRef_MakeZeroed' > SkMallocPixelRef::MakeZeroed< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_tryAllocPixels' > < / a >
2017-10-04 18:31:33 +00:00
## tryAllocPixels
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool SK_WARN_UNUSED_RESULT < a href = '#SkBitmap_tryAllocPixels' > tryAllocPixels< / a > (const < a href = 'SkImageInfo_Reference#SkImageInfo' > SkImageInfo< / a > & info, size_t < a href = '#SkBitmap_rowBytes' > rowBytes< / a > )
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > to info following the rules in < a href = '#SkBitmap_setInfo' > setInfo< / a > and allocates pixel
memory. < a href = '#SkBitmap_rowBytes' > rowBytes< / a > must equal or exceed info.< a href = '#SkBitmap_width' > width< / a > times info.< a href = '#SkBitmap_bytesPerPixel' > bytesPerPixel< / a > ,
or equal zero. Pass in zero for < a href = '#SkBitmap_rowBytes' > rowBytes< / a > to compute the minimum valid value.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Returns false and calls < a href = '#SkBitmap_reset' > reset< / a > if < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > could not be set, or memory could
2017-10-04 18:31:33 +00:00
not be allocated.
On most platforms, allocating pixel memory may succeed even though there is
not sufficient memory to hold pixels; allocation does not take place
until the pixels are written to. The actual behavior depends on the platform
implementation of malloc().
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_tryAllocPixels_info' > < code > < strong > info< / strong > < / code > < / a > < / td >
< td > contains width, height, < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , < a href = 'undocumented#Color_Space' > Color Space< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_tryAllocPixels_rowBytes' > < code > < strong > rowBytes< / strong > < / code > < / a > < / td >
< td > size of pixel row or larger; may be zero< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
true if pixel storage is allocated
### Example
< div > < fiddle-embed name = "34479d5aa23ce9f5e334b0786c9edb22" > < / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_tryAllocPixelsFlags' > tryAllocPixelsFlags< / a > < a href = '#SkBitmap_allocPixels' > allocPixels< / a > < sup > < a href = '#SkBitmap_allocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_4' > [4]< / a > < / sup > < a href = 'undocumented#SkMallocPixelRef_MakeAllocate' > SkMallocPixelRef::MakeAllocate< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_allocPixels' > < / a >
2017-10-04 18:31:33 +00:00
## allocPixels
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_allocPixels' > allocPixels< / a > (const < a href = 'SkImageInfo_Reference#SkImageInfo' > SkImageInfo< / a > & info, size_t < a href = '#SkBitmap_rowBytes' > rowBytes< / a > )
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > to info following the rules in < a href = '#SkBitmap_setInfo' > setInfo< / a > and allocates pixel
memory. < a href = '#SkBitmap_rowBytes' > rowBytes< / a > must equal or exceed info.< a href = '#SkBitmap_width' > width< / a > times info.< a href = '#SkBitmap_bytesPerPixel' > bytesPerPixel< / a > ,
or equal zero. Pass in zero for < a href = '#SkBitmap_rowBytes' > rowBytes< / a > to compute the minimum valid value.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Aborts execution if < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > could not be set, or memory could
2017-11-27 15:44:06 +00:00
not be allocated. Abort steps may be provided by
2018-01-04 21:11:51 +00:00
the user at compile time by defining SK_ABORT.
2017-10-04 18:31:33 +00:00
On most platforms, allocating pixel memory may succeed even though there is
not sufficient memory to hold pixels; allocation does not take place
until the pixels are written to. The actual behavior depends on the platform
implementation of malloc().
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_allocPixels_info' > < code > < strong > info< / strong > < / code > < / a > < / td >
< td > contains width, height, < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , < a href = 'undocumented#Color_Space' > Color Space< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_allocPixels_rowBytes' > < code > < strong > rowBytes< / strong > < / code > < / a > < / td >
< td > size of pixel row or larger; may be zero< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "555c0f62f96602a9dcd459badcd005e0" > < / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_tryAllocPixels' > tryAllocPixels< / a > < sup > < a href = '#SkBitmap_tryAllocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_tryAllocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_tryAllocPixels_4' > [4]< / a > < / sup > < a href = '#SkBitmap_allocPixelsFlags' > allocPixelsFlags< / a > < a href = 'undocumented#SkMallocPixelRef_MakeAllocate' > SkMallocPixelRef::MakeAllocate< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_tryAllocPixels_2' > < / a >
2018-01-26 17:56:22 +00:00
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool SK_WARN_UNUSED_RESULT < a href = '#SkBitmap_tryAllocPixels' > tryAllocPixels< / a > (const < a href = 'SkImageInfo_Reference#SkImageInfo' > SkImageInfo< / a > & info)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > to info following the rules in < a href = '#SkBitmap_setInfo' > setInfo< / a > and allocates pixel
2018-01-04 21:11:51 +00:00
memory.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Returns false and calls < a href = '#SkBitmap_reset' > reset< / a > if < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > could not be set, or memory could
2017-10-04 18:31:33 +00:00
not be allocated.
On most platforms, allocating pixel memory may succeed even though there is
not sufficient memory to hold pixels; allocation does not take place
until the pixels are written to. The actual behavior depends on the platform
implementation of malloc().
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_tryAllocPixels_2_info' > < code > < strong > info< / strong > < / code > < / a > < / td >
< td > contains width, height, < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , < a href = 'undocumented#Color_Space' > Color Space< / a > < / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
true if pixel storage is allocated
### Example
< div > < fiddle-embed name = "7ef3d043c4c5885649e591dd7dca92ff" > < / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_tryAllocPixelsFlags' > tryAllocPixelsFlags< / a > < a href = '#SkBitmap_allocPixels' > allocPixels< / a > < sup > < a href = '#SkBitmap_allocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_4' > [4]< / a > < / sup > < a href = 'undocumented#SkMallocPixelRef_MakeAllocate' > SkMallocPixelRef::MakeAllocate< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_allocPixels_2' > < / a >
2018-01-26 17:56:22 +00:00
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_allocPixels' > allocPixels< / a > (const < a href = 'SkImageInfo_Reference#SkImageInfo' > SkImageInfo< / a > & info)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > to info following the rules in < a href = '#SkBitmap_setInfo' > setInfo< / a > and allocates pixel
2018-01-04 21:11:51 +00:00
memory.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Aborts execution if < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > could not be set, or memory could
2017-11-27 15:44:06 +00:00
not be allocated. Abort steps may be provided by
2018-01-04 21:11:51 +00:00
the user at compile time by defining SK_ABORT.
2017-10-04 18:31:33 +00:00
On most platforms, allocating pixel memory may succeed even though there is
not sufficient memory to hold pixels; allocation does not take place
until the pixels are written to. The actual behavior depends on the platform
implementation of malloc().
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_allocPixels_2_info' > < code > < strong > info< / strong > < / code > < / a > < / td >
< td > contains width, height, < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , < a href = 'undocumented#Color_Space' > Color Space< / a > < / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "91f474a11a2112cd5c88c40a9015048d" > < / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_tryAllocPixels' > tryAllocPixels< / a > < sup > < a href = '#SkBitmap_tryAllocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_tryAllocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_tryAllocPixels_4' > [4]< / a > < / sup > < a href = '#SkBitmap_allocPixelsFlags' > allocPixelsFlags< / a > < a href = 'undocumented#SkMallocPixelRef_MakeAllocate' > SkMallocPixelRef::MakeAllocate< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_tryAllocN32Pixels' > < / a >
2017-10-04 18:31:33 +00:00
## tryAllocN32Pixels
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool SK_WARN_UNUSED_RESULT < a href = '#SkBitmap_tryAllocN32Pixels' > tryAllocN32Pixels< / a > (int width, int height, bool < a href = '#SkBitmap_isOpaque' > isOpaque< / a > = false)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > to width, height, and < a href = 'SkImageInfo_Reference#kN32_SkColorType' > Native_Color_Type< / a > ; and allocates
pixel memory. If < a href = '#SkBitmap_isOpaque' > isOpaque< / a > is true, sets < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > to < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a > ;
otherwise, sets to < a href = 'SkImageInfo_Reference#kPremul_SkAlphaType' > kPremul_SkAlphaType< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Calls < a href = '#SkBitmap_reset' > reset< / a > and returns false if width exceeds 29 bits or is negative,
2018-01-26 17:56:22 +00:00
or height is negative.
2017-10-04 18:31:33 +00:00
Returns false if allocation fails.
2018-05-16 11:07:07 +00:00
Use to create < a href = '#Bitmap' > Bitmap< / a > that matches < a href = 'SkColor_Reference#SkPMColor' > SkPMColor< / a > , the native pixel arrangement on
the platform. < a href = '#Bitmap' > Bitmap< / a > drawn to output device skips converting its pixel format.
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_tryAllocN32Pixels_width' > < code > < strong > width< / strong > < / code > < / a > < / td >
< td > pixel column count; must be zero or greater< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_tryAllocN32Pixels_height' > < code > < strong > height< / strong > < / code > < / a > < / td >
< td > pixel row count; must be zero or greater< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_tryAllocN32Pixels_isOpaque' > < code > < strong > isOpaque< / strong > < / code > < / a > < / td >
< td > true if pixels do not have transparency< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
true if pixel storage is allocated
### Example
2018-07-18 20:21:51 +00:00
< div > < fiddle-embed name = "a2b1e0910f37066f15ae56368775a6d8" > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_tryAllocPixels' > tryAllocPixels< / a > < sup > < a href = '#SkBitmap_tryAllocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_tryAllocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_tryAllocPixels_4' > [4]< / a > < / sup > < a href = '#SkBitmap_allocN32Pixels' > allocN32Pixels< / a > < a href = 'undocumented#SkMallocPixelRef_MakeAllocate' > SkMallocPixelRef::MakeAllocate< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_allocN32Pixels' > < / a >
2017-10-04 18:31:33 +00:00
## allocN32Pixels
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_allocN32Pixels' > allocN32Pixels< / a > (int width, int height, bool < a href = '#SkBitmap_isOpaque' > isOpaque< / a > = false)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > to width, height, and the < a href = 'SkImageInfo_Reference#kN32_SkColorType' > Native_Color_Type< / a > ; and allocates
pixel memory. If < a href = '#SkBitmap_isOpaque' > isOpaque< / a > is true, sets < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > to < a href = 'SkImageInfo_Reference#kPremul_SkAlphaType' > kPremul_SkAlphaType< / a > ;
otherwise, sets to < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a > .
2017-10-04 18:31:33 +00:00
2018-01-26 17:56:22 +00:00
Aborts if width exceeds 29 bits or is negative, or height is negative, or
2017-10-04 18:31:33 +00:00
allocation fails. Abort steps may be provided by the user at compile time by
2018-01-04 21:11:51 +00:00
defining SK_ABORT.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Use to create < a href = '#Bitmap' > Bitmap< / a > that matches < a href = 'SkColor_Reference#SkPMColor' > SkPMColor< / a > , the native pixel arrangement on
the platform. < a href = '#Bitmap' > Bitmap< / a > drawn to output device skips converting its pixel format.
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_allocN32Pixels_width' > < code > < strong > width< / strong > < / code > < / a > < / td >
< td > pixel column count; must be zero or greater< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_allocN32Pixels_height' > < code > < strong > height< / strong > < / code > < / a > < / td >
< td > pixel row count; must be zero or greater< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_allocN32Pixels_isOpaque' > < code > < strong > isOpaque< / strong > < / code > < / a > < / td >
< td > true if pixels do not have transparency< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "c717491f9251604724c9cbde7088ec20" > < / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_allocPixels' > allocPixels< / a > < sup > < a href = '#SkBitmap_allocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_4' > [4]< / a > < / sup > < a href = '#SkBitmap_tryAllocN32Pixels' > tryAllocN32Pixels< / a > < a href = 'undocumented#SkMallocPixelRef_MakeAllocate' > SkMallocPixelRef::MakeAllocate< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_installPixels' > < / a >
2017-10-04 18:31:33 +00:00
## installPixels
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_installPixels' > installPixels< / a > (const < a href = 'SkImageInfo_Reference#SkImageInfo' > SkImageInfo< / a > & info, void* pixels, size_t < a href = '#SkBitmap_rowBytes' > rowBytes< / a > , void (*releaseProc)
2017-11-27 15:44:06 +00:00
(void* addr, void* context) , void* context)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > to info following the rules in < a href = '#SkBitmap_setInfo' > setInfo< / a > , and creates < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a >
containing < a href = '#SkBitmap_installPixels_pixels' > pixels< / a > and < a href = '#SkBitmap_rowBytes' > rowBytes< / a > . < a href = '#SkBitmap_installPixels_releaseProc' > releaseProc< / a > , if not nullptr, is called
immediately on failure or when < a href = '#SkBitmap_installPixels_pixels' > pixels< / a > are no longer referenced. < a href = '#SkBitmap_installPixels_context' > context< / a > may be
2017-10-04 18:31:33 +00:00
nullptr.
2018-05-16 11:07:07 +00:00
If < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > could not be set, or < a href = '#SkBitmap_rowBytes' > rowBytes< / a > is less than info.< a href = 'SkImageInfo_Reference#SkImageInfo' > minRowBytes< / a > :
calls < a href = '#SkBitmap_installPixels_releaseProc' > releaseProc< / a > if present, calls < a href = '#SkBitmap_reset' > reset< / a > , and returns false.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Otherwise, if < a href = '#SkBitmap_installPixels_pixels' > pixels< / a > equals nullptr: sets < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , calls < a href = '#SkBitmap_installPixels_releaseProc' > releaseProc< / a > if
2017-10-04 18:31:33 +00:00
present, returns true.
2018-05-16 11:07:07 +00:00
If < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > is set, < a href = '#SkBitmap_installPixels_pixels' > pixels< / a > is not nullptr, and < a href = '#SkBitmap_installPixels_releaseProc' > releaseProc< / a > is not nullptr:
when < a href = '#SkBitmap_installPixels_pixels' > pixels< / a > are no longer referenced, calls < a href = '#SkBitmap_installPixels_releaseProc' > releaseProc< / a > with < a href = '#SkBitmap_installPixels_pixels' > pixels< / a > and < a href = '#SkBitmap_installPixels_context' > context< / a >
2017-10-04 18:31:33 +00:00
as parameters.
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_installPixels_info' > < code > < strong > info< / strong > < / code > < / a > < / td >
< td > contains width, height, < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , < a href = 'undocumented#Color_Space' > Color Space< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_installPixels_pixels' > < code > < strong > pixels< / strong > < / code > < / a > < / td >
< td > address or pixel storage; may be nullptr< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_installPixels_rowBytes' > < code > < strong > rowBytes< / strong > < / code > < / a > < / td >
< td > size of pixel row or larger< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_installPixels_releaseProc' > < code > < strong > releaseProc< / strong > < / code > < / a > < / td >
< td > function called when < a href = '#SkBitmap_installPixels_pixels' > pixels< / a > can be deleted; may be nullptr< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_installPixels_context' > < code > < strong > context< / strong > < / code > < / a > < / td >
< td > caller state passed to < a href = '#SkBitmap_installPixels_releaseProc' > releaseProc< / a > ; may be nullptr< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > is set to info
2017-10-04 18:31:33 +00:00
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "8c4f7bf73fffa1a812ee8e88e44e639c" > < div > < a href = '#SkBitmap_installPixels_releaseProc' > releaseProc< / a > is called immediately because < a href = '#SkBitmap_rowBytes' > rowBytes< / a > is too small for < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > .
2018-03-05 18:26:16 +00:00
< / div >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
before installPixels
releaseProc called
install not successful
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_allocPixels' > allocPixels< / a > < sup > < a href = '#SkBitmap_allocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_4' > [4]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_installPixels_2' > < / a >
2018-01-26 17:56:22 +00:00
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_installPixels' > installPixels< / a > (const < a href = 'SkImageInfo_Reference#SkImageInfo' > SkImageInfo< / a > & info, void* pixels, size_t < a href = '#SkBitmap_rowBytes' > rowBytes< / a > )
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > to info following the rules in < a href = '#SkBitmap_setInfo' > setInfo< / a > , and creates < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a >
containing < a href = '#SkBitmap_installPixels_2_pixels' > pixels< / a > and < a href = '#SkBitmap_rowBytes' > rowBytes< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
If < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > could not be set, or < a href = '#SkBitmap_rowBytes' > rowBytes< / a > is less than info.< a href = 'SkImageInfo_Reference#SkImageInfo' > minRowBytes< / a > :
calls < a href = '#SkBitmap_reset' > reset< / a > , and returns false.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Otherwise, if < a href = '#SkBitmap_installPixels_2_pixels' > pixels< / a > equals nullptr: sets < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , returns true.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Caller must ensure that < a href = '#SkBitmap_installPixels_2_pixels' > pixels< / a > are valid for the lifetime of < a href = '#Bitmap' > Bitmap< / a > and < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > .
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_installPixels_2_info' > < code > < strong > info< / strong > < / code > < / a > < / td >
< td > contains width, height, < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , < a href = 'undocumented#Color_Space' > Color Space< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_installPixels_2_pixels' > < code > < strong > pixels< / strong > < / code > < / a > < / td >
< td > address or pixel storage; may be nullptr< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_installPixels_2_rowBytes' > < code > < strong > rowBytes< / strong > < / code > < / a > < / td >
< td > size of pixel row or larger< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > is set to info
2017-10-04 18:31:33 +00:00
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "a7e04447b2081010c50d7920e80a6bb2" > < div > GPU does not support < a href = 'SkImageInfo_Reference#kUnpremul_SkAlphaType' > kUnpremul_SkAlphaType< / a > , does not assert that it does not.
2018-03-05 18:26:16 +00:00
< / div > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_allocPixels' > allocPixels< / a > < sup > < a href = '#SkBitmap_allocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_4' > [4]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_installPixels_3' > < / a >
2018-01-26 17:56:22 +00:00
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_installPixels' > installPixels< / a > (const < a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > & pixmap)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > to pixmap.< a href = '#SkBitmap_info' > info< / a > following the rules in < a href = '#SkBitmap_setInfo' > setInfo< / a > , and creates
< a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > containing pixmap.addr() and pixmap.< a href = '#SkBitmap_rowBytes' > rowBytes< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
If < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > could not be set, or pixmap.< a href = '#SkBitmap_rowBytes' > rowBytes< / a > is less than
< a href = 'SkImageInfo_Reference#SkImageInfo_minRowBytes' > SkImageInfo::minRowBytes< / a > : calls < a href = '#SkBitmap_reset' > reset< / a > , and returns false.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Otherwise, if pixmap.addr() equals nullptr: sets < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , returns true.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Caller must ensure that pixmap is valid for the lifetime of < a href = '#Bitmap' > Bitmap< / a > and < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > .
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_installPixels_3_pixmap' > < code > < strong > pixmap< / strong > < / code > < / a > < / td >
< td > < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , pixel address, and < a href = '#SkBitmap_rowBytes' > rowBytes< / a > < / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > was set to pixmap.< a href = '#SkBitmap_info' > info< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-07-03 05:29:30 +00:00
< div > < fiddle-embed name = "6e2a8c9358b34aebd2ec586815fe9d3a" > < div > < a href = '#Draw' > Draw< / a > a five by five bitmap, and draw it again with a center white pixel.
2018-03-05 18:26:16 +00:00
< / div > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_allocPixels' > allocPixels< / a > < sup > < a href = '#SkBitmap_allocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_4' > [4]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_installMaskPixels' > < / a >
2017-10-04 18:31:33 +00:00
## installMaskPixels
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_installMaskPixels' > installMaskPixels< / a > (const < a href = 'undocumented#SkMask' > SkMask< / a > & mask)
2017-10-04 18:31:33 +00:00
< / pre >
2018-09-06 16:47:04 +00:00
To be deprecated soon.
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
## <a name='Pixels'>Pixels</a>
< table style = 'border-collapse: collapse; width: 62.5em' >
< tr >< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Topic</ th >
< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Description</ th ></ tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_notifyPixelsChanged' > notifyPixelsChanged</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > marks pixels as changed, altering the unique ID</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_peekPixels' > peekPixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns < a href = 'SkPixmap_Reference#Pixmap' > Pixmap</ a > if possible</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_readPixels' > readPixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > copies and converts pixels</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
2018-07-17 17:19:56 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_readPixels' > readPixels(const SkImageInfo& dstInfo, void* dstPixels, size t dstRowBytes, int srcX, int srcY)</ a > const</ td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
2018-07-17 17:19:56 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_readPixels_2' > readPixels(const SkPixmap& dst, int srcX, int srcY)</ a > const</ td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
2018-07-17 17:19:56 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_readPixels_3' > readPixels(const SkPixmap& dst)</ a > const</ td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_setPixels' > setPixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > sets < a href = 'undocumented#Pixel_Ref' > Pixel Ref</ a > without an offset</ td >
< / tr >
2018-07-17 17:19:56 +00:00
< tr >
2018-05-16 11:07:07 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_writePixels' > writePixels</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > copies and converts pixels</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
2018-07-17 17:19:56 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_writePixels' > writePixels(const SkPixmap& src, int dstX, int dstY)</ a ></ td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' ></ td >
2018-07-17 17:19:56 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_writePixels_2' > writePixels(const SkPixmap& src)</ a ></ td >
2018-05-16 11:07:07 +00:00
< / tr >
< / table >
2018-02-07 12:27:09 +00:00
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_setPixels' > < / a >
2017-10-04 18:31:33 +00:00
## setPixels
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_setPixels' > setPixels< / a > (void* pixels)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Replaces < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > with < a href = '#SkBitmap_setPixels_pixels' > pixels< / a > , preserving < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > and < a href = '#SkBitmap_rowBytes' > rowBytes< / a > .
Sets < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > origin to (0, 0).
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
If < a href = '#SkBitmap_setPixels_pixels' > pixels< / a > is nullptr, or if < a href = '#SkBitmap_info' > info< / a > .< a href = '#SkBitmap_colorType' > colorType< / a > equals < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > ;
release reference to < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > , and set < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > to nullptr.
2017-10-04 18:31:33 +00:00
Caller is responsible for handling ownership pixel memory for the lifetime
2018-05-16 11:07:07 +00:00
of < a href = '#Bitmap' > Bitmap< / a > and < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > .
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_setPixels_pixels' > < code > < strong > pixels< / strong > < / code > < / a > < / td >
< td > address of pixel storage, managed by caller< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "f0db16e06c9a1436917c8179f8c1718f" > < / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_installPixels' > installPixels< / a > < sup > < a href = '#SkBitmap_installPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_installPixels_3' > [3]< / a > < / sup > < a href = '#SkBitmap_allocPixels' > allocPixels< / a > < sup > < a href = '#SkBitmap_allocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_4' > [4]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_tryAllocPixels_3' > < / a >
2018-01-26 17:56:22 +00:00
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool SK_WARN_UNUSED_RESULT < a href = '#SkBitmap_tryAllocPixels' > tryAllocPixels< / a > ()
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Allocates pixel memory with < a href = '#SkBitmap_HeapAllocator' > HeapAllocator< / a > , and replaces existing < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > .
The allocation size is determined by < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > width, height, and < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Returns false if < a href = '#SkBitmap_info' > info< / a > .< a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > , or allocation fails.
2017-10-04 18:31:33 +00:00
### Return Value
true if the allocation succeeds
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "720e4c053fae9e929ab6518b47e49370" > < div > < a href = '#Bitmap' > Bitmap< / a > hosts and draws gray values in set1. < a href = '#SkBitmap_tryAllocPixels' > tryAllocPixels< / a > replaces < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a >
and erases it to black, but does not alter set1. < a href = '#SkBitmap_setPixels' > setPixels< / a > replaces black
< a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > with set1.
2018-03-05 18:26:16 +00:00
< / div > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_allocPixels' > allocPixels< / a > < sup > < a href = '#SkBitmap_allocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_4' > [4]< / a > < / sup > < a href = '#SkBitmap_installPixels' > installPixels< / a > < sup > < a href = '#SkBitmap_installPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_installPixels_3' > [3]< / a > < / sup > < a href = '#SkBitmap_setPixels' > setPixels< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_allocPixels_3' > < / a >
2018-01-26 17:56:22 +00:00
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_allocPixels' > allocPixels< / a > ()
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Allocates pixel memory with < a href = '#SkBitmap_HeapAllocator' > HeapAllocator< / a > , and replaces existing < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > .
The allocation size is determined by < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > width, height, and < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Aborts if < a href = '#SkBitmap_info' > info< / a > .< a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > , or allocation fails.
2017-11-27 15:44:06 +00:00
Abort steps may be provided by the user at compile
2018-01-04 21:11:51 +00:00
time by defining SK_ABORT.
2017-10-04 18:31:33 +00:00
### Example
2018-07-18 20:21:51 +00:00
< div > < fiddle-embed name = "1219b38c788bf270fb20f8cd2d78cff8" > < div > < a href = '#Bitmap' > Bitmap< / a > hosts and draws gray values in set1. < a href = '#SkBitmap_allocPixels' > allocPixels< / a > replaces < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a >
2018-05-16 11:07:07 +00:00
and erases it to black, but does not alter set1. < a href = '#SkBitmap_setPixels' > setPixels< / a > replaces black
< a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > with set2.
2018-03-05 18:26:16 +00:00
< / div > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_tryAllocPixels' > tryAllocPixels< / a > < sup > < a href = '#SkBitmap_tryAllocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_tryAllocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_tryAllocPixels_4' > [4]< / a > < / sup > < a href = '#SkBitmap_installPixels' > installPixels< / a > < sup > < a href = '#SkBitmap_installPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_installPixels_3' > [3]< / a > < / sup > < a href = '#SkBitmap_setPixels' > setPixels< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_tryAllocPixels_4' > < / a >
2018-01-26 17:56:22 +00:00
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool SK_WARN_UNUSED_RESULT < a href = '#SkBitmap_tryAllocPixels' > tryAllocPixels< / a > (< a href = '#SkBitmap_Allocator' > Allocator< / a > * allocator)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Allocates pixel memory with < a href = '#SkBitmap_tryAllocPixels_4_allocator' > allocator< / a > , and replaces existing < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > .
The allocation size is determined by < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > width, height, and < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > .
If < a href = '#SkBitmap_tryAllocPixels_4_allocator' > allocator< / a > is nullptr, use < a href = '#SkBitmap_HeapAllocator' > HeapAllocator< / a > instead.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Returns false if < a href = '#SkBitmap_Allocator_allocPixelRef' > Allocator::allocPixelRef< / a > return false.
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_tryAllocPixels_4_allocator' > < code > < strong > allocator< / strong > < / code > < / a > < / td >
< td > instance of < a href = '#SkBitmap_Allocator' > SkBitmap::Allocator< / a > instantiation< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if custom < a href = '#SkBitmap_tryAllocPixels_4_allocator' > allocator< / a > reports success
2017-10-04 18:31:33 +00:00
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "eb6f861ca1839146d26e40d56c2a001c" > < div > < a href = '#SkBitmap_HeapAllocator' > HeapAllocator< / a > limits the maximum size of < a href = '#Bitmap' > Bitmap< / a > to two gigabytes. Using
a custom < a href = '#SkBitmap_tryAllocPixels_4_allocator' > allocator< / a > , this limitation may be relaxed. This example can be
modified to allocate an eight gigabyte < a href = '#Bitmap' > Bitmap< / a > on a 64-bit platform with
2018-03-05 18:26:16 +00:00
sufficient memory.
< / div > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_allocPixels' > allocPixels< / a > < sup > < a href = '#SkBitmap_allocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_4' > [4]< / a > < / sup > < a href = '#SkBitmap_Allocator' > Allocator< / a > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_allocPixels_4' > < / a >
2018-01-26 17:56:22 +00:00
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_allocPixels' > allocPixels< / a > (< a href = '#SkBitmap_Allocator' > Allocator< / a > * allocator)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Allocates pixel memory with < a href = '#SkBitmap_allocPixels_4_allocator' > allocator< / a > , and replaces existing < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > .
The allocation size is determined by < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > width, height, and < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > .
If < a href = '#SkBitmap_allocPixels_4_allocator' > allocator< / a > is nullptr, use < a href = '#SkBitmap_HeapAllocator' > HeapAllocator< / a > instead.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Aborts if < a href = '#SkBitmap_Allocator_allocPixelRef' > Allocator::allocPixelRef< / a > return false. Abort steps may be provided by
2018-01-04 21:11:51 +00:00
the user at compile time by defining SK_ABORT.
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_allocPixels_4_allocator' > < code > < strong > allocator< / strong > < / code > < / a > < / td >
< td > instance of < a href = '#SkBitmap_Allocator' > SkBitmap::Allocator< / a > instantiation< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Example
< div > < fiddle-embed name = "1b2800d23c9ea249b45c2c21a34b6d14" > < / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_allocPixels' > allocPixels< / a > < sup > < a href = '#SkBitmap_allocPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_3' > [3]< / a > < / sup > < sup > < a href = '#SkBitmap_allocPixels_4' > [4]< / a > < / sup > < a href = '#SkBitmap_Allocator' > Allocator< / a > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_pixelRef' > < / a >
2017-10-04 18:31:33 +00:00
## pixelRef
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = 'undocumented#SkPixelRef' > SkPixelRef< / a > * < a href = '#SkBitmap_pixelRef' > pixelRef< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > , which contains: pixel base address; its dimensions; and
< a href = '#SkBitmap_rowBytes' > rowBytes< / a > , the interval from one row to the next. Does not change < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a >
reference count. < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > may be shared by multiple bitmaps.
If < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > has not been set, returns nullptr.
2017-10-04 18:31:33 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > , or nullptr
2017-10-04 18:31:33 +00:00
### Example
2018-07-11 05:28:17 +00:00
< div > < fiddle-embed name = "5db2d30870a7cc45f28e22578d1880c3" > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_getPixels' > getPixels< / a > < a href = '#SkBitmap_getAddr' > getAddr< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_pixelRefOrigin' > < / a >
2017-10-04 18:31:33 +00:00
## pixelRefOrigin
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = 'SkIPoint_Reference#SkIPoint' > SkIPoint< / a > < a href = '#SkBitmap_pixelRefOrigin' > pixelRefOrigin< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns origin of pixels within < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > . < a href = '#Bitmap' > Bitmap< / a > bounds is always contained
by < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > bounds, which may be the same size or larger. Multiple < a href = '#Bitmap' > Bitmaps< / a >
can share the same < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > , where each < a href = '#Bitmap' > Bitmap< / a > has different bounds.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
The returned origin added to < a href = '#Bitmap' > Bitmap< / a > dimensions equals or is smaller than the
< a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > dimensions.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Returns (0, 0) if < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is nullptr.
2017-10-04 18:31:33 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
pixel origin within < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-07-03 05:29:30 +00:00
< div > < fiddle-embed name = "6d31686c6c0829c70f284ae716526d6a" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
source origin: 0, 0
subset origin: 32, 64
~~~~
< / fiddle-embed > < / div >
2017-11-02 21:49:34 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#SkPixelRef' > SkPixelRef< / a > < a href = '#SkBitmap_getSubset' > getSubset< / a > < a href = '#SkBitmap_setPixelRef' > setPixelRef< / a >
2017-11-02 21:49:34 +00:00
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
## <a name='Set'>Set</a>
< table style = 'border-collapse: collapse; width: 62.5em' >
< tr >< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Topic</ th >
< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Description</ th ></ tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_setAlphaType' > setAlphaType</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > sets < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type</ a > of shared pixels</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_setHasHardwareMipMap' > setHasHardwareMipMap</ a ></ td >
2018-06-14 16:28:14 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > sets < a href = 'undocumented#Mip_Map' > Mip Map</ a > support present; Android only</ td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_setImmutable' > setImmutable</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > marks that pixels will not change</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_setInfo' > setInfo</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > sets height, width, < a href = 'SkImageInfo_Reference#Color_Type' > Color Type</ a > , and so on, releasing pixels</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_setIsVolatile' > setIsVolatile</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > marks if pixels should not be cached</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_setPixelRef' > setPixelRef</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > sets < a href = 'undocumented#Pixel_Ref' > Pixel Ref</ a > and offset</ td >
< / tr >
< / table >
2018-02-07 12:27:09 +00:00
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_setPixelRef' > < / a >
2017-10-04 18:31:33 +00:00
## setPixelRef
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_setPixelRef' > setPixelRef< / a > (< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkPixelRef' > SkPixelRef< / a > > < a href = '#SkBitmap_pixelRef' > pixelRef< / a > , int dx, int dy)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Replaces < a href = '#SkBitmap_pixelRef' > pixelRef< / a > and origin in < a href = '#Bitmap' > Bitmap< / a > . < a href = '#SkBitmap_setPixelRef_dx' > dx< / a > and < a href = '#SkBitmap_setPixelRef_dy' > dy< / a > specify the offset
within the < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > pixels for the top-left corner of the bitmap.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Asserts in debug builds if < a href = '#SkBitmap_setPixelRef_dx' > dx< / a > or < a href = '#SkBitmap_setPixelRef_dy' > dy< / a > are out of range. Pins < a href = '#SkBitmap_setPixelRef_dx' > dx< / a > and < a href = '#SkBitmap_setPixelRef_dy' > dy< / a >
2017-10-04 18:31:33 +00:00
to legal range in release builds.
The caller is responsible for ensuring that the pixels match the
2018-05-16 11:07:07 +00:00
< a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > and < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > in < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > .
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_setPixelRef_pixelRef' > < code > < strong > pixelRef< / strong > < / code > < / a > < / td >
< td > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > describing pixel address and < a href = '#SkBitmap_rowBytes' > rowBytes< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_setPixelRef_dx' > < code > < strong > dx< / strong > < / code > < / a > < / td >
< td > column offset in < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > for bitmap origin< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_setPixelRef_dy' > < code > < strong > dy< / strong > < / code > < / a > < / td >
< td > row offset in < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > for bitmap origin< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Example
2018-07-18 20:21:51 +00:00
< div > < fiddle-embed name = "f98cc0451c6e77a8833d261c9a484c5f" > < div > Treating 32-bit data as 8-bit data is unlikely to produce useful results.
2018-03-05 18:26:16 +00:00
< / div > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_setInfo' > setInfo< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_readyToDraw' > < / a >
2017-10-04 18:31:33 +00:00
## readyToDraw
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_readyToDraw' > readyToDraw< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns true if < a href = '#Bitmap' > Bitmap< / a > is can be drawn.
2017-10-04 18:31:33 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = '#SkBitmap_getPixels' > getPixels< / a > is not nullptr
2017-10-04 18:31:33 +00:00
### Example
< div > < fiddle-embed name = "e89c78ca992e2e789ed50944fe68f920" > < / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_getPixels' > getPixels< / a > < a href = '#SkBitmap_drawsNothing' > drawsNothing< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_getGenerationID' > < / a >
2017-10-04 18:31:33 +00:00
## getGenerationID
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
uint32_t < a href = '#SkBitmap_getGenerationID' > getGenerationID< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns a unique value corresponding to the pixels in < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > .
Returns a different value after < a href = '#SkBitmap_notifyPixelsChanged' > notifyPixelsChanged< / a > has been called.
Returns zero if < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is nullptr.
2017-10-04 18:31:33 +00:00
Determines if pixels have changed since last examined.
### Return Value
2018-05-16 11:07:07 +00:00
unique value for pixels in < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a >
2017-10-04 18:31:33 +00:00
### Example
< div > < fiddle-embed name = "db9dd91e0207c3941c09538555817b4b" >
#### Example Output
~~~~
#Volatile
empty id 0
alloc id 4
erase id 6
~~~~
< / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_notifyPixelsChanged' > notifyPixelsChanged< / a > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_notifyPixelsChanged' > < / a >
2017-10-04 18:31:33 +00:00
## notifyPixelsChanged
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_notifyPixelsChanged' > notifyPixelsChanged< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Marks that pixels in < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > have changed. Subsequent calls to
< a href = '#SkBitmap_getGenerationID' > getGenerationID< / a > return a different value.
2017-10-04 18:31:33 +00:00
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "8f463ed17b0ed4fb9c503a0ec71706f9" > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_getGenerationID' > getGenerationID< / a > < a href = '#SkBitmap_isVolatile' > isVolatile< / a > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
## <a name='Draw'>Draw</a>
< table style = 'border-collapse: collapse; width: 62.5em' >
< tr >< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Topic</ th >
< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Description</ th ></ tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_erase' > erase</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > writes < a href = 'SkColor_Reference#Color' > Color</ a > to rectangle of pixels</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_eraseARGB' > eraseARGB</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > writes < a href = 'SkColor_Reference#Color' > Color</ a > to pixels</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_eraseColor' > eraseColor</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > writes < a href = 'SkColor_Reference#Color' > Color</ a > to pixels</ td >
< / tr >
< / table >
2018-02-07 12:27:09 +00:00
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_eraseColor' > < / a >
2017-10-04 18:31:33 +00:00
## eraseColor
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_eraseColor' > eraseColor< / a > (< a href = 'SkColor_Reference#SkColor' > SkColor< / a > c) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Replaces pixel values with < a href = '#SkBitmap_eraseColor_c' > c< / a > . All pixels contained by < a href = '#SkBitmap_bounds' > bounds< / a > are affected.
If the < a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > or k565_SkColorType, then < a href = 'SkColor_Reference#Alpha' > Color Alpha< / a >
2018-05-17 16:17:28 +00:00
is ignored; RGB is treated as opaque. If < a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > ,
then RGB is ignored.
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_eraseColor_c' > < code > < strong > c< / strong > < / code > < / a > < / td >
< td > < a href = 'undocumented#Unpremultiply' > Unpremultiplied< / a > < a href = 'SkColor_Reference#Color' > Color< / a > < / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "418928dbfffa9eb00c8225530f44baf5" > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_eraseARGB' > eraseARGB< / a > < a href = '#SkBitmap_erase' > erase< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_eraseARGB' > < / a >
2017-10-04 18:31:33 +00:00
## eraseARGB
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_eraseARGB' > eraseARGB< / a > (< a href = 'undocumented#U8CPU' > U8CPU< / a > a, < a href = 'undocumented#U8CPU' > U8CPU< / a > r, < a href = 'undocumented#U8CPU' > U8CPU< / a > g, < a href = 'undocumented#U8CPU' > U8CPU< / a > b) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Replaces pixel values with < a href = 'undocumented#Unpremultiply' > Unpremultiplied< / a > < a href = 'SkColor_Reference#Color' > Color< / a > built from < a href = '#SkBitmap_eraseARGB_a' > a< / a > , < a href = '#SkBitmap_eraseARGB_r' > r< / a > , < a href = '#SkBitmap_eraseARGB_g' > g< / a > , and < a href = '#SkBitmap_eraseARGB_b' > b< / a > .
All pixels contained by < a href = '#SkBitmap_bounds' > bounds< / a > are affected.
If the < a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > or k565_SkColorType, then < a href = '#SkBitmap_eraseARGB_a' > a< / a >
is ignored; < a href = '#SkBitmap_eraseARGB_r' > r< / a > , < a href = '#SkBitmap_eraseARGB_g' > g< / a > , and < a href = '#SkBitmap_eraseARGB_b' > b< / a > are treated as opaque. If < a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > ,
then < a href = '#SkBitmap_eraseARGB_r' > r< / a > , < a href = '#SkBitmap_eraseARGB_g' > g< / a > , and < a href = '#SkBitmap_eraseARGB_b' > b< / a > are ignored.
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_eraseARGB_a' > < code > < strong > a< / strong > < / code > < / a > < / td >
< td > amount of < a href = 'SkColor_Reference#Alpha' > Color Alpha< / a > , from fully transparent (0) to fully opaque (255)< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_eraseARGB_r' > < code > < strong > r< / strong > < / code > < / a > < / td >
2018-05-17 16:17:28 +00:00
< td > amount of red, from no red (0) to full red (255)< / td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr > < td > < a name = 'SkBitmap_eraseARGB_g' > < code > < strong > g< / strong > < / code > < / a > < / td >
2018-05-17 16:17:28 +00:00
< td > amount of green, from no green (0) to full green (255)< / td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr > < td > < a name = 'SkBitmap_eraseARGB_b' > < code > < strong > b< / strong > < / code > < / a > < / td >
2018-05-17 16:17:28 +00:00
< td > amount of blue, from no blue (0) to full blue (255)< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "67277b0a1003f340473a35982533561c" > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_eraseColor' > eraseColor< / a > < a href = '#SkBitmap_erase' > erase< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_eraseRGB' > < / a >
2017-10-04 18:31:33 +00:00
## eraseRGB
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_eraseRGB' > eraseRGB< / a > (< a href = 'undocumented#U8CPU' > U8CPU< / a > r, < a href = 'undocumented#U8CPU' > U8CPU< / a > g, < a href = 'undocumented#U8CPU' > U8CPU< / a > b) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Deprecated.
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_erase' > < / a >
2017-10-04 18:31:33 +00:00
## erase
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_erase' > erase< / a > (< a href = 'SkColor_Reference#SkColor' > SkColor< / a > c, const < a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > & area) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Replaces pixel values inside < a href = '#SkBitmap_erase_area' > area< / a > with < a href = '#SkBitmap_erase_c' > c< / a > . If < a href = '#SkBitmap_erase_area' > area< / a > does not intersect < a href = '#SkBitmap_bounds' > bounds< / a > ,
2017-10-04 18:31:33 +00:00
call has no effect.
2018-05-16 11:07:07 +00:00
If the < a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > or k565_SkColorType, then < a href = 'SkColor_Reference#Alpha' > Color Alpha< / a >
2018-05-17 16:17:28 +00:00
is ignored; RGB is treated as opaque. If < a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > ,
then RGB is ignored.
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_erase_c' > < code > < strong > c< / strong > < / code > < / a > < / td >
< td > < a href = 'undocumented#Unpremultiply' > Unpremultiplied< / a > < a href = 'SkColor_Reference#Color' > Color< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_erase_area' > < code > < strong > area< / strong > < / code > < / a > < / td >
< td > rectangle to fill< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "2c5c4230ccd2861a5d15b7cd2764ab6e" > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_eraseColor' > eraseColor< / a > < a href = '#SkBitmap_eraseARGB' > eraseARGB< / a > < a href = '#SkBitmap_eraseRGB' > eraseRGB< / a > < a href = 'SkCanvas_Reference#SkCanvas_drawRect' > SkCanvas::drawRect< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_eraseArea' > < / a >
2017-10-04 18:31:33 +00:00
## eraseArea
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_eraseArea' > eraseArea< / a > (const < a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > & area, < a href = 'SkColor_Reference#SkColor' > SkColor< / a > c) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Deprecated.
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_getColor' > < / a >
2017-10-04 18:31:33 +00:00
## getColor
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = 'SkColor_Reference#SkColor' > SkColor< / a > < a href = '#SkBitmap_getColor' > getColor< / a > (int x, int y) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns pixel at (< a href = '#SkBitmap_getColor_x' > x< / a > , < a href = '#SkBitmap_getColor_y' > y< / a > ) as < a href = 'undocumented#Unpremultiply' > Unpremultiplied< / a > < a href = 'SkColor_Reference#Color' > Color< / a > .
Returns black with < a href = 'SkColor_Reference#Alpha' > Alpha< / a > if < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > is < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Input is not validated: out of bounds values of < a href = '#SkBitmap_getColor_x' > x< / a > or < a href = '#SkBitmap_getColor_y' > y< / a > trigger an assert() if
2018-01-04 21:11:51 +00:00
built with SK_DEBUG defined; and returns undefined values or may crash if
2018-05-16 11:07:07 +00:00
SK_RELEASE is defined. Fails if < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > is < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > or
2017-10-04 18:31:33 +00:00
pixel address is nullptr.
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#Color_Space' > Color Space< / a > in < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > is ignored. Some < a href = 'SkColor_Reference#Color' > Color< / a > precision may be lost in the
conversion to < a href = 'undocumented#Unpremultiply' > Unpremultiplied< / a > < a href = 'SkColor_Reference#Color' > Color< / a > ; original pixel data may have additional
2017-10-04 18:31:33 +00:00
precision.
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_getColor_x' > < code > < strong > x< / strong > < / code > < / a > < / td >
< td > column index, zero or greater, and less than < a href = '#SkBitmap_width' > width< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_getColor_y' > < code > < strong > y< / strong > < / code > < / a > < / td >
< td > row index, zero or greater, and less than < a href = '#SkBitmap_height' > height< / a > < / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
pixel converted to < a href = 'undocumented#Unpremultiply' > Unpremultiplied< / a > < a href = 'SkColor_Reference#Color' > Color< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-07-05 05:35:27 +00:00
< div > < fiddle-embed name = "193d1f6d8a43b7a8e9f27ba21de38617" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
Premultiplied:
(0, 0) 0x00000000 0x2a0e002a 0x55380055 0x7f7f007f
(0, 1) 0x2a000e2a 0x551c1c55 0x7f542a7f 0xaaaa38aa
(0, 2) 0x55003855 0x7f2a547f 0xaa7171aa 0xd4d48dd4
(0, 3) 0x7f007f7f 0xaa38aaaa 0xd48dd4d4 0xffffffff
Unpremultiplied:
(0, 0) 0x00000000 0x2a5500ff 0x55a800ff 0x7fff00ff
(0, 1) 0x2a0055ff 0x555454ff 0x7fa954ff 0xaaff54ff
(0, 2) 0x5500a8ff 0x7f54a9ff 0xaaaaaaff 0xd4ffaaff
(0, 3) 0x7f00ffff 0xaa54ffff 0xd4aaffff 0xffffffff
~~~~
< / fiddle-embed > < / div >
### See Also
2018-07-17 17:19:56 +00:00
< a href = '#SkBitmap_getAddr' > getAddr< / a > < a href = '#SkBitmap_readPixels' > readPixels< / a > < sup > < a href = '#SkBitmap_readPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_readPixels_3' > [3]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_getAddr' > < / a >
2017-10-04 18:31:33 +00:00
## getAddr
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void* < a href = '#SkBitmap_getAddr' > getAddr< / a > (int x, int y) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns pixel address at (< a href = '#SkBitmap_getAddr_x' > x< / a > , < a href = '#SkBitmap_getAddr_y' > y< / a > ).
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Input is not validated: out of bounds values of < a href = '#SkBitmap_getAddr_x' > x< / a > or < a href = '#SkBitmap_getAddr_y' > y< / a > , or < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > ,
2018-01-04 21:11:51 +00:00
trigger an assert() if built with SK_DEBUG defined. Returns nullptr if
2018-05-16 11:07:07 +00:00
< a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > is < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > , or < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is nullptr.
2017-10-04 18:31:33 +00:00
2018-01-04 21:11:51 +00:00
Performs a lookup of pixel size; for better performance, call
2018-05-16 11:07:07 +00:00
one of: < a href = '#SkBitmap_getAddr8' > getAddr8< / a > , < a href = '#SkBitmap_getAddr16' > getAddr16< / a > , or < a href = '#SkBitmap_getAddr32' > getAddr32< / a > .
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_getAddr_x' > < code > < strong > x< / strong > < / code > < / a > < / td >
< td > column index, zero or greater, and less than < a href = '#SkBitmap_width' > width< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_getAddr_y' > < code > < strong > y< / strong > < / code > < / a > < / td >
< td > row index, zero or greater, and less than < a href = '#SkBitmap_height' > height< / a > < / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
generic pointer to pixel
### Example
2018-03-16 15:34:15 +00:00
< div > < fiddle-embed name = "ffcefb2344cd38c3b99f69cfe6d64a17" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
addr interval == rowBytes
~~~~
< / fiddle-embed > < / div >
### See Also
2018-07-17 17:19:56 +00:00
< a href = '#SkBitmap_getAddr8' > getAddr8< / a > < a href = '#SkBitmap_getAddr16' > getAddr16< / a > < a href = '#SkBitmap_getAddr32' > getAddr32< / a > < a href = '#SkBitmap_readPixels' > readPixels< / a > < sup > < a href = '#SkBitmap_readPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_readPixels_3' > [3]< / a > < / sup > < a href = 'SkPixmap_Reference#SkPixmap_addr' > SkPixmap::addr< / a > < sup > < a href = 'SkPixmap_Reference#SkPixmap_addr_2' > [2]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_getAddr32' > < / a >
2017-10-04 18:31:33 +00:00
## getAddr32
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
inline uint32_t* < a href = '#SkBitmap_getAddr32' > getAddr32< / a > (int x, int y) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns address at (< a href = '#SkBitmap_getAddr32_x' > x< / a > , < a href = '#SkBitmap_getAddr32_y' > y< / a > ).
2017-10-04 18:31:33 +00:00
2018-01-04 21:11:51 +00:00
Input is not validated. Triggers an assert() if built with SK_DEBUG defined and:
2017-10-04 18:31:33 +00:00
< table > < tr >
2018-05-16 11:07:07 +00:00
< td > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is nullptr< / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_bytesPerPixel' > bytesPerPixel< / a > is not four< / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_getAddr32_x' > x< / a > is negative, or not less than < a href = '#SkBitmap_width' > width< / a > < / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_getAddr32_y' > y< / a > is negative, or not less than < a href = '#SkBitmap_height' > height< / a > < / td >
< / tr >
2017-10-04 18:31:33 +00:00
< / table >
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_getAddr32_x' > < code > < strong > x< / strong > < / code > < / a > < / td >
< td > column index, zero or greater, and less than < a href = '#SkBitmap_width' > width< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_getAddr32_y' > < code > < strong > y< / strong > < / code > < / a > < / td >
< td > row index, zero or greater, and less than < a href = '#SkBitmap_height' > height< / a > < / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
unsigned 32-bit pointer to pixel at (< a href = '#SkBitmap_getAddr32_x' > x< / a > , < a href = '#SkBitmap_getAddr32_y' > y< / a > )
2017-10-04 18:31:33 +00:00
### Example
< div > < fiddle-embed name = "837a2bcc9fb9ce617a3420956cefc64a" >
#### Example Output
~~~~
addr interval == rowBytes
~~~~
< / fiddle-embed > < / div >
### See Also
2018-07-17 17:19:56 +00:00
< a href = '#SkBitmap_getAddr8' > getAddr8< / a > < a href = '#SkBitmap_getAddr16' > getAddr16< / a > < a href = '#SkBitmap_getAddr' > getAddr< / a > < a href = '#SkBitmap_readPixels' > readPixels< / a > < sup > < a href = '#SkBitmap_readPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_readPixels_3' > [3]< / a > < / sup > < a href = 'SkPixmap_Reference#SkPixmap_addr32' > SkPixmap::addr32< / a > < sup > < a href = 'SkPixmap_Reference#SkPixmap_addr32_2' > [2]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_getAddr16' > < / a >
2017-10-04 18:31:33 +00:00
## getAddr16
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
inline uint16_t* < a href = '#SkBitmap_getAddr16' > getAddr16< / a > (int x, int y) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns address at (< a href = '#SkBitmap_getAddr16_x' > x< / a > , < a href = '#SkBitmap_getAddr16_y' > y< / a > ).
2017-10-04 18:31:33 +00:00
2018-01-04 21:11:51 +00:00
Input is not validated. Triggers an assert() if built with SK_DEBUG defined and:
2017-10-04 18:31:33 +00:00
< table > < tr >
2018-05-16 11:07:07 +00:00
< td > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is nullptr< / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_bytesPerPixel' > bytesPerPixel< / a > is not two< / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_getAddr16_x' > x< / a > is negative, or not less than < a href = '#SkBitmap_width' > width< / a > < / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_getAddr16_y' > y< / a > is negative, or not less than < a href = '#SkBitmap_height' > height< / a > < / td >
< / tr >
2017-10-04 18:31:33 +00:00
< / table >
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_getAddr16_x' > < code > < strong > x< / strong > < / code > < / a > < / td >
< td > column index, zero or greater, and less than < a href = '#SkBitmap_width' > width< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_getAddr16_y' > < code > < strong > y< / strong > < / code > < / a > < / td >
< td > row index, zero or greater, and less than < a href = '#SkBitmap_height' > height< / a > < / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
unsigned 16-bit pointer to pixel at (< a href = '#SkBitmap_getAddr16_x' > x< / a > , < a href = '#SkBitmap_getAddr16_y' > y< / a > )
2017-10-04 18:31:33 +00:00
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "53e00899ef2e00e2096daf7a07d9b059" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
addr interval == rowBytes
~~~~
< / fiddle-embed > < / div >
### See Also
2018-07-17 17:19:56 +00:00
< a href = '#SkBitmap_getAddr8' > getAddr8< / a > < a href = '#SkBitmap_getAddr' > getAddr< / a > < a href = '#SkBitmap_getAddr32' > getAddr32< / a > < a href = '#SkBitmap_readPixels' > readPixels< / a > < sup > < a href = '#SkBitmap_readPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_readPixels_3' > [3]< / a > < / sup > < a href = 'SkPixmap_Reference#SkPixmap_addr16' > SkPixmap::addr16< / a > < sup > < a href = 'SkPixmap_Reference#SkPixmap_addr16_2' > [2]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_getAddr8' > < / a >
2017-10-04 18:31:33 +00:00
## getAddr8
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
inline uint8_t* < a href = '#SkBitmap_getAddr8' > getAddr8< / a > (int x, int y) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns address at (< a href = '#SkBitmap_getAddr8_x' > x< / a > , < a href = '#SkBitmap_getAddr8_y' > y< / a > ).
2017-10-04 18:31:33 +00:00
2018-01-04 21:11:51 +00:00
Input is not validated. Triggers an assert() if built with SK_DEBUG defined and:
2017-10-04 18:31:33 +00:00
< table > < tr >
2018-05-16 11:07:07 +00:00
< td > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is nullptr< / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_bytesPerPixel' > bytesPerPixel< / a > is not one< / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_getAddr8_x' > x< / a > is negative, or not less than < a href = '#SkBitmap_width' > width< / a > < / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_getAddr8_y' > y< / a > is negative, or not less than < a href = '#SkBitmap_height' > height< / a > < / td >
< / tr >
2017-10-04 18:31:33 +00:00
< / table >
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_getAddr8_x' > < code > < strong > x< / strong > < / code > < / a > < / td >
< td > column index, zero or greater, and less than < a href = '#SkBitmap_width' > width< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_getAddr8_y' > < code > < strong > y< / strong > < / code > < / a > < / td >
< td > row index, zero or greater, and less than < a href = '#SkBitmap_height' > height< / a > < / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
unsigned 8-bit pointer to pixel at (< a href = '#SkBitmap_getAddr8_x' > x< / a > , < a href = '#SkBitmap_getAddr8_y' > y< / a > )
2017-10-04 18:31:33 +00:00
### Example
< div > < fiddle-embed name = "cb9a08e8ff779b6a1cf8bb54f3883aaf" >
#### Example Output
~~~~
& pixels[4][2] == bitmap.getAddr8(2, 4)
~~~~
< / fiddle-embed > < / div >
### See Also
2018-07-17 17:19:56 +00:00
< a href = '#SkBitmap_getAddr' > getAddr< / a > < a href = '#SkBitmap_getAddr16' > getAddr16< / a > < a href = '#SkBitmap_getAddr32' > getAddr32< / a > < a href = '#SkBitmap_readPixels' > readPixels< / a > < sup > < a href = '#SkBitmap_readPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_readPixels_3' > [3]< / a > < / sup > < a href = 'SkPixmap_Reference#SkPixmap_addr8' > SkPixmap::addr8< / a > < sup > < a href = 'SkPixmap_Reference#SkPixmap_addr8_2' > [2]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_extractSubset' > < / a >
2017-10-04 18:31:33 +00:00
## extractSubset
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_extractSubset' > extractSubset< / a > (< a href = '#SkBitmap' > SkBitmap< / a > * dst, const < a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > & subset) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Shares < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > with < a href = '#SkBitmap_extractSubset_dst' > dst< / a > . < a href = '#Pixels' > Pixels< / a > are not copied; < a href = '#Bitmap' > Bitmap< / a > and < a href = '#SkBitmap_extractSubset_dst' > dst< / a > point
to the same pixels; < a href = '#SkBitmap_extractSubset_dst' > dst< / a > < a href = '#SkBitmap_bounds' > bounds< / a > are set to the intersection of < a href = '#SkBitmap_extractSubset_subset' > subset< / a >
and the original < a href = '#SkBitmap_bounds' > bounds< / a > .
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_extractSubset_subset' > subset< / a > may be larger than < a href = '#SkBitmap_bounds' > bounds< / a > . Any area outside of < a href = '#SkBitmap_bounds' > bounds< / a > is ignored.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Any contents of < a href = '#SkBitmap_extractSubset_dst' > dst< / a > are discarded. < a href = '#SkBitmap_isVolatile' > isVolatile< / a > setting is copied to < a href = '#SkBitmap_extractSubset_dst' > dst< / a > .
< a href = '#SkBitmap_extractSubset_dst' > dst< / a > is set to < a href = '#SkBitmap_colorType' > colorType< / a > , < a href = '#SkBitmap_alphaType' > alphaType< / a > , and < a href = '#SkBitmap_colorSpace' > colorSpace< / a > .
2017-10-04 18:31:33 +00:00
Return false if:
< table > < tr >
2018-05-16 11:07:07 +00:00
< td > < a href = '#SkBitmap_extractSubset_dst' > dst< / a > is nullptr< / td >
< / tr > < tr >
< td > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is nullptr< / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_extractSubset_subset' > subset< / a > does not intersect < a href = '#SkBitmap_bounds' > bounds< / a > < / td >
< / tr >
2017-10-04 18:31:33 +00:00
< / table >
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_extractSubset_dst' > < code > < strong > dst< / strong > < / code > < / a > < / td >
< td > < a href = '#Bitmap' > Bitmap< / a > set to < a href = '#SkBitmap_extractSubset_subset' > subset< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_extractSubset_subset' > < code > < strong > subset< / strong > < / code > < / a > < / td >
< td > rectangle of pixels to reference< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = '#SkBitmap_extractSubset_dst' > dst< / a > is replaced by < a href = '#SkBitmap_extractSubset_subset' > subset< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-07-18 20:21:51 +00:00
< div > < fiddle-embed name = "304148c50c91490bfd58e9222342419c" >
2017-10-04 18:31:33 +00:00
#### Example Output
~~~~
bounds: 0, 0, 512, 512
subset: -100, 100, 0, 200 success; false
subset: -100, 100, 100, 200 success; true subset: 0, 0, 100, 100
subset: -100, 100, 1000, 200 success; true subset: 0, 0, 512, 100
subset: 0, 100, 0, 200 success; false
subset: 0, 100, 100, 200 success; true subset: 0, 0, 100, 100
subset: 0, 100, 1000, 200 success; true subset: 0, 0, 512, 100
subset: 100, 100, 0, 200 success; false
subset: 100, 100, 100, 200 success; false
subset: 100, 100, 1000, 200 success; true subset: 0, 0, 412, 100
subset: 1000, 100, 0, 200 success; false
subset: 1000, 100, 100, 200 success; false
subset: 1000, 100, 1000, 200 success; false
~~~~
< / fiddle-embed > < / div >
### See Also
2018-07-17 17:19:56 +00:00
< a href = '#SkBitmap_readPixels' > readPixels< / a > < sup > < a href = '#SkBitmap_readPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_readPixels_3' > [3]< / a > < / sup > < a href = '#SkBitmap_writePixels' > writePixels< / a > < sup > < a href = '#SkBitmap_writePixels_2' > [2]< / a > < / sup > < a href = 'SkCanvas_Reference#SkCanvas_drawBitmap' > SkCanvas::drawBitmap< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_readPixels' > < / a >
2017-10-04 18:31:33 +00:00
## readPixels
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
2018-07-17 17:19:56 +00:00
bool < a href = '#SkBitmap_readPixels' > readPixels< / a > (const < a href = 'SkImageInfo_Reference#SkImageInfo' > SkImageInfo< / a > & dstInfo, void* dstPixels, size_t dstRowBytes, int srcX, int srcY) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-07-17 17:19:56 +00:00
Copies a < a href = 'SkRect_Reference#Rect' > Rect< / a > of pixels from < a href = '#Bitmap' > Bitmap< / a > to < a href = '#SkBitmap_readPixels_dstPixels' > dstPixels< / a > . Copy starts at (< a href = '#SkBitmap_readPixels_srcX' > srcX< / a > , < a href = '#SkBitmap_readPixels_srcY' > srcY< / a > ),
2018-05-16 11:07:07 +00:00
and does not exceed < a href = '#Bitmap' > Bitmap< / a > (< a href = '#SkBitmap_width' > width< / a > , < a href = '#SkBitmap_height' > height< / a > ).
2017-10-04 18:31:33 +00:00
2018-07-17 17:19:56 +00:00
< a href = '#SkBitmap_readPixels_dstInfo' > dstInfo< / a > specifies width, height, < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , and < a href = 'undocumented#Color_Space' > Color Space< / a > of
destination. < a href = '#SkBitmap_readPixels_dstRowBytes' > dstRowBytes< / a > specifics the gap from one destination row to the next.
Returns true if pixels are copied. Returns false if:
2017-10-04 18:31:33 +00:00
< table > < tr >
2018-05-16 11:07:07 +00:00
< td > < a href = '#SkBitmap_readPixels_dstInfo' > dstInfo< / a > .addr() equals nullptr< / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_readPixels_dstRowBytes' > dstRowBytes< / a > is less than < a href = '#SkBitmap_readPixels_dstInfo' > dstInfo< / a > .< a href = 'SkImageInfo_Reference#SkImageInfo' > minRowBytes< / a > < / td >
< / tr > < tr >
< td > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is nullptr< / td >
< / tr >
2017-10-04 18:31:33 +00:00
< / table >
2018-05-16 11:07:07 +00:00
< a href = '#Pixels' > Pixels< / a > are copied only if pixel conversion is possible. If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_colorType' > colorType< / a > is
< a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , or < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > ; < a href = '#SkBitmap_readPixels_dstInfo' > dstInfo< / a > .< a href = '#SkBitmap_colorType' > colorType< / a > must match.
If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , < a href = '#SkBitmap_readPixels_dstInfo' > dstInfo< / a > .< a href = '#SkBitmap_colorSpace' > colorSpace< / a > must match.
If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_alphaType' > alphaType< / a > is < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a > , < a href = '#SkBitmap_readPixels_dstInfo' > dstInfo< / a > .< a href = '#SkBitmap_alphaType' > alphaType< / a > must
match. If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_colorSpace' > colorSpace< / a > is nullptr, < a href = '#SkBitmap_readPixels_dstInfo' > dstInfo< / a > .< a href = '#SkBitmap_colorSpace' > colorSpace< / a > must match. Returns
2017-10-04 18:31:33 +00:00
false if pixel conversion is not possible.
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_readPixels_srcX' > srcX< / a > and < a href = '#SkBitmap_readPixels_srcY' > srcY< / a > may be negative to copy only top or left of source. Returns
false if < a href = '#SkBitmap_width' > width< / a > or < a href = '#SkBitmap_height' > height< / a > is zero or negative.
Condense embedded formulas.
Bookmaker delimits formulas and equations to allow
representing variables and symbols without tripping
up reference lookup, spell checking, and comment
generation.
Before, formulas were represented with:
some text
#Formula
(x + y, 0)
##
, and more text
This made it difficult to know when spacing should
be preserved before and after the formula. Now,
formulas are represented with:
some text #Formula # (x + y, 0) ##, and more text
The presence or absence of a space between ## and ,
is now significant (before it was not).
Also, formulas are bracketed by <code> in markdown
generation, so that variables stand out better.
See:
https://skia.org/user/api/SkBlendMode_Reference?cl=152781#Dst_Out
for an example.
Also fixed 100 column offenders and added a code
check to identify them. For the moment, 100 column
offenders are outed with SkDebugf but their presence
does not cause bookmaker to fail.
TBR=caryclark@google.com
Docs-Preview: https://skia.org/?cl=152781
Bug: skia:6898
Change-Id: If92a65a234f5d616bf4485984a8d219a6f04821a
Reviewed-on: https://skia-review.googlesource.com/152781
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-09-13 16:04:30 +00:00
Returns false if < code > abs(srcX) >= < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_width' > width< / a > < / code > , or if < code > abs(srcY) >= < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_height' > height< / a > < / code > .
2018-05-16 11:07:07 +00:00
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_readPixels_dstInfo' > < code > < strong > dstInfo< / strong > < / code > < / a > < / td >
< td > destination width, height, < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , < a href = 'undocumented#Color_Space' > Color Space< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_readPixels_dstPixels' > < code > < strong > dstPixels< / strong > < / code > < / a > < / td >
< td > destination pixel storage< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_readPixels_dstRowBytes' > < code > < strong > dstRowBytes< / strong > < / code > < / a > < / td >
< td > destination row length< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_readPixels_srcX' > < code > < strong > srcX< / strong > < / code > < / a > < / td >
< td > column index whose absolute value is less than < a href = '#SkBitmap_width' > width< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_readPixels_srcY' > < code > < strong > srcY< / strong > < / code > < / a > < / td >
< td > row index whose absolute value is less than < a href = '#SkBitmap_height' > height< / a > < / td >
< / tr >
2017-10-04 18:31:33 +00:00
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if pixels are copied to < a href = '#SkBitmap_readPixels_dstPixels' > dstPixels< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-07-17 17:19:56 +00:00
< div > < fiddle-embed name = "b2cbbbbcffb618865d8aae3bc04b2a62" > < div > Transferring the gradient from 8 bits per component to 4 bits per component
creates visible banding.
< / div > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-07-17 17:19:56 +00:00
< a href = '#SkBitmap_writePixels' > writePixels< / a > < sup > < a href = '#SkBitmap_writePixels_2' > [2]< / a > < / sup > < a href = 'SkPixmap_Reference#SkPixmap_readPixels' > SkPixmap::readPixels< / a > < sup > < a href = 'SkPixmap_Reference#SkPixmap_readPixels_2' > [2]< / a > < / sup > < sup > < a href = 'SkPixmap_Reference#SkPixmap_readPixels_3' > [3]< / a > < / sup > < sup > < a href = 'SkPixmap_Reference#SkPixmap_readPixels_4' > [4]< / a > < / sup > < a href = 'SkCanvas_Reference#SkCanvas_readPixels' > SkCanvas::readPixels< / a > < sup > < a href = 'SkCanvas_Reference#SkCanvas_readPixels_2' > [2]< / a > < / sup > < sup > < a href = 'SkCanvas_Reference#SkCanvas_readPixels_3' > [3]< / a > < / sup > < a href = 'SkImage_Reference#SkImage_readPixels' > SkImage::readPixels< / a > < sup > < a href = 'SkImage_Reference#SkImage_readPixels_2' > [2]< / a > < / sup > < a href = 'SkSurface_Reference#SkSurface_readPixels' > SkSurface::readPixels< / a > < sup > < a href = 'SkSurface_Reference#SkSurface_readPixels_2' > [2]< / a > < / sup > < sup > < a href = 'SkSurface_Reference#SkSurface_readPixels_3' > [3]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_readPixels_2' > < / a >
2018-01-26 17:56:22 +00:00
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
2018-07-17 17:19:56 +00:00
bool < a href = '#SkBitmap_readPixels' > readPixels< / a > (const < a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > & dst, int srcX, int srcY) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-07-17 17:19:56 +00:00
Copies a < a href = 'SkRect_Reference#Rect' > Rect< / a > of pixels from < a href = '#Bitmap' > Bitmap< / a > to < a href = '#SkBitmap_readPixels_2_dst' > dst< / a > . Copy starts at (< a href = '#SkBitmap_readPixels_2_srcX' > srcX< / a > , < a href = '#SkBitmap_readPixels_2_srcY' > srcY< / a > ), and
does not exceed < a href = '#Bitmap' > Bitmap< / a > (< a href = '#SkBitmap_width' > width< / a > , < a href = '#SkBitmap_height' > height< / a > ).
2017-10-04 18:31:33 +00:00
2018-07-17 17:19:56 +00:00
< a href = '#SkBitmap_readPixels_2_dst' > dst< / a > specifies width, height, < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , < a href = 'undocumented#Color_Space' > Color Space< / a > , pixel storage,
and row bytes of destination. < a href = '#SkBitmap_readPixels_2_dst' > dst< / a > .< a href = '#SkBitmap_rowBytes' > rowBytes< / a > specifics the gap from one destination
row to the next. Returns true if pixels are copied. Returns false if:
2017-10-04 18:31:33 +00:00
< table > < tr >
2018-07-17 17:19:56 +00:00
< td > < a href = '#SkBitmap_readPixels_2_dst' > dst< / a > pixel storage equals nullptr< / td >
2018-05-16 11:07:07 +00:00
< / tr > < tr >
2018-07-17 17:19:56 +00:00
< td > < a href = '#SkBitmap_readPixels_2_dst' > dst< / a > .< a href = '#SkBitmap_rowBytes' > rowBytes< / a > is less than < a href = 'SkImageInfo_Reference#SkImageInfo_minRowBytes' > SkImageInfo::minRowBytes< / a > < / td >
2018-05-16 11:07:07 +00:00
< / tr > < tr >
< td > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is nullptr< / td >
< / tr >
2017-10-04 18:31:33 +00:00
< / table >
2018-05-16 11:07:07 +00:00
< a href = '#Pixels' > Pixels< / a > are copied only if pixel conversion is possible. If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_colorType' > colorType< / a > is
2018-07-17 17:19:56 +00:00
< a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , or < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > ; < a href = '#SkBitmap_readPixels_2_dst' > dst< / a > < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > must match.
If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , < a href = '#SkBitmap_readPixels_2_dst' > dst< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > must match.
If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_alphaType' > alphaType< / a > is < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a > , < a href = '#SkBitmap_readPixels_2_dst' > dst< / a > < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > must
match. If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_colorSpace' > colorSpace< / a > is nullptr, < a href = '#SkBitmap_readPixels_2_dst' > dst< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > must match. Returns
2017-10-04 18:31:33 +00:00
false if pixel conversion is not possible.
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_readPixels_2_srcX' > srcX< / a > and < a href = '#SkBitmap_readPixels_2_srcY' > srcY< / a > may be negative to copy only top or left of source. Returns
false if < a href = '#SkBitmap_width' > width< / a > or < a href = '#SkBitmap_height' > height< / a > is zero or negative.
Condense embedded formulas.
Bookmaker delimits formulas and equations to allow
representing variables and symbols without tripping
up reference lookup, spell checking, and comment
generation.
Before, formulas were represented with:
some text
#Formula
(x + y, 0)
##
, and more text
This made it difficult to know when spacing should
be preserved before and after the formula. Now,
formulas are represented with:
some text #Formula # (x + y, 0) ##, and more text
The presence or absence of a space between ## and ,
is now significant (before it was not).
Also, formulas are bracketed by <code> in markdown
generation, so that variables stand out better.
See:
https://skia.org/user/api/SkBlendMode_Reference?cl=152781#Dst_Out
for an example.
Also fixed 100 column offenders and added a code
check to identify them. For the moment, 100 column
offenders are outed with SkDebugf but their presence
does not cause bookmaker to fail.
TBR=caryclark@google.com
Docs-Preview: https://skia.org/?cl=152781
Bug: skia:6898
Change-Id: If92a65a234f5d616bf4485984a8d219a6f04821a
Reviewed-on: https://skia-review.googlesource.com/152781
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-09-13 16:04:30 +00:00
Returns false if < code > abs(srcX) >= < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_width' > width< / a > < / code > , or if < code > abs(srcY) >= < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_height' > height< / a > < / code > .
2017-10-04 18:31:33 +00:00
### Parameters
2018-07-17 17:19:56 +00:00
< table > < tr > < td > < a name = 'SkBitmap_readPixels_2_dst' > < code > < strong > dst< / strong > < / code > < / a > < / td >
< td > destination < a href = 'SkPixmap_Reference#Pixmap' > Pixmap< / a > : < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , pixels, row bytes< / td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr > < td > < a name = 'SkBitmap_readPixels_2_srcX' > < code > < strong > srcX< / strong > < / code > < / a > < / td >
< td > column index whose absolute value is less than < a href = '#SkBitmap_width' > width< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_readPixels_2_srcY' > < code > < strong > srcY< / strong > < / code > < / a > < / td >
< td > row index whose absolute value is less than < a href = '#SkBitmap_height' > height< / a > < / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-07-17 17:19:56 +00:00
true if pixels are copied to < a href = '#SkBitmap_readPixels_2_dst' > dst< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-07-17 17:19:56 +00:00
< div > < fiddle-embed name = "e9f70cbc9827097449a386ec7a8a8188" > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-07-17 17:19:56 +00:00
< a href = '#SkBitmap_writePixels' > writePixels< / a > < sup > < a href = '#SkBitmap_writePixels_2' > [2]< / a > < / sup > < a href = 'SkPixmap_Reference#SkPixmap_readPixels' > SkPixmap::readPixels< / a > < sup > < a href = 'SkPixmap_Reference#SkPixmap_readPixels_2' > [2]< / a > < / sup > < sup > < a href = 'SkPixmap_Reference#SkPixmap_readPixels_3' > [3]< / a > < / sup > < sup > < a href = 'SkPixmap_Reference#SkPixmap_readPixels_4' > [4]< / a > < / sup > < a href = 'SkCanvas_Reference#SkCanvas_readPixels' > SkCanvas::readPixels< / a > < sup > < a href = 'SkCanvas_Reference#SkCanvas_readPixels_2' > [2]< / a > < / sup > < sup > < a href = 'SkCanvas_Reference#SkCanvas_readPixels_3' > [3]< / a > < / sup > < a href = 'SkImage_Reference#SkImage_readPixels' > SkImage::readPixels< / a > < sup > < a href = 'SkImage_Reference#SkImage_readPixels_2' > [2]< / a > < / sup > < a href = 'SkSurface_Reference#SkSurface_readPixels' > SkSurface::readPixels< / a > < sup > < a href = 'SkSurface_Reference#SkSurface_readPixels_2' > [2]< / a > < / sup > < sup > < a href = 'SkSurface_Reference#SkSurface_readPixels_3' > [3]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_readPixels_3' > < / a >
2018-01-26 17:56:22 +00:00
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
2018-07-17 17:19:56 +00:00
bool < a href = '#SkBitmap_readPixels' > readPixels< / a > (const < a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > & dst) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-07-17 17:19:56 +00:00
Copies a < a href = 'SkRect_Reference#Rect' > Rect< / a > of pixels from < a href = '#Bitmap' > Bitmap< / a > to < a href = '#SkBitmap_readPixels_3_dst' > dst< / a > . Copy starts at (0, 0), and
2018-05-16 11:07:07 +00:00
does not exceed < a href = '#Bitmap' > Bitmap< / a > (< a href = '#SkBitmap_width' > width< / a > , < a href = '#SkBitmap_height' > height< / a > ).
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_readPixels_3_dst' > dst< / a > specifies width, height, < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , < a href = 'undocumented#Color_Space' > Color Space< / a > , pixel storage,
and row bytes of destination. < a href = '#SkBitmap_readPixels_3_dst' > dst< / a > .< a href = '#SkBitmap_rowBytes' > rowBytes< / a > specifics the gap from one destination
2017-10-04 18:31:33 +00:00
row to the next. Returns true if pixels are copied. Returns false if:
< table > < tr >
2018-05-16 11:07:07 +00:00
< td > < a href = '#SkBitmap_readPixels_3_dst' > dst< / a > pixel storage equals nullptr< / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_readPixels_3_dst' > dst< / a > .< a href = '#SkBitmap_rowBytes' > rowBytes< / a > is less than < a href = 'SkImageInfo_Reference#SkImageInfo_minRowBytes' > SkImageInfo::minRowBytes< / a > < / td >
< / tr > < tr >
< td > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is nullptr< / td >
< / tr >
2017-10-04 18:31:33 +00:00
< / table >
2018-05-16 11:07:07 +00:00
< a href = '#Pixels' > Pixels< / a > are copied only if pixel conversion is possible. If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_colorType' > colorType< / a > is
< a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , or < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > ; < a href = '#SkBitmap_readPixels_3_dst' > dst< / a > < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > must match.
If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , < a href = '#SkBitmap_readPixels_3_dst' > dst< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > must match.
If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_alphaType' > alphaType< / a > is < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a > , < a href = '#SkBitmap_readPixels_3_dst' > dst< / a > < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > must
match. If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_colorSpace' > colorSpace< / a > is nullptr, < a href = '#SkBitmap_readPixels_3_dst' > dst< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > must match. Returns
2017-10-04 18:31:33 +00:00
false if pixel conversion is not possible.
2018-05-16 11:07:07 +00:00
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_readPixels_3_dst' > < code > < strong > dst< / strong > < / code > < / a > < / td >
< td > destination < a href = 'SkPixmap_Reference#Pixmap' > Pixmap< / a > : < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , pixels, row bytes< / td >
< / tr >
2017-10-04 18:31:33 +00:00
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if pixels are copied to < a href = '#SkBitmap_readPixels_3_dst' > dst< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "4590fbf052659d6e629fbfd827081ae5" > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-07-17 17:19:56 +00:00
< a href = '#SkBitmap_writePixels' > writePixels< / a > < sup > < a href = '#SkBitmap_writePixels_2' > [2]< / a > < / sup > < a href = 'SkPixmap_Reference#SkPixmap_readPixels' > SkPixmap::readPixels< / a > < sup > < a href = 'SkPixmap_Reference#SkPixmap_readPixels_2' > [2]< / a > < / sup > < sup > < a href = 'SkPixmap_Reference#SkPixmap_readPixels_3' > [3]< / a > < / sup > < sup > < a href = 'SkPixmap_Reference#SkPixmap_readPixels_4' > [4]< / a > < / sup > < a href = 'SkCanvas_Reference#SkCanvas_readPixels' > SkCanvas::readPixels< / a > < sup > < a href = 'SkCanvas_Reference#SkCanvas_readPixels_2' > [2]< / a > < / sup > < sup > < a href = 'SkCanvas_Reference#SkCanvas_readPixels_3' > [3]< / a > < / sup > < a href = 'SkImage_Reference#SkImage_readPixels' > SkImage::readPixels< / a > < sup > < a href = 'SkImage_Reference#SkImage_readPixels_2' > [2]< / a > < / sup > < a href = 'SkSurface_Reference#SkSurface_readPixels' > SkSurface::readPixels< / a > < sup > < a href = 'SkSurface_Reference#SkSurface_readPixels_2' > [2]< / a > < / sup > < sup > < a href = 'SkSurface_Reference#SkSurface_readPixels_3' > [3]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_writePixels' > < / a >
2017-10-04 18:31:33 +00:00
## writePixels
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_writePixels' > writePixels< / a > (const < a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > & src, int dstX, int dstY)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Copies a < a href = 'SkRect_Reference#Rect' > Rect< / a > of pixels from < a href = '#SkBitmap_writePixels_src' > src< / a > . Copy starts at (< a href = '#SkBitmap_writePixels_dstX' > dstX< / a > , < a href = '#SkBitmap_writePixels_dstY' > dstY< / a > ), and does not exceed
(< a href = '#SkBitmap_writePixels_src' > src< / a > .< a href = '#SkBitmap_width' > width< / a > , < a href = '#SkBitmap_writePixels_src' > src< / a > .< a href = '#SkBitmap_height' > height< / a > ).
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_writePixels_src' > src< / a > specifies width, height, < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , < a href = 'undocumented#Color_Space' > Color Space< / a > , pixel storage,
and row bytes of source. < a href = '#SkBitmap_writePixels_src' > src< / a > .< a href = '#SkBitmap_rowBytes' > rowBytes< / a > specifics the gap from one source
2017-10-04 18:31:33 +00:00
row to the next. Returns true if pixels are copied. Returns false if:
< table > < tr >
2018-05-16 11:07:07 +00:00
< td > < a href = '#SkBitmap_writePixels_src' > src< / a > pixel storage equals nullptr< / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_writePixels_src' > src< / a > .< a href = '#SkBitmap_rowBytes' > rowBytes< / a > is less than < a href = 'SkImageInfo_Reference#SkImageInfo_minRowBytes' > SkImageInfo::minRowBytes< / a > < / td >
< / tr > < tr >
< td > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is nullptr< / td >
< / tr >
2017-10-04 18:31:33 +00:00
< / table >
2018-05-16 11:07:07 +00:00
< a href = '#Pixels' > Pixels< / a > are copied only if pixel conversion is possible. If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_colorType' > colorType< / a > is
< a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , or < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > ; < a href = '#SkBitmap_writePixels_src' > src< / a > < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > must match.
If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , < a href = '#SkBitmap_writePixels_src' > src< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > must match.
If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_alphaType' > alphaType< / a > is < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a > , < a href = '#SkBitmap_writePixels_src' > src< / a > < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > must
match. If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_colorSpace' > colorSpace< / a > is nullptr, < a href = '#SkBitmap_writePixels_src' > src< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > must match. Returns
2017-10-04 18:31:33 +00:00
false if pixel conversion is not possible.
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_writePixels_dstX' > dstX< / a > and < a href = '#SkBitmap_writePixels_dstY' > dstY< / a > may be negative to copy only top or left of source. Returns
false if < a href = '#SkBitmap_width' > width< / a > or < a href = '#SkBitmap_height' > height< / a > is zero or negative.
Condense embedded formulas.
Bookmaker delimits formulas and equations to allow
representing variables and symbols without tripping
up reference lookup, spell checking, and comment
generation.
Before, formulas were represented with:
some text
#Formula
(x + y, 0)
##
, and more text
This made it difficult to know when spacing should
be preserved before and after the formula. Now,
formulas are represented with:
some text #Formula # (x + y, 0) ##, and more text
The presence or absence of a space between ## and ,
is now significant (before it was not).
Also, formulas are bracketed by <code> in markdown
generation, so that variables stand out better.
See:
https://skia.org/user/api/SkBlendMode_Reference?cl=152781#Dst_Out
for an example.
Also fixed 100 column offenders and added a code
check to identify them. For the moment, 100 column
offenders are outed with SkDebugf but their presence
does not cause bookmaker to fail.
TBR=caryclark@google.com
Docs-Preview: https://skia.org/?cl=152781
Bug: skia:6898
Change-Id: If92a65a234f5d616bf4485984a8d219a6f04821a
Reviewed-on: https://skia-review.googlesource.com/152781
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-09-13 16:04:30 +00:00
Returns false if < code > abs(dstX) >= < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_width' > width< / a > < / code > , or if < code > abs(dstY) >= < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_height' > height< / a > < / code > .
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_writePixels_src' > < code > < strong > src< / strong > < / code > < / a > < / td >
< td > source < a href = 'SkPixmap_Reference#Pixmap' > Pixmap< / a > : < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , pixels, row bytes< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_writePixels_dstX' > < code > < strong > dstX< / strong > < / code > < / a > < / td >
< td > column index whose absolute value is less than < a href = '#SkBitmap_width' > width< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_writePixels_dstY' > < code > < strong > dstY< / strong > < / code > < / a > < / td >
< td > row index whose absolute value is less than < a href = '#SkBitmap_height' > height< / a > < / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = '#SkBitmap_writePixels_src' > src< / a > pixels are copied to < a href = '#Bitmap' > Bitmap< / a >
2017-10-04 18:31:33 +00:00
### Example
< div > < fiddle-embed name = "9b3133a6673d2514d166398adbe1f9f4" > < / fiddle-embed > < / div >
### See Also
2018-07-17 17:19:56 +00:00
< a href = '#SkBitmap_readPixels' > readPixels< / a > < sup > < a href = '#SkBitmap_readPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_readPixels_3' > [3]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_writePixels_2' > < / a >
2018-01-26 17:56:22 +00:00
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_writePixels' > writePixels< / a > (const < a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > & src)
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Copies a < a href = 'SkRect_Reference#Rect' > Rect< / a > of pixels from < a href = '#SkBitmap_writePixels_2_src' > src< / a > . Copy starts at (0, 0), and does not exceed
(< a href = '#SkBitmap_writePixels_2_src' > src< / a > .< a href = '#SkBitmap_width' > width< / a > , < a href = '#SkBitmap_writePixels_2_src' > src< / a > .< a href = '#SkBitmap_height' > height< / a > ).
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_writePixels_2_src' > src< / a > specifies width, height, < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > , < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > , < a href = 'undocumented#Color_Space' > Color Space< / a > , pixel storage,
and row bytes of source. < a href = '#SkBitmap_writePixels_2_src' > src< / a > .< a href = '#SkBitmap_rowBytes' > rowBytes< / a > specifics the gap from one source
2017-10-04 18:31:33 +00:00
row to the next. Returns true if pixels are copied. Returns false if:
< table > < tr >
2018-05-16 11:07:07 +00:00
< td > < a href = '#SkBitmap_writePixels_2_src' > src< / a > pixel storage equals nullptr< / td >
< / tr > < tr >
< td > < a href = '#SkBitmap_writePixels_2_src' > src< / a > .< a href = '#SkBitmap_rowBytes' > rowBytes< / a > is less than < a href = 'SkImageInfo_Reference#SkImageInfo_minRowBytes' > SkImageInfo::minRowBytes< / a > < / td >
< / tr > < tr >
< td > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > is nullptr< / td >
< / tr >
2017-10-04 18:31:33 +00:00
< / table >
2018-05-16 11:07:07 +00:00
< a href = '#Pixels' > Pixels< / a > are copied only if pixel conversion is possible. If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_colorType' > colorType< / a > is
< a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , or < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > ; < a href = '#SkBitmap_writePixels_2_src' > src< / a > < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > must match.
If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_colorType' > colorType< / a > is < a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , < a href = '#SkBitmap_writePixels_2_src' > src< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > must match.
If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_alphaType' > alphaType< / a > is < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a > , < a href = '#SkBitmap_writePixels_2_src' > src< / a > < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > must
match. If < a href = '#Bitmap' > Bitmap< / a > < a href = '#SkBitmap_colorSpace' > colorSpace< / a > is nullptr, < a href = '#SkBitmap_writePixels_2_src' > src< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > must match. Returns
2017-10-04 18:31:33 +00:00
false if pixel conversion is not possible.
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_writePixels_2_src' > < code > < strong > src< / strong > < / code > < / a > < / td >
< td > source < a href = 'SkPixmap_Reference#Pixmap' > Pixmap< / a > : < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , pixels, row bytes< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = '#SkBitmap_writePixels_2_src' > src< / a > pixels are copied to < a href = '#Bitmap' > Bitmap< / a >
2017-10-04 18:31:33 +00:00
### Example
< div > < fiddle-embed name = "faa5dfa466f6e16c07c124d971f32679" > < / fiddle-embed > < / div >
### See Also
2018-07-17 17:19:56 +00:00
< a href = '#SkBitmap_readPixels' > readPixels< / a > < sup > < a href = '#SkBitmap_readPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_readPixels_3' > [3]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_hasHardwareMipMap' > < / a >
2017-10-04 18:31:33 +00:00
## hasHardwareMipMap
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_hasHardwareMipMap' > hasHardwareMipMap< / a > () const
2017-10-04 18:31:33 +00:00
< / pre >
2018-06-27 15:00:21 +00:00
For use by Android framework only.
2018-05-16 11:07:07 +00:00
2017-10-04 18:31:33 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = '#SkBitmap_setHasHardwareMipMap' > setHasHardwareMipMap< / a > has been called with true
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_setHasHardwareMipMap' > setHasHardwareMipMap< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_setHasHardwareMipMap' > < / a >
2017-10-04 18:31:33 +00:00
## setHasHardwareMipMap
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_setHasHardwareMipMap' > setHasHardwareMipMap< / a > (bool < a href = '#SkBitmap_hasHardwareMipMap' > hasHardwareMipMap< / a > )
2017-10-04 18:31:33 +00:00
< / pre >
2018-06-27 15:00:21 +00:00
For use by Android framework only.
2018-05-16 11:07:07 +00:00
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_setHasHardwareMipMap_hasHardwareMipMap' > < code > < strong > hasHardwareMipMap< / strong > < / code > < / a > < / td >
< td > sets state< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_hasHardwareMipMap' > hasHardwareMipMap< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_extractAlpha' > < / a >
2017-10-04 18:31:33 +00:00
## extractAlpha
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_extractAlpha' > extractAlpha< / a > (< a href = '#SkBitmap' > SkBitmap< / a > * dst) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets < a href = '#SkBitmap_extractAlpha_dst' > dst< / a > to < a href = 'SkColor_Reference#Alpha' > Alpha< / a > described by pixels. Returns false if < a href = '#SkBitmap_extractAlpha_dst' > dst< / a > cannot be written to
or < a href = '#SkBitmap_extractAlpha_dst' > dst< / a > pixels cannot be allocated.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
Uses < a href = '#SkBitmap_HeapAllocator' > HeapAllocator< / a > to reserve memory for < a href = '#SkBitmap_extractAlpha_dst' > dst< / a > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > .
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_extractAlpha_dst' > < code > < strong > dst< / strong > < / code > < / a > < / td >
< td > holds < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > to fill with alpha layer< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = 'SkColor_Reference#Alpha' > Alpha< / a > layer was constructed in < a href = '#SkBitmap_extractAlpha_dst' > dst< / a > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a >
2017-10-04 18:31:33 +00:00
### Example
< div > < fiddle-embed name = "ab6577df079e6c70511cf2bfc6447b44" > < / fiddle-embed > < / div >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_extractSubset' > extractSubset< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_extractAlpha_2' > < / a >
2018-01-26 17:56:22 +00:00
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_extractAlpha' > extractAlpha< / a > (< a href = '#SkBitmap' > SkBitmap< / a > * dst, const < a href = 'SkPaint_Reference#SkPaint' > SkPaint< / a > * paint, < a href = 'SkIPoint_Reference#SkIPoint' > SkIPoint< / a > * offset) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets < a href = '#SkBitmap_extractAlpha_2_dst' > dst< / a > to < a href = 'SkColor_Reference#Alpha' > Alpha< / a > described by pixels. Returns false if < a href = '#SkBitmap_extractAlpha_2_dst' > dst< / a > cannot be written to
or < a href = '#SkBitmap_extractAlpha_2_dst' > dst< / a > pixels cannot be allocated.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
If < a href = '#SkBitmap_extractAlpha_2_paint' > paint< / a > is not nullptr and contains < a href = 'undocumented#Mask_Filter' > Mask Filter< / a > , < a href = 'undocumented#SkMaskFilter' > SkMaskFilter< / a >
generates < a href = 'undocumented#Mask_Alpha' > Mask Alpha< / a > from < a href = '#Bitmap' > Bitmap< / a > . Uses < a href = '#SkBitmap_HeapAllocator' > HeapAllocator< / a > to reserve memory for < a href = '#SkBitmap_extractAlpha_2_dst' > dst< / a >
< a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > . Sets < a href = '#SkBitmap_extractAlpha_2_offset' > offset< / a > to top-left position for < a href = '#SkBitmap_extractAlpha_2_dst' > dst< / a > for alignment with < a href = '#Bitmap' > Bitmap< / a > ;
(0, 0) unless < a href = 'undocumented#SkMaskFilter' > SkMaskFilter< / a > generates mask.
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_extractAlpha_2_dst' > < code > < strong > dst< / strong > < / code > < / a > < / td >
< td > holds < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > to fill with alpha layer< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_extractAlpha_2_paint' > < code > < strong > paint< / strong > < / code > < / a > < / td >
< td > holds optional < a href = 'undocumented#Mask_Filter' > Mask Filter< / a > ; may be nullptr< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_extractAlpha_2_offset' > < code > < strong > offset< / strong > < / code > < / a > < / td >
< td > top-left position for < a href = '#SkBitmap_extractAlpha_2_dst' > dst< / a > ; may be nullptr< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = 'SkColor_Reference#Alpha' > Alpha< / a > layer was constructed in < a href = '#SkBitmap_extractAlpha_2_dst' > dst< / a > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-07-18 20:21:51 +00:00
< div > < fiddle-embed name = "092739b4cd5d732a27c07ced8ef45f01" > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_extractSubset' > extractSubset< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_extractAlpha_3' > < / a >
2018-01-26 17:56:22 +00:00
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_extractAlpha' > extractAlpha< / a > (< a href = '#SkBitmap' > SkBitmap< / a > * dst, const < a href = 'SkPaint_Reference#SkPaint' > SkPaint< / a > * paint, < a href = '#SkBitmap_Allocator' > Allocator< / a > * allocator, < a href = 'SkIPoint_Reference#SkIPoint' > SkIPoint< / a > * offset) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Sets < a href = '#SkBitmap_extractAlpha_3_dst' > dst< / a > to < a href = 'SkColor_Reference#Alpha' > Alpha< / a > described by pixels. Returns false if < a href = '#SkBitmap_extractAlpha_3_dst' > dst< / a > cannot be written to
or < a href = '#SkBitmap_extractAlpha_3_dst' > dst< / a > pixels cannot be allocated.
2017-10-04 18:31:33 +00:00
2018-05-16 11:07:07 +00:00
If < a href = '#SkBitmap_extractAlpha_3_paint' > paint< / a > is not nullptr and contains < a href = 'undocumented#Mask_Filter' > Mask Filter< / a > , < a href = 'undocumented#SkMaskFilter' > SkMaskFilter< / a >
generates < a href = 'undocumented#Mask_Alpha' > Mask Alpha< / a > from < a href = '#Bitmap' > Bitmap< / a > . < a href = '#SkBitmap_extractAlpha_3_allocator' > allocator< / a > may reference a custom allocation
class or be set to nullptr to use < a href = '#SkBitmap_HeapAllocator' > HeapAllocator< / a > . Sets < a href = '#SkBitmap_extractAlpha_3_offset' > offset< / a > to top-left
position for < a href = '#SkBitmap_extractAlpha_3_dst' > dst< / a > for alignment with < a href = '#Bitmap' > Bitmap< / a > ; (0, 0) unless < a href = 'undocumented#SkMaskFilter' > SkMaskFilter< / a > generates
2017-10-04 18:31:33 +00:00
mask.
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_extractAlpha_3_dst' > < code > < strong > dst< / strong > < / code > < / a > < / td >
< td > holds < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > to fill with alpha layer< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_extractAlpha_3_paint' > < code > < strong > paint< / strong > < / code > < / a > < / td >
< td > holds optional < a href = 'undocumented#Mask_Filter' > Mask Filter< / a > ; may be nullptr< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_extractAlpha_3_allocator' > < code > < strong > allocator< / strong > < / code > < / a > < / td >
< td > function to reserve memory for < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a > ; may be nullptr< / td >
< / tr >
< tr > < td > < a name = 'SkBitmap_extractAlpha_3_offset' > < code > < strong > offset< / strong > < / code > < / a > < / td >
< td > top-left position for < a href = '#SkBitmap_extractAlpha_3_dst' > dst< / a > ; may be nullptr< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = 'SkColor_Reference#Alpha' > Alpha< / a > layer was constructed in < a href = '#SkBitmap_extractAlpha_3_dst' > dst< / a > < a href = 'undocumented#Pixel_Ref' > Pixel Ref< / a >
2017-10-04 18:31:33 +00:00
### Example
2018-07-19 14:50:44 +00:00
< div > < fiddle-embed name = "cd7543fa8c9f3cede46dc2d72eb8c4bd" > < / fiddle-embed > < / div >
2017-10-04 18:31:33 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkBitmap_extractSubset' > extractSubset< / a >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkBitmap_peekPixels' > < / a >
2017-10-04 18:31:33 +00:00
## peekPixels
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkBitmap_peekPixels' > peekPixels< / a > (< a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > * pixmap) const
2017-10-04 18:31:33 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Copies < a href = '#Bitmap' > Bitmap< / a > pixel address, row bytes, and < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > to pixmap, if address
2017-10-26 11:58:48 +00:00
is available, and returns true. If pixel address is not available, return
2018-01-26 17:56:22 +00:00
false and leave pixmap unchanged.
2017-10-26 11:58:48 +00:00
2018-05-16 11:07:07 +00:00
pixmap contents become invalid on any future change to < a href = '#Bitmap' > Bitmap< / a > .
2017-10-04 18:31:33 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkBitmap_peekPixels_pixmap' > < code > < strong > pixmap< / strong > < / code > < / a > < / td >
< td > storage for pixel state if pixels are readable; otherwise, ignored< / td >
2017-10-04 18:31:33 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = '#Bitmap' > Bitmap< / a > has direct access to pixels
2017-10-04 18:31:33 +00:00
### Example
< div > < fiddle-embed name = "0cc2c6a0dffa61a88711534bd3d43b40" >
#### Example Output
~~~~
------
2017-11-27 15:44:06 +00:00
-xxx--
x---x-
2017-10-04 18:31:33 +00:00
----x-
2017-11-27 15:44:06 +00:00
---x--
--x---
2017-10-04 18:31:33 +00:00
--x---
------
--x---
--x---
------
~~~~
< / fiddle-embed > < / div >
### See Also
2018-07-17 17:19:56 +00:00
< a href = '#SkBitmap_pixmap' > pixmap< / a > < a href = '#SkBitmap_installPixels' > installPixels< / a > < sup > < a href = '#SkBitmap_installPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_installPixels_3' > [3]< / a > < / sup > < a href = '#SkBitmap_readPixels' > readPixels< / a > < sup > < a href = '#SkBitmap_readPixels_2' > [2]< / a > < / sup > < sup > < a href = '#SkBitmap_readPixels_3' > [3]< / a > < / sup > < a href = '#SkBitmap_writePixels' > writePixels< / a > < sup > < a href = '#SkBitmap_writePixels_2' > [2]< / a > < / sup >
2017-10-04 18:31:33 +00:00
---
2018-05-16 11:07:07 +00:00
## <a name='Utility'>Utility</a>
2018-02-07 12:27:09 +00:00
2018-05-16 11:07:07 +00:00
< table style = 'border-collapse: collapse; width: 62.5em' >
< tr >< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Topic</ th >
< th style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > Description</ th ></ tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_ComputeIsOpaque' > ComputeIsOpaque</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns true if all pixels are opaque</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_computeByteSize' > computeByteSize</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns size required for pixels</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_getGenerationID' > getGenerationID</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns unique ID</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_readyToDraw' > readyToDraw</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > returns true if address of pixels is not nullptr</ td >
< / tr >
< tr style = 'background-color: #f0f0f0 ; ' >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_swap' > swap</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > exchanges < a href = '#Bitmap' > Bitmap</ a > pair</ td >
< / tr >
< tr >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a href = '#SkBitmap_validate' > validate</ a ></ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' > asserts if < a href = '#Bitmap' > Bitmap</ a > is invalid (debug only)</ td >
< / tr >
< / table >
< a name = 'SkBitmap_validate' > < / a >
2017-10-26 11:58:48 +00:00
## validate
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
void < a href = '#SkBitmap_validate' > validate< / a > () const;
2017-10-26 11:58:48 +00:00
< / pre >
2018-01-04 21:11:51 +00:00
Asserts if internal values are illegal or inconsistent. Only available if
SK_DEBUG is defined at compile time.
2017-10-26 11:58:48 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = 'SkImageInfo_Reference#SkImageInfo_validate' > SkImageInfo::validate< / a >
2017-10-26 11:58:48 +00:00
---
