2017-11-27 15:44:06 +00:00
SkImage Reference
===
2018-10-08 18:57:48 +00:00
< a name = 'SkImage' > < / a >
2017-11-27 15:44:06 +00:00
2018-10-08 18:57:48 +00:00
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
class < a href = '#SkImage' > SkImage< / a > : public < a href = 'undocumented#SkRefCnt' > SkRefCnt< / a > {
public:
typedef void* < a href = '#SkImage_ReleaseContext' > ReleaseContext< / a > ;
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeRasterCopy' > MakeRasterCopy< / a > (const < a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > & pixmap);
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeRasterData' > MakeRasterData< / a > (const < a href = 'SkImageInfo_Reference#SkImageInfo' > SkImageInfo< / a > & info, sk_sp< < a href = 'undocumented#SkData' > SkData< / a > > pixels,
size_t rowBytes);
typedef void (*< a href = '#SkImage_RasterReleaseProc' > RasterReleaseProc< / a > )(const void* pixels, < a href = '#SkImage_ReleaseContext' > ReleaseContext< / a > );
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromRaster' > MakeFromRaster< / a > (const < a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > & pixmap,
< a href = '#SkImage_RasterReleaseProc' > RasterReleaseProc< / a > rasterReleaseProc,
< a href = '#SkImage_ReleaseContext' > ReleaseContext< / a > releaseContext);
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromBitmap' > MakeFromBitmap< / a > (const < a href = 'SkBitmap_Reference#SkBitmap' > SkBitmap< / a > & bitmap);
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromGenerator' > MakeFromGenerator< / a > (std::unique_ptr< < a href = 'undocumented#SkImageGenerator' > SkImageGenerator< / a > > imageGenerator,
const < a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > * subset = nullptr);
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromEncoded' > MakeFromEncoded< / a > (sk_sp< < a href = 'undocumented#SkData' > SkData< / a > > encoded, const < a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > * subset = nullptr);
typedef void (*< a href = '#SkImage_TextureReleaseProc' > TextureReleaseProc< / a > )(< a href = '#SkImage_ReleaseContext' > ReleaseContext< / a > releaseContext);
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromTexture' > MakeFromTexture< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context,
const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > & backendTexture,
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > origin,
< a href = 'SkImageInfo_Reference#SkColorType' > SkColorType< / a > colorType,
< a href = 'SkImageInfo_Reference#SkAlphaType' > SkAlphaType< / a > alphaType,
sk_sp< < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > colorSpace);
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromTexture_2' > MakeFromTexture< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context,
const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > & backendTexture,
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > origin,
< a href = 'SkImageInfo_Reference#SkColorType' > SkColorType< / a > colorType,
< a href = 'SkImageInfo_Reference#SkAlphaType' > SkAlphaType< / a > alphaType,
sk_sp< < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > colorSpace,
< a href = '#SkImage_TextureReleaseProc' > TextureReleaseProc< / a > textureReleaseProc,
< a href = '#SkImage_ReleaseContext' > ReleaseContext< / a > releaseContext);
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeCrossContextFromEncoded' > MakeCrossContextFromEncoded< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context, sk_sp< < a href = 'undocumented#SkData' > SkData< / a > > data,
bool buildMips, < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > * dstColorSpace,
bool limitToMaxTextureSize = false);
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeCrossContextFromPixmap' > MakeCrossContextFromPixmap< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context, const < a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > & pixmap,
bool buildMips, < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > * dstColorSpace,
bool limitToMaxTextureSize = false);
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromAdoptedTexture' > MakeFromAdoptedTexture< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context,
const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > & backendTexture,
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > surfaceOrigin,
< a href = 'SkImageInfo_Reference#SkColorType' > SkColorType< / a > colorType,
< a href = 'SkImageInfo_Reference#SkAlphaType' > SkAlphaType< / a > alphaType = < a href = 'SkImageInfo_Reference#kPremul_SkAlphaType' > kPremul_SkAlphaType< / a > ,
sk_sp< < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > colorSpace = nullptr);
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromYUVATexturesCopy' > MakeFromYUVATexturesCopy< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context,
< a href = 'SkImageInfo_Reference#SkYUVColorSpace' > SkYUVColorSpace< / a > yuvColorSpace,
const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > yuvaTextures[],
const < a href = 'undocumented#SkYUVAIndex' > SkYUVAIndex< / a > yuvaIndices[4],
< a href = 'undocumented#SkISize' > SkISize< / a > imageSize,
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > imageOrigin,
sk_sp< < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > imageColorSpace = nullptr);
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromYUVATexturesCopyWithExternalBackend' > MakeFromYUVATexturesCopyWithExternalBackend< / a > (
< a href = 'undocumented#GrContext' > GrContext< / a > * context,
< a href = 'SkImageInfo_Reference#SkYUVColorSpace' > SkYUVColorSpace< / a > yuvColorSpace,
const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > yuvaTextures[],
const < a href = 'undocumented#SkYUVAIndex' > SkYUVAIndex< / a > yuvaIndices[4],
< a href = 'undocumented#SkISize' > SkISize< / a > imageSize,
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > imageOrigin,
const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > & backendTexture,
sk_sp< < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > imageColorSpace = nullptr);
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromYUVTexturesCopy' > MakeFromYUVTexturesCopy< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context, < a href = 'SkImageInfo_Reference#SkYUVColorSpace' > SkYUVColorSpace< / a > yuvColorSpace,
const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > yuvTextures[3],
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > imageOrigin,
sk_sp< < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > imageColorSpace = nullptr);
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromYUVTexturesCopyWithExternalBackend' > MakeFromYUVTexturesCopyWithExternalBackend< / a > (
< a href = 'undocumented#GrContext' > GrContext< / a > * context, < a href = 'SkImageInfo_Reference#SkYUVColorSpace' > SkYUVColorSpace< / a > yuvColorSpace,
const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > yuvTextures[3], < a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > imageOrigin,
const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > & backendTexture, sk_sp< < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > imageColorSpace = nullptr);
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromNV12TexturesCopy' > MakeFromNV12TexturesCopy< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context,
< a href = 'SkImageInfo_Reference#SkYUVColorSpace' > SkYUVColorSpace< / a > yuvColorSpace,
const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > nv12Textures[2],
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > imageOrigin,
sk_sp< < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > imageColorSpace = nullptr);
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromNV12TexturesCopyWithExternalBackend' > MakeFromNV12TexturesCopyWithExternalBackend< / a > (
< a href = 'undocumented#GrContext' > GrContext< / a > * context,
< a href = 'SkImageInfo_Reference#SkYUVColorSpace' > SkYUVColorSpace< / a > yuvColorSpace,
const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > nv12Textures[2],
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > imageOrigin,
const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > & backendTexture,
sk_sp< < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > imageColorSpace = nullptr);
2018-02-01 14:37:32 +00:00
2018-10-08 18:57:48 +00:00
enum class < a href = '#SkImage_BitDepth' > BitDepth< / a > {
< a href = '#SkImage_BitDepth_kU8' > kU8< / a > ,
< a href = '#SkImage_BitDepth_kF16' > kF16< / a > ,
};
2018-02-01 14:37:32 +00:00
2018-10-08 18:57:48 +00:00
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromPicture' > MakeFromPicture< / a > (sk_sp< < a href = 'SkPicture_Reference#SkPicture' > SkPicture< / a > > picture, const < a href = 'undocumented#SkISize' > SkISize< / a > & dimensions,
const < a href = 'SkMatrix_Reference#SkMatrix' > SkMatrix< / a > * matrix, const < a href = 'SkPaint_Reference#SkPaint' > SkPaint< / a > * paint,
< a href = '#SkImage_BitDepth' > BitDepth< / a > bitDepth,
sk_sp< < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > colorSpace);
static < a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromAHardwareBuffer' > MakeFromAHardwareBuffer< / a > (
AHardwareBuffer* hardwareBuffer,
< a href = 'SkImageInfo_Reference#SkAlphaType' > SkAlphaType< / a > alphaType = < a href = 'SkImageInfo_Reference#kPremul_SkAlphaType' > kPremul_SkAlphaType< / a > ,
sk_sp< < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > colorSpace = nullptr,
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > surfaceOrigin = < a href = 'undocumented#kTopLeft_GrSurfaceOrigin' > kTopLeft_GrSurfaceOrigin< / a > );
int < a href = '#SkImage_width' > width< / a > () const;
int < a href = '#SkImage_height' > height< / a > () const;
< a href = 'undocumented#SkISize' > SkISize< / a > < a href = '#SkImage_dimensions' > dimensions< / a > () const;
< a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > < a href = '#SkImage_bounds' > bounds< / a > () const;
uint32_t < a href = '#SkImage_uniqueID' > uniqueID< / a > () const;
< a href = 'SkImageInfo_Reference#SkAlphaType' > SkAlphaType< / a > < a href = '#SkImage_alphaType' > alphaType< / a > () const;
< a href = 'SkImageInfo_Reference#SkColorType' > SkColorType< / a > < a href = '#SkImage_colorType' > colorType< / a > () const;
< a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > * < a href = '#SkImage_colorSpace' > colorSpace< / a > () const;
< a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > < a href = '#SkImage_refColorSpace' > refColorSpace< / a > () const;
bool < a href = '#SkImage_isAlphaOnly' > isAlphaOnly< / a > () const;
bool < a href = '#SkImage_isOpaque' > isOpaque< / a > () const;
< a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = 'undocumented#SkShader' > SkShader< / a > > < a href = '#SkImage_makeShader' > makeShader< / a > (< a href = 'undocumented#SkShader_TileMode' > SkShader::TileMode< / a > tileMode1, < a href = 'undocumented#SkShader_TileMode' > SkShader::TileMode< / a > tileMode2,
const < a href = 'SkMatrix_Reference#SkMatrix' > SkMatrix< / a > * localMatrix = nullptr) const;
< a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = 'undocumented#SkShader' > SkShader< / a > > < a href = '#SkImage_makeShader_2' > makeShader< / a > (const < a href = 'SkMatrix_Reference#SkMatrix' > SkMatrix< / a > * localMatrix = nullptr) const;
bool < a href = '#SkImage_peekPixels' > peekPixels< / a > (< a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > * pixmap) const;
GrTexture* < a href = '#SkImage_getTexture' > getTexture< / a > () const;
bool < a href = '#SkImage_isTextureBacked' > isTextureBacked< / a > () const;
bool < a href = '#SkImage_isValid' > isValid< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context) const;
< a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > < a href = '#SkImage_getBackendTexture' > getBackendTexture< / a > (bool flushPendingGrContextIO,
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > * origin = nullptr) const;
2018-02-01 14:37:32 +00:00
2018-10-08 18:57:48 +00:00
enum < a href = '#SkImage_CachingHint' > CachingHint< / a > {
< a href = '#SkImage_kAllow_CachingHint' > kAllow_CachingHint< / a > ,
< a href = '#SkImage_kDisallow_CachingHint' > kDisallow_CachingHint< / a > ,
};
2018-05-16 11:07:07 +00:00
2018-10-08 18:57:48 +00:00
bool < a href = '#SkImage_readPixels' > readPixels< / a > (const < a href = 'SkImageInfo_Reference#SkImageInfo' > SkImageInfo< / a > & dstInfo, void* dstPixels, size_t dstRowBytes,
int srcX, int srcY, < a href = '#SkImage_CachingHint' > CachingHint< / a > cachingHint = < a href = '#SkImage_kAllow_CachingHint' > kAllow_CachingHint< / a > ) const;
bool < a href = '#SkImage_readPixels_2' > readPixels< / a > (const < a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > & dst, int srcX, int srcY,
< a href = '#SkImage_CachingHint' > CachingHint< / a > cachingHint = < a href = '#SkImage_kAllow_CachingHint' > kAllow_CachingHint< / a > ) const;
bool < a href = '#SkImage_scalePixels' > scalePixels< / a > (const < a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > & dst, < a href = 'undocumented#SkFilterQuality' > SkFilterQuality< / a > filterQuality,
< a href = '#SkImage_CachingHint' > CachingHint< / a > cachingHint = < a href = '#SkImage_kAllow_CachingHint' > kAllow_CachingHint< / a > ) const;
< a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = 'undocumented#SkData' > SkData< / a > > < a href = '#SkImage_encodeToData' > encodeToData< / a > (< a href = 'undocumented#SkEncodedImageFormat' > SkEncodedImageFormat< / a > encodedImageFormat, int quality) const;
< a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = 'undocumented#SkData' > SkData< / a > > < a href = '#SkImage_encodeToData_2' > encodeToData< / a > () const;
< a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = 'undocumented#SkData' > SkData< / a > > < a href = '#SkImage_refEncodedData' > refEncodedData< / a > () const;
< a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_makeSubset' > makeSubset< / a > (const < a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > & subset) const;
< a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_makeTextureImage' > makeTextureImage< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context, < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > * dstColorSpace,
< a href = 'undocumented#GrMipMapped' > GrMipMapped< / a > mipMapped = < a href = 'undocumented#GrMipMapped_kNo' > GrMipMapped::kNo< / a > ) const;
< a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_makeNonTextureImage' > makeNonTextureImage< / a > () const;
< a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_makeRasterImage' > makeRasterImage< / a > () const;
< a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_makeWithFilter' > makeWithFilter< / a > (const < a href = 'undocumented#SkImageFilter' > SkImageFilter< / a > * filter, const < a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > & subset,
const < a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > & clipBounds, < a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > * outSubset,
< a href = 'SkIPoint_Reference#SkIPoint' > SkIPoint< / a > * offset) const;
typedef std::function< void ( GrBackendTexture ) > < a href = '#SkImage_BackendTextureReleaseProc' > BackendTextureReleaseProc< / a > ;
static bool < a href = '#SkImage_MakeBackendTextureFromSkImage' > MakeBackendTextureFromSkImage< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context,
sk_sp< < a href = '#SkImage' > SkImage< / a > > image,
< a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > * backendTexture,
< a href = '#SkImage_BackendTextureReleaseProc' > BackendTextureReleaseProc< / a > * backendTextureReleaseProc);
2018-01-02 16:34:14 +00:00
2018-10-08 18:57:48 +00:00
enum < a href = '#SkImage_LegacyBitmapMode' > LegacyBitmapMode< / a > {
< a href = '#SkImage_kRO_LegacyBitmapMode' > kRO_LegacyBitmapMode< / a > ,
};
2018-01-02 16:34:14 +00:00
2018-10-13 05:30:17 +00:00
bool < a href = '#SkImage_asLegacyBitmap' > asLegacyBitmap< / a > (< a href = 'SkBitmap_Reference#SkBitmap' > SkBitmap< / a > * bitmap,
< a href = '#SkImage_LegacyBitmapMode' > LegacyBitmapMode< / a > legacyBitmapMode = < a href = '#SkImage_kRO_LegacyBitmapMode' > kRO_LegacyBitmapMode< / a > ) const;
2018-10-08 18:57:48 +00:00
bool < a href = '#SkImage_isLazyGenerated' > isLazyGenerated< / a > () const;
< a href = 'undocumented#sk_sp' > sk_sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_makeColorSpace' > makeColorSpace< / a > (sk_sp< < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > target) const;
};
< / pre >
2018-06-27 15:00:21 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > describes a two dimensional array of pixels to draw. The pixels may be
2018-06-27 15:00:21 +00:00
decoded in a < a href = 'undocumented#Raster_Bitmap' > Raster Bitmap< / a > , encoded in a < a href = 'SkPicture_Reference#Picture' > Picture< / a > or compressed data stream,
2018-05-16 11:07:07 +00:00
or located in GPU memory as a < a href = 'undocumented#GPU_Texture' > GPU Texture< / a > .
< a href = '#Image' > Image< / a > cannot be modified after it is created. < a href = '#Image' > Image< / a > may allocate additional
storage as needed; for instance, an encoded < a href = '#Image' > Image< / a > may decode when drawn.
< a href = '#Image' > Image< / a > width and height are greater than zero. Creating an < a href = '#Image' > Image< / a > with zero width
or height returns < a href = '#Image' > Image< / a > equal to nullptr.
2018-06-27 15:00:21 +00:00
< a href = '#Image' > Image< / a > may be created from < a href = 'SkBitmap_Reference#Bitmap' > Bitmap< / a > , < a href = 'SkPixmap_Reference#Pixmap' > Pixmap< / a > , < a href = 'SkSurface_Reference#Surface' > Surface< / a > , < a href = 'SkPicture_Reference#Picture' > Picture< / a > , encoded streams,
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#GPU_Texture' > GPU Texture< / a > , < a href = 'SkImageInfo_Reference#YUV_ColorSpace' > YUV ColorSpace< / a > data, or hardware buffer. Encoded streams supported
2018-02-06 14:41:53 +00:00
include BMP, GIF, HEIF, ICO, JPEG, PNG, WBMP, WebP. Supported encoding details
2018-01-02 16:34:14 +00:00
vary with platform.
2018-05-16 11:07:07 +00:00
## <a name='Raster_Image'>Raster Image</a>
2018-02-01 14:37:32 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Raster_Image' > Raster Image< / a > pixels are decoded in a < a href = 'undocumented#Raster_Bitmap' > Raster Bitmap< / a > . These pixels may be read
2018-01-02 16:34:14 +00:00
directly and in most cases written to, although edited pixels may not be drawn
2018-05-16 11:07:07 +00:00
if < a href = '#Image' > Image< / a > has been copied internally.
2018-01-02 16:34:14 +00:00
2018-05-16 11:07:07 +00:00
## <a name='Texture_Image'>Texture Image</a>
2018-02-01 14:37:32 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Texture_Image' > Texture Image< / a > are located on GPU and pixels are not accessible. < a href = '#Texture_Image' > Texture Image< / a >
are allocated optimally for best performance. < a href = '#Raster_Image' > Raster Image< / a > may
be drawn to < a href = 'undocumented#GPU_Surface' > GPU Surface< / a > , but pixels are uploaded from CPU to GPU downgrading
2018-01-02 16:34:14 +00:00
performance.
2018-05-16 11:07:07 +00:00
## <a name='Lazy_Image'>Lazy Image</a>
2018-02-01 14:37:32 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Lazy_Image' > Lazy Image< / a > defer allocating buffer for < a href = '#Image' > Image< / a > pixels and decoding stream until
< a href = '#Image' > Image< / a > is drawn. < a href = '#Lazy_Image' > Lazy Image< / a > caches result if possible to speed up repeated
2018-01-02 16:34:14 +00:00
drawing.
2017-11-27 15:44:06 +00:00
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_MakeRasterCopy' > < / a >
2017-11-27 15:44:06 +00:00
## MakeRasterCopy
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeRasterCopy' > MakeRasterCopy< / a > (const < a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > & pixmap)
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = '#Image' > Image< / a > from < a href = 'SkPixmap_Reference#Pixmap' > Pixmap< / a > and copy of pixels. Since pixels are copied, < a href = 'SkPixmap_Reference#Pixmap' > Pixmap< / a >
pixels may be modified or deleted without affecting < a href = '#Image' > Image< / a > .
2017-12-01 16:49:58 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > is returned if < a href = 'SkPixmap_Reference#Pixmap' > Pixmap< / a > is valid. Valid < a href = 'SkPixmap_Reference#Pixmap' > Pixmap< / a > parameters include:
2018-01-26 17:56:22 +00:00
dimensions are greater than zero;
2017-12-01 16:49:58 +00:00
each dimension fits in 29 bits;
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 > are valid, and < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > is not < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > ;
2017-12-01 16:49:58 +00:00
row bytes are large enough to hold one row of pixels;
pixel address is not nullptr.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_MakeRasterCopy_pixmap' > < code > < strong > pixmap< / strong > < / code > < / a > < / td >
< td > < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , pixel address, and row bytes< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
copy of < a href = 'SkPixmap_Reference#Pixmap' > Pixmap< / a > pixels, or nullptr
2017-11-27 15:44:06 +00:00
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "513afec5795a9504ebf6af5373d16b6b" > < div > Draw a five by five bitmap, and draw a copy in an < a href = '#Image' > Image< / a > . Editing the < a href = '#SkImage_MakeRasterCopy_pixmap' > pixmap< / a >
alters the bitmap draw, but does not alter the < a href = '#Image' > Image< / a > draw since the < a href = '#Image' > Image< / a >
2018-03-05 18:26:16 +00:00
contains a copy of the pixels.
< / div > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeRasterData' > MakeRasterData< / a > < a href = '#SkImage_MakeFromGenerator' > MakeFromGenerator< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_MakeRasterData' > < / a >
2017-11-27 15:44:06 +00:00
## MakeRasterData
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeRasterData' > MakeRasterData< / a > (const < a href = 'SkImageInfo_Reference#SkImageInfo' > SkImageInfo< / a > & info, < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkData' > SkData< / a > > pixels, size_t rowBytes)
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = '#Image' > Image< / a > from < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , sharing < a href = '#SkImage_MakeRasterData_pixels' > pixels< / a > .
2017-12-01 16:49:58 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > is returned if < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > is valid. Valid < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > parameters include:
2018-01-26 17:56:22 +00:00
dimensions are greater than zero;
2017-12-01 16:49:58 +00:00
each dimension fits in 29 bits;
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 > are valid, and < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > is not < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > ;
< a href = '#SkImage_MakeRasterData_rowBytes' > rowBytes< / a > are large enough to hold one row of < a href = '#SkImage_MakeRasterData_pixels' > pixels< / a > ;
< a href = '#SkImage_MakeRasterData_pixels' > pixels< / a > is not nullptr, and contains enough data for < a href = '#Image' > Image< / a > .
2017-12-01 16:49:58 +00:00
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_MakeRasterData_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 = 'SkImage_MakeRasterData_pixels' > < code > < strong > pixels< / strong > < / code > < / a > < / td >
< td > address or pixel storage< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeRasterData_rowBytes' > < code > < strong > rowBytes< / strong > < / code > < / a > < / td >
< td > size of pixel row or larger< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > sharing < a href = '#SkImage_MakeRasterData_pixels' > pixels< / a > , or nullptr
2017-11-27 15:44:06 +00:00
### Example
2018-05-16 11:07:07 +00:00
< div > < fiddle-embed name = "22e7ce79ab2fe94252d23319f2258127" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeRasterCopy' > MakeRasterCopy< / a > < a href = '#SkImage_MakeFromGenerator' > MakeFromGenerator< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-17 16:17:28 +00:00
## <a name='SkImage_ReleaseContext'>Typedef SkImage::ReleaseContext</a>
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
typedef void* < a href = '#SkImage_ReleaseContext' > ReleaseContext< / a > ;
< / pre >
2018-05-16 11:07:07 +00:00
Caller data passed to < a href = '#SkImage_RasterReleaseProc' > RasterReleaseProc< / a > ; may be nullptr.
2017-12-01 16:49:58 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeFromRaster' > MakeFromRaster< / a > < a href = '#SkImage_RasterReleaseProc' > RasterReleaseProc< / a >
2017-12-01 16:49:58 +00:00
2018-05-17 16:17:28 +00:00
## <a name='SkImage_RasterReleaseProc'>Typedef SkImage::RasterReleaseProc</a>
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
typedef void (*< a href = '#SkImage_RasterReleaseProc' > RasterReleaseProc< / a > )(const void* pixels, < a href = '#SkImage_ReleaseContext' > ReleaseContext< / a > );
< / pre >
2018-05-16 11:07:07 +00:00
Function called when < a href = '#Image' > Image< / a > no longer shares pixels. < a href = '#SkImage_ReleaseContext' > ReleaseContext< / a > is
provided by caller when < a href = '#Image' > Image< / a > is created, and may be nullptr.
2017-12-01 16:49:58 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_ReleaseContext' > ReleaseContext< / a > < a href = '#SkImage_MakeFromRaster' > MakeFromRaster< / a >
2017-12-01 16:49:58 +00:00
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_MakeFromRaster' > < / a >
2017-11-27 15:44:06 +00:00
## MakeFromRaster
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromRaster' > MakeFromRaster< / a > (const < a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > & pixmap, < a href = '#SkImage_RasterReleaseProc' > RasterReleaseProc< / a > rasterReleaseProc,
< a href = '#SkImage_ReleaseContext' > ReleaseContext< / a > releaseContext)
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = '#Image' > Image< / a > from < a href = '#SkImage_MakeFromRaster_pixmap' > pixmap< / a > , sharing < a href = 'SkPixmap_Reference#Pixmap' > Pixmap< / a > pixels. < a href = '#Pixels' > Pixels< / a > must remain valid and
unchanged until < a href = '#SkImage_MakeFromRaster_rasterReleaseProc' > rasterReleaseProc< / a > is called. < a href = '#SkImage_MakeFromRaster_rasterReleaseProc' > rasterReleaseProc< / a > is passed
< a href = '#SkImage_MakeFromRaster_releaseContext' > releaseContext< / a > when < a href = '#Image' > Image< / a > is deleted or no longer refers to < a href = '#SkImage_MakeFromRaster_pixmap' > pixmap< / a > pixels.
2017-12-01 16:49:58 +00:00
2018-05-16 11:07:07 +00:00
Pass nullptr for < a href = '#SkImage_MakeFromRaster_rasterReleaseProc' > rasterReleaseProc< / a > to share < a href = 'SkPixmap_Reference#Pixmap' > Pixmap< / a > without requiring a callback
when < a href = '#Image' > Image< / a > is released. Pass nullptr for < a href = '#SkImage_MakeFromRaster_releaseContext' > releaseContext< / a > if < a href = '#SkImage_MakeFromRaster_rasterReleaseProc' > rasterReleaseProc< / a >
2017-12-15 16:21:51 +00:00
does not require state.
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > is returned if < a href = '#SkImage_MakeFromRaster_pixmap' > pixmap< / a > is valid. Valid < a href = 'SkPixmap_Reference#Pixmap' > Pixmap< / a > parameters include:
2018-01-26 17:56:22 +00:00
dimensions are greater than zero;
2017-12-01 16:49:58 +00:00
each dimension fits in 29 bits;
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 > are valid, and < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > is not < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > ;
2017-12-01 16:49:58 +00:00
row bytes are large enough to hold one row of pixels;
pixel address is not nullptr.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_MakeFromRaster_pixmap' > < code > < strong > pixmap< / strong > < / code > < / a > < / td >
< td > < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , pixel address, and row bytes< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromRaster_rasterReleaseProc' > < code > < strong > rasterReleaseProc< / strong > < / code > < / a > < / td >
< td > function called when pixels can be released; or nullptr< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromRaster_releaseContext' > < code > < strong > releaseContext< / strong > < / code > < / a > < / td >
< td > state passed to < a href = '#SkImage_MakeFromRaster_rasterReleaseProc' > rasterReleaseProc< / a > ; or nullptr< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > sharing < a href = '#SkImage_MakeFromRaster_pixmap' > pixmap< / a >
2017-11-27 15:44:06 +00:00
### Example
2017-12-15 16:21:51 +00:00
< div > < fiddle-embed name = "275356b65d18c8868f4434137350cddc" >
#### Example Output
~~~~
before reset: 0
after reset: 1
~~~~
< / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeRasterCopy' > MakeRasterCopy< / a > < a href = '#SkImage_MakeRasterData' > MakeRasterData< / a > < a href = '#SkImage_MakeFromGenerator' > MakeFromGenerator< / a > < a href = '#SkImage_RasterReleaseProc' > RasterReleaseProc< / a > < a href = '#SkImage_ReleaseContext' > ReleaseContext< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_MakeFromBitmap' > < / a >
2017-11-27 15:44:06 +00:00
## MakeFromBitmap
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromBitmap' > MakeFromBitmap< / a > (const < a href = 'SkBitmap_Reference#SkBitmap' > SkBitmap< / a > & bitmap)
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = '#Image' > Image< / a > from < a href = '#SkImage_MakeFromBitmap_bitmap' > bitmap< / a > , sharing or copying < a href = '#SkImage_MakeFromBitmap_bitmap' > bitmap< / a > pixels. If the < a href = '#SkImage_MakeFromBitmap_bitmap' > bitmap< / a >
2017-12-01 16:49:58 +00:00
is marked immutable, and its pixel memory is shareable, it may be shared
instead of copied.
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > is returned if < a href = '#SkImage_MakeFromBitmap_bitmap' > bitmap< / a > is valid. Valid < a href = 'SkBitmap_Reference#Bitmap' > Bitmap< / a > parameters include:
2018-01-26 17:56:22 +00:00
dimensions are greater than zero;
2017-12-01 16:49:58 +00:00
each dimension fits in 29 bits;
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 > are valid, and < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > is not < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > ;
2017-12-01 16:49:58 +00:00
row bytes are large enough to hold one row of pixels;
pixel address is not nullptr.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_MakeFromBitmap_bitmap' > < code > < strong > bitmap< / strong > < / code > < / a > < / td >
< td > < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , row bytes, and pixels< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
created < a href = '#Image' > Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
### Example
2018-07-19 14:50:44 +00:00
< div > < fiddle-embed name = "cf2cf53321e4e6a77c2841bfbc0ef707" > < div > The first < a href = 'SkBitmap_Reference#Bitmap' > Bitmap< / a > is shared; writing to the pixel memory changes the first
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > .
The second < a href = 'SkBitmap_Reference#Bitmap' > Bitmap< / a > is marked immutable, and is copied; writing to the pixel
memory does not alter the second < a href = '#Image' > Image< / a > .
2018-03-05 18:26:16 +00:00
< / div > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeFromRaster' > MakeFromRaster< / a > < a href = '#SkImage_MakeRasterCopy' > MakeRasterCopy< / a > < a href = '#SkImage_MakeFromGenerator' > MakeFromGenerator< / a > < a href = '#SkImage_MakeRasterData' > MakeRasterData< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_MakeFromGenerator' > < / a >
2017-11-27 15:44:06 +00:00
## MakeFromGenerator
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromGenerator' > MakeFromGenerator< / a > (std::unique_ptr< < a href = 'undocumented#SkImageGenerator' > SkImageGenerator< / a > > imageGenerator,
const < a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > * subset = nullptr)
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = '#Image' > Image< / a > from data returned by < a href = '#SkImage_MakeFromGenerator_imageGenerator' > imageGenerator< / a > . Generated data is owned by < a href = '#Image' > Image< / a > and may not
2017-12-15 16:21:51 +00:00
be shared or accessed.
2017-12-01 16:49:58 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeFromGenerator_subset' > subset< / a > allows selecting a portion of the full image. Pass nullptr to select the entire image;
otherwise, < a href = '#SkImage_MakeFromGenerator_subset' > subset< / a > must be contained by image bounds.
2017-12-15 16:21:51 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > is returned if generator data is valid. Valid data parameters vary by type of data
2017-12-15 16:21:51 +00:00
and platform.
2017-12-01 16:49:58 +00:00
2018-06-27 15:00:21 +00:00
< a href = '#SkImage_MakeFromGenerator_imageGenerator' > imageGenerator< / a > may wrap < a href = 'SkPicture_Reference#Picture' > Picture< / a > data, codec data, or custom data.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_MakeFromGenerator_imageGenerator' > < code > < strong > imageGenerator< / strong > < / code > < / a > < / td >
< td > stock or custom routines to retrieve < a href = '#Image' > Image< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromGenerator_subset' > < code > < strong > subset< / strong > < / code > < / a > < / td >
< td > bounds of returned < a href = '#Image' > Image< / a > ; may be nullptr< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
created < a href = '#Image' > Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
### Example
2018-06-27 15:00:21 +00:00
< div > < fiddle-embed name = "c2fec0746f88ca34d7dce59dd9bdef9e" > < div > The generator returning < a href = 'SkPicture_Reference#Picture' > Picture< / a > cannot be shared; std::move transfers ownership to generated < a href = '#Image' > Image< / a > .
2018-03-05 18:26:16 +00:00
< / div > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeFromEncoded' > MakeFromEncoded< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_MakeFromEncoded' > < / a >
2017-11-27 15:44:06 +00:00
## MakeFromEncoded
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromEncoded' > MakeFromEncoded< / a > (< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkData' > SkData< / a > > encoded, const < a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > * subset = nullptr)
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = '#Image' > Image< / a > from < a href = '#SkImage_MakeFromEncoded_encoded' > encoded< / a > data.
< a href = '#SkImage_MakeFromEncoded_subset' > subset< / a > allows selecting a portion of the full image. Pass nullptr to select the entire image;
otherwise, < a href = '#SkImage_MakeFromEncoded_subset' > subset< / a > must be contained by image bounds.
2017-12-01 16:49:58 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > is returned if format of the < a href = '#SkImage_MakeFromEncoded_encoded' > encoded< / a > data is recognized and supported.
2018-02-06 14:41:53 +00:00
Recognized formats vary by platform.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_MakeFromEncoded_encoded' > < code > < strong > encoded< / strong > < / code > < / a > < / td >
< td > data of < a href = '#Image' > Image< / a > to decode< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromEncoded_subset' > < code > < strong > subset< / strong > < / code > < / a > < / td >
< td > bounds of returned < a href = '#Image' > Image< / a > ; may be nullptr< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
created < a href = '#Image' > Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
2018-01-02 16:34:14 +00:00
### Example
< div > < fiddle-embed name = "894f732ed6409b1f392bc5481421d0e9" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeFromGenerator' > MakeFromGenerator< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-17 16:17:28 +00:00
## <a name='SkImage_TextureReleaseProc'>Typedef SkImage::TextureReleaseProc</a>
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
typedef void (*< a href = '#SkImage_TextureReleaseProc' > TextureReleaseProc< / a > )(< a href = '#SkImage_ReleaseContext' > ReleaseContext< / a > releaseContext);
< / pre >
2018-05-16 11:07:07 +00:00
User function called when supplied texture may be deleted.
### See Also
< a href = '#SkImage_MakeFromTexture' > MakeFromTexture< / a > < sup > < a href = '#SkImage_MakeFromTexture_2' > [2]< / a > < / sup >
< a name = 'SkImage_MakeFromTexture' > < / a >
2018-03-21 12:52:41 +00:00
## MakeFromTexture
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 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromTexture' > MakeFromTexture< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context, const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > & backendTexture,
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > origin, < a href = 'SkImageInfo_Reference#SkColorType' > SkColorType< / a > < a href = '#SkImage_colorType' > colorType< / a > ,
< a href = 'SkImageInfo_Reference#SkAlphaType' > SkAlphaType< / a > < a href = '#SkImage_alphaType' > alphaType< / a > , < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > < a href = '#SkImage_colorSpace' > colorSpace< / a > )
2018-01-02 16:34:14 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = '#Image' > Image< / a > from < a href = 'undocumented#GPU_Texture' > GPU Texture< / a > associated with < a href = '#SkImage_MakeFromTexture_context' > context< / a > . Caller is responsible for
managing the lifetime of < a href = 'undocumented#GPU_Texture' > GPU Texture< / a > .
2018-01-02 16:34:14 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > is returned if format of < a href = '#SkImage_MakeFromTexture_backendTexture' > backendTexture< / a > is recognized and supported.
2018-01-04 21:11:51 +00:00
Recognized formats vary by GPU back-end.
2018-01-02 16:34:14 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_MakeFromTexture_context' > < code > < strong > context< / strong > < / code > < / a > < / td >
< td > < a href = 'undocumented#GPU_Context' > GPU Context< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromTexture_backendTexture' > < code > < strong > backendTexture< / strong > < / code > < / a > < / td >
< td > texture residing on GPU< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromTexture_origin' > < code > < strong > origin< / strong > < / code > < / a > < / td >
< td > one of: < a href = 'undocumented#kBottomLeft_GrSurfaceOrigin' > kBottomLeft GrSurfaceOrigin< / a > , < a href = 'undocumented#kTopLeft_GrSurfaceOrigin' > kTopLeft GrSurfaceOrigin< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromTexture_colorType' > < code > < strong > colorType< / strong > < / code > < / a > < / td >
< td > 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 > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromTexture_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 >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromTexture_colorSpace' > < code > < strong > colorSpace< / strong > < / code > < / a > < / td >
< td > range of colors; may be nullptr< / td >
2018-01-02 16:34:14 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
created < a href = '#Image' > Image< / a > , or nullptr
2018-01-02 16:34:14 +00:00
2017-11-27 15:44:06 +00:00
### Example
2018-06-07 21:07:17 +00:00
< div > < fiddle-embed name = "94e9296c53bad074bf2a48ff885dac13" gpu = "true" > < div > A back-end texture has been created and uploaded to the GPU outside of this example.
2018-03-05 18:26:16 +00:00
< / div > < / fiddle-embed > < / div >
2018-01-02 16:34:14 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeFromAdoptedTexture' > MakeFromAdoptedTexture< / a > < a href = 'SkSurface_Reference#SkSurface_MakeFromBackendTexture' > SkSurface::MakeFromBackendTexture< / a >
2018-01-02 16:34:14 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_MakeFromTexture_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 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromTexture' > MakeFromTexture< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context, const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > & backendTexture,
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > origin, < a href = 'SkImageInfo_Reference#SkColorType' > SkColorType< / a > < a href = '#SkImage_colorType' > colorType< / a > ,
< a href = 'SkImageInfo_Reference#SkAlphaType' > SkAlphaType< / a > < a href = '#SkImage_alphaType' > alphaType< / a > , < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > < a href = '#SkImage_colorSpace' > colorSpace< / a > ,
< a href = '#SkImage_TextureReleaseProc' > TextureReleaseProc< / a > textureReleaseProc,
< a href = '#SkImage_ReleaseContext' > ReleaseContext< / a > releaseContext)
2018-01-02 16:34:14 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = '#Image' > Image< / a > from < a href = 'undocumented#GPU_Texture' > GPU Texture< / a > associated with < a href = '#SkImage_MakeFromTexture_2_context' > context< / a > . < a href = 'undocumented#GPU_Texture' > GPU Texture< / a > must stay
valid and unchanged until < a href = '#SkImage_MakeFromTexture_2_textureReleaseProc' > textureReleaseProc< / a > is called. < a href = '#SkImage_MakeFromTexture_2_textureReleaseProc' > textureReleaseProc< / a > is
passed < a href = '#SkImage_MakeFromTexture_2_releaseContext' > releaseContext< / a > when < a href = '#Image' > Image< / a > is deleted or no longer refers to texture.
2018-01-02 16:34:14 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > is returned if format of < a href = '#SkImage_MakeFromTexture_2_backendTexture' > backendTexture< / a > is recognized and supported.
2018-01-04 21:11:51 +00:00
Recognized formats vary by GPU back-end.
2018-01-02 16:34:14 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_MakeFromTexture_2_context' > < code > < strong > context< / strong > < / code > < / a > < / td >
< td > < a href = 'undocumented#GPU_Context' > GPU Context< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromTexture_2_backendTexture' > < code > < strong > backendTexture< / strong > < / code > < / a > < / td >
< td > texture residing on GPU< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromTexture_2_origin' > < code > < strong > origin< / strong > < / code > < / a > < / td >
< td > one of: < a href = 'undocumented#kBottomLeft_GrSurfaceOrigin' > kBottomLeft GrSurfaceOrigin< / a > , < a href = 'undocumented#kTopLeft_GrSurfaceOrigin' > kTopLeft GrSurfaceOrigin< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromTexture_2_colorType' > < code > < strong > colorType< / strong > < / code > < / a > < / td >
< td > 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 > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromTexture_2_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 >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromTexture_2_colorSpace' > < code > < strong > colorSpace< / strong > < / code > < / a > < / td >
< td > range of colors; may be nullptr< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromTexture_2_textureReleaseProc' > < code > < strong > textureReleaseProc< / strong > < / code > < / a > < / td >
< td > function called when texture can be released< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromTexture_2_releaseContext' > < code > < strong > releaseContext< / strong > < / code > < / a > < / td >
< td > state passed to < a href = '#SkImage_MakeFromTexture_2_textureReleaseProc' > textureReleaseProc< / a > < / td >
2018-01-02 16:34:14 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
created < a href = '#Image' > Image< / a > , or nullptr
2018-01-02 16:34:14 +00:00
### Example
2018-10-05 19:19:24 +00:00
< div > < fiddle-embed name = "f40e1ebba6b067714062b81877b22fa1" gpu = "true" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeFromAdoptedTexture' > MakeFromAdoptedTexture< / a > < a href = 'SkSurface_Reference#SkSurface_MakeFromBackendTexture' > SkSurface::MakeFromBackendTexture< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_MakeCrossContextFromEncoded' > < / a >
2017-11-27 15:44:06 +00:00
## MakeCrossContextFromEncoded
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeCrossContextFromEncoded' > MakeCrossContextFromEncoded< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context, < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkData' > SkData< / a > > data,
bool buildMips, < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > * dstColorSpace,
2018-04-24 18:25:33 +00:00
bool limitToMaxTextureSize = false)
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = '#Image' > Image< / a > from encoded < a href = '#SkImage_MakeCrossContextFromEncoded_data' > data< / a > . < a href = '#Image' > Image< / a > is uploaded to GPU back-end using < a href = '#SkImage_MakeCrossContextFromEncoded_context' > context< / a > .
2017-12-01 16:49:58 +00:00
2018-05-16 11:07:07 +00:00
Created < a href = '#Image' > Image< / a > is available to other GPU contexts, and is available across thread
2018-06-14 16:28:14 +00:00
boundaries. All contexts must be in the same < a href = 'undocumented#GPU_Share_Group' > GPU Share Group< / a > , or otherwise
2017-12-01 16:49:58 +00:00
share resources.
2018-05-16 11:07:07 +00:00
When < a href = '#Image' > Image< / a > is no longer referenced, < a href = '#SkImage_MakeCrossContextFromEncoded_context' > context< / a > releases texture memory
2017-11-27 15:44:06 +00:00
asynchronously.
2017-12-01 16:49:58 +00:00
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#Texture' > Texture< / a > decoded from < a href = '#SkImage_MakeCrossContextFromEncoded_data' > data< / a > is uploaded to match < a href = 'SkSurface_Reference#Surface' > Surface< / a > created with
< a href = '#SkImage_MakeCrossContextFromEncoded_dstColorSpace' > dstColorSpace< / a > . < a href = 'undocumented#Color_Space' > Color Space< / a > of < a href = '#Image' > Image< / a > is determined by encoded < a href = '#SkImage_MakeCrossContextFromEncoded_data' > data< / a > .
2017-12-01 16:49:58 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > is returned if format of < a href = '#SkImage_MakeCrossContextFromEncoded_data' > data< / a > is recognized and supported, and if < a href = '#SkImage_MakeCrossContextFromEncoded_context' > context< / a >
2018-01-04 21:11:51 +00:00
supports moving resources. Recognized formats vary by platform and GPU back-end.
2017-11-27 15:44:06 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > is returned using < a href = '#SkImage_MakeFromEncoded' > MakeFromEncoded< / a > if < a href = '#SkImage_MakeCrossContextFromEncoded_context' > context< / a > is nullptr or does not support
2018-01-02 16:34:14 +00:00
moving resources between contexts.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_MakeCrossContextFromEncoded_context' > < code > < strong > context< / strong > < / code > < / a > < / td >
< td > < a href = 'undocumented#GPU_Context' > GPU Context< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeCrossContextFromEncoded_data' > < code > < strong > data< / strong > < / code > < / a > < / td >
< td > < a href = '#Image' > Image< / a > to decode< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeCrossContextFromEncoded_buildMips' > < code > < strong > buildMips< / strong > < / code > < / a > < / td >
2018-06-14 16:28:14 +00:00
< td > create < a href = '#Image' > Image< / a > as < a href = 'undocumented#Mip_Map' > Mip Map< / a > if true< / td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr > < td > < a name = 'SkImage_MakeCrossContextFromEncoded_dstColorSpace' > < code > < strong > dstColorSpace< / strong > < / code > < / a > < / td >
< td > range of colors of matching < a href = 'SkSurface_Reference#Surface' > Surface< / a > on GPU< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeCrossContextFromEncoded_limitToMaxTextureSize' > < code > < strong > limitToMaxTextureSize< / strong > < / code > < / a > < / td >
< td > downscale image to GPU maximum texture size, if necessary< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
created < a href = '#Image' > Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
### Example
2018-01-11 15:35:44 +00:00
< div > < fiddle-embed name = "069c7b116479e3ca46f953f07dcbdd36" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeCrossContextFromPixmap' > MakeCrossContextFromPixmap< / a >
2017-12-01 16:49:58 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_MakeCrossContextFromPixmap' > < / a >
2017-12-01 16:49:58 +00:00
## MakeCrossContextFromPixmap
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeCrossContextFromPixmap' > MakeCrossContextFromPixmap< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context, const < a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > & pixmap,
bool buildMips, < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > * dstColorSpace,
2018-04-24 18:25:33 +00:00
bool limitToMaxTextureSize = false)
2017-12-01 16:49:58 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = '#Image' > Image< / a > from < a href = '#SkImage_MakeCrossContextFromPixmap_pixmap' > pixmap< / a > . < a href = '#Image' > Image< / a > is uploaded to GPU back-end using < a href = '#SkImage_MakeCrossContextFromPixmap_context' > context< / a > .
2017-12-01 16:49:58 +00:00
2018-05-16 11:07:07 +00:00
Created < a href = '#Image' > Image< / a > is available to other GPU contexts, and is available across thread
2018-06-14 16:28:14 +00:00
boundaries. All contexts must be in the same < a href = 'undocumented#GPU_Share_Group' > GPU Share Group< / a > , or otherwise
2017-12-01 16:49:58 +00:00
share resources.
2018-05-16 11:07:07 +00:00
When < a href = '#Image' > Image< / a > is no longer referenced, < a href = '#SkImage_MakeCrossContextFromPixmap_context' > context< / a > releases texture memory
2017-12-01 16:49:58 +00:00
asynchronously.
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#Texture' > Texture< / a > created from < a href = '#SkImage_MakeCrossContextFromPixmap_pixmap' > pixmap< / a > is uploaded to match < a href = 'SkSurface_Reference#Surface' > Surface< / a > created with
2018-10-08 18:57:48 +00:00
< a href = '#SkImage_MakeCrossContextFromPixmap_dstColorSpace' > dstColorSpace< / a > . < a href = 'undocumented#Color_Space' > Color Space< / a > of < a href = '#Image' > Image< / a > is determined by < a href = '#SkImage_MakeCrossContextFromPixmap_pixmap' > pixmap< / a > .< a href = '#SkImage_colorSpace' > colorSpace< / a > ().
2017-12-01 16:49:58 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > is returned referring to GPU back-end if < a href = '#SkImage_MakeCrossContextFromPixmap_context' > context< / a > is not nullptr,
format of data is recognized and supported, and if < a href = '#SkImage_MakeCrossContextFromPixmap_context' > context< / a > supports moving
resources between contexts. Otherwise, < a href = '#SkImage_MakeCrossContextFromPixmap_pixmap' > pixmap< / a > pixel data is copied and < a href = '#Image' > Image< / a >
2018-01-02 16:34:14 +00:00
as returned in raster format if possible; nullptr may be returned.
2018-01-04 21:11:51 +00:00
Recognized GPU formats vary by platform and GPU back-end.
2017-12-01 16:49:58 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_MakeCrossContextFromPixmap_context' > < code > < strong > context< / strong > < / code > < / a > < / td >
< td > < a href = 'undocumented#GPU_Context' > GPU Context< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeCrossContextFromPixmap_pixmap' > < code > < strong > pixmap< / strong > < / code > < / a > < / td >
< td > < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > , pixel address, and row bytes< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeCrossContextFromPixmap_buildMips' > < code > < strong > buildMips< / strong > < / code > < / a > < / td >
2018-06-14 16:28:14 +00:00
< td > create < a href = '#Image' > Image< / a > as < a href = 'undocumented#Mip_Map' > Mip Map< / a > if true< / td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr > < td > < a name = 'SkImage_MakeCrossContextFromPixmap_dstColorSpace' > < code > < strong > dstColorSpace< / strong > < / code > < / a > < / td >
< td > range of colors of matching < a href = 'SkSurface_Reference#Surface' > Surface< / a > on GPU< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeCrossContextFromPixmap_limitToMaxTextureSize' > < code > < strong > limitToMaxTextureSize< / strong > < / code > < / a > < / td >
< td > downscale image to GPU maximum texture size, if necessary< / td >
2017-12-01 16:49:58 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
created < a href = '#Image' > Image< / a > , or nullptr
2017-12-01 16:49:58 +00:00
### Example
2018-07-06 05:23:23 +00:00
< div > < fiddle-embed name = "45bca8747b8f49b5be34b520897ef048" > < / fiddle-embed > < / div >
2017-12-01 16:49:58 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeCrossContextFromEncoded' > MakeCrossContextFromEncoded< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_MakeFromAdoptedTexture' > < / a >
2018-03-22 06:06:07 +00:00
## MakeFromAdoptedTexture
2017-11-27 15:44:06 +00:00
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromAdoptedTexture' > MakeFromAdoptedTexture< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context,
const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > & backendTexture,
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > surfaceOrigin, < a href = 'SkImageInfo_Reference#SkColorType' > SkColorType< / a > < a href = '#SkImage_colorType' > colorType< / a > ,
< a href = 'SkImageInfo_Reference#SkAlphaType' > SkAlphaType< / a > < a href = '#SkImage_alphaType' > alphaType< / a > = < a href = 'SkImageInfo_Reference#kPremul_SkAlphaType' > kPremul_SkAlphaType< / a > ,
< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > < a href = '#SkImage_colorSpace' > colorSpace< / a > = nullptr)
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = '#Image' > Image< / a > from < a href = '#SkImage_MakeFromAdoptedTexture_backendTexture' > backendTexture< / a > associated with < a href = '#SkImage_MakeFromAdoptedTexture_context' > context< / a > . < a href = '#SkImage_MakeFromAdoptedTexture_backendTexture' > backendTexture< / a > and
returned < a href = '#Image' > Image< / a > are managed internally, and are released when no longer needed.
2018-01-02 16:34:14 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > is returned if format of < a href = '#SkImage_MakeFromAdoptedTexture_backendTexture' > backendTexture< / a > is recognized and supported.
2018-01-04 21:11:51 +00:00
Recognized formats vary by GPU back-end.
2018-01-02 16:34:14 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_MakeFromAdoptedTexture_context' > < code > < strong > context< / strong > < / code > < / a > < / td >
< td > < a href = 'undocumented#GPU_Context' > GPU Context< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromAdoptedTexture_backendTexture' > < code > < strong > backendTexture< / strong > < / code > < / a > < / td >
< td > texture residing on GPU< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromAdoptedTexture_surfaceOrigin' > < code > < strong > surfaceOrigin< / strong > < / code > < / a > < / td >
< td > one of: < a href = 'undocumented#kBottomLeft_GrSurfaceOrigin' > kBottomLeft GrSurfaceOrigin< / a > , < a href = 'undocumented#kTopLeft_GrSurfaceOrigin' > kTopLeft GrSurfaceOrigin< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromAdoptedTexture_colorType' > < code > < strong > colorType< / strong > < / code > < / a > < / td >
< td > 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 > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromAdoptedTexture_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 >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromAdoptedTexture_colorSpace' > < code > < strong > colorSpace< / strong > < / code > < / a > < / td >
< td > range of colors; may be nullptr< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
created < a href = '#Image' > Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
### Example
2018-07-17 12:20:27 +00:00
< div > < fiddle-embed name = "b034517e39394b7543f06ec885e36d7d" gpu = "true" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeFromTexture' > MakeFromTexture< / a > < sup > < a href = '#SkImage_MakeFromTexture_2' > [2]< / a > < / sup > < a href = '#SkImage_MakeFromYUVTexturesCopy' > MakeFromYUVTexturesCopy< / a >
2017-11-27 15:44:06 +00:00
---
2018-10-05 19:19:24 +00:00
< a name = 'SkImage_MakeFromYUVATexturesCopy' > < / a >
## MakeFromYUVATexturesCopy
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromYUVATexturesCopy' > MakeFromYUVATexturesCopy< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context, < a href = 'SkImageInfo_Reference#SkYUVColorSpace' > SkYUVColorSpace< / a > yuvColorSpace,
const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > yuvaTextures[],
const < a href = 'undocumented#SkYUVAIndex' > SkYUVAIndex< / a > yuvaIndices[4], < a href = 'undocumented#SkISize' > SkISize< / a > imageSize,
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > imageOrigin,
< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > imageColorSpace = nullptr)
< / pre >
2018-10-08 18:57:48 +00:00
Creates an < a href = '#SkImage' > SkImage< / a > by flattening the specified YUVA planes into a single,
interleaved RGBA image.
< a href = '#SkImage_MakeFromYUVATexturesCopy_yuvaTextures' > yuvaTextures< / a > points to array of up to four YUVA textures which reside on GPU.
YUVA textures contain YUVA planes which may be interleaved.
2018-10-05 19:19:24 +00:00
### Parameters
< table > < tr > < td > < a name = 'SkImage_MakeFromYUVATexturesCopy_context' > < code > < strong > context< / strong > < / code > < / a > < / td >
< td > GPU < a href = '#SkImage_MakeFromYUVATexturesCopy_context' > context< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVATexturesCopy_yuvColorSpace' > < code > < strong > yuvColorSpace< / strong > < / code > < / a > < / td >
2018-10-08 18:57:48 +00:00
< td > one of: < a href = 'SkImageInfo_Reference#kJPEG_SkYUVColorSpace' > kJPEG_SkYUVColorSpace< / a > , < a href = 'SkImageInfo_Reference#kRec601_SkYUVColorSpace' > kRec601_SkYUVColorSpace< / a > ,
2018-10-05 19:19:24 +00:00
< a href = 'SkImageInfo_Reference#kRec709_SkYUVColorSpace' > kRec709_SkYUVColorSpace< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVATexturesCopy_yuvaTextures' > < code > < strong > yuvaTextures< / strong > < / code > < / a > < / td >
2018-10-08 18:57:48 +00:00
< td > array of YUVA textures< / td >
2018-10-05 19:19:24 +00:00
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVATexturesCopy_yuvaIndices' > < code > < strong > yuvaIndices< / strong > < / code > < / a > < / td >
2018-10-08 18:57:48 +00:00
< td > array indicating < a href = '#SkImage_MakeFromYUVATexturesCopy_yuvaTextures' > yuvaTextures< / a > element and channel
that map to Y, U, V, and A< / td >
2018-10-05 19:19:24 +00:00
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVATexturesCopy_imageSize' > < code > < strong > imageSize< / strong > < / code > < / a > < / td >
< td > size of the resulting image< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVATexturesCopy_imageOrigin' > < code > < strong > imageOrigin< / strong > < / code > < / a > < / td >
2018-10-08 18:57:48 +00:00
< td > one of: < a href = 'undocumented#kBottomLeft_GrSurfaceOrigin' > kBottomLeft GrSurfaceOrigin< / a > , < a href = 'undocumented#kTopLeft_GrSurfaceOrigin' > kTopLeft GrSurfaceOrigin< / a > < / td >
2018-10-05 19:19:24 +00:00
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVATexturesCopy_imageColorSpace' > < code > < strong > imageColorSpace< / strong > < / code > < / a > < / td >
< td > range of colors of the resulting image; may be nullptr< / td >
< / tr >
< / table >
### Return Value
created < a href = '#SkImage' > SkImage< / a > , or nullptr
### See Also
< a href = '#SkImage_MakeFromYUVATexturesCopyWithExternalBackend' > MakeFromYUVATexturesCopyWithExternalBackend< / a >
---
< a name = 'SkImage_MakeFromYUVATexturesCopyWithExternalBackend' > < / a >
## MakeFromYUVATexturesCopyWithExternalBackend
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromYUVATexturesCopyWithExternalBackend' > MakeFromYUVATexturesCopyWithExternalBackend< / a > (
< a href = 'undocumented#GrContext' > GrContext< / a > * context,
< a href = 'SkImageInfo_Reference#SkYUVColorSpace' > SkYUVColorSpace< / a > yuvColorSpace, const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > yuvaTextures[],
const < a href = 'undocumented#SkYUVAIndex' > SkYUVAIndex< / a > yuvaIndices[4], < a href = 'undocumented#SkISize' > SkISize< / a > imageSize,
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > imageOrigin, const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > & backendTexture,
< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > imageColorSpace = nullptr)
< / pre >
2018-10-08 18:57:48 +00:00
Creates an < a href = '#SkImage' > SkImage< / a > by flattening the specified YUVA planes into a single,
interleaved RGBA image. < a href = '#SkImage_MakeFromYUVATexturesCopyWithExternalBackend_backendTexture' > backendTexture< / a > is used to store the result of flattening.
< a href = '#SkImage_MakeFromYUVATexturesCopyWithExternalBackend_yuvaTextures' > yuvaTextures< / a > points to array of up to four YUVA textures which reside on GPU.
YUVA textures contain YUVA planes which may be interleaved.
2018-10-05 19:19:24 +00:00
### Parameters
< table > < tr > < td > < a name = 'SkImage_MakeFromYUVATexturesCopyWithExternalBackend_context' > < code > < strong > context< / strong > < / code > < / a > < / td >
< td > GPU < a href = '#SkImage_MakeFromYUVATexturesCopyWithExternalBackend_context' > context< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVATexturesCopyWithExternalBackend_yuvColorSpace' > < code > < strong > yuvColorSpace< / strong > < / code > < / a > < / td >
2018-10-08 18:57:48 +00:00
< td > one of: < a href = 'SkImageInfo_Reference#kJPEG_SkYUVColorSpace' > kJPEG_SkYUVColorSpace< / a > , < a href = 'SkImageInfo_Reference#kRec601_SkYUVColorSpace' > kRec601_SkYUVColorSpace< / a > ,
2018-10-05 19:19:24 +00:00
< a href = 'SkImageInfo_Reference#kRec709_SkYUVColorSpace' > kRec709_SkYUVColorSpace< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVATexturesCopyWithExternalBackend_yuvaTextures' > < code > < strong > yuvaTextures< / strong > < / code > < / a > < / td >
2018-10-08 18:57:48 +00:00
< td > array of YUVA textures< / td >
2018-10-05 19:19:24 +00:00
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVATexturesCopyWithExternalBackend_yuvaIndices' > < code > < strong > yuvaIndices< / strong > < / code > < / a > < / td >
2018-10-08 18:57:48 +00:00
< td > array indicating < a href = '#SkImage_MakeFromYUVATexturesCopyWithExternalBackend_yuvaTextures' > yuvaTextures< / a > element and channel
that map to Y, U, V, and A< / td >
2018-10-05 19:19:24 +00:00
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVATexturesCopyWithExternalBackend_imageSize' > < code > < strong > imageSize< / strong > < / code > < / a > < / td >
< td > size of the resulting image< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVATexturesCopyWithExternalBackend_imageOrigin' > < code > < strong > imageOrigin< / strong > < / code > < / a > < / td >
2018-10-08 18:57:48 +00:00
< td > one of: < a href = 'undocumented#kBottomLeft_GrSurfaceOrigin' > kBottomLeft GrSurfaceOrigin< / a > , < a href = 'undocumented#kTopLeft_GrSurfaceOrigin' > kTopLeft GrSurfaceOrigin< / a > < / td >
2018-10-05 19:19:24 +00:00
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVATexturesCopyWithExternalBackend_backendTexture' > < code > < strong > backendTexture< / strong > < / code > < / a > < / td >
2018-10-08 18:57:48 +00:00
< td > resource that stores the final pixels< / td >
2018-10-05 19:19:24 +00:00
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVATexturesCopyWithExternalBackend_imageColorSpace' > < code > < strong > imageColorSpace< / strong > < / code > < / a > < / td >
< td > range of colors of the resulting image; may be nullptr< / td >
< / tr >
< / table >
### Return Value
created < a href = '#SkImage' > SkImage< / a > , or nullptr
### See Also
< a href = '#SkImage_MakeFromYUVATexturesCopy' > MakeFromYUVATexturesCopy< / a >
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_MakeFromYUVTexturesCopy' > < / a >
2017-11-27 15:44:06 +00:00
## MakeFromYUVTexturesCopy
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromYUVTexturesCopy' > MakeFromYUVTexturesCopy< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context, < a href = 'SkImageInfo_Reference#SkYUVColorSpace' > SkYUVColorSpace< / a > yuvColorSpace,
const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > yuvTextures[3],
2018-10-05 19:19:24 +00:00
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > imageOrigin,
< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > imageColorSpace = nullptr)
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = '#Image' > Image< / a > from copy of < a href = '#SkImage_MakeFromYUVTexturesCopy_yuvTextures' > yuvTextures< / a > , an array of textures on GPU.
< a href = '#SkImage_MakeFromYUVTexturesCopy_yuvTextures' > yuvTextures< / a > contain pixels for YUV planes of < a href = '#Image' > Image< / a > . Returned < a href = '#Image' > Image< / a > has the dimensions
< a href = '#SkImage_MakeFromYUVTexturesCopy_yuvTextures' > yuvTextures< / a > [0]. < a href = '#SkImage_MakeFromYUVTexturesCopy_yuvColorSpace' > yuvColorSpace< / a > describes how YUV colors convert to RGB colors.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_MakeFromYUVTexturesCopy_context' > < code > < strong > context< / strong > < / code > < / a > < / td >
< td > < a href = 'undocumented#GPU_Context' > GPU Context< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVTexturesCopy_yuvColorSpace' > < code > < strong > yuvColorSpace< / strong > < / code > < / a > < / td >
< td > one of: < a href = 'SkImageInfo_Reference#kJPEG_SkYUVColorSpace' > kJPEG_SkYUVColorSpace< / a > , < a href = 'SkImageInfo_Reference#kRec601_SkYUVColorSpace' > kRec601_SkYUVColorSpace< / a > ,
< a href = 'SkImageInfo_Reference#kRec709_SkYUVColorSpace' > kRec709_SkYUVColorSpace< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVTexturesCopy_yuvTextures' > < code > < strong > yuvTextures< / strong > < / code > < / a > < / td >
< td > array of YUV textures on GPU< / td >
< / tr >
2018-10-05 19:19:24 +00:00
< tr > < td > < a name = 'SkImage_MakeFromYUVTexturesCopy_imageOrigin' > < code > < strong > imageOrigin< / strong > < / code > < / a > < / td >
2018-05-16 11:07:07 +00:00
< td > one of: < a href = 'undocumented#kBottomLeft_GrSurfaceOrigin' > kBottomLeft GrSurfaceOrigin< / a > , < a href = 'undocumented#kTopLeft_GrSurfaceOrigin' > kTopLeft GrSurfaceOrigin< / a > < / td >
< / tr >
2018-10-05 19:19:24 +00:00
< tr > < td > < a name = 'SkImage_MakeFromYUVTexturesCopy_imageColorSpace' > < code > < strong > imageColorSpace< / strong > < / code > < / a > < / td >
2018-05-16 11:07:07 +00:00
< td > range of colors; may be nullptr< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
created < a href = '#Image' > Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
2018-01-02 16:34:14 +00:00
### See Also
2017-11-27 15:44:06 +00:00
2018-10-05 19:19:24 +00:00
< a href = '#SkImage_MakeFromYUVTexturesCopyWithExternalBackend' > MakeFromYUVTexturesCopyWithExternalBackend< / a > < a href = '#SkImage_MakeFromNV12TexturesCopy' > MakeFromNV12TexturesCopy< / a > < a href = '#SkImage_MakeFromYUVATexturesCopy' > MakeFromYUVATexturesCopy< / a >
2018-09-18 11:31:37 +00:00
---
< a name = 'SkImage_MakeFromYUVTexturesCopyWithExternalBackend' > < / a >
## MakeFromYUVTexturesCopyWithExternalBackend
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromYUVTexturesCopyWithExternalBackend' > MakeFromYUVTexturesCopyWithExternalBackend< / a > (
< a href = 'undocumented#GrContext' > GrContext< / a > * context,
< a href = 'SkImageInfo_Reference#SkYUVColorSpace' > SkYUVColorSpace< / a > yuvColorSpace, const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > yuvTextures[3],
2018-10-05 19:19:24 +00:00
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > imageOrigin, const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > & backendTexture,
< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > imageColorSpace = nullptr) ;
2018-09-18 11:31:37 +00:00
< / pre >
Creates < a href = '#Image' > Image< / a > from copy of < a href = '#SkImage_MakeFromYUVTexturesCopyWithExternalBackend_yuvTextures' > yuvTextures< / a > , an array of textures on GPU.
< a href = '#SkImage_MakeFromYUVTexturesCopyWithExternalBackend_yuvTextures' > yuvTextures< / a > contain pixels for YUV planes of < a href = '#Image' > Image< / a > . Returned < a href = '#Image' > Image< / a > has the dimensions
< a href = '#SkImage_MakeFromYUVTexturesCopyWithExternalBackend_yuvTextures' > yuvTextures< / a > [0] and stores pixels in < a href = '#SkImage_MakeFromYUVTexturesCopyWithExternalBackend_backendTexture' > backendTexture< / a > . < a href = '#SkImage_MakeFromYUVTexturesCopyWithExternalBackend_yuvColorSpace' > yuvColorSpace< / a > describes how YUV colors
convert to RGB colors.
### Parameters
< table > < tr > < td > < a name = 'SkImage_MakeFromYUVTexturesCopyWithExternalBackend_context' > < code > < strong > context< / strong > < / code > < / a > < / td >
< td > < a href = 'undocumented#GPU_Context' > GPU Context< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVTexturesCopyWithExternalBackend_yuvColorSpace' > < code > < strong > yuvColorSpace< / strong > < / code > < / a > < / td >
< td > one of: < a href = 'SkImageInfo_Reference#kJPEG_SkYUVColorSpace' > kJPEG_SkYUVColorSpace< / a > , < a href = 'SkImageInfo_Reference#kRec601_SkYUVColorSpace' > kRec601_SkYUVColorSpace< / a > ,
< a href = 'SkImageInfo_Reference#kRec709_SkYUVColorSpace' > kRec709_SkYUVColorSpace< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVTexturesCopyWithExternalBackend_yuvTextures' > < code > < strong > yuvTextures< / strong > < / code > < / a > < / td >
< td > array of YUV textures on GPU< / td >
< / tr >
2018-10-05 19:19:24 +00:00
< tr > < td > < a name = 'SkImage_MakeFromYUVTexturesCopyWithExternalBackend_imageOrigin' > < code > < strong > imageOrigin< / strong > < / code > < / a > < / td >
2018-09-18 11:31:37 +00:00
< td > one of: < a href = 'undocumented#kBottomLeft_GrSurfaceOrigin' > kBottomLeft GrSurfaceOrigin< / a > , < a href = 'undocumented#kTopLeft_GrSurfaceOrigin' > kTopLeft GrSurfaceOrigin< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromYUVTexturesCopyWithExternalBackend_backendTexture' > < code > < strong > backendTexture< / strong > < / code > < / a > < / td >
2018-10-08 18:57:48 +00:00
< td > resource that stores final pixels< / td >
2018-09-18 11:31:37 +00:00
< / tr >
2018-10-05 19:19:24 +00:00
< tr > < td > < a name = 'SkImage_MakeFromYUVTexturesCopyWithExternalBackend_imageColorSpace' > < code > < strong > imageColorSpace< / strong > < / code > < / a > < / td >
2018-09-18 11:31:37 +00:00
< td > range of colors; may be nullptr< / td >
< / tr >
< / table >
### Return Value
created < a href = '#SkImage' > SkImage< / a > , or nullptr
### See Also
2018-10-05 19:19:24 +00:00
< a href = '#SkImage_MakeFromYUVTexturesCopy' > MakeFromYUVTexturesCopy< / a > < a href = '#SkImage_MakeFromNV12TexturesCopy' > MakeFromNV12TexturesCopy< / a > < a href = '#SkImage_MakeFromYUVATexturesCopyWithExternalBackend' > MakeFromYUVATexturesCopyWithExternalBackend< / a >
2018-01-02 16:34:14 +00:00
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_MakeFromNV12TexturesCopy' > < / a >
2017-11-27 15:44:06 +00:00
## MakeFromNV12TexturesCopy
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromNV12TexturesCopy' > MakeFromNV12TexturesCopy< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context, < a href = 'SkImageInfo_Reference#SkYUVColorSpace' > SkYUVColorSpace< / a > yuvColorSpace,
const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > nv12Textures[2],
2018-10-05 19:19:24 +00:00
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > imageOrigin,
< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > imageColorSpace = nullptr)
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = '#Image' > Image< / a > from copy of < a href = '#SkImage_MakeFromNV12TexturesCopy_nv12Textures' > nv12Textures< / a > , an array of textures on GPU.
2018-06-14 16:28:14 +00:00
< a href = '#SkImage_MakeFromNV12TexturesCopy_nv12Textures' > nv12Textures< / a > [0] contains pixels for < a href = 'undocumented#YUV_Component_Y' > YUV Component Y< / a > plane.
< a href = '#SkImage_MakeFromNV12TexturesCopy_nv12Textures' > nv12Textures< / a > [1] contains pixels for < a href = 'undocumented#YUV_Component_U' > YUV Component U< / a > plane,
followed by pixels for < a href = 'undocumented#YUV_Component_V' > YUV Component V< / a > plane.
2018-05-16 11:07:07 +00:00
Returned < a href = '#Image' > Image< / a > has the dimensions < a href = '#SkImage_MakeFromNV12TexturesCopy_nv12Textures' > nv12Textures< / a > [2].
< a href = '#SkImage_MakeFromNV12TexturesCopy_yuvColorSpace' > yuvColorSpace< / a > describes how YUV colors convert to RGB colors.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_MakeFromNV12TexturesCopy_context' > < code > < strong > context< / strong > < / code > < / a > < / td >
< td > < a href = 'undocumented#GPU_Context' > GPU Context< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromNV12TexturesCopy_yuvColorSpace' > < code > < strong > yuvColorSpace< / strong > < / code > < / a > < / td >
< td > one of: < a href = 'SkImageInfo_Reference#kJPEG_SkYUVColorSpace' > kJPEG_SkYUVColorSpace< / a > , < a href = 'SkImageInfo_Reference#kRec601_SkYUVColorSpace' > kRec601_SkYUVColorSpace< / a > ,
< a href = 'SkImageInfo_Reference#kRec709_SkYUVColorSpace' > kRec709_SkYUVColorSpace< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromNV12TexturesCopy_nv12Textures' > < code > < strong > nv12Textures< / strong > < / code > < / a > < / td >
< td > array of YUV textures on GPU< / td >
< / tr >
2018-10-05 19:19:24 +00:00
< tr > < td > < a name = 'SkImage_MakeFromNV12TexturesCopy_imageOrigin' > < code > < strong > imageOrigin< / strong > < / code > < / a > < / td >
2018-05-16 11:07:07 +00:00
< td > one of: < a href = 'undocumented#kBottomLeft_GrSurfaceOrigin' > kBottomLeft GrSurfaceOrigin< / a > , < a href = 'undocumented#kTopLeft_GrSurfaceOrigin' > kTopLeft GrSurfaceOrigin< / a > < / td >
< / tr >
2018-10-05 19:19:24 +00:00
< tr > < td > < a name = 'SkImage_MakeFromNV12TexturesCopy_imageColorSpace' > < code > < strong > imageColorSpace< / strong > < / code > < / a > < / td >
2018-05-16 11:07:07 +00:00
< td > range of colors; may be nullptr< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
created < a href = '#Image' > Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
2018-01-02 16:34:14 +00:00
### See Also
2017-11-27 15:44:06 +00:00
2018-10-05 19:19:24 +00:00
< a href = '#SkImage_MakeFromNV12TexturesCopyWithExternalBackend' > MakeFromNV12TexturesCopyWithExternalBackend< / a > < a href = '#SkImage_MakeFromYUVTexturesCopy' > MakeFromYUVTexturesCopy< / a > < a href = '#SkImage_MakeFromYUVATexturesCopy' > MakeFromYUVATexturesCopy< / a >
2018-09-18 11:31:37 +00:00
---
< a name = 'SkImage_MakeFromNV12TexturesCopyWithExternalBackend' > < / a >
## MakeFromNV12TexturesCopyWithExternalBackend
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromNV12TexturesCopyWithExternalBackend' > MakeFromNV12TexturesCopyWithExternalBackend< / a > (
< a href = 'undocumented#GrContext' > GrContext< / a > * context,
< a href = 'SkImageInfo_Reference#SkYUVColorSpace' > SkYUVColorSpace< / a > yuvColorSpace, const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > nv12Textures[2],
2018-10-05 19:19:24 +00:00
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > imageOrigin, const < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > & backendTexture,
< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > imageColorSpace = nullptr) ;
2018-09-18 11:31:37 +00:00
< / pre >
Creates < a href = '#Image' > Image< / a > from copy of < a href = '#SkImage_MakeFromNV12TexturesCopyWithExternalBackend_nv12Textures' > nv12Textures< / a > , an array of textures on GPU.
< a href = '#SkImage_MakeFromNV12TexturesCopyWithExternalBackend_nv12Textures' > nv12Textures< / a > [0] contains pixels for < a href = 'undocumented#YUV_Component_Y' > YUV Component Y< / a > plane.
< a href = '#SkImage_MakeFromNV12TexturesCopyWithExternalBackend_nv12Textures' > nv12Textures< / a > [1] contains pixels for < a href = 'undocumented#YUV_Component_U' > YUV Component U< / a > plane,
followed by pixels for < a href = 'undocumented#YUV_Component_V' > YUV Component V< / a > plane.
Returned < a href = '#Image' > Image< / a > has the dimensions < a href = '#SkImage_MakeFromNV12TexturesCopyWithExternalBackend_nv12Textures' > nv12Textures< / a > [2] and stores pixels in < a href = '#SkImage_MakeFromNV12TexturesCopyWithExternalBackend_backendTexture' > backendTexture< / a > .
< a href = '#SkImage_MakeFromNV12TexturesCopyWithExternalBackend_yuvColorSpace' > yuvColorSpace< / a > describes how YUV colors convert to RGB colors.
### Parameters
< table > < tr > < td > < a name = 'SkImage_MakeFromNV12TexturesCopyWithExternalBackend_context' > < code > < strong > context< / strong > < / code > < / a > < / td >
< td > < a href = 'undocumented#GPU_Context' > GPU Context< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromNV12TexturesCopyWithExternalBackend_yuvColorSpace' > < code > < strong > yuvColorSpace< / strong > < / code > < / a > < / td >
< td > one of: < a href = 'SkImageInfo_Reference#kJPEG_SkYUVColorSpace' > kJPEG_SkYUVColorSpace< / a > , < a href = 'SkImageInfo_Reference#kRec601_SkYUVColorSpace' > kRec601_SkYUVColorSpace< / a > ,
< a href = 'SkImageInfo_Reference#kRec709_SkYUVColorSpace' > kRec709_SkYUVColorSpace< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromNV12TexturesCopyWithExternalBackend_nv12Textures' > < code > < strong > nv12Textures< / strong > < / code > < / a > < / td >
< td > array of YUV textures on GPU< / td >
< / tr >
2018-10-05 19:19:24 +00:00
< tr > < td > < a name = 'SkImage_MakeFromNV12TexturesCopyWithExternalBackend_imageOrigin' > < code > < strong > imageOrigin< / strong > < / code > < / a > < / td >
2018-09-18 11:31:37 +00:00
< td > one of: < a href = 'undocumented#kBottomLeft_GrSurfaceOrigin' > kBottomLeft GrSurfaceOrigin< / a > , < a href = 'undocumented#kTopLeft_GrSurfaceOrigin' > kTopLeft GrSurfaceOrigin< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromNV12TexturesCopyWithExternalBackend_backendTexture' > < code > < strong > backendTexture< / strong > < / code > < / a > < / td >
2018-10-08 18:57:48 +00:00
< td > resource that stores final pixels< / td >
2018-09-18 11:31:37 +00:00
< / tr >
2018-10-05 19:19:24 +00:00
< tr > < td > < a name = 'SkImage_MakeFromNV12TexturesCopyWithExternalBackend_imageColorSpace' > < code > < strong > imageColorSpace< / strong > < / code > < / a > < / td >
2018-09-18 11:31:37 +00:00
< td > range of colors; may be nullptr< / td >
< / tr >
< / table >
### Return Value
created < a href = '#Image' > Image< / a > , or nullptr
### See Also
2018-10-05 19:19:24 +00:00
< a href = '#SkImage_MakeFromNV12TexturesCopy' > MakeFromNV12TexturesCopy< / a > < a href = '#SkImage_MakeFromYUVTexturesCopy' > MakeFromYUVTexturesCopy< / a > < a href = '#SkImage_MakeFromYUVATexturesCopyWithExternalBackend' > MakeFromYUVATexturesCopyWithExternalBackend< / a >
2018-01-02 16:34:14 +00:00
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
## <a name='SkImage_BitDepth'>Enum SkImage::BitDepth</a>
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 class < a href = '#SkImage_BitDepth' > BitDepth< / a > {
< a href = '#SkImage_BitDepth_kU8' > kU8< / a > ,
< a href = '#SkImage_BitDepth_kF16' > kF16< / a > ,
2018-04-03 12:43:27 +00:00
};
2018-03-05 18:26:16 +00:00
< / pre >
2017-11-27 15:44:06 +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 = 'SkImage_BitDepth_kU8' >< code > SkImage::BitDepth::kU8</ code ></ a ></ td >
< td style = 'text-align: center; border: 2px solid #dddddd ; padding: 8px; ' > 0</ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >
2018-05-17 16:17:28 +00:00
Use 8 bits per ARGB component using unsigned integer format.
2018-03-05 18:26:16 +00:00
< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< tr >
2018-05-16 11:07:07 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a name = 'SkImage_BitDepth_kF16' >< code > SkImage::BitDepth::kF16</ 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; ' >
2018-05-17 16:17:28 +00:00
Use 16 bits per ARGB component using half-precision floating point format.
2018-03-05 18:26:16 +00:00
< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeFromPicture' > MakeFromPicture< / a >
2017-11-27 15:44:06 +00:00
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_MakeFromPicture' > < / a >
2017-11-27 15:44:06 +00:00
## MakeFromPicture
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
2018-06-27 15:00:21 +00:00
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromPicture' > MakeFromPicture< / a > (< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'SkPicture_Reference#SkPicture' > SkPicture< / a > > picture, const < a href = 'undocumented#SkISize' > SkISize< / a > & dimensions,
2018-05-16 11:07:07 +00:00
const < a href = 'SkMatrix_Reference#SkMatrix' > SkMatrix< / a > * matrix, const < a href = 'SkPaint_Reference#SkPaint' > SkPaint< / a > * paint,
< a href = '#SkImage_BitDepth' > BitDepth< / a > bitDepth, < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > < a href = '#SkImage_colorSpace' > colorSpace< / a > )
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = '#Image' > Image< / a > from < a href = '#SkImage_MakeFromPicture_picture' > picture< / a > . Returned < a href = '#Image' > Image< / a > width and height are set by dimensions.
< a href = '#Image' > Image< / a > draws < a href = '#SkImage_MakeFromPicture_picture' > picture< / a > with < a href = '#SkImage_MakeFromPicture_matrix' > matrix< / a > and < a href = '#SkImage_MakeFromPicture_paint' > paint< / a > , set to < a href = '#SkImage_MakeFromPicture_bitDepth' > bitDepth< / a > and < a href = '#SkImage_colorSpace' > colorSpace< / a > .
2018-01-02 16:34:14 +00:00
2018-05-16 11:07:07 +00:00
If < a href = '#SkImage_MakeFromPicture_matrix' > matrix< / a > is nullptr, draws with identity < a href = 'SkMatrix_Reference#Matrix' > Matrix< / a > . If < a href = '#SkImage_MakeFromPicture_paint' > paint< / a > is nullptr, draws
with default < a href = 'SkPaint_Reference#Paint' > Paint< / a > . < a href = '#SkImage_colorSpace' > colorSpace< / a > may be nullptr.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_MakeFromPicture_picture' > < code > < strong > picture< / strong > < / code > < / a > < / td >
< td > stream of drawing commands< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromPicture_dimensions' > < code > < strong > dimensions< / strong > < / code > < / a > < / td >
< td > width and height< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromPicture_matrix' > < code > < strong > matrix< / strong > < / code > < / a > < / td >
< td > < a href = 'SkMatrix_Reference#Matrix' > Matrix< / a > to rotate, scale, translate, and so on; may be nullptr< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromPicture_paint' > < code > < strong > paint< / strong > < / code > < / a > < / td >
< td > < a href = 'SkPaint_Reference#Paint' > Paint< / a > to apply transparency, filtering, and so on; may be nullptr< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromPicture_bitDepth' > < code > < strong > bitDepth< / strong > < / code > < / a > < / td >
< td > 8-bit integer or 16-bit float: per component< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromPicture_colorSpace' > < code > < strong > colorSpace< / strong > < / code > < / a > < / td >
< td > range of colors; may be nullptr< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
created < a href = '#Image' > Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
### Example
2018-01-02 16:34:14 +00:00
< div > < fiddle-embed name = "4aa2879b9e44dfd6648995326d2c4dcf" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = 'SkCanvas_Reference#SkCanvas_drawPicture' > SkCanvas::drawPicture< / a > < sup > < a href = 'SkCanvas_Reference#SkCanvas_drawPicture_2' > [2]< / a > < / sup > < sup > < a href = 'SkCanvas_Reference#SkCanvas_drawPicture_3' > [3]< / a > < / sup > < sup > < a href = 'SkCanvas_Reference#SkCanvas_drawPicture_4' > [4]< / a > < / sup >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_MakeFromAHardwareBuffer' > < / a >
2017-11-27 15:44:06 +00:00
## MakeFromAHardwareBuffer
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
2018-09-13 19:26:33 +00:00
static < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_MakeFromAHardwareBuffer' > MakeFromAHardwareBuffer< / a > (
AHardwareBuffer* hardwareBuffer,
< a href = 'SkImageInfo_Reference#SkAlphaType' > SkAlphaType< / a > < a href = '#SkImage_alphaType' > alphaType< / a > = < a href = 'SkImageInfo_Reference#kPremul_SkAlphaType' > kPremul_SkAlphaType< / a > ,
< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > < a href = '#SkImage_colorSpace' > colorSpace< / a > = nullptr,
< a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > surfaceOrigin = < a href = 'undocumented#kTopLeft_GrSurfaceOrigin' > kTopLeft GrSurfaceOrigin< / a > )
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = '#Image' > Image< / a > from Android hardware buffer.
Returned < a href = '#Image' > Image< / a > takes a reference on the buffer.
2017-11-27 15:44:06 +00:00
2018-01-04 21:11:51 +00:00
Only available on Android, when __ANDROID_API__ is defined to be 26 or greater.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_MakeFromAHardwareBuffer_hardwareBuffer' > < code > < strong > hardwareBuffer< / strong > < / code > < / a > < / td >
< td > AHardwareBuffer Android hardware buffer< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromAHardwareBuffer_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 >
< / tr >
< tr > < td > < a name = 'SkImage_MakeFromAHardwareBuffer_colorSpace' > < code > < strong > colorSpace< / strong > < / code > < / a > < / td >
< td > range of colors; may be nullptr< / td >
2017-11-27 15:44:06 +00:00
< / tr >
2018-09-13 19:26:33 +00:00
< tr > < td > < a name = 'SkImage_MakeFromAHardwareBuffer_surfaceOrigin' > < code > < strong > surfaceOrigin< / strong > < / code > < / a > < / td >
< td > one of: < a href = 'undocumented#kBottomLeft_GrSurfaceOrigin' > kBottomLeft GrSurfaceOrigin< / a > , < a href = 'undocumented#kTopLeft_GrSurfaceOrigin' > kTopLeft GrSurfaceOrigin< / a > < / td >
< / tr >
2017-11-27 15:44:06 +00:00
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
created < a href = '#Image' > Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeFromRaster' > MakeFromRaster< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
## <a name='Property'>Property</a>
< a name = 'SkImage_width' > < / a >
2017-11-27 15:44:06 +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 = '#SkImage_width' > width< / a > () const
2017-11-27 15:44:06 +00:00
< / pre >
2018-01-02 16:34:14 +00:00
Returns pixel count in each row.
2017-11-27 15:44:06 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
pixel width in < a href = '#Image' > Image< / a >
2017-11-27 15:44:06 +00:00
### Example
2018-01-11 15:35:44 +00:00
< div > < fiddle-embed name = "39a6d0bbeac6d957c2338e0bff865cf8" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-10-08 18:57:48 +00:00
< a href = '#SkImage_dimensions' > dimensions< / a > () < a href = '#SkImage_height' > height< / a > ()
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_height' > < / a >
2017-11-27 15:44:06 +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 = '#SkImage_height' > height< / a > () const
2017-11-27 15:44:06 +00:00
< / pre >
2017-12-11 21:03:17 +00:00
Returns pixel row count.
2017-11-27 15:44:06 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
pixel height in < a href = '#Image' > Image< / a >
2017-11-27 15:44:06 +00:00
### Example
2018-07-09 05:28:19 +00:00
< div > < fiddle-embed name = "6e563cb8351d34bd8af555a51bcd7a96" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-10-08 18:57:48 +00:00
< a href = '#SkImage_dimensions' > dimensions< / a > () < a href = '#SkImage_width' > width< / a > ()
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_dimensions' > < / a >
2017-11-27 15:44:06 +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 = '#SkImage_dimensions' > dimensions< / a > () const
2017-11-27 15:44:06 +00:00
< / pre >
2018-10-08 18:57:48 +00:00
Returns < a href = 'undocumented#ISize' > ISize< / a > { < a href = '#SkImage_width' > width< / a > (), < a href = '#SkImage_height' > height< / a > () }.
2017-12-11 21:03:17 +00:00
2017-11-27 15:44:06 +00:00
### Return Value
2018-10-08 18:57:48 +00:00
integral size of < a href = '#SkImage_width' > width< / a > () and < a href = '#SkImage_height' > height< / a > ()
2017-11-27 15:44:06 +00:00
### Example
2018-03-16 15:34:15 +00:00
< div > < fiddle-embed name = "96b4bc43b3667df9ba9e2dafb770d33c" >
#### Example Output
~~~~
dimensionsAsBounds == bounds
~~~~
< / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-10-08 18:57:48 +00:00
< a href = '#SkImage_height' > height< / a > () < a href = '#SkImage_width' > width< / a > () < a href = '#SkImage_bounds' > bounds< / a > ()
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_bounds' > < / a >
2017-11-27 15:44:06 +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 = '#SkImage_bounds' > bounds< / a > () const
2017-11-27 15:44:06 +00:00
< / pre >
2018-10-08 18:57:48 +00:00
Returns < a href = 'SkIRect_Reference#IRect' > IRect< / a > { 0, 0, < a href = '#SkImage_width' > width< / a > (), < a href = '#SkImage_height' > height< / a > () }.
2017-12-11 21:03:17 +00:00
2017-11-27 15:44:06 +00:00
### Return Value
2018-10-08 18:57:48 +00:00
integral rectangle from origin to < a href = '#SkImage_width' > width< / a > () and < a href = '#SkImage_height' > height< / a > ()
2017-11-27 15:44:06 +00:00
### Example
2018-07-19 03:49:13 +00:00
< div > < fiddle-embed name = "c204b38b3fc08914b0a634aa4eaec894" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-10-08 18:57:48 +00:00
< a href = '#SkImage_dimensions' > dimensions< / a > ()
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_uniqueID' > < / a >
2017-11-27 15:44:06 +00:00
## uniqueID
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 = '#SkImage_uniqueID' > uniqueID< / a > () const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns value unique to image. < a href = '#Image' > Image< / a > contents cannot change after < a href = '#Image' > Image< / a > is
created. Any operation to create a new < a href = '#Image' > Image< / a > will receive generate a new
2018-01-02 16:34:14 +00:00
unique number.
2017-11-27 15:44:06 +00:00
### Return Value
2018-01-02 16:34:14 +00:00
unique identifier
2017-11-27 15:44:06 +00:00
### Example
2018-01-02 16:34:14 +00:00
< div > < fiddle-embed name = "d70194c9c51e700335f95de91846d023" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_isLazyGenerated' > isLazyGenerated< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_alphaType' > < / a >
2017-11-27 15:44:06 +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 = '#SkImage_alphaType' > alphaType< / a > () const
2017-11-27 15:44:06 +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 > .
< a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > returned was a parameter to an < a href = '#Image' > Image< / a > constructor,
2018-01-02 16:34:14 +00:00
or was parsed from encoded data.
2017-11-27 15:44:06 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
< a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > in < a href = '#Image' > Image< / a >
2017-11-27 15:44:06 +00:00
### Example
2018-05-17 16:17:28 +00:00
< div > < fiddle-embed name = "1b9f1f05026ceb14ccb6926a13cdaa83" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = 'SkImageInfo_Reference#SkImageInfo_alphaType' > SkImageInfo::alphaType< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_colorType' > < / a >
2018-03-16 15:34:15 +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 = '#SkImage_colorType' > colorType< / a > () const
2018-03-16 15:34:15 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > if known; otherwise, returns < a href = 'SkImageInfo_Reference#kUnknown_SkColorType' > kUnknown_SkColorType< / a > .
2018-03-16 15:34:15 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
< a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > of < a href = '#Image' > Image< / a >
2018-03-16 15:34:15 +00:00
### Example
2018-05-17 16:17:28 +00:00
< div > < fiddle-embed name = "50396fad4a128f58e400ca00fe09711f" > < / fiddle-embed > < / div >
2018-03-16 15:34:15 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = 'SkImageInfo_Reference#SkImageInfo_colorType' > SkImageInfo::colorType< / a >
2018-03-16 15:34:15 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_colorSpace' > < / a >
2017-11-27 15:44:06 +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 = '#SkImage_colorSpace' > colorSpace< / a > () const
2017-11-27 15:44:06 +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 = '#Image' > Image< / 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-12-11 21:03:17 +00:00
immutable.
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#Color_Space' > Color Space< / a > returned was passed to an < a href = '#Image' > Image< / a > constructor,
or was parsed from encoded data. < a href = 'undocumented#Color_Space' > Color Space< / a > returned may be ignored when < a href = '#Image' > Image< / a >
is drawn, depending on the capabilities of the < a href = 'SkSurface_Reference#Surface' > Surface< / a > receiving the drawing.
2017-11-27 15:44:06 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#Color_Space' > Color Space< / a > in < a href = '#Image' > Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
### Example
2018-07-07 05:34:31 +00:00
< div > < fiddle-embed name = "4468d573f42af6f5e234be10a5453bb2" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_refColorSpace' > refColorSpace< / a > < a href = '#SkImage_makeColorSpace' > makeColorSpace< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_refColorSpace' > < / a >
2017-11-27 15:44:06 +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 = '#SkImage_refColorSpace' > refColorSpace< / a > () const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns a smart pointer to < a href = 'undocumented#Color_Space' > Color Space< / a > , the range of colors, associated with
< a href = '#Image' > Image< / a > . The smart pointer tracks the number of objects sharing this
< a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > reference so the memory is released when the owners destruct.
2018-01-03 13:37:53 +00:00
2018-05-16 11:07:07 +00:00
The returned < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > is immutable.
2018-01-03 13:37:53 +00:00
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#Color_Space' > Color Space< / a > returned was passed to an < a href = '#Image' > Image< / a > constructor,
or was parsed from encoded data. < a href = 'undocumented#Color_Space' > Color Space< / a > returned may be ignored when < a href = '#Image' > Image< / a >
is drawn, depending on the capabilities of the < a href = 'SkSurface_Reference#Surface' > Surface< / a > receiving the drawing.
2018-01-03 13:37:53 +00:00
2017-11-27 15:44:06 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#Color_Space' > Color Space< / a > in < a href = '#Image' > Image< / a > , or nullptr, wrapped in a smart pointer
2017-11-27 15:44:06 +00:00
### Example
2018-01-03 13:37:53 +00:00
< div > < fiddle-embed name = "59b2078ebfbda8736a57c0486ae33332" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_colorSpace' > colorSpace< / a > < a href = '#SkImage_makeColorSpace' > makeColorSpace< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_isAlphaOnly' > < / a >
2017-11-27 15:44:06 +00:00
## isAlphaOnly
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkImage_isAlphaOnly' > isAlphaOnly< / a > () const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns true if < a href = '#Image' > Image< / a > pixels represent transparency only. If true, each pixel
is packed in 8 bits as defined by < a href = 'SkImageInfo_Reference#kAlpha_8_SkColorType' > kAlpha_8_SkColorType< / a > .
2017-11-27 15:44:06 +00:00
### Return Value
2017-12-11 21:03:17 +00:00
true if pixels represent a transparency mask
2017-11-27 15:44:06 +00:00
### Example
2018-01-03 13:37:53 +00:00
< div > < fiddle-embed name = "50762c73b8ea91959c5a7b68fbf1062d" >
#### Example Output
~~~~
alphaOnly = true
~~~~
< / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_alphaType' > alphaType< / a > < a href = '#SkImage_isOpaque' > isOpaque< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_isOpaque' > < / a >
2017-11-27 15:44:06 +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 = '#SkImage_isOpaque' > isOpaque< / a > () const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns true if pixels ignore their < a href = 'SkColor_Reference#Alpha' > Alpha< / a > value and are treated as fully opaque.
2017-12-11 21:03:17 +00:00
2017-11-27 15:44:06 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > is < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a >
2017-11-27 15:44:06 +00:00
### Example
2018-01-03 13:37:53 +00:00
< div > < fiddle-embed name = "e3340460003b74ee286d625e68589d65" >
#### Example Output
~~~~
isOpaque = false
isOpaque = true
~~~~
< / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_alphaType' > alphaType< / a > < a href = '#SkImage_isAlphaOnly' > isAlphaOnly< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_makeShader' > < / a >
2017-11-27 15:44:06 +00:00
## makeShader
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#SkShader' > SkShader< / a > > < a href = '#SkImage_makeShader' > makeShader< / a > (< a href = 'undocumented#SkShader_TileMode' > SkShader::TileMode< / a > tileMode1, < a href = 'undocumented#SkShader_TileMode' > SkShader::TileMode< / a > tileMode2,
const < a href = 'SkMatrix_Reference#SkMatrix' > SkMatrix< / a > * localMatrix = nullptr) const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = 'undocumented#Shader' > Shader< / a > from < a href = '#Image' > Image< / a > . < a href = 'undocumented#Shader' > Shader< / a > dimensions are taken from < a href = '#Image' > Image< / a > . < a href = 'undocumented#Shader' > Shader< / a > uses
< a href = 'undocumented#SkShader_TileMode' > SkShader::TileMode< / a > rules to fill drawn area outside < a href = '#Image' > Image< / a > . < a href = '#SkImage_makeShader_localMatrix' > localMatrix< / a > permits
transforming < a href = '#Image' > Image< / a > before < a href = 'SkCanvas_Reference#Matrix' > Canvas Matrix< / a > is applied.
2018-01-03 13:37:53 +00:00
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_makeShader_tileMode1' > < code > < strong > tileMode1< / strong > < / code > < / a > < / td >
2018-06-14 16:28:14 +00:00
< td > tiling on x-axis, one of: < a href = 'undocumented#SkShader_kClamp_TileMode' > SkShader::kClamp TileMode< / a > ,
< a href = 'undocumented#SkShader_kRepeat_TileMode' > SkShader::kRepeat TileMode< / a > , < a href = 'undocumented#SkShader_kMirror_TileMode' > SkShader::kMirror TileMode< / a > < / td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr > < td > < a name = 'SkImage_makeShader_tileMode2' > < code > < strong > tileMode2< / strong > < / code > < / a > < / td >
2018-06-14 16:28:14 +00:00
< td > tiling on y-axis, one of: < a href = 'undocumented#SkShader_kClamp_TileMode' > SkShader::kClamp TileMode< / a > ,
< a href = 'undocumented#SkShader_kRepeat_TileMode' > SkShader::kRepeat TileMode< / a > , < a href = 'undocumented#SkShader_kMirror_TileMode' > SkShader::kMirror TileMode< / a > < / td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr > < td > < a name = 'SkImage_makeShader_localMatrix' > < code > < strong > localMatrix< / strong > < / code > < / a > < / td >
< td > < a href = '#Image' > Image< / a > transformation, or nullptr< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#Shader' > Shader< / a > containing < a href = '#Image' > Image< / a >
2017-11-27 15:44:06 +00:00
### Example
2018-01-03 13:37:53 +00:00
< div > < fiddle-embed name = "1c6de6fe72b00b5be970f5f718363449" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_scalePixels' > scalePixels< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_makeShader_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 " >
< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkShader' > SkShader< / a > > < a href = '#SkImage_makeShader' > makeShader< / a > (const < a href = 'SkMatrix_Reference#SkMatrix' > SkMatrix< / a > * localMatrix = nullptr) const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = 'undocumented#Shader' > Shader< / a > from < a href = '#Image' > Image< / a > . < a href = 'undocumented#Shader' > Shader< / a > dimensions are taken from < a href = '#Image' > Image< / a > . < a href = 'undocumented#Shader' > Shader< / a > uses
< a href = 'undocumented#SkShader_kClamp_TileMode' > SkShader::kClamp TileMode< / a > to fill drawn area outside < a href = '#Image' > Image< / a > . < a href = '#SkImage_makeShader_2_localMatrix' > localMatrix< / a > permits
transforming < a href = '#Image' > Image< / a > before < a href = 'SkCanvas_Reference#Matrix' > Canvas Matrix< / a > is applied.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_makeShader_2_localMatrix' > < code > < strong > localMatrix< / strong > < / code > < / a > < / td >
< td > < a href = '#Image' > Image< / a > transformation, or nullptr< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
< a href = 'undocumented#Shader' > Shader< / a > containing < a href = '#Image' > Image< / a >
2017-11-27 15:44:06 +00:00
### Example
2018-07-05 05:35:27 +00:00
< div > < fiddle-embed name = "10172fca71b9dbdcade772513ffeb27e" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_scalePixels' > scalePixels< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
## <a name='Pixels'>Pixels</a>
< a name = 'SkImage_peekPixels' > < / a >
2017-11-27 15:44:06 +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 = '#SkImage_peekPixels' > peekPixels< / a > (< a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > * pixmap) const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Copies < a href = '#Image' > Image< / a > pixel address, row bytes, and < a href = 'SkImageInfo_Reference#Image_Info' > Image Info< / a > to < a href = '#SkImage_peekPixels_pixmap' > pixmap< / a > , if address
2018-01-05 17:10:09 +00:00
is available, and returns true. If pixel address is not available, return
2018-05-16 11:07:07 +00:00
false and leave < a href = '#SkImage_peekPixels_pixmap' > pixmap< / a > unchanged.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_peekPixels_pixmap' > < code > < strong > pixmap< / strong > < / code > < / a > < / td >
< td > storage for pixel state if pixels are readable; otherwise, ignored< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = '#Image' > Image< / a > has direct access to pixels
2017-11-27 15:44:06 +00:00
### Example
2018-01-05 17:10:09 +00:00
< div > < fiddle-embed name = "900c0eab8dfdecd8301ed5be95887f8e" >
#### Example Output
~~~~
------------
--xx----x---
-x--x--x----
-x--x--x----
-x--x-x-----
--xx-xx-xx--
-----x-x--x-
----x--x--x-
----x--x--x-
---x----xx--
------------
~~~~
< / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_readPixels' > readPixels< / a > < sup > < a href = '#SkImage_readPixels_2' > [2]< / a > < / sup >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_getTexture' > < / a >
2017-11-27 15:44:06 +00:00
## getTexture
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
GrTexture* < a href = '#SkImage_getTexture' > getTexture< / a > () const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Deprecated.
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_isTextureBacked' > < / a >
2017-11-27 15:44:06 +00:00
## isTextureBacked
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkImage_isTextureBacked' > isTextureBacked< / a > () const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns true the contents of < a href = '#Image' > Image< / a > was created on or uploaded to GPU memory,
and is available as a < a href = 'undocumented#GPU_Texture' > GPU Texture< / a > .
2017-11-27 15:44:06 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = '#Image' > Image< / a > is a < a href = 'undocumented#GPU_Texture' > GPU Texture< / a >
2017-11-27 15:44:06 +00:00
### Example
2018-07-08 05:32:09 +00:00
< div > < fiddle-embed name = "27a0ab44659201f1aa2ac7fea73368c2" gpu = "true" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeFromTexture' > MakeFromTexture< / a > < sup > < a href = '#SkImage_MakeFromTexture_2' > [2]< / a > < / sup > < a href = '#SkImage_isValid' > isValid< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_isValid' > < / a >
2017-11-27 15:44:06 +00:00
## isValid
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkImage_isValid' > isValid< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context) const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns true if < a href = '#Image' > Image< / a > can be drawn on either < a href = 'undocumented#Raster_Surface' > Raster Surface< / a > or < a href = 'undocumented#GPU_Surface' > GPU Surface< / a > .
If < a href = '#SkImage_isValid_context' > context< / a > is nullptr, tests if < a href = '#Image' > Image< / a > draws on < a href = 'undocumented#Raster_Surface' > Raster Surface< / a > ;
otherwise, tests if < a href = '#Image' > Image< / a > draws on < a href = 'undocumented#GPU_Surface' > GPU Surface< / a > associated with < a href = '#SkImage_isValid_context' > context< / a > .
2017-11-27 15:44:06 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > backed by < a href = 'undocumented#GPU_Texture' > GPU Texture< / a > may become invalid if associated < a href = 'undocumented#GrContext' > GrContext< / a > is
invalid. < a href = '#Lazy_Image' > Lazy Image< / a > may be invalid and may not draw to < a href = 'undocumented#Raster_Surface' > Raster Surface< / a > or
< a href = 'undocumented#GPU_Surface' > GPU Surface< / a > or both.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_isValid_context' > < code > < strong > context< / strong > < / code > < / a > < / td >
< td > < a href = 'undocumented#GPU_Context' > GPU Context< / a > < / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = '#Image' > Image< / a > can be drawn
2017-11-27 15:44:06 +00:00
### Example
2018-06-07 21:07:17 +00:00
< div > < fiddle-embed name = "8f7281446008cf4a9910fe73f44fa8d6" gpu = "true" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_isTextureBacked' > isTextureBacked< / a > < a href = '#SkImage_isLazyGenerated' > isLazyGenerated< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_getBackendTexture' > < / a >
2018-04-05 06:22:29 +00:00
## getBackendTexture
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
< a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > < a href = '#SkImage_getBackendTexture' > getBackendTexture< / a > (bool flushPendingGrContextIO, < a href = 'undocumented#GrSurfaceOrigin' > GrSurfaceOrigin< / a > * origin = nullptr) const
2018-04-05 06:22:29 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Retrieves the back-end texture. If < a href = '#Image' > Image< / a > has no back-end texture, an invalid
object is returned. Call < a href = 'undocumented#GrBackendTexture_isValid' > GrBackendTexture::isValid< / a > to determine if the result
2018-04-05 12:18:41 +00:00
is valid.
2018-05-16 11:07:07 +00:00
If < a href = '#SkImage_getBackendTexture_flushPendingGrContextIO' > flushPendingGrContextIO< / a > is true, completes deferred I/O operations.
2018-04-05 06:22:29 +00:00
2018-05-16 11:07:07 +00:00
If < a href = '#SkImage_getBackendTexture_origin' > origin< / a > in not nullptr, copies location of content drawn into < a href = '#Image' > Image< / a > .
2018-04-05 06:22:29 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_getBackendTexture_flushPendingGrContextIO' > < code > < strong > flushPendingGrContextIO< / strong > < / code > < / a > < / td >
< td > flag to flush outstanding requests< / td >
< / tr >
< tr > < td > < a name = 'SkImage_getBackendTexture_origin' > < code > < strong > origin< / strong > < / code > < / a > < / td >
< td > storage for one of: < a href = 'undocumented#kTopLeft_GrSurfaceOrigin' > kTopLeft GrSurfaceOrigin< / a > ,
< a href = 'undocumented#kBottomLeft_GrSurfaceOrigin' > kBottomLeft GrSurfaceOrigin< / a > ; or nullptr< / td >
2018-04-05 06:22:29 +00:00
< / tr >
< / table >
### Return Value
2018-04-05 12:18:41 +00:00
back-end API texture handle; invalid on failure
### Example
< div > < fiddle-embed name = "d093aad721261f421c4bef4a296aab48" gpu = "true" > < / fiddle-embed > < / div >
2018-04-05 06:22:29 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeFromTexture' > MakeFromTexture< / a > < sup > < a href = '#SkImage_MakeFromTexture_2' > [2]< / a > < / sup > < a href = '#SkImage_isTextureBacked' > isTextureBacked< / a >
2018-04-05 06:22:29 +00:00
---
2018-05-16 11:07:07 +00:00
## <a name='SkImage_CachingHint'>Enum SkImage::CachingHint</a>
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 = '#SkImage_CachingHint' > CachingHint< / a > {
2018-10-08 18:57:48 +00:00
< a href = '#SkImage_kAllow_CachingHint' > kAllow_CachingHint< / a > ,
< a href = '#SkImage_kDisallow_CachingHint' > kDisallow_CachingHint< / a > ,
2018-04-03 12:43:27 +00:00
};
2018-03-05 18:26:16 +00:00
< / pre >
2017-11-27 15:44:06 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_CachingHint' > CachingHint< / a > selects whether Skia may internally cache < a href = 'SkBitmap_Reference#Bitmap' > Bitmaps< / a > generated by
decoding < a href = '#Image' > Image< / a > , or by copying < a href = '#Image' > Image< / a > from GPU to CPU. The default behavior
allows caching < a href = 'SkBitmap_Reference#Bitmap' > Bitmaps< / a > .
2018-01-11 15:35:44 +00:00
2018-05-16 11:07:07 +00:00
Choose < a href = '#SkImage_kDisallow_CachingHint' > kDisallow CachingHint< / a > if < a href = '#Image' > Image< / a > pixels are to be used only once, or
if < a href = '#Image' > Image< / a > pixels reside in a cache outside of Skia, or to reduce memory pressure.
2018-01-11 15:35:44 +00:00
2018-05-16 11:07:07 +00:00
Choosing < a href = '#SkImage_kAllow_CachingHint' > kAllow CachingHint< / a > does not ensure that pixels will be cached.
< a href = '#Image' > Image< / a > pixels may not be cached if memory requirements are too large or
2018-01-11 15:35:44 +00:00
pixels are not accessible.
2017-11-27 15:44:06 +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 = 'SkImage_kAllow_CachingHint' >< code > SkImage::kAllow_CachingHint</ code ></ a ></ td >
< td style = 'text-align: center; border: 2px solid #dddddd ; padding: 8px; ' > 0</ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >
allows internally caching decoded and copied pixels< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< tr >
2018-05-16 11:07:07 +00:00
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >< a name = 'SkImage_kDisallow_CachingHint' >< code > SkImage::kDisallow_CachingHint</ 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; ' >
disallows internally caching decoded and copied pixels< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_readPixels' > readPixels< / a > < sup > < a href = '#SkImage_readPixels_2' > [2]< / a > < / sup > < a href = '#SkImage_scalePixels' > scalePixels< / a >
2017-11-27 15:44:06 +00:00
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_readPixels' > < / a >
2017-11-27 15:44:06 +00:00
## readPixels
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkImage_readPixels' > readPixels< / a > (const < a href = 'SkImageInfo_Reference#SkImageInfo' > SkImageInfo< / a > & dstInfo, void* dstPixels, size_t dstRowBytes, int srcX, int srcY,
< a href = '#SkImage_CachingHint' > CachingHint< / a > cachingHint = < a href = '#SkImage_kAllow_CachingHint' > kAllow CachingHint< / a > ) const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Copies < a href = 'SkRect_Reference#Rect' > Rect< / a > of pixels from < a href = '#Image' > Image< / a > to < a href = '#SkImage_readPixels_dstPixels' > dstPixels< / a > . Copy starts at offset (< a href = '#SkImage_readPixels_srcX' > srcX< / a > , < a href = '#SkImage_readPixels_srcY' > srcY< / a > ),
2018-10-08 18:57:48 +00:00
and does not exceed < a href = '#Image' > Image< / a > (< a href = '#SkImage_width' > width< / a > (), < a href = '#SkImage_height' > height< / a > ()).
2017-11-27 15:44:06 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_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 = '#SkImage_readPixels_dstRowBytes' > dstRowBytes< / a > specifics the gap from one destination row to the next.
2018-01-11 15:35:44 +00:00
Returns true if pixels are copied. Returns false if:
< table > < tr >
2018-05-16 11:07:07 +00:00
< td > < a href = '#SkImage_readPixels_dstInfo' > dstInfo< / a > .addr() equals nullptr< / td >
< / tr > < tr >
< td > < a href = '#SkImage_readPixels_dstRowBytes' > dstRowBytes< / a > is less than < a href = '#SkImage_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 >
2018-01-11 15:35:44 +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 = '#Image' > Image< / a > < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / 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 = '#SkImage_readPixels_dstInfo' > dstInfo< / a > .< a href = '#SkImage_colorType' > colorType< / a > must match.
If < a href = '#Image' > Image< / a > < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > is < a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , < a href = '#SkImage_readPixels_dstInfo' > dstInfo< / a > .< a href = '#SkImage_colorSpace' > colorSpace< / a > must match.
If < a href = '#Image' > Image< / a > < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > is < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a > , < a href = '#SkImage_readPixels_dstInfo' > dstInfo< / a > .< a href = '#SkImage_alphaType' > alphaType< / a > must
match. If < a href = '#Image' > Image< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > is nullptr, < a href = '#SkImage_readPixels_dstInfo' > dstInfo< / a > .< a href = '#SkImage_colorSpace' > colorSpace< / a > must match. Returns
2018-01-11 15:35:44 +00:00
false if pixel conversion is not possible.
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_readPixels_srcX' > srcX< / a > and < a href = '#SkImage_readPixels_srcY' > srcY< / a > may be negative to copy only top or left of source. Returns
2018-10-08 18:57:48 +00:00
false if < a href = '#SkImage_width' > width< / a > () or < a href = '#SkImage_height' > height< / a > () is zero or negative.
Returns false if < code > abs(srcX) >= < a href = '#Image' > Image</ a > < a href = '#SkImage_width' > width</ a > (\)</ code > , or if < code > abs(srcY) >= < a href = '#Image' > Image</ a > < a href = '#SkImage_height' > height</ a > (\)</ code > .
2017-11-27 15:44:06 +00:00
2018-05-16 11:07:07 +00:00
If < a href = '#SkImage_readPixels_cachingHint' > cachingHint< / a > is < a href = '#SkImage_kAllow_CachingHint' > kAllow CachingHint< / a > , pixels may be retained locally.
If < a href = '#SkImage_readPixels_cachingHint' > cachingHint< / a > is < a href = '#SkImage_kDisallow_CachingHint' > kDisallow CachingHint< / a > , pixels are not added to the local cache.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_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 = 'SkImage_readPixels_dstPixels' > < code > < strong > dstPixels< / strong > < / code > < / a > < / td >
< td > destination pixel storage< / td >
< / tr >
< tr > < td > < a name = 'SkImage_readPixels_dstRowBytes' > < code > < strong > dstRowBytes< / strong > < / code > < / a > < / td >
< td > destination row length< / td >
< / tr >
< tr > < td > < a name = 'SkImage_readPixels_srcX' > < code > < strong > srcX< / strong > < / code > < / a > < / td >
2018-10-08 18:57:48 +00:00
< td > column index whose absolute value is less than < a href = '#SkImage_width' > width< / a > ()< / td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr > < td > < a name = 'SkImage_readPixels_srcY' > < code > < strong > srcY< / strong > < / code > < / a > < / td >
2018-10-08 18:57:48 +00:00
< td > row index whose absolute value is less than < a href = '#SkImage_height' > height< / a > ()< / td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr > < td > < a name = 'SkImage_readPixels_cachingHint' > < code > < strong > cachingHint< / strong > < / code > < / a > < / td >
< td > one of: < a href = '#SkImage_kAllow_CachingHint' > kAllow CachingHint< / a > , < a href = '#SkImage_kDisallow_CachingHint' > kDisallow CachingHint< / a > < / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if pixels are copied to < a href = '#SkImage_readPixels_dstPixels' > dstPixels< / a >
2017-11-27 15:44:06 +00:00
### Example
2018-01-11 15:35:44 +00:00
< div > < fiddle-embed name = "8aa8ca63dff4641dfc6ea8a3c555d59c" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-07-17 17:19:56 +00:00
< a href = '#SkImage_scalePixels' > scalePixels< / a > < a href = 'SkBitmap_Reference#SkBitmap_readPixels' > SkBitmap::readPixels< / a > < sup > < a href = 'SkBitmap_Reference#SkBitmap_readPixels_2' > [2]< / a > < / sup > < sup > < a href = 'SkBitmap_Reference#SkBitmap_readPixels_3' > [3]< / 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 = '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-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_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 " >
bool < a href = '#SkImage_readPixels' > readPixels< / a > (const < a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > & dst, int srcX, int srcY, < a href = '#SkImage_CachingHint' > CachingHint< / a > cachingHint = < a href = '#SkImage_kAllow_CachingHint' > kAllow CachingHint< / a > ) const
2017-11-27 15:44:06 +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 = '#Image' > Image< / a > to < a href = '#SkImage_readPixels_2_dst' > dst< / a > . Copy starts at (< a href = '#SkImage_readPixels_2_srcX' > srcX< / a > , < a href = '#SkImage_readPixels_2_srcY' > srcY< / a > ), and
2018-10-08 18:57:48 +00:00
does not exceed < a href = '#Image' > Image< / a > (< a href = '#SkImage_width' > width< / a > (), < a href = '#SkImage_height' > height< / a > ()).
2018-01-11 15:35:44 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_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 = '#SkImage_readPixels_2_dst' > dst< / a > .< a href = 'SkPixmap_Reference#SkPixmap' > rowBytes< / a > specifics the gap from one destination
2018-01-11 15:35:44 +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 = '#SkImage_readPixels_2_dst' > dst< / a > pixel storage equals nullptr< / td >
< / tr > < tr >
< td > < a href = '#SkImage_readPixels_2_dst' > dst< / a > .< a href = 'SkPixmap_Reference#SkPixmap' > 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 >
2018-01-11 15:35:44 +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 = '#Image' > Image< / a > < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / 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 = '#SkImage_readPixels_2_dst' > dst< / a > .< a href = '#SkImage_colorType' > colorType< / a > must match.
If < a href = '#Image' > Image< / a > < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > is < a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , < a href = '#SkImage_readPixels_2_dst' > dst< / a > .< a href = '#SkImage_colorSpace' > colorSpace< / a > must match.
If < a href = '#Image' > Image< / a > < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > is < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a > , < a href = '#SkImage_readPixels_2_dst' > dst< / a > .< a href = '#SkImage_alphaType' > alphaType< / a > must
match. If < a href = '#Image' > Image< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > is nullptr, < a href = '#SkImage_readPixels_2_dst' > dst< / a > .< a href = '#SkImage_colorSpace' > colorSpace< / a > must match. Returns
2018-01-11 15:35:44 +00:00
false if pixel conversion is not possible.
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_readPixels_2_srcX' > srcX< / a > and < a href = '#SkImage_readPixels_2_srcY' > srcY< / a > may be negative to copy only top or left of source. Returns
2018-10-08 18:57:48 +00:00
false if < a href = '#SkImage_width' > width< / a > () or < a href = '#SkImage_height' > height< / a > () is zero or negative.
Returns false if < code > abs(srcX) >= < a href = '#Image' > Image</ a > < a href = '#SkImage_width' > width</ a > (\)</ code > , or if < code > abs(srcY) >= < a href = '#Image' > Image</ a > < a href = '#SkImage_height' > height</ a > (\)</ code > .
2018-05-16 11:07:07 +00:00
If < a href = '#SkImage_readPixels_2_cachingHint' > cachingHint< / a > is < a href = '#SkImage_kAllow_CachingHint' > kAllow CachingHint< / a > , pixels may be retained locally.
If < a href = '#SkImage_readPixels_2_cachingHint' > cachingHint< / a > is < a href = '#SkImage_kDisallow_CachingHint' > kDisallow CachingHint< / a > , pixels are not added to the local cache.
2018-01-11 15:35:44 +00:00
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_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 >
< / tr >
< tr > < td > < a name = 'SkImage_readPixels_2_srcX' > < code > < strong > srcX< / strong > < / code > < / a > < / td >
2018-10-08 18:57:48 +00:00
< td > column index whose absolute value is less than < a href = '#SkImage_width' > width< / a > ()< / td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr > < td > < a name = 'SkImage_readPixels_2_srcY' > < code > < strong > srcY< / strong > < / code > < / a > < / td >
2018-10-08 18:57:48 +00:00
< td > row index whose absolute value is less than < a href = '#SkImage_height' > height< / a > ()< / td >
2018-05-16 11:07:07 +00:00
< / tr >
< tr > < td > < a name = 'SkImage_readPixels_2_cachingHint' > < code > < strong > cachingHint< / strong > < / code > < / a > < / td >
< td > one of: < a href = '#SkImage_kAllow_CachingHint' > kAllow CachingHint< / a > , < a href = '#SkImage_kDisallow_CachingHint' > kDisallow CachingHint< / a > < / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if pixels are copied to < a href = '#SkImage_readPixels_2_dst' > dst< / a >
2017-11-27 15:44:06 +00:00
### Example
2018-01-11 15:35:44 +00:00
< div > < fiddle-embed name = "b77a73c4baa63a4a8e2a4fdd96144d0b" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-07-17 17:19:56 +00:00
< a href = '#SkImage_scalePixels' > scalePixels< / a > < a href = 'SkBitmap_Reference#SkBitmap_readPixels' > SkBitmap::readPixels< / a > < sup > < a href = 'SkBitmap_Reference#SkBitmap_readPixels_2' > [2]< / a > < / sup > < sup > < a href = 'SkBitmap_Reference#SkBitmap_readPixels_3' > [3]< / 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 = '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-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_scalePixels' > < / a >
2017-11-27 15:44:06 +00:00
## scalePixels
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkImage_scalePixels' > scalePixels< / a > (const < a href = 'SkPixmap_Reference#SkPixmap' > SkPixmap< / a > & dst, < a href = 'undocumented#SkFilterQuality' > SkFilterQuality< / a > filterQuality,
< a href = '#SkImage_CachingHint' > CachingHint< / a > cachingHint = < a href = '#SkImage_kAllow_CachingHint' > kAllow CachingHint< / a > ) const
2017-11-27 15:44:06 +00:00
< / pre >
2018-10-08 18:57:48 +00:00
Copies < a href = '#Image' > Image< / a > to < a href = '#SkImage_scalePixels_dst' > dst< / a > , scaling pixels to fit < a href = '#SkImage_scalePixels_dst' > dst< / a > .< a href = '#SkImage_width' > width< / a > () and < a href = '#SkImage_scalePixels_dst' > dst< / a > .< a href = '#SkImage_height' > height< / a > (), and
2018-05-16 11:07:07 +00:00
converting pixels to match < a href = '#SkImage_scalePixels_dst' > dst< / a > .< a href = '#SkImage_colorType' > colorType< / a > and < a href = '#SkImage_scalePixels_dst' > dst< / a > .< a href = '#SkImage_alphaType' > alphaType< / a > . Returns true if
pixels are copied. Returns false if < a href = '#SkImage_scalePixels_dst' > dst< / a > .addr() is nullptr, or < a href = '#SkImage_scalePixels_dst' > dst< / a > .< a href = 'SkPixmap_Reference#SkPixmap' > rowBytes< / a > is
less than < a href = '#SkImage_scalePixels_dst' > dst< / a > < a href = 'SkImageInfo_Reference#SkImageInfo_minRowBytes' > SkImageInfo::minRowBytes< / a > .
2018-01-11 15:35:44 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Pixels' > Pixels< / a > are copied only if pixel conversion is possible. If < a href = '#Image' > Image< / a > < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / 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 = '#SkImage_scalePixels_dst' > dst< / a > .< a href = '#SkImage_colorType' > colorType< / a > must match.
If < a href = '#Image' > Image< / a > < a href = 'SkImageInfo_Reference#Color_Type' > Color Type< / a > is < a href = 'SkImageInfo_Reference#kGray_8_SkColorType' > kGray_8_SkColorType< / a > , < a href = '#SkImage_scalePixels_dst' > dst< / a > .< a href = '#SkImage_colorSpace' > colorSpace< / a > must match.
If < a href = '#Image' > Image< / a > < a href = 'SkImageInfo_Reference#Alpha_Type' > Alpha Type< / a > is < a href = 'SkImageInfo_Reference#kOpaque_SkAlphaType' > kOpaque_SkAlphaType< / a > , < a href = '#SkImage_scalePixels_dst' > dst< / a > .< a href = '#SkImage_alphaType' > alphaType< / a > must
match. If < a href = '#Image' > Image< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > is nullptr, < a href = '#SkImage_scalePixels_dst' > dst< / a > .< a href = '#SkImage_colorSpace' > colorSpace< / a > must match. Returns
2018-01-11 15:35:44 +00:00
false if pixel conversion is not possible.
2018-10-08 18:57:48 +00:00
Scales the image, with < a href = '#SkImage_scalePixels_filterQuality' > filterQuality< / a > , to match < a href = '#SkImage_scalePixels_dst' > dst< / a > .< a href = '#SkImage_width' > width< / a > () and < a href = '#SkImage_scalePixels_dst' > dst< / a > .< a href = '#SkImage_height' > height< / a > ().
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_scalePixels_filterQuality' > filterQuality< / a > < a href = 'undocumented#kNone_SkFilterQuality' > kNone_SkFilterQuality< / a > is fastest, typically implemented with
< a href = 'undocumented#Nearest_Neighbor' > Filter Quality Nearest Neighbor< / a > . < a href = 'undocumented#kLow_SkFilterQuality' > kLow_SkFilterQuality< / a > is typically implemented with
< a href = 'undocumented#Bilerp' > Filter Quality Bilerp< / a > . < a href = 'undocumented#kMedium_SkFilterQuality' > kMedium_SkFilterQuality< / a > is typically implemented with
< a href = 'undocumented#Bilerp' > Filter Quality Bilerp< / a > , and < a href = 'undocumented#MipMap' > Filter Quality MipMap< / a > when size is reduced.
< a href = 'undocumented#kHigh_SkFilterQuality' > kHigh_SkFilterQuality< / a > is slowest, typically implemented with < a href = 'undocumented#BiCubic' > Filter Quality BiCubic< / a > .
2018-01-11 15:35:44 +00:00
2018-05-16 11:07:07 +00:00
If < a href = '#SkImage_scalePixels_cachingHint' > cachingHint< / a > is < a href = '#SkImage_kAllow_CachingHint' > kAllow CachingHint< / a > , pixels may be retained locally.
If < a href = '#SkImage_scalePixels_cachingHint' > cachingHint< / a > is < a href = '#SkImage_kDisallow_CachingHint' > kDisallow CachingHint< / a > , pixels are not added to the local cache.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_scalePixels_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 >
< tr > < td > < a name = 'SkImage_scalePixels_filterQuality' > < code > < strong > filterQuality< / strong > < / code > < / a > < / td >
< td > one of: < a href = 'undocumented#kNone_SkFilterQuality' > kNone_SkFilterQuality< / a > , < a href = 'undocumented#kLow_SkFilterQuality' > kLow_SkFilterQuality< / a > ,
< a href = 'undocumented#kMedium_SkFilterQuality' > kMedium_SkFilterQuality< / a > , < a href = 'undocumented#kHigh_SkFilterQuality' > kHigh_SkFilterQuality< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_scalePixels_cachingHint' > < code > < strong > cachingHint< / strong > < / code > < / a > < / td >
< td > one of: < a href = '#SkImage_kAllow_CachingHint' > kAllow CachingHint< / a > , < a href = '#SkImage_kDisallow_CachingHint' > kDisallow CachingHint< / a > < / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if pixels are scaled to fit < a href = '#SkImage_scalePixels_dst' > dst< / a >
2017-11-27 15:44:06 +00:00
### Example
2018-01-11 15:35:44 +00:00
< div > < fiddle-embed name = "5949c9a63610cae30019e5b1899ee38f" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = 'SkCanvas_Reference#SkCanvas_drawImage' > SkCanvas::drawImage< / a > < sup > < a href = 'SkCanvas_Reference#SkCanvas_drawImage_2' > [2]< / a > < / sup > < a href = '#SkImage_readPixels' > readPixels< / a > < sup > < a href = '#SkImage_readPixels_2' > [2]< / a > < / sup > < a href = 'SkPixmap_Reference#SkPixmap_scalePixels' > SkPixmap::scalePixels< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_encodeToData' > < / a >
2017-11-27 15:44:06 +00:00
## encodeToData
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#SkData' > SkData< / a > > < a href = '#SkImage_encodeToData' > encodeToData< / a > (< a href = 'undocumented#SkEncodedImageFormat' > SkEncodedImageFormat< / a > encodedImageFormat, int quality) const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Encodes < a href = '#Image' > Image< / a > pixels, returning result as < a href = 'undocumented#SkData' > SkData< / a > .
2017-12-11 21:03:17 +00:00
2018-05-16 11:07:07 +00:00
Returns nullptr if encoding fails, or if < a href = '#SkImage_encodeToData_encodedImageFormat' > encodedImageFormat< / a > is not supported.
2018-01-11 15:35:44 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#Image' > Image< / a > encoding in a format requires both building with one or more of:
2018-01-11 15:35:44 +00:00
SK_HAS_JPEG_LIBRARY, SK_HAS_PNG_LIBRARY, SK_HAS_WEBP_LIBRARY; and platform support
for the encoded format.
2018-05-16 11:07:07 +00:00
If SK_BUILD_FOR_MAC or SK_BUILD_FOR_IOS is defined, < a href = '#SkImage_encodeToData_encodedImageFormat' > encodedImageFormat< / a > can
additionally be one of: < a href = 'undocumented#SkEncodedImageFormat_kICO' > SkEncodedImageFormat::kICO< / a > , < a href = 'undocumented#SkEncodedImageFormat_kBMP' > SkEncodedImageFormat::kBMP< / a > ,
< a href = 'undocumented#SkEncodedImageFormat_kGIF' > SkEncodedImageFormat::kGIF< / a > .
2018-01-11 15:35:44 +00:00
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_encodeToData_quality' > quality< / a > is a platform and format specific metric trading off size and encoding
error. When used, < a href = '#SkImage_encodeToData_quality' > quality< / a > equaling 100 encodes with the least error. < a href = '#SkImage_encodeToData_quality' > quality< / a > may
2018-01-11 15:35:44 +00:00
be ignored by the encoder.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_encodeToData_encodedImageFormat' > < code > < strong > encodedImageFormat< / strong > < / code > < / a > < / td >
< td > one of: < a href = 'undocumented#SkEncodedImageFormat_kJPEG' > SkEncodedImageFormat::kJPEG< / a > , < a href = 'undocumented#SkEncodedImageFormat_kPNG' > SkEncodedImageFormat::kPNG< / a > ,
< a href = 'undocumented#SkEncodedImageFormat_kWEBP' > SkEncodedImageFormat::kWEBP< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_encodeToData_quality' > < code > < strong > quality< / strong > < / code > < / a > < / td >
< td > encoder specific metric with 100 equaling best< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
encoded < a href = '#Image' > Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
### Example
2018-07-08 05:32:09 +00:00
< div > < fiddle-embed name = "7a3bf8851bb7160e4e49c48f8c09639d" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_refEncodedData' > refEncodedData< / a > < a href = '#SkImage_MakeFromEncoded' > MakeFromEncoded< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_encodeToData_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 " >
< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkData' > SkData< / a > > < a href = '#SkImage_encodeToData' > encodeToData< / a > () const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Encodes < a href = '#Image' > Image< / a > pixels, returning result as < a href = 'undocumented#SkData' > SkData< / a > . Returns existing encoded data
if present; otherwise, < a href = '#Image' > Image< / a > is encoded with < a href = 'undocumented#SkEncodedImageFormat_kPNG' > SkEncodedImageFormat::kPNG< / a > . Skia
must be built with SK_HAS_PNG_LIBRARY to encode < a href = '#Image' > Image< / a > .
2017-11-27 15:44:06 +00:00
2018-01-11 15:35:44 +00:00
Returns nullptr if existing encoded data is missing or invalid, and
2017-11-27 15:44:06 +00:00
encoding fails.
### Return Value
2018-05-16 11:07:07 +00:00
encoded < a href = '#Image' > Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
### Example
2018-01-11 15:35:44 +00:00
< div > < fiddle-embed name = "30cee813f6aa476b0a9c8a24283e53a3" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_refEncodedData' > refEncodedData< / a > < a href = '#SkImage_MakeFromEncoded' > MakeFromEncoded< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_refEncodedData' > < / a >
2017-11-27 15:44:06 +00:00
## refEncodedData
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#SkData' > SkData< / a > > < a href = '#SkImage_refEncodedData' > refEncodedData< / a > () const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns encoded < a href = '#Image' > Image< / a > pixels as < a href = 'undocumented#SkData' > SkData< / a > , if < a href = '#Image' > Image< / a > was created from supported
2018-01-11 15:35:44 +00:00
encoded stream format. Platform support for formats vary and may require building
with one or more of: SK_HAS_JPEG_LIBRARY, SK_HAS_PNG_LIBRARY, SK_HAS_WEBP_LIBRARY.
2017-11-27 15:44:06 +00:00
2018-05-16 11:07:07 +00:00
Returns nullptr if < a href = '#Image' > Image< / a > contents are not encoded.
2017-11-27 15:44:06 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
encoded < a href = '#Image' > Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
### Example
2018-06-07 21:07:17 +00:00
< div > < fiddle-embed name = "80856fe921ce36f8d5a32d8672bccbfc" gpu = "true" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_encodeToData' > encodeToData< / a > < sup > < a href = '#SkImage_encodeToData_2' > [2]< / a > < / sup > < a href = '#SkImage_MakeFromEncoded' > MakeFromEncoded< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
## <a name='Utility'>Utility</a>
< a name = 'SkImage_makeSubset' > < / a >
2017-11-27 15:44:06 +00:00
## makeSubset
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 = '#SkImage' > SkImage< / a > > < a href = '#SkImage_makeSubset' > makeSubset< / a > (const < a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > & subset) const
2017-11-27 15:44:06 +00:00
< / pre >
2018-10-08 18:57:48 +00:00
Returns < a href = '#SkImage_makeSubset_subset' > subset< / a > of < a href = '#Image' > Image< / a > . < a href = '#SkImage_makeSubset_subset' > subset< / a > must be fully contained by < a href = '#Image' > Image< / a > < a href = '#SkImage_dimensions' > dimensions< / a > ().
2018-01-11 15:35:44 +00:00
The implementation may share pixels, or may copy them.
2018-05-16 11:07:07 +00:00
Returns nullptr if < a href = '#SkImage_makeSubset_subset' > subset< / a > is empty, or < a href = '#SkImage_makeSubset_subset' > subset< / a > is not contained by bounds, or
pixels in < a href = '#Image' > Image< / a > could not be read or copied.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_makeSubset_subset' > < code > < strong > subset< / strong > < / code > < / a > < / td >
< td > bounds of returned < a href = '#Image' > Image< / a > < / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
partial or full < a href = '#Image' > Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
### Example
2018-07-24 12:09:27 +00:00
< div > < fiddle-embed name = "889e495ce3e3b3bacc96e8230932331c" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeFromEncoded' > MakeFromEncoded< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_makeTextureImage' > < / a >
2017-11-27 15:44:06 +00:00
## makeTextureImage
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
2018-06-14 06:41:13 +00:00
< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_makeTextureImage' > makeTextureImage< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context, < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > * dstColorSpace,
2018-06-14 16:28:14 +00:00
< a href = 'undocumented#GrMipMapped' > GrMipMapped< / a > mipMapped = < a href = 'undocumented#GrMipMapped_kNo' > GrMipMapped::kNo< / a > ) const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns < a href = '#Image' > Image< / a > backed by < a href = 'undocumented#GPU_Texture' > GPU Texture< / a > associated with < a href = '#SkImage_makeTextureImage_context' > context< / a > . Returned < a href = '#Image' > Image< / a > is
2018-06-14 16:28:14 +00:00
compatible with < a href = 'SkSurface_Reference#Surface' > Surface< / a > created with < a href = '#SkImage_makeTextureImage_dstColorSpace' > dstColorSpace< / a > . The returned < a href = '#Image' > Image< / a > respects
< a href = '#SkImage_makeTextureImage_mipMapped' > mipMapped< / a > setting; if < a href = '#SkImage_makeTextureImage_mipMapped' > mipMapped< / a > equals < a href = 'undocumented#GrMipMapped_kYes' > GrMipMapped::kYes< / a > , the backing texture
allocates < a href = 'undocumented#Mip_Map' > Mip Map< / a > levels. Returns original < a href = '#Image' > Image< / a > if < a href = '#SkImage_makeTextureImage_context' > context< / a >
and < a href = '#SkImage_makeTextureImage_dstColorSpace' > dstColorSpace< / a > match and < a href = '#SkImage_makeTextureImage_mipMapped' > mipMapped< / a > is compatible with backing < a href = 'undocumented#GPU_Texture' > GPU Texture< / a > .
2018-01-11 15:35:44 +00:00
2018-05-16 11:07:07 +00:00
Returns nullptr if < a href = '#SkImage_makeTextureImage_context' > context< / a > is nullptr, or if < a href = '#Image' > Image< / a > was created with another
< a href = 'undocumented#GrContext' > GrContext< / a > .
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_makeTextureImage_context' > < code > < strong > context< / strong > < / code > < / a > < / td >
< td > < a href = 'undocumented#GPU_Context' > GPU Context< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_makeTextureImage_dstColorSpace' > < code > < strong > dstColorSpace< / strong > < / code > < / a > < / td >
< td > range of colors of matching < a href = 'SkSurface_Reference#Surface' > Surface< / a > on GPU< / td >
2017-11-27 15:44:06 +00:00
< / tr >
2018-06-14 06:41:13 +00:00
< tr > < td > < a name = 'SkImage_makeTextureImage_mipMapped' > < code > < strong > mipMapped< / strong > < / code > < / a > < / td >
2018-06-14 16:28:14 +00:00
< td > whether created < a href = '#Image' > Image< / a > texture must allocate < a href = 'undocumented#Mip_Map' > Mip Map< / a > levels< / td >
2018-06-14 06:41:13 +00:00
< / tr >
2017-11-27 15:44:06 +00:00
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
created < a href = '#Image' > Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
### Example
2018-06-07 21:07:17 +00:00
< div > < fiddle-embed name = "b14d9debfe87295373b44a179992a999" gpu = "true" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeFromTexture' > MakeFromTexture< / a > < sup > < a href = '#SkImage_MakeFromTexture_2' > [2]< / a > < / sup >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_makeNonTextureImage' > < / a >
2017-11-27 15:44:06 +00:00
## makeNonTextureImage
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 = '#SkImage' > SkImage< / a > > < a href = '#SkImage_makeNonTextureImage' > makeNonTextureImage< / a > () const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns < a href = '#Raster_Image' > Raster Image< / a > or < a href = '#Lazy_Image' > Lazy Image< / a > . Copies < a href = '#Image' > Image< / a > backed by < a href = 'undocumented#GPU_Texture' > GPU Texture< / a > into
CPU memory if needed. Returns original < a href = '#Image' > Image< / a > if decoded in < a href = 'undocumented#Raster_Bitmap' > Raster Bitmap< / a > ,
2018-01-11 15:35:44 +00:00
or if encoded in a stream.
2018-05-16 11:07:07 +00:00
Returns nullptr if backed by < a href = 'undocumented#GPU_Texture' > GPU Texture< / a > and copy fails.
2018-01-02 16:34:14 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
< a href = '#Raster_Image' > Raster Image< / a > , < a href = '#Lazy_Image' > Lazy Image< / a > , or nullptr
2018-01-02 16:34:14 +00:00
### Example
2018-06-07 21:07:17 +00:00
< div > < fiddle-embed name = "c77bfb00fb82e378eea4b7f7c18a8b84" gpu = "true" > < / fiddle-embed > < / div >
2018-01-02 16:34:14 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_makeTextureImage' > makeTextureImage< / a > < a href = '#SkImage_makeRasterImage' > makeRasterImage< / a > < a href = '#SkImage_MakeBackendTextureFromSkImage' > MakeBackendTextureFromSkImage< / a >
2018-01-02 16:34:14 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_makeRasterImage' > < / a >
2018-01-02 16:34:14 +00:00
## makeRasterImage
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 = '#SkImage' > SkImage< / a > > < a href = '#SkImage_makeRasterImage' > makeRasterImage< / a > () const
2018-01-02 16:34:14 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns < a href = '#Raster_Image' > Raster Image< / a > . Copies < a href = '#Image' > Image< / a > backed by < a href = 'undocumented#GPU_Texture' > GPU Texture< / a > into CPU memory,
or decodes < a href = '#Image' > Image< / a > from < a href = '#Lazy_Image' > Lazy Image< / a > . Returns original < a href = '#Image' > Image< / a > if decoded in
< a href = 'undocumented#Raster_Bitmap' > Raster Bitmap< / a > .
2018-01-11 15:35:44 +00:00
Returns nullptr if copy, decode, or pixel read fails.
2017-11-27 15:44:06 +00:00
### Return Value
2018-05-16 11:07:07 +00:00
< a href = '#Raster_Image' > Raster Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
### Example
2018-07-18 20:21:51 +00:00
< div > < fiddle-embed name = "505a6d9458394b1deb5d2f6c44e1cd76" gpu = "true" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_isTextureBacked' > isTextureBacked< / a > < a href = '#SkImage_isLazyGenerated' > isLazyGenerated< / a > < a href = '#SkImage_MakeFromRaster' > MakeFromRaster< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_makeWithFilter' > < / a >
2017-11-27 15:44:06 +00:00
## makeWithFilter
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 = '#SkImage' > SkImage< / a > > < a href = '#SkImage_makeWithFilter' > makeWithFilter< / a > (const < a href = 'undocumented#SkImageFilter' > SkImageFilter< / a > * filter, const < a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > & subset,
const < a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > & clipBounds, < a href = 'SkIRect_Reference#SkIRect' > SkIRect< / a > * outSubset, < a href = 'SkIPoint_Reference#SkIPoint' > SkIPoint< / a > * offset) const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates filtered < a href = '#Image' > Image< / a > . < a href = '#SkImage_makeWithFilter_filter' > filter< / a > processes original < a href = '#Image' > Image< / a > , potentially changing
color, position, and size. < a href = '#SkImage_makeWithFilter_subset' > subset< / a > is the bounds of original < a href = '#Image' > Image< / a > processed
by < a href = '#SkImage_makeWithFilter_filter' > filter< / a > . < a href = '#SkImage_makeWithFilter_clipBounds' > clipBounds< / a > is the expected bounds of the filtered < a href = '#Image' > Image< / a > . < a href = '#SkImage_makeWithFilter_outSubset' > outSubset< / a >
is required storage for the actual bounds of the filtered < a href = '#Image' > Image< / a > . < a href = '#SkImage_makeWithFilter_offset' > offset< / a > is
required storage for translation of returned < a href = '#Image' > Image< / a > .
2018-01-11 15:35:44 +00:00
2018-05-16 11:07:07 +00:00
Returns nullptr if < a href = '#Image' > Image< / a > could not be created. If nullptr is returned, < a href = '#SkImage_makeWithFilter_outSubset' > outSubset< / a >
and < a href = '#SkImage_makeWithFilter_offset' > offset< / a > are undefined.
2018-01-11 15:35:44 +00:00
2018-05-16 11:07:07 +00:00
Useful for animation of < a href = 'undocumented#SkImageFilter' > SkImageFilter< / a > that varies size from frame to frame.
Returned < a href = '#Image' > Image< / a > is created larger than required by < a href = '#SkImage_makeWithFilter_filter' > filter< / a > so that < a href = 'undocumented#GPU_Texture' > GPU Texture< / a >
can be reused with different sized effects. < a href = '#SkImage_makeWithFilter_outSubset' > outSubset< / a > describes the valid bounds
of < a href = 'undocumented#GPU_Texture' > GPU Texture< / a > returned. < a href = '#SkImage_makeWithFilter_offset' > offset< / a > translates the returned < a href = '#Image' > Image< / a > to keep subsequent
2018-02-08 19:45:18 +00:00
animation frames aligned with respect to each other.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_makeWithFilter_filter' > < code > < strong > filter< / strong > < / code > < / a > < / td >
< td > how < a href = '#Image' > Image< / a > is sampled when transformed< / td >
< / tr >
< tr > < td > < a name = 'SkImage_makeWithFilter_subset' > < code > < strong > subset< / strong > < / code > < / a > < / td >
< td > bounds of < a href = '#Image' > Image< / a > processed by < a href = '#SkImage_makeWithFilter_filter' > filter< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_makeWithFilter_clipBounds' > < code > < strong > clipBounds< / strong > < / code > < / a > < / td >
< td > expected bounds of filtered < a href = '#Image' > Image< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_makeWithFilter_outSubset' > < code > < strong > outSubset< / strong > < / code > < / a > < / td >
< td > storage for returned < a href = '#Image' > Image< / a > bounds< / td >
< / tr >
< tr > < td > < a name = 'SkImage_makeWithFilter_offset' > < code > < strong > offset< / strong > < / code > < / a > < / td >
< td > storage for returned < a href = '#Image' > Image< / a > translation< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
filtered < a href = '#Image' > Image< / a > , or nullptr
2017-11-27 15:44:06 +00:00
### Example
2018-09-21 15:36:41 +00:00
< div > < fiddle-embed name = "85a76163138a2720ac003691d6363938" gpu = "true" > < div > In each frame of the animation, filtered < a href = '#Image' > Image< / a > is drawn in a different location.
2018-05-16 11:07:07 +00:00
By translating canvas by returned < a href = '#SkImage_makeWithFilter_offset' > offset< / a > , < a href = '#Image' > Image< / a > appears stationary.
2018-03-05 18:26:16 +00:00
< / div > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_makeShader' > makeShader< / a > < sup > < a href = '#SkImage_makeShader_2' > [2]< / a > < / sup > < a href = 'SkPaint_Reference#SkPaint_setImageFilter' > SkPaint::setImageFilter< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-17 16:17:28 +00:00
## <a name='SkImage_BackendTextureReleaseProc'>Typedef SkImage::BackendTextureReleaseProc</a>
< a href = '#SkImage_BackendTextureReleaseProc' > BackendTextureReleaseProc< / a >
< pre style = "padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0 " >
typedef std::function< void ( GrBackendTexture ) > < a href = '#SkImage_BackendTextureReleaseProc' > BackendTextureReleaseProc< / a > ;
< / pre >
2018-06-07 13:59:07 +00:00
Defines a callback function, taking one parameter of type < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > with
no return value. Function is called when back-end texture is to be released.
2017-11-27 15:44:06 +00:00
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_MakeBackendTextureFromSkImage' > < / a >
2017-11-27 15:44:06 +00:00
## MakeBackendTextureFromSkImage
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 = '#SkImage_MakeBackendTextureFromSkImage' > MakeBackendTextureFromSkImage< / a > (< a href = 'undocumented#GrContext' > GrContext< / a > * context, < a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > image,
< a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > * backendTexture,
< a href = '#SkImage_BackendTextureReleaseProc' > BackendTextureReleaseProc< / a > * backendTextureReleaseProc)
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates a < a href = 'undocumented#GrBackendTexture' > GrBackendTexture< / a > from the provided < a href = '#SkImage' > SkImage< / a > . Returns true and
stores result in < a href = '#SkImage_MakeBackendTextureFromSkImage_backendTexture' > backendTexture< / a > and < a href = '#SkImage_MakeBackendTextureFromSkImage_backendTextureReleaseProc' > backendTextureReleaseProc< / a > if
2018-02-08 19:45:18 +00:00
texture is created; otherwise, returns false and leaves
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeBackendTextureFromSkImage_backendTexture' > backendTexture< / a > and < a href = '#SkImage_MakeBackendTextureFromSkImage_backendTextureReleaseProc' > backendTextureReleaseProc< / a > unmodified.
2017-11-27 15:44:06 +00:00
2018-05-16 11:07:07 +00:00
Call < a href = '#SkImage_MakeBackendTextureFromSkImage_backendTextureReleaseProc' > backendTextureReleaseProc< / a > after deleting < a href = '#SkImage_MakeBackendTextureFromSkImage_backendTexture' > backendTexture< / a > .
< a href = '#SkImage_MakeBackendTextureFromSkImage_backendTextureReleaseProc' > backendTextureReleaseProc< / a > cleans up auxiliary data related to returned
< a href = '#SkImage_MakeBackendTextureFromSkImage_backendTexture' > backendTexture< / a > . The caller must delete returned < a href = '#SkImage_MakeBackendTextureFromSkImage_backendTexture' > backendTexture< / a > after use.
2017-11-27 15:44:06 +00:00
2018-05-16 11:07:07 +00:00
If < a href = '#Image' > Image< / a > is both texture backed and singly referenced, < a href = '#SkImage_MakeBackendTextureFromSkImage_image' > image< / a > is returned in
< a href = '#SkImage_MakeBackendTextureFromSkImage_backendTexture' > backendTexture< / a > without conversion or making a copy. < a href = '#Image' > Image< / a > is singly referenced
2018-02-08 19:45:18 +00:00
if its was transferred solely using std::move().
2018-05-16 11:07:07 +00:00
If < a href = '#Image' > Image< / a > is not texture backed, returns texture with < a href = '#Image' > Image< / a > contents.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_MakeBackendTextureFromSkImage_context' > < code > < strong > context< / strong > < / code > < / a > < / td >
< td > < a href = 'undocumented#GPU_Context' > GPU Context< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeBackendTextureFromSkImage_image' > < code > < strong > image< / strong > < / code > < / a > < / td >
< td > < a href = '#Image' > Image< / a > used for texture< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeBackendTextureFromSkImage_backendTexture' > < code > < strong > backendTexture< / strong > < / code > < / a > < / td >
< td > storage for back-end texture< / td >
< / tr >
< tr > < td > < a name = 'SkImage_MakeBackendTextureFromSkImage_backendTextureReleaseProc' > < code > < strong > backendTextureReleaseProc< / strong > < / code > < / a > < / td >
< td > storage for clean up function< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if back-end texture was created
2017-11-27 15:44:06 +00:00
### Example
2018-07-19 03:49:13 +00:00
< div > < fiddle-embed name = "06aeb3cf63ffccf7b49fe556e5def351" gpu = "true" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeFromTexture' > MakeFromTexture< / a > < sup > < a href = '#SkImage_MakeFromTexture_2' > [2]< / a > < / sup > < a href = '#SkImage_makeTextureImage' > makeTextureImage< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
## <a name='SkImage_LegacyBitmapMode'>Enum SkImage::LegacyBitmapMode</a>
2018-09-06 16:47:04 +00:00
To be deprecated soon.
2018-02-08 19:45:18 +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 = '#SkImage_LegacyBitmapMode' > LegacyBitmapMode< / a > {
2018-10-08 18:57:48 +00:00
< a href = '#SkImage_kRO_LegacyBitmapMode' > kRO_LegacyBitmapMode< / a > ,
2018-04-03 12:43:27 +00:00
};
2018-03-05 18:26:16 +00:00
< / pre >
2017-11-27 15:44:06 +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 = 'SkImage_kRO_LegacyBitmapMode' >< code > SkImage::kRO_LegacyBitmapMode</ code ></ a ></ td >
< td style = 'text-align: center; border: 2px solid #dddddd ; padding: 8px; ' > 0</ td >
< td style = 'text-align: left; border: 2px solid #dddddd ; padding: 8px; ' >
returned bitmap is read-only and immutable< / td >
2017-11-27 15:44:06 +00:00
< / tr >
2018-05-16 11:07:07 +00:00
< / table >
2017-11-27 15:44:06 +00:00
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_asLegacyBitmap' > < / a >
2017-11-27 15:44:06 +00:00
## asLegacyBitmap
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkImage_asLegacyBitmap' > asLegacyBitmap< / a > (< a href = 'SkBitmap_Reference#SkBitmap' > SkBitmap< / a > * bitmap, < a href = '#SkImage_LegacyBitmapMode' > LegacyBitmapMode< / a > legacyBitmapMode = < a href = '#SkImage_kRO_LegacyBitmapMode' > kRO LegacyBitmapMode< / a > ) const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates raster < a href = 'SkBitmap_Reference#Bitmap' > Bitmap< / a > with same pixels as < a href = '#Image' > Image< / a > . If < a href = '#SkImage_asLegacyBitmap_legacyBitmapMode' > legacyBitmapMode< / a > is
< a href = '#SkImage_kRO_LegacyBitmapMode' > kRO LegacyBitmapMode< / a > , returned < a href = '#SkImage_asLegacyBitmap_bitmap' > bitmap< / a > is read-only and immutable.
Returns true if < a href = 'SkBitmap_Reference#Bitmap' > Bitmap< / a > is stored in < a href = '#SkImage_asLegacyBitmap_bitmap' > bitmap< / a > . Returns false and resets < a href = '#SkImage_asLegacyBitmap_bitmap' > bitmap< / a > if
< a href = 'SkBitmap_Reference#Bitmap' > Bitmap< / a > write did not succeed.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_asLegacyBitmap_bitmap' > < code > < strong > bitmap< / strong > < / code > < / a > < / td >
< td > storage for legacy < a href = 'SkBitmap_Reference#Bitmap' > Bitmap< / a > < / td >
< / tr >
< tr > < td > < a name = 'SkImage_asLegacyBitmap_legacyBitmapMode' > < code > < strong > legacyBitmapMode< / strong > < / code > < / a > < / td >
< td > to be deprecated< / td >
2017-11-27 15:44:06 +00:00
< / tr >
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = 'SkBitmap_Reference#Bitmap' > Bitmap< / a > was created
2017-11-27 15:44:06 +00:00
2018-06-07 21:07:17 +00:00
### Example
2018-07-08 05:32:09 +00:00
< div > < fiddle-embed name = "78374702fa113076ddc6070053ab5cd4" gpu = "true" > < / fiddle-embed > < / div >
2018-06-07 21:07:17 +00:00
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_MakeRasterData' > MakeRasterData< / a > < a href = '#SkImage_makeRasterImage' > makeRasterImage< / a > < a href = '#SkImage_makeNonTextureImage' > makeNonTextureImage< / a >
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_isLazyGenerated' > < / a >
2017-11-27 15:44:06 +00:00
## isLazyGenerated
2018-05-16 11:07:07 +00:00
< pre style = "padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0 " >
bool < a href = '#SkImage_isLazyGenerated' > isLazyGenerated< / a > () const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Returns true if < a href = '#Image' > Image< / a > is backed by an image-generator or other service that creates
2017-11-27 15:44:06 +00:00
and caches its pixels or texture on-demand.
### Return Value
2018-05-16 11:07:07 +00:00
true if < a href = '#Image' > Image< / a > is created as needed
2017-11-27 15:44:06 +00:00
### Example
2017-12-11 21:03:17 +00:00
< div > < fiddle-embed name = "a8b8bd4bfe968e2c63085f867665227f" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
2018-01-05 17:10:09 +00:00
### Example
2018-06-07 21:07:17 +00:00
< div > < fiddle-embed name = "25305461b916baf40d7d379e04a5589c" gpu = "true" > < / fiddle-embed > < / div >
2018-01-05 17:10:09 +00:00
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
< a href = '#SkImage_isTextureBacked' > isTextureBacked< / a > MakeNonTextureImage
2017-11-27 15:44:06 +00:00
---
2018-05-16 11:07:07 +00:00
< a name = 'SkImage_makeColorSpace' > < / a >
2017-11-27 15:44:06 +00:00
## makeColorSpace
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
< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = '#SkImage' > SkImage< / a > > < a href = '#SkImage_makeColorSpace' > makeColorSpace< / a > (< a href = 'undocumented#sk_sp' > sk sp< / a > < < a href = 'undocumented#SkColorSpace' > SkColorSpace< / a > > target) const
2017-11-27 15:44:06 +00:00
< / pre >
2018-05-16 11:07:07 +00:00
Creates < a href = '#Image' > Image< / a > in < a href = '#SkImage_makeColorSpace_target' > target< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > .
Returns nullptr if < a href = '#Image' > Image< / a > could not be created.
2018-01-11 15:35:44 +00:00
2018-05-16 11:07:07 +00:00
Returns original < a href = '#Image' > Image< / a > if it is in < a href = '#SkImage_makeColorSpace_target' > target< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > .
Otherwise, converts pixels from < a href = '#Image' > Image< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > to < a href = '#SkImage_makeColorSpace_target' > target< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > .
If < a href = '#Image' > Image< / a > < a href = '#SkImage_colorSpace' > colorSpace< / a > returns nullptr, < a href = '#Image' > Image< / a > < a href = 'undocumented#Color_Space' > Color Space< / a > is assumed to be sRGB.
2017-11-27 15:44:06 +00:00
### Parameters
2018-05-16 11:07:07 +00:00
< table > < tr > < td > < a name = 'SkImage_makeColorSpace_target' > < code > < strong > target< / strong > < / code > < / a > < / td >
< td > < a href = 'undocumented#Color_Space' > Color Space< / a > describing color range of returned < a href = '#Image' > Image< / a > < / td >
< / tr >
2017-11-27 15:44:06 +00:00
< / table >
### Return Value
2018-05-16 11:07:07 +00:00
created < a href = '#Image' > Image< / a > in < a href = '#SkImage_makeColorSpace_target' > target< / a > < a href = 'undocumented#Color_Space' > Color Space< / a >
2017-11-27 15:44:06 +00:00
### Example
2018-07-18 13:25:15 +00:00
< div > < fiddle-embed name = "dbf5f75c1275a3013672f896767140fb" > < / fiddle-embed > < / div >
2017-11-27 15:44:06 +00:00
### See Also
2018-05-16 11:07:07 +00:00
MakeFromPixture < a href = '#SkImage_MakeFromTexture' > MakeFromTexture< / a > < sup > < a href = '#SkImage_MakeFromTexture_2' > [2]< / a > < / sup >
2017-11-27 15:44:06 +00:00
---
