GrSurface Class Reference

#include <GrSurface.h>

Inheritance diagram for GrSurface:

Classes
class	RefCntedReleaseProc

Public Types
typedef void *	ReleaseCtx
typedef void(*	ReleaseProc) (ReleaseCtx)
Public Types inherited from GrIORef< GrGpuResource >
enum	LastRemovedRef

Public Member Functions
SkISize	dimensions () const
int	width () const
int	height () const
SkRect	getBoundsRect () const
virtual GrBackendFormat	backendFormat () const =0
void	setRelease (sk_sp< skgpu::RefCntedCallback > releaseHelper)
void	setRelease (ReleaseProc proc, ReleaseCtx ctx)
virtual GrTexture *	asTexture ()
virtual const GrTexture *	asTexture () const
virtual GrRenderTarget *	asRenderTarget ()
virtual const GrRenderTarget *	asRenderTarget () const
GrInternalSurfaceFlags	flags () const
bool	readOnly () const
bool	framebufferOnly () const
bool	isProtected () const
void	setFramebufferOnly ()
Public Member Functions inherited from GrGpuResource
bool	wasDestroyed () const
const GrDirectContext *	getContext () const
GrDirectContext *	getContext ()
size_t	gpuMemorySize () const
UniqueID	uniqueID () const
const skgpu::UniqueKey &	getUniqueKey () const
std::string	getLabel () const
void	setLabel (std::string_view label)
CacheAccess	cacheAccess ()
const CacheAccess	cacheAccess () const
ProxyAccess	proxyAccess ()
ResourcePriv	resourcePriv ()
const ResourcePriv	resourcePriv () const
virtual void	dumpMemoryStatistics (SkTraceMemoryDump *traceMemoryDump) const
Public Member Functions inherited from GrIORef< GrGpuResource >
bool	unique () const
void	ref () const
void	unref () const
void	refCommandBuffer () const
void	unrefCommandBuffer () const
Public Member Functions inherited from SkNoncopyable
	SkNoncopyable ()=default
	SkNoncopyable (SkNoncopyable &&)=default
SkNoncopyable &	operator= (SkNoncopyable &&)=default

Static Public Member Functions
static size_t	ComputeSize (const GrBackendFormat &, SkISize dimensions, int colorSamplesPerPixel, skgpu::Mipmapped, bool binSize=false)
Static Public Member Functions inherited from GrGpuResource
static uint32_t	CreateUniqueID ()

Protected Member Functions
void	setGLRTFBOIDIs0 ()
bool	glRTFBOIDis0 () const
void	setRequiresManualMSAAResolve ()
bool	requiresManualMSAAResolve () const
void	setReadOnly ()
void	setVkRTSupportsInputAttachment ()
	GrSurface (GrGpu *gpu, const SkISize &dimensions, skgpu::Protected isProtected, std::string_view label)
	~GrSurface () override
void	onRelease () override
void	onAbandon () override
Protected Member Functions inherited from GrGpuResource
void	registerWithCache (skgpu::Budgeted)
void	registerWithCacheWrapped (GrWrapCacheable)
	GrGpuResource (GrGpu *, std::string_view label)
virtual	~GrGpuResource ()
GrGpu *	getGpu () const
virtual void	setMemoryBacking (SkTraceMemoryDump *, const SkString &) const
SkString	getResourceName () const
void	dumpMemoryStatisticsPriv (SkTraceMemoryDump *traceMemoryDump, const SkString &resourceName, const char *type, size_t size) const
Protected Member Functions inherited from GrIORef< GrGpuResource >
	GrIORef ()
bool	internalHasRef () const
bool	internalHasNoCommandBufferUsages () const
void	addInitialRef () const

Private Member Functions
const char *	getResourceType () const override
virtual void	onSetRelease (sk_sp< RefCntedReleaseProc >)

Detailed Description

Definition at line 22 of file GrSurface.h.

Member Typedef Documentation

ReleaseCtx

typedef void* GrSurface::ReleaseCtx

Definition at line 50 of file GrSurface.h.

ReleaseProc

typedef void(* GrSurface::ReleaseProc) (ReleaseCtx)

Definition at line 51 of file GrSurface.h.

Constructor & Destructor Documentation

GrSurface()

GrSurface::GrSurface ( GrGpu *  gpu, const SkISize &  dimensions, skgpu::Protected  isProtected, std::string_view  label  )

inlineprotected

Definition at line 140 of file GrSurface.h.

            : INHERITED(gpu, label)
            , fDimensions(dimensions)
            , fSurfaceFlags(GrInternalSurfaceFlags::kNone)
            , fIsProtected(isProtected) {}

~GrSurface()

GrSurface::~GrSurface ( )

inlineoverrideprotected

Definition at line 149 of file GrSurface.h.

                          {
        // check that invokeReleaseProc has been called (if needed)
        SkASSERT(!fReleaseHelper);
    }

Member Function Documentation

asRenderTarget() [1/2]

