#include <Surface_Graphite.h>

Inheritance diagram for skgpu::graphite::Surface:

Public Member Functions
	Surface (sk_sp< Device >)

	~Surface () override

SkImageInfo	imageInfo () const override

SkSurface_Base::Type	type () const override

Recorder *	onGetRecorder () const override

SkCanvas *	onNewCanvas () override

sk_sp< SkSurface >	onNewSurface (const SkImageInfo &) override

sk_sp< SkImage >	onNewImageSnapshot (const SkIRect *subset) override

void	onWritePixels (const SkPixmap &, int x, int y) override

void	onAsyncRescaleAndReadPixels (const SkImageInfo &info, SkIRect srcRect, RescaleGamma rescaleGamma, RescaleMode rescaleMode, ReadPixelsCallback callback, ReadPixelsContext context) override

void	onAsyncRescaleAndReadPixelsYUV420 (SkYUVColorSpace yuvColorSpace, bool readAlpha, sk_sp< SkColorSpace > dstColorSpace, SkIRect srcRect, SkISize dstSize, RescaleGamma rescaleGamma, RescaleMode, ReadPixelsCallback callback, ReadPixelsContext context) override

bool	onCopyOnWrite (ContentChangeMode) override

sk_sp< const SkCapabilities >	onCapabilities () override

TextureProxyView	readSurfaceView () const

sk_sp< Image >	asImage () const

sk_sp< Image >	makeImageCopy (const SkIRect *subset, Mipmapped) const

TextureProxy *	backingTextureProxy () const

Public Member Functions inherited from SkSurface_Base
	SkSurface_Base (int width, int height, const SkSurfaceProps *)

	SkSurface_Base (const SkImageInfo &, const SkSurfaceProps *)

	~SkSurface_Base () override

bool	replaceBackendTexture (const GrBackendTexture &, GrSurfaceOrigin, ContentChangeMode, TextureReleaseProc, ReleaseContext) override

bool	isRasterBacked () const

bool	isGaneshBacked () const

bool	isGraphiteBacked () const

virtual GrRecordingContext *	onGetRecordingContext () const

virtual void	onDraw (SkCanvas , SkScalar x, SkScalar y, const SkSamplingOptions &, const SkPaint )

virtual void	onDiscard ()

virtual void	onRestoreBackingMutability ()

virtual bool	onWait (int numSemaphores, const GrBackendSemaphore *waitSemaphores, bool deleteSemaphoresAfterWait)

virtual bool	onCharacterize (GrSurfaceCharacterization *) const

virtual bool	onIsCompatible (const GrSurfaceCharacterization &) const

SkCanvas *	getCachedCanvas ()

sk_sp< SkImage >	refCachedImage ()

bool	hasCachedImage () const

uint32_t	newGenerationID ()

Public Member Functions inherited from SkSurface
bool	isCompatible (const GrSurfaceCharacterization &characterization) const

int	width () const

int	height () const

uint32_t	generationID ()

void	notifyContentWillChange (ContentChangeMode mode)

GrRecordingContext *	recordingContext () const

skgpu::graphite::Recorder *	recorder () const

SkCanvas *	getCanvas ()

sk_sp< const SkCapabilities >	capabilities ()

sk_sp< SkSurface >	makeSurface (const SkImageInfo &imageInfo)

sk_sp< SkSurface >	makeSurface (int width, int height)

sk_sp< SkImage >	makeImageSnapshot ()

sk_sp< SkImage >	makeImageSnapshot (const SkIRect &bounds)

void	draw (SkCanvas canvas, SkScalar x, SkScalar y, const SkSamplingOptions &sampling, const SkPaint paint)

void	draw (SkCanvas canvas, SkScalar x, SkScalar y, const SkPaint paint=nullptr)

bool	peekPixels (SkPixmap *pixmap)

bool	readPixels (const SkPixmap &dst, int srcX, int srcY)

bool	readPixels (const SkImageInfo &dstInfo, void *dstPixels, size_t dstRowBytes, int srcX, int srcY)

bool	readPixels (const SkBitmap &dst, int srcX, int srcY)

void	asyncRescaleAndReadPixels (const SkImageInfo &info, const SkIRect &srcRect, RescaleGamma rescaleGamma, RescaleMode rescaleMode, ReadPixelsCallback callback, ReadPixelsContext context)

void	asyncRescaleAndReadPixelsYUV420 (SkYUVColorSpace yuvColorSpace, sk_sp< SkColorSpace > dstColorSpace, const SkIRect &srcRect, const SkISize &dstSize, RescaleGamma rescaleGamma, RescaleMode rescaleMode, ReadPixelsCallback callback, ReadPixelsContext context)

void	asyncRescaleAndReadPixelsYUVA420 (SkYUVColorSpace yuvColorSpace, sk_sp< SkColorSpace > dstColorSpace, const SkIRect &srcRect, const SkISize &dstSize, RescaleGamma rescaleGamma, RescaleMode rescaleMode, ReadPixelsCallback callback, ReadPixelsContext context)

void	writePixels (const SkPixmap &src, int dstX, int dstY)

void	writePixels (const SkBitmap &src, int dstX, int dstY)

const SkSurfaceProps &	props () const

bool	wait (int numSemaphores, const GrBackendSemaphore *waitSemaphores, bool deleteSemaphoresAfterWait=true)

bool	characterize (GrSurfaceCharacterization *characterization) const

Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()

virtual	~SkRefCntBase ()

bool	unique () const

void	ref () const

void	unref () const

Static Public Member Functions
static sk_sp< Surface >	Make (Recorder recorder, const SkImageInfo &info, Budgeted budgeted, Mipmapped mipmapped=Mipmapped::kNo, SkBackingFit backingFit=SkBackingFit::kExact, const SkSurfaceProps props=nullptr)

static sk_sp< Surface >	MakeScratch (Recorder *recorder, const SkImageInfo &info, Budgeted budgeted=Budgeted::kYes, Mipmapped mipmapped=Mipmapped::kNo, SkBackingFit backingFit=SkBackingFit::kApprox)

Friends
void	Flush (SkSurface *)

Additional Inherited Members
Public Types inherited from SkSurface_Base
enum class	Type { kNull , kGanesh , kGraphite , kRaster }

Public Types inherited from SkSurface
enum	ContentChangeMode { kDiscard_ContentChangeMode , kRetain_ContentChangeMode }

enum class	BackendHandleAccess { kFlushRead , kFlushWrite , kDiscardWrite , kFlushRead_BackendHandleAccess = kFlushRead , kFlushWrite_BackendHandleAccess = kFlushWrite , kDiscardWrite_BackendHandleAccess = kDiscardWrite }

using	ReleaseContext = void *

using	TextureReleaseProc = void(*)(ReleaseContext)

using	AsyncReadResult = SkImage::AsyncReadResult

using	ReadPixelsContext = void *

using	ReadPixelsCallback = void(ReadPixelsContext, std::unique_ptr< const AsyncReadResult >)

using	RescaleGamma = SkImage::RescaleGamma

using	RescaleMode = SkImage::RescaleMode

Static Public Attributes inherited from SkSurface
static constexpr BackendHandleAccess	kFlushRead_BackendHandleAccess

static constexpr BackendHandleAccess	kFlushWrite_BackendHandleAccess

static constexpr BackendHandleAccess	kDiscardWrite_BackendHandleAccess

Protected Member Functions inherited from SkSurface
	SkSurface (int width, int height, const SkSurfaceProps *surfaceProps)

	SkSurface (const SkImageInfo &imageInfo, const SkSurfaceProps *surfaceProps)

void	dirtyGenerationID ()

Detailed Description

Definition at line 26 of file Surface_Graphite.h.

Constructor & Destructor Documentation

◆ Surface()

Surface::Surface ( sk_sp< Device > device )

Definition at line 28 of file Surface_Graphite.cpp.

        : SkSurface_Base(device->width(), device->height(), &device->surfaceProps())
        , fDevice(std::move(device))
        , fImageView(Image::WrapDevice(fDevice)) {}

◆ ~Surface()

Surface::~Surface ( )

override

Definition at line 33 of file Surface_Graphite.cpp.

                  {
    // Mark the device immutable when the Surface is destroyed to flush any pending work to the
    // recorder and to flag the device so that any linked image views can detach from the Device
    // when they are next drawn.
    fDevice->setImmutable();
}

Member Function Documentation

◆ asImage()

sk_sp< Image > Surface::asImage ( ) const

Definition at line 65 of file Surface_Graphite.cpp.

                                    {
    if (this->hasCachedImage()) {
        SKGPU_LOG_W("Intermingling makeImageSnapshot and asImage calls may produce "
                    "unexpected results. Please use either the old _or_ new API.");
    }
    return fImageView;
}

◆ backingTextureProxy()

TextureProxy * Surface::backingTextureProxy ( ) const

Definition at line 117 of file Surface_Graphite.cpp.

117{ return fDevice->target(); }

◆ imageInfo()

SkImageInfo Surface::imageInfo ( ) const

overridevirtual

Returns an ImageInfo describing the surface.

Reimplemented from SkSurface.

Definition at line 40 of file Surface_Graphite.cpp.

                                     {
    return fDevice->imageInfo();
}

◆ Make()

static sk_sp< Surface > skgpu::graphite::Surface::Make	(	Recorder *	recorder,
		const SkImageInfo &	info,
		Budgeted	budgeted,
		Mipmapped	mipmapped = `Mipmapped::kNo`,
		SkBackingFit	backingFit = `SkBackingFit::kExact`,
		const SkSurfaceProps *	props = `nullptr`
	)

inlinestatic

Definition at line 29 of file Surface_Graphite.h.

                                                                      {
        return Make(recorder, info, budgeted, mipmapped, backingFit, props,
                    LoadOp::kClear, /*registerWithRecorder=*/true);
    }

◆ makeImageCopy()

sk_sp< Image > Surface::makeImageCopy	(	const SkIRect *	subset,
		Mipmapped	mipmapped
	)		const

Definition at line 73 of file Surface_Graphite.cpp.

                                                                                    {
    if (this->hasCachedImage()) {
        SKGPU_LOG_W("Intermingling makeImageSnapshot and asImage calls may produce "
                    "unexpected results. Please use either the old _or_ new API.");
    }
 
    SkIRect srcRect = subset ? *subset : SkIRect::MakeSize(this->imageInfo().dimensions());
    // NOTE: Must copy through fDevice and not fImageView if the surface's texture is not sampleable
    return fDevice->makeImageCopy(srcRect, Budgeted::kNo, mipmapped, SkBackingFit::kExact);
}

◆ MakeScratch()

static sk_sp< Surface > skgpu::graphite::Surface::MakeScratch	(	Recorder *	recorder,
		const SkImageInfo &	info,
		Budgeted	budgeted = `Budgeted::kYes`,
		Mipmapped	mipmapped = `Mipmapped::kNo`,
		SkBackingFit	backingFit = `SkBackingFit::kApprox`
	)

inlinestatic

Definition at line 42 of file Surface_Graphite.h.

                                                                                     {
        return Make(recorder, info, budgeted, mipmapped, backingFit,
                    /*props=*/nullptr, LoadOp::kDiscard, /*registerWithRecorder=*/false);
    }

◆ onAsyncRescaleAndReadPixels()

void Surface::onAsyncRescaleAndReadPixels	(	const SkImageInfo &	info,
		SkIRect	srcRect,
		RescaleGamma	rescaleGamma,
		RescaleMode	rescaleMode,
		ReadPixelsCallback	callback,
		ReadPixelsContext	context
	)

overridevirtual

Default implementation does a rescale/read and then calls the callback.

Reimplemented from SkSurface_Base.

Definition at line 90 of file Surface_Graphite.cpp.

                                                                     {
    // Not supported for Graphite. Use Context::asyncRescaleAndReadPixels instead.
    callback(context, nullptr);
}

◆ onAsyncRescaleAndReadPixelsYUV420()

void Surface::onAsyncRescaleAndReadPixelsYUV420	(	SkYUVColorSpace	yuvColorSpace,
		bool	readAlpha,
		sk_sp< SkColorSpace >	dstColorSpace,
		SkIRect	srcRect,
		SkISize	dstSize,
		RescaleGamma	rescaleGamma,
		RescaleMode	,
		ReadPixelsCallback	callback,
		ReadPixelsContext	context
	)

overridevirtual

Default implementation does a rescale/read/yuv conversion and then calls the callback.

Reimplemented from SkSurface_Base.

Definition at line 100 of file Surface_Graphite.cpp.

                                                                           {
    // Not supported for Graphite. Use Context::asyncRescaleAndReadPixelsYUV420 instead.
    callback(context, nullptr);
}

◆ onCapabilities()

sk_sp< const SkCapabilities > Surface::onCapabilities ( )

overridevirtual

Reimplemented from SkSurface_Base.

Definition at line 113 of file Surface_Graphite.cpp.

                                                    {
    return fDevice->recorder()->priv().caps()->capabilities();
}

◆ onCopyOnWrite()

bool Surface::onCopyOnWrite ( ContentChangeMode )

overridevirtual

If the surface is about to change, we call this so that our subclass can optionally fork their backend (copy-on-write) in case it was being shared with the cachedImage.

Returns false if the backing cannot be un-shared.

Implements SkSurface_Base.

Definition at line 88 of file Surface_Graphite.cpp.

88{ return true; }

◆ onGetRecorder()

Recorder * Surface::onGetRecorder ( ) const

overridevirtual

Reimplemented from SkSurface_Base.

Definition at line 44 of file Surface_Graphite.cpp.

44{ return fDevice->recorder(); }

◆ onNewCanvas()

SkCanvas * Surface::onNewCanvas ( )

overridevirtual

Allocate a canvas that will draw into this surface. We will cache this canvas, to return the same object to the caller multiple times. We take ownership, and will call unref() on the canvas when we go out of scope.

Implements SkSurface_Base.

Definition at line 50 of file Surface_Graphite.cpp.

50{ return new SkCanvas(fDevice); }

SkSurface_Base::SkCanvas

friend class SkCanvas

Definition SkSurface_Base.h:188

◆ onNewImageSnapshot()

sk_sp< SkImage > Surface::onNewImageSnapshot ( const SkIRect * subset )

overridevirtual

Allocate an SkImage that represents the current contents of the surface. This needs to be able to outlive the surface itself (if need be), and must faithfully represent the current contents, even if the surface is changed after this called (e.g. it is drawn to via its canvas).

If a subset is specified, the the impl must make a copy, rather than try to wait on copy-on-write.

Reimplemented from SkSurface_Base.

Definition at line 56 of file Surface_Graphite.cpp.

                                                                {
    TextureProxyView srcView = fDevice->readSurfaceView();
    if (!srcView) {
        return nullptr;
    }
 
    return this->makeImageCopy(subset, srcView.mipmapped());
}

◆ onNewSurface()

sk_sp< SkSurface > Surface::onNewSurface ( const SkImageInfo & ii )

overridevirtual

Implements SkSurface_Base.

Definition at line 52 of file Surface_Graphite.cpp.

                                                            {
    return SkSurfaces::RenderTarget(fDevice->recorder(), ii, Mipmapped::kNo, &this->props());
}

◆ onWritePixels()

void Surface::onWritePixels	(	const SkPixmap &	pixmap,
		int	x,
		int	y
	)

overridevirtual

Implements SkSurface_Base.

Definition at line 84 of file Surface_Graphite.cpp.

                                                                {
    fDevice->writePixels(pixmap, x, y);
}

◆ readSurfaceView()

TextureProxyView Surface::readSurfaceView ( ) const

Definition at line 46 of file Surface_Graphite.cpp.

                                                {
    return fDevice->readSurfaceView();
}

◆ type()

SkSurface_Base::Type skgpu::graphite::Surface::type ( ) const

inlineoverridevirtual

Reimplemented from SkSurface_Base.

Definition at line 58 of file Surface_Graphite.h.

58{ return SkSurface_Base::Type::kGraphite; }

SkSurface_Base::Type::kGraphite

@ kGraphite

Friends And Related Symbol Documentation

◆ Flush

void Flush ( SkSurface * )

friend

Definition at line 25 of file GpuTools.h.

                                      {
#if defined(SK_GANESH)
    skgpu::ganesh::Flush(surface);
#endif
#if defined(SK_GRAPHITE)
    skgpu::graphite::Flush(surface);
#endif
}

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

third_party/skia/src/gpu/graphite/Surface_Graphite.h
third_party/skia/src/gpu/graphite/Surface_Graphite.cpp

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Surface()

◆ ~Surface()

Member Function Documentation

◆ asImage()

◆ backingTextureProxy()

◆ imageInfo()

◆ Make()

◆ makeImageCopy()

◆ MakeScratch()

◆ onAsyncRescaleAndReadPixels()

◆ onAsyncRescaleAndReadPixelsYUV420()

◆ onCapabilities()

◆ onCopyOnWrite()

◆ onGetRecorder()

◆ onNewCanvas()

◆ onNewImageSnapshot()

◆ onNewSurface()

◆ onWritePixels()

◆ readSurfaceView()

◆ type()

Friends And Related Symbol Documentation

◆ Flush