GrGpuResource Class Reference

#include <GrGpuResource.h>

Inheritance diagram for GrGpuResource:

Classes
class	CacheAccess
class	ProxyAccess
class	ResourcePriv
class	UniqueID

Public Member Functions
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
virtual const char *	getResourceType () const =0
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 uint32_t	CreateUniqueID ()

Protected Member Functions
void	registerWithCache (skgpu::Budgeted)
void	registerWithCacheWrapped (GrWrapCacheable)
	GrGpuResource (GrGpu *, std::string_view label)
virtual	~GrGpuResource ()
GrGpu *	getGpu () const
virtual void	onRelease ()
virtual void	onAbandon ()
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
virtual void	computeScratchKey (skgpu::ScratchKey *) const
virtual size_t	onGpuMemorySize () const =0
virtual void	onSetLabel ()=0

Friends
class	GrIORef< GrGpuResource >

Additional Inherited Members
Public Types inherited from GrIORef< GrGpuResource >
enum	LastRemovedRef

Detailed Description

Base class for objects that can be kept in the GrResourceCache.

Definition at line 126 of file GrGpuResource.h.

Constructor & Destructor Documentation

GrGpuResource()

GrGpuResource::GrGpuResource ( GrGpu *  gpu, std::string_view  label  )

protected

Definition at line 27 of file GrGpuResource.cpp.

        : fGpu(gpu), fUniqueID(CreateUniqueID()), fLabel(label) {
    SkDEBUGCODE(fCacheArrayIndex = -1);
}

~GrGpuResource()

GrGpuResource::~GrGpuResource ( )

protectedvirtual

Definition at line 49 of file GrGpuResource.cpp.

                              {
    // The cache should have released or destroyed this resource.
    SkASSERT(this->wasDestroyed());
}

Member Function Documentation

cacheAccess() [1/2]

GrGpuResource::CacheAccess GrGpuResource::cacheAccess ( )

inline

Definition at line 104 of file GrGpuResourceCacheAccess.h.

{ return CacheAccess(this); }

cacheAccess() [2/2]

const GrGpuResource::CacheAccess GrGpuResource::cacheAccess ( ) const

inline

Definition at line 106 of file GrGpuResourceCacheAccess.h.

                                                                       {  // NOLINT(readability-const-return-type)
    return CacheAccess(const_cast<GrGpuResource*>(this));
}

computeScratchKey()

virtual void GrGpuResource::computeScratchKey ( skgpu::ScratchKey *  ) const

inlineprivatevirtual

Called by the registerWithCache if the resource is available to be used as scratch. Resource subclasses should override this if the instances should be recycled as scratch resources and populate the scratchKey with the key. By default resources are not recycled as scratch.

Reimplemented in GrTexture.

Definition at line 294 of file GrGpuResource.h.

{}

CreateUniqueID()

uint32_t GrGpuResource::CreateUniqueID ( )

static

Definition at line 210 of file GrGpuResource.cpp.

                                       {
    static std::atomic<uint32_t> nextID{1};
    uint32_t id;
    do {
        id = nextID.fetch_add(1, std::memory_order_relaxed);
    } while (id == SK_InvalidUniqueID);
    return id;
}

dumpMemoryStatistics()

void GrGpuResource::dumpMemoryStatistics ( SkTraceMemoryDump *  traceMemoryDump ) const

virtual

Dumps memory usage information for this GrGpuResource to traceMemoryDump. Typically, subclasses should not need to override this, and should only need to override setMemoryBacking.

Reimplemented in GrGLRenderTarget, GrGLTexture, and GrGLTextureRenderTarget.

Definition at line 73 of file GrGpuResource.cpp.

                                                                                 {
    if (this->fRefsWrappedObjects && !traceMemoryDump->shouldDumpWrappedObjects()) {
        return;
    }
 
    this->dumpMemoryStatisticsPriv(traceMemoryDump, this->getResourceName(),
                                   this->getResourceType(), this->gpuMemorySize());
}

dumpMemoryStatisticsPriv()

void GrGpuResource::dumpMemoryStatisticsPriv ( SkTraceMemoryDump *  traceMemoryDump, const SkString &  resourceName, const char *  type, size_t  size  ) const

protected

A helper for subclasses that override dumpMemoryStatistics(). This method using a format consistent with the default implementation of dumpMemoryStatistics() but allows the caller to customize various inputs.