virtual GrRenderTarget * GrSurface::asRenderTarget ( )

inlinevirtual

Returns

the render target underlying this surface, may be null.

Reimplemented in GrRenderTarget, and GrMockTextureRenderTarget.

Definition at line 65 of file GrSurface.h.

{ return nullptr; }

asRenderTarget() [2/2]

virtual const GrRenderTarget * GrSurface::asRenderTarget ( ) const

inlinevirtual

Reimplemented in GrRenderTarget, and GrMockTextureRenderTarget.

Definition at line 66 of file GrSurface.h.

{ return nullptr; }

asTexture() [1/2]

virtual GrTexture * GrSurface::asTexture ( )

inlinevirtual

Returns

the texture associated with the surface, may be null.

Reimplemented in GrTexture, and GrMockTextureRenderTarget.

Definition at line 59 of file GrSurface.h.

{ return nullptr; }

asTexture() [2/2]

virtual const GrTexture * GrSurface::asTexture ( ) const

inlinevirtual

Reimplemented in GrTexture, and GrMockTextureRenderTarget.

Definition at line 60 of file GrSurface.h.

{ return nullptr; }

backendFormat()

virtual GrBackendFormat GrSurface::backendFormat ( ) const

pure virtual

Implemented in GrD3DAttachment, GrD3DRenderTarget, GrD3DTexture, GrD3DTextureRenderTarget, GrGLAttachment, GrGLRenderTarget, GrGLTexture, GrGLTextureRenderTarget, GrMockAttachment, GrMockTexture, GrMockRenderTarget, GrMockTextureRenderTarget, GrMtlAttachment, GrMtlRenderTarget, GrMtlTexture, GrMtlTextureRenderTarget, GrVkImage, GrVkRenderTarget, GrVkTexture, and GrVkTextureRenderTarget.

ComputeSize()

size_t GrSurface::ComputeSize ( const GrBackendFormat &  format, SkISize  dimensions, int  colorSamplesPerPixel, skgpu::Mipmapped  mipmapped, bool  binSize = false  )

static

Definition at line 21 of file GrSurface.cpp.

                                            {
    // For external formats we do not actually know the real size of the resource so we just return
    // 0 here to indicate this.
    if (format.textureType() == GrTextureType::kExternal) {
        return 0;
    }
 
    size_t colorSize;
 
    if (binSize) {
        dimensions = skgpu::GetApproxSize(dimensions);
    }
 
    SkTextureCompressionType compressionType = GrBackendFormatToCompressionType(format);
    if (compressionType != SkTextureCompressionType::kNone) {
        colorSize = SkCompressedFormatDataSize(
                compressionType, dimensions, mipmapped == skgpu::Mipmapped::kYes);
    } else {
        colorSize = (size_t)dimensions.width() * dimensions.height() *
                    GrBackendFormatBytesPerPixel(format);
    }
    SkASSERT(colorSize > 0);
 
    size_t finalSize = colorSamplesPerPixel * colorSize;
 
    if (skgpu::Mipmapped::kYes == mipmapped) {
        // We don't have to worry about the mipmaps being a different dimensions than
        // we'd expect because we never change fDesc.fWidth/fHeight.
        finalSize += colorSize/3;
    }
    return finalSize;
}

dimensions()

SkISize GrSurface::dimensions ( ) const

inline

Retrieves the dimensions of the surface.

Definition at line 27 of file GrSurface.h.

{ return fDimensions; }

flags()

GrInternalSurfaceFlags GrSurface::flags ( ) const

inline

Definition at line 68 of file GrSurface.h.

{ return fSurfaceFlags; }

framebufferOnly()

bool GrSurface::framebufferOnly ( ) const

inline

Definition at line 82 of file GrSurface.h.

                                 {
        return fSurfaceFlags & GrInternalSurfaceFlags::kFramebufferOnly;
    }

getBoundsRect()

SkRect GrSurface::getBoundsRect ( ) const

inline

Helper that gets the width and height of the surface as a bounding rectangle.

Definition at line 42 of file GrSurface.h.

{ return SkRect::Make(this->dimensions()); }

getResourceType()

const char * GrSurface::getResourceType ( ) const

inlineoverrideprivatevirtual

Describes the type of gpu resource that is represented by the implementing class (e.g. texture, buffer object, stencil). This data is used for diagnostic purposes by dumpMemoryStatistics().

The value returned is expected to be long lived and will not be copied by the caller.

Implements GrGpuResource.

Definition at line 158 of file GrSurface.h.

{ return "Surface"; }

glRTFBOIDis0()

bool GrSurface::glRTFBOIDis0 ( ) const

inlineprotected

Definition at line 117 of file GrSurface.h.

                              {
        return fSurfaceFlags & GrInternalSurfaceFlags::kGLRTFBOIDIs0;
    }

height()

int GrSurface::height ( ) const

inline

Retrieves the height of the surface.

Definition at line 37 of file GrSurface.h.

{ return fDimensions.height(); }

isProtected()

bool GrSurface::isProtected ( ) const

inline

Definition at line 87 of file GrSurface.h.

{ return fIsProtected == skgpu::Protected::kYes; }

onAbandon()

void GrSurface::onAbandon ( )

overrideprotectedvirtual

Overridden to abandon any internal handles, ptrs, etc to backend API resources. This may be called when the underlying 3D context is no longer valid and so no backend API calls should be made.

Reimplemented from GrGpuResource.

Reimplemented in GrVkImage, GrVkRenderTarget, GrVkTexture, and GrVkTextureRenderTarget.

Definition at line 86 of file GrSurface.cpp.

                          {
    this->invokeReleaseProc();
    this->INHERITED::onAbandon();
}

onRelease()

void GrSurface::onRelease ( )

overrideprotectedvirtual

Overridden to free GPU resources in the backend API.

Reimplemented from GrGpuResource.

Reimplemented in GrVkImage, GrVkRenderTarget, GrVkTexture, and GrVkTextureRenderTarget.

Definition at line 81 of file GrSurface.cpp.

                          {
    this->invokeReleaseProc();
    this->INHERITED::onRelease();
}

onSetRelease()

virtual void GrSurface::onSetRelease ( sk_sp< RefCntedReleaseProc >  )

inlineprivatevirtual

Reimplemented in GrD3DRenderTarget, GrD3DTexture, GrD3DTextureRenderTarget, GrVkRenderTarget, GrVkTexture, and GrVkTextureRenderTarget.

Definition at line 164 of file GrSurface.h.

{}

readOnly()

bool GrSurface::readOnly ( ) const

inline

The pixel values of this surface cannot be modified (e.g. doesn't support write pixels or MIP map level regen).

Definition at line 80 of file GrSurface.h.

{ return fSurfaceFlags & GrInternalSurfaceFlags::kReadOnly; }

requiresManualMSAAResolve()

bool GrSurface::requiresManualMSAAResolve ( ) const

inlineprotected

Definition at line 126 of file GrSurface.h.

                                           {
        return fSurfaceFlags & GrInternalSurfaceFlags::kRequiresManualMSAAResolve;
    }

setFramebufferOnly()

void GrSurface::setFramebufferOnly ( )

inline

Definition at line 89 of file GrSurface.h.

                              {
        SkASSERT(this->asRenderTarget());
        fSurfaceFlags |= GrInternalSurfaceFlags::kFramebufferOnly;
    }

setGLRTFBOIDIs0()

void GrSurface::setGLRTFBOIDIs0 ( )

inlineprotected

Definition at line 111 of file GrSurface.h.

                           {
        SkASSERT(!this->requiresManualMSAAResolve());
        SkASSERT(!this->asTexture());
        SkASSERT(this->asRenderTarget());
        fSurfaceFlags |= GrInternalSurfaceFlags::kGLRTFBOIDIs0;
    }

setReadOnly()

void GrSurface::setReadOnly ( )

inlineprotected

Definition at line 130 of file GrSurface.h.

                       {
        SkASSERT(!this->asRenderTarget());
        fSurfaceFlags |= GrInternalSurfaceFlags::kReadOnly;
    }

setRelease() [1/2]

void GrSurface::setRelease ( ReleaseProc  proc, ReleaseCtx  ctx  )

inline

Definition at line 52 of file GrSurface.h.

                                                      {
        this->setRelease(skgpu::RefCntedCallback::Make(proc, ctx));
    }

setRelease() [2/2]

void GrSurface::setRelease

(

sk_sp< skgpu::RefCntedCallback >

releaseHelper

)

Definition at line 60 of file GrSurface.cpp.

                                                                     {
    SkASSERT(this->getContext());
    fReleaseHelper.reset(new RefCntedReleaseProc(std::move(releaseHelper),
                                                 sk_ref_sp(this->getContext())));
    this->onSetRelease(fReleaseHelper);
}

setRequiresManualMSAAResolve()

void GrSurface::setRequiresManualMSAAResolve ( )

inlineprotected

Definition at line 121 of file GrSurface.h.

                                        {
        SkASSERT(!this->glRTFBOIDis0());
        SkASSERT(this->asRenderTarget());
        fSurfaceFlags |= GrInternalSurfaceFlags::kRequiresManualMSAAResolve;
    }

setVkRTSupportsInputAttachment()

void GrSurface::setVkRTSupportsInputAttachment ( )

inlineprotected

Definition at line 135 of file GrSurface.h.

                                          {
        SkASSERT(this->asRenderTarget());
        fSurfaceFlags |= GrInternalSurfaceFlags::kVkRTSupportsInputAttachment;
    }

width()

int GrSurface::width ( ) const

inline

Retrieves the width of the surface.

Definition at line 32 of file GrSurface.h.

{ return fDimensions.width(); }

---

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

• third_party/skia/src/gpu/ganesh/GrSurface.h
• third_party/skia/src/gpu/ganesh/GrSurface.cpp