GrGLBuffer Class Reference

#include <GrGLBuffer.h>

Inheritance diagram for GrGLBuffer:

Public Member Functions
	~GrGLBuffer () override
GrGLuint	bufferID () const
void	setHasAttachedToTexture ()
bool	hasAttachedToTexture () const
Public Member Functions inherited from GrGpuBuffer
GrAccessPattern	accessPattern () const
size_t	size () const final
void	ref () const final
void	unref () const final
void *	map ()
void	unmap ()
bool	isMapped () const
bool	isCpuBuffer () const final
bool	clearToZero ()
bool	updateData (const void *src, size_t offset, size_t size, bool preserve)
GrGpuBufferType	intendedType () const
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
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
Public Member Functions inherited from GrBuffer
	GrBuffer (const GrBuffer &)=delete
GrBuffer &	operator= (const GrBuffer &)=delete
virtual	~GrBuffer ()=default
virtual void	ref () const =0
virtual void	unref () const =0
virtual size_t	size () const =0
virtual bool	isCpuBuffer () const =0

Static Public Member Functions
static sk_sp< GrGLBuffer >	Make (GrGLGpu *, size_t size, GrGpuBufferType intendedType, GrAccessPattern)
Static Public Member Functions inherited from GrGpuBuffer
static void	ComputeScratchKeyForDynamicBuffer (size_t size, GrGpuBufferType, skgpu::ScratchKey *)
Static Public Member Functions inherited from GrGpuResource
static uint32_t	CreateUniqueID ()

Protected Member Functions
	GrGLBuffer (GrGLGpu *, size_t size, GrGpuBufferType intendedType, GrAccessPattern, std::string_view label)
void	onAbandon () override
void	onRelease () override
void	setMemoryBacking (SkTraceMemoryDump *traceMemoryDump, const SkString &dumpName) const override
Protected Member Functions inherited from GrGpuBuffer
	GrGpuBuffer (GrGpu *, size_t sizeInBytes, GrGpuBufferType, GrAccessPattern, std::string_view label)
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	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
Protected Member Functions inherited from GrBuffer
	GrBuffer ()=default

Additional Inherited Members
Public Types inherited from GrIORef< GrGpuResource >
enum	LastRemovedRef
Protected Types inherited from GrGpuBuffer
enum class	MapType { kRead , kWriteDiscard }
Protected Attributes inherited from GrGpuBuffer
void *	fMapPtr

Detailed Description

Definition at line 17 of file GrGLBuffer.h.

Constructor & Destructor Documentation

~GrGLBuffer()

GrGLBuffer::~GrGLBuffer ( )

inlineoverride

Definition at line 24 of file GrGLBuffer.h.

                           {
        // either release or abandon should have been called by the owner of this object.
        SkASSERT(0 == fBufferID);
    }

GrGLBuffer()

GrGLBuffer::GrGLBuffer ( GrGLGpu *  gpu, size_t  size, GrGpuBufferType  intendedType, GrAccessPattern  accessPattern, std::string_view  label  )

protected

Definition at line 103 of file GrGLBuffer.cpp.

        : INHERITED(gpu, size, intendedType, accessPattern, label)
        , fIntendedType(intendedType)
        , fBufferID(0)
        , fUsage(gr_to_gl_access_pattern(intendedType, accessPattern, gpu->glCaps()))
        , fHasAttachedToTexture(false) {
    GL_CALL(GenBuffers(1, &fBufferID));
    if (fBufferID) {
        GrGLenum target = gpu->bindBuffer(fIntendedType, this);
        GrGLenum error = GL_ALLOC_CALL(this->glGpu(), BufferData(target,
                                                                 (GrGLsizeiptr)size,
                                                                 nullptr,
                                                                 fUsage));
        if (error != GR_GL_NO_ERROR) {
            GL_CALL(DeleteBuffers(1, &fBufferID));
            fBufferID = 0;
        }
    }
    this->registerWithCache(skgpu::Budgeted::kYes);
    if (!fBufferID) {
        this->resourcePriv().removeScratchKey();
    }
}

Member Function Documentation

bufferID()

GrGLuint GrGLBuffer::bufferID ( ) const

inline

Definition at line 29 of file GrGLBuffer.h.

{ return fBufferID; }

hasAttachedToTexture()

bool GrGLBuffer::hasAttachedToTexture ( ) const

inline

Definition at line 32 of file GrGLBuffer.h.

{ return fHasAttachedToTexture; }

Make()

sk_sp< GrGLBuffer > GrGLBuffer::Make ( GrGLGpu *  gpu, size_t  size, GrGpuBufferType  intendedType, GrAccessPattern  accessPattern  )

static

Definition at line 31 of file GrGLBuffer.cpp.

                                                                  {
    if (gpu->glCaps().transferBufferType() == GrGLCaps::TransferBufferType::kNone &&
        (GrGpuBufferType::kXferCpuToGpu == intendedType ||
         GrGpuBufferType::kXferGpuToCpu == intendedType)) {
        return nullptr;
    }
 
    sk_sp<GrGLBuffer> buffer(new GrGLBuffer(gpu, size, intendedType, accessPattern,
                                            /*label=*/"MakeGlBuffer"));
    if (0 == buffer->bufferID()) {
        return nullptr;
    }
    return buffer;
}

onAbandon()

void GrGLBuffer::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.

Definition at line 155 of file GrGLBuffer.cpp.

                           {
    fBufferID = 0;
    fMapPtr = nullptr;
    INHERITED::onAbandon();
}

onRelease()

void GrGLBuffer::onRelease ( )

overrideprotectedvirtual

Overridden to free GPU resources in the backend API.

Reimplemented from GrGpuResource.

Definition at line 140 of file GrGLBuffer.cpp.

                           {
    TRACE_EVENT0("skia.gpu", TRACE_FUNC);
 
    if (!this->wasDestroyed()) {
        // make sure we've not been abandoned or already released
        if (fBufferID) {
            GL_CALL(DeleteBuffers(1, &fBufferID));
            fBufferID = 0;
        }
        fMapPtr = nullptr;
    }
 
    INHERITED::onRelease();
}

setHasAttachedToTexture()

void GrGLBuffer::setHasAttachedToTexture ( )

inline

Definition at line 31 of file GrGLBuffer.h.

{ fHasAttachedToTexture = true; }

setMemoryBacking()

void GrGLBuffer::setMemoryBacking ( SkTraceMemoryDump *  , const SkString &    ) const

overrideprotectedvirtual

Allows subclasses to add additional backing information to the SkTraceMemoryDump.

Reimplemented from GrGpuResource.

Definition at line 288 of file GrGLBuffer.cpp.

                                                                  {
    SkString buffer_id;
    buffer_id.appendU32(this->bufferID());
    traceMemoryDump->setMemoryBacking(dumpName.c_str(), "gl_buffer", buffer_id.c_str());
}

---

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

• third_party/skia/src/gpu/ganesh/gl/GrGLBuffer.h
• third_party/skia/src/gpu/ganesh/gl/GrGLBuffer.cpp