Definition at line 82 of file GrGpuResource.cpp.

                                                                                  {
    const char* tag = "Scratch";
    if (fUniqueKey.isValid()) {
        tag = (fUniqueKey.tag() != nullptr) ? fUniqueKey.tag() : "Other";
    }
 
    traceMemoryDump->dumpNumericValue(resourceName.c_str(), "size", "bytes", size);
    traceMemoryDump->dumpStringValue(resourceName.c_str(), "type", type);
    traceMemoryDump->dumpStringValue(resourceName.c_str(), "label", this->getLabel().c_str());
    traceMemoryDump->dumpStringValue(resourceName.c_str(), "category", tag);
    if (this->isPurgeable()) {
        traceMemoryDump->dumpNumericValue(resourceName.c_str(), "purgeable_size", "bytes", size);
    }
    if (traceMemoryDump->shouldDumpWrappedObjects()) {
        traceMemoryDump->dumpWrappedState(resourceName.c_str(), fRefsWrappedObjects);
    }
 
    this->setMemoryBacking(traceMemoryDump, resourceName);
}

getContext() [1/2]

GrDirectContext * GrGpuResource::getContext

(

)

Definition at line 133 of file GrGpuResource.cpp.

                                           {
    if (fGpu) {
        return fGpu->getContext();
    } else {
        return nullptr;
    }
}

getContext() [2/2]

const GrDirectContext * GrGpuResource::getContext

(

)

const

Retrieves the context that owns the object. Note that it is possible for this to return NULL. When objects have been release()ed or abandon()ed they no longer have an owning context. Destroying a GrDirectContext automatically releases all its resources.

Definition at line 125 of file GrGpuResource.cpp.

                                                       {
    if (fGpu) {
        return fGpu->getContext();
    } else {
        return nullptr;
    }
}

getGpu()

GrGpu * GrGpuResource::getGpu ( ) const

inlineprotected

Definition at line 255 of file GrGpuResource.h.

{ return fGpu; }

getLabel()

std::string GrGpuResource::getLabel ( ) const

inline

Definition at line 193 of file GrGpuResource.h.

{ return fLabel; }

getResourceName()

SkString GrGpuResource::getResourceName ( ) const

protected

Returns a string that uniquely identifies this resource.

Definition at line 118 of file GrGpuResource.cpp.

                                              {
    // Dump resource as "skia/gpu_resources/resource_#".
    SkString resourceName("skia/gpu_resources/resource_");
    resourceName.appendU32(this->uniqueID().asUInt());
    return resourceName;
}

getResourceType()

virtual const char * GrGpuResource::getResourceType ( ) const

pure virtual

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.

getUniqueKey()

const skgpu::UniqueKey & GrGpuResource::getUniqueKey ( ) const

inline

Returns the current unique key for the resource. It will be invalid if the resource has no associated unique key.

Definition at line 191 of file GrGpuResource.h.

{ return fUniqueKey; }

gpuMemorySize()

size_t GrGpuResource::gpuMemorySize ( ) const

inline

Retrieves the amount of GPU memory used by this resource in bytes. It is approximate since we aren't aware of additional padding or copies made by the driver.

Returns

the amount of GPU memory used in bytes

Definition at line 156 of file GrGpuResource.h.

                                 {
        if (kInvalidGpuMemorySize == fGpuMemorySize) {
            fGpuMemorySize = this->onGpuMemorySize();
            SkASSERT(kInvalidGpuMemorySize != fGpuMemorySize);
        }
        return fGpuMemorySize;
    }

onAbandon()

virtual void GrGpuResource::onAbandon ( )

inlineprotectedvirtual

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 in GrD3DAttachment, GrD3DBuffer, GrD3DRenderTarget, GrD3DTexture, GrD3DTextureRenderTarget, GrGLAttachment, GrGLBuffer, GrGLRenderTarget, GrGLTexture, GrGLTextureRenderTarget, GrRenderTarget, GrSurface, GrMockTexture, GrMtlAttachment, GrMtlBuffer, GrMtlRenderTarget, GrMtlTexture, GrMtlTextureRenderTarget, GrVkRenderTarget, GrVkTexture, and GrVkTextureRenderTarget.

Definition at line 262 of file GrGpuResource.h.

{ }

onGpuMemorySize()

virtual size_t GrGpuResource::onGpuMemorySize ( ) const

privatepure virtual

Implemented in GrD3DRenderTarget, GrMockRenderTarget, GrMtlRenderTarget, and GrVkRenderTarget.

onRelease()

virtual void GrGpuResource::onRelease ( )

inlineprotectedvirtual

Overridden to free GPU resources in the backend API.

Reimplemented in GrD3DAttachment, GrD3DBuffer, GrD3DRenderTarget, GrD3DTexture, GrD3DTextureRenderTarget, GrGLAttachment, GrGLBuffer, GrGLRenderTarget, GrGLTexture, GrGLTextureRenderTarget, GrRenderTarget, GrSurface, GrMockTexture, GrMtlAttachment, GrMtlBuffer, GrMtlRenderTarget, GrMtlTexture, GrMtlTextureRenderTarget, GrVkRenderTarget, GrVkTexture, and GrVkTextureRenderTarget.

Definition at line 258 of file GrGpuResource.h.

{ }

onSetLabel()

virtual void GrGpuResource::onSetLabel ( )

privatepure virtual

Implemented in GrD3DRenderTarget, GrD3DTexture, GrGLTexture, GrMtlRenderTarget, GrMtlTexture, and GrVkRenderTarget.

proxyAccess()

GrGpuResource::ProxyAccess GrGpuResource::proxyAccess ( )

inline

Definition at line 367 of file GrGpuResource.h.

{ return ProxyAccess(this); }

registerWithCache()

void GrGpuResource::registerWithCache ( skgpu::Budgeted  budgeted )

protected

Definition at line 32 of file GrGpuResource.cpp.

                                                            {
    SkASSERT(fBudgetedType == GrBudgetedType::kUnbudgetedUncacheable);
    fBudgetedType = budgeted == skgpu::Budgeted::kYes ? GrBudgetedType::kBudgeted
                                                      : GrBudgetedType::kUnbudgetedUncacheable;
    this->computeScratchKey(&fScratchKey);
    get_resource_cache(fGpu)->resourceAccess().insertResource(this);
}

registerWithCacheWrapped()

void GrGpuResource::registerWithCacheWrapped ( GrWrapCacheable  wrapType )

protected

Definition at line 40 of file GrGpuResource.cpp.

                                                                     {
    SkASSERT(fBudgetedType == GrBudgetedType::kUnbudgetedUncacheable);
    // Resources referencing wrapped objects are never budgeted. They may be cached or uncached.
    fBudgetedType = wrapType == GrWrapCacheable::kNo ? GrBudgetedType::kUnbudgetedUncacheable
                                                     : GrBudgetedType::kUnbudgetedCacheable;
    fRefsWrappedObjects = true;
    get_resource_cache(fGpu)->resourceAccess().insertResource(this);
}

resourcePriv() [1/2]

GrGpuResource::ResourcePriv GrGpuResource::resourcePriv ( )

inline

Definition at line 91 of file GrGpuResourcePriv.h.

{ return ResourcePriv(this); }

resourcePriv() [2/2]

const GrGpuResource::ResourcePriv GrGpuResource::resourcePriv ( ) const

inline

Definition at line 93 of file GrGpuResourcePriv.h.

                                                                         {  // NOLINT(readability-const-return-type)
    return ResourcePriv(const_cast<GrGpuResource*>(this));
}

setLabel()

void GrGpuResource::setLabel ( std::string_view  label )

inline

Definition at line 195 of file GrGpuResource.h.

                                        {
        fLabel = label;
        this->onSetLabel();
    }

setMemoryBacking()

virtual void GrGpuResource::setMemoryBacking ( SkTraceMemoryDump *  , const SkString &    ) const

inlineprotectedvirtual

Allows subclasses to add additional backing information to the SkTraceMemoryDump.

Reimplemented in GrGLAttachment, and GrGLBuffer.

Definition at line 267 of file GrGpuResource.h.

{}

uniqueID()

UniqueID GrGpuResource::uniqueID ( ) const

inline

Gets an id that is unique for this GrGpuResource object. It is static in that it does not change when the content of the GrGpuResource object changes. This will never return 0.

Definition at line 187 of file GrGpuResource.h.

{ return fUniqueID; }

wasDestroyed()

bool GrGpuResource::wasDestroyed ( ) const

inline

Tests whether a object has been abandoned or released. All objects will be in this state after their creating GrContext is destroyed or has contextLost called. It's up to the client to test wasDestroyed() before attempting to use an object if it holds refs on objects across ~GrContext, freeResources with the force flag, or contextLost.

Returns

true if the object has been released or abandoned, false otherwise.

Definition at line 138 of file GrGpuResource.h.

{ return nullptr == fGpu; }

Friends And Related Function Documentation

GrIORef< GrGpuResource >

friend class GrIORef< GrGpuResource >

friend

Definition at line 343 of file GrGpuResource.h.

---

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

• third_party/skia/src/gpu/ganesh/GrGpuResource.h
• third_party/skia/src/gpu/ganesh/GrGpuResource.cpp
• third_party/skia/src/gpu/ganesh/GrGpuResourceCacheAccess.h
• third_party/skia/src/gpu/ganesh/GrGpuResourcePriv.h