Skia
2D Graphics Library
SkDeferredDisplayListRecorder Class Reference

#include <SkDeferredDisplayListRecorder.h>

Public Types

using PromiseImageTextureContext = void *
 
using PromiseImageTextureFulfillProc = sk_sp< SkPromiseImageTexture >(*)(PromiseImageTextureContext)
 
using PromiseImageTextureReleaseProc = void(*)(PromiseImageTextureContext)
 

Public Member Functions

 SkDeferredDisplayListRecorder (const SkSurfaceCharacterization &)
 
 ~SkDeferredDisplayListRecorder ()
 
const SkSurfaceCharacterizationcharacterization () const
 
SkCanvasgetCanvas ()
 
sk_sp< SkDeferredDisplayListdetach ()
 
sk_sp< SkImagemakePromiseTexture (const GrBackendFormat &backendFormat, int width, int height, GrMipmapped mipMapped, GrSurfaceOrigin origin, SkColorType colorType, SkAlphaType alphaType, sk_sp< SkColorSpace > colorSpace, PromiseImageTextureFulfillProc textureFulfillProc, PromiseImageTextureReleaseProc textureReleaseProc, PromiseImageTextureContext textureContext)
 Create a new SkImage that is very similar to an SkImage created by MakeFromTexture. More...
 
sk_sp< SkImagemakeYUVAPromiseTexture (const GrYUVABackendTextureInfo &yuvaBackendTextureInfo, sk_sp< SkColorSpace > imageColorSpace, PromiseImageTextureFulfillProc textureFulfillProc, PromiseImageTextureReleaseProc textureReleaseProc, PromiseImageTextureContext textureContexts[])
 This entry point operates like 'makePromiseTexture' but it is used to construct a SkImage from YUV[A] data. More...
 

Member Typedef Documentation

◆ PromiseImageTextureContext

◆ PromiseImageTextureFulfillProc

◆ PromiseImageTextureReleaseProc

Constructor & Destructor Documentation

◆ SkDeferredDisplayListRecorder()

SkDeferredDisplayListRecorder::SkDeferredDisplayListRecorder ( const SkSurfaceCharacterization )

◆ ~SkDeferredDisplayListRecorder()

SkDeferredDisplayListRecorder::~SkDeferredDisplayListRecorder ( )

Member Function Documentation

◆ characterization()

const SkSurfaceCharacterization& SkDeferredDisplayListRecorder::characterization ( ) const
inline

◆ detach()

sk_sp<SkDeferredDisplayList> SkDeferredDisplayListRecorder::detach ( )

◆ getCanvas()

SkCanvas* SkDeferredDisplayListRecorder::getCanvas ( )

◆ makePromiseTexture()

sk_sp<SkImage> SkDeferredDisplayListRecorder::makePromiseTexture ( const GrBackendFormat backendFormat,
int  width,
int  height,
GrMipmapped  mipMapped,
GrSurfaceOrigin  origin,
SkColorType  colorType,
SkAlphaType  alphaType,
sk_sp< SkColorSpace colorSpace,
PromiseImageTextureFulfillProc  textureFulfillProc,
PromiseImageTextureReleaseProc  textureReleaseProc,
PromiseImageTextureContext  textureContext 
)

Create a new SkImage that is very similar to an SkImage created by MakeFromTexture.

The difference is that the caller need not have created the texture nor populated it with the image pixel data. Moreover, the SkImage may be created on a thread as the creation of the image does not require access to the backend API or GrContext. Instead of passing a GrBackendTexture the client supplies a description of the texture consisting of GrBackendFormat, width, height, and GrMipmapped state. The resulting SkImage can be drawn to a SkDeferredDisplayListRecorder or directly to a GPU-backed SkSurface.

When the actual texture is required to perform a backend API draw, textureFulfillProc will be called to receive a GrBackendTexture. The properties of the GrBackendTexture must match those set during the SkImage creation, and it must refer to a valid existing texture in the backend API context/device, and be populated with the image pixel data. The texture cannot be deleted until textureReleaseProc is called.

There is at most one call to each of textureFulfillProc and textureReleaseProc. textureReleaseProc is always called even if image creation fails or if the image is never fulfilled (e.g. it is never drawn or all draws are clipped out)

This call is only valid if the SkDeferredDisplayListRecorder is backed by a GPU context.

Parameters
backendFormatformat of promised gpu texture
widthwidth of promised gpu texture
heightheight of promised gpu texture
mipMappedmip mapped state of promised gpu texture
colorSpacerange of colors; may be nullptr
textureFulfillProcfunction called to get actual gpu texture
textureReleaseProcfunction called when texture can be deleted
textureContextstate passed to textureFulfillProc and textureReleaseProc
versioncontrols when textureReleaseProc is called
Returns
created SkImage, or nullptr

◆ makeYUVAPromiseTexture()

sk_sp<SkImage> SkDeferredDisplayListRecorder::makeYUVAPromiseTexture ( const GrYUVABackendTextureInfo yuvaBackendTextureInfo,
sk_sp< SkColorSpace imageColorSpace,
PromiseImageTextureFulfillProc  textureFulfillProc,
PromiseImageTextureReleaseProc  textureReleaseProc,
PromiseImageTextureContext  textureContexts[] 
)

This entry point operates like 'makePromiseTexture' but it is used to construct a SkImage from YUV[A] data.

The source data may be planar (i.e. spread across multiple textures). In the extreme Y, U, V, and A are all in different planes and thus the image is specified by four textures. 'yuvaBackendTextureInfo' describes the planar arrangement, texture formats, conversion to RGB, and origin of the textures. Separate 'textureFulfillProc' and 'textureReleaseProc' calls are made for each texture. Each texture has its own PromiseImageTextureContext. If 'yuvaBackendTextureinfo' is not valid then no release proc calls are made. Otherwise, the calls will be made even on failure. 'textureContexts' has one entry for each of the up to four textures, as indicated by 'yuvaBackendTextureinfo'.

Currently the mip mapped property of 'yuvaBackendTextureInfo' is ignored. However, in the near future it will be required that if it is kYes then textureFulfillProc must return a mip mapped texture for each plane in order to successfully draw the image.


The documentation for this class was generated from the following file: