#include <GrGpuBuffer.h>

Inheritance diagram for GrGpuBuffer:

Public Member Functions
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 void	ComputeScratchKeyForDynamicBuffer (size_t size, GrGpuBufferType, skgpu::ScratchKey *)

Static Public Member Functions inherited from GrGpuResource
static uint32_t	CreateUniqueID ()

Protected Types
enum class	MapType { kRead , kWriteDiscard }

Protected Member Functions
	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

Protected Attributes
void *	fMapPtr

Private Member Functions
virtual void	onMap (MapType)=0

virtual void	onUnmap (MapType)=0

virtual bool	onClearToZero ()=0

virtual bool	onUpdateData (const void *src, size_t offset, size_t size, bool preserve)=0

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

Detailed Description

Definition at line 24 of file GrGpuBuffer.h.

Member Enumeration Documentation

◆ MapType

enum class GrGpuBuffer::MapType

strongprotected

Enumerator
kRead	Maps for reading. The effect of writes is undefined.
kWriteDiscard	Maps for writing. The existing contents are discarded and the initial contents of the buffer. Reads (even after overwriting initial contents) should be avoided for performance reasons as the memory may not be cached.

Definition at line 108 of file GrGpuBuffer.h.

                       {
        /** Maps for reading. The effect of writes is undefined. */
        kRead,
        /**
         * Maps for writing. The existing contents are discarded and the initial contents of the
         * buffer. Reads (even after overwriting initial contents) should be avoided for performance
         * reasons as the memory may not be cached.
         */
        kWriteDiscard,
    };

Constructor & Destructor Documentation

◆ GrGpuBuffer()

GrGpuBuffer::GrGpuBuffer	(	GrGpu *	gpu,
		size_t	sizeInBytes,
		GrGpuBufferType	type,
		GrAccessPattern	pattern,
		std::string_view	label
	)

protected

Definition at line 19 of file GrGpuBuffer.cpp.

        : GrGpuResource(gpu, label)
        , fMapPtr(nullptr)
        , fSizeInBytes(sizeInBytes)
        , fAccessPattern(pattern)
        , fIntendedType(type) {}

Member Function Documentation

◆ accessPattern()

GrAccessPattern GrGpuBuffer::accessPattern ( ) const

inline

Definition at line 32 of file GrGpuBuffer.h.

32{ return fAccessPattern; }

◆ clearToZero()

bool GrGpuBuffer::clearToZero ( )

Overwrites the buffer with zero bytes. Always fails for GrGpuBufferType::kXferGpuToCpu buffers. The buffer must not currently be mapped.

Definition at line 49 of file GrGpuBuffer.cpp.

                              {
    SkASSERT(!this->isMapped());
 
    if (this->wasDestroyed()) {
        return false;
    }
 
    if (this->intendedType()  == GrGpuBufferType::kXferGpuToCpu) {
        return false;
    }
 
    return this->onClearToZero();
}

◆ ComputeScratchKeyForDynamicBuffer()

void GrGpuBuffer::ComputeScratchKeyForDynamicBuffer	(	size_t	size,
		GrGpuBufferType	intendedType,
		skgpu::ScratchKey *	key
	)

static

Computes a scratch key for a GPU-side buffer with a "dynamic" access pattern. (Buffers with "static" and "stream" patterns are disqualified by nature from being cached and reused.)

Definition at line 86 of file GrGpuBuffer.cpp.

                                                                          {
    static const skgpu::ScratchKey::ResourceType kType = skgpu::ScratchKey::GenerateResourceType();
    skgpu::ScratchKey::Builder builder(key, kType, 1 + (sizeof(size_t) + 3) / 4);
    builder[0] = SkToU32(intendedType);
    builder[1] = (uint32_t)size;
    if (sizeof(size_t) > 4) {
        builder[2] = (uint32_t)((uint64_t)size >> 32);
    }
}

◆ intendedType()

GrGpuBufferType GrGpuBuffer::intendedType ( ) const

inline

Definition at line 99 of file GrGpuBuffer.h.

99{ return fIntendedType; }

◆ isCpuBuffer()

bool GrGpuBuffer::isCpuBuffer ( ) const

inlinefinalvirtual

Is this an instance of GrCpuBuffer? Otherwise, an instance of GrGpuBuffer.

Implements GrBuffer.

Definition at line 71 of file GrGpuBuffer.h.

71{ return false; }

◆ isMapped()

bool GrGpuBuffer::isMapped ( ) const

Queries whether the buffer has been mapped.

Returns: true if the buffer is mapped, false otherwise.

Definition at line 47 of file GrGpuBuffer.cpp.

47{ return SkToBool(fMapPtr); }

SkToBool

static constexpr bool SkToBool(const T &x)

Definition: SkTo.h:35

◆ map()

void * GrGpuBuffer::map ( )

Maps the buffer to be read or written by the CPU.

It is an error to draw from the buffer while it is mapped or transfer to/from the buffer. It may fail if the backend doesn't support mapping the buffer. Once a buffer is mapped, subsequent calls to map() trivially succeed. No matter how many times map() is called, umap() will unmap the buffer on the first call if it is mapped.

If the buffer is of type GrGpuBufferType::kXferGpuToCpu then it is mapped for reading only. Otherwise it is mapped writing only. Writing to a buffer that is mapped for reading or vice versa produces undefined results. If the buffer is mapped for writing then the buffer's previous contents are invalidated.

Returns: a pointer to the data or nullptr if the map fails.

Definition at line 28 of file GrGpuBuffer.cpp.

                       {
    if (this->wasDestroyed()) {
        return nullptr;
    }
    if (!fMapPtr) {
        this->onMap(this->mapType());
    }
    return fMapPtr;
}

◆ onClearToZero()

virtual bool GrGpuBuffer::onClearToZero ( )

privatepure virtual

◆ onMap()

virtual void GrGpuBuffer::onMap ( MapType )

privatepure virtual

◆ onUnmap()

virtual void GrGpuBuffer::onUnmap ( MapType )

privatepure virtual

◆ onUpdateData()

virtual bool GrGpuBuffer::onUpdateData	(	const void *	src,
		size_t	offset,
		size_t	size,
		bool	preserve
	)

privatepure virtual

◆ ref()

void GrGpuBuffer::ref ( ) const

inlinefinalvirtual

Implements GrBuffer.

Definition at line 36 of file GrGpuBuffer.h.

36{ GrGpuResource::ref(); }

GrIORef< GrGpuResource >::ref

void ref() const

Definition: GrGpuResource.h:49

◆ size()

size_t GrGpuBuffer::size ( ) const

inlinefinalvirtual

Size of the buffer in bytes.

Implements GrBuffer.

Definition at line 34 of file GrGpuBuffer.h.

34{ return fSizeInBytes; }

◆ unmap()

void GrGpuBuffer::unmap ( )

Unmaps the buffer if it is mapped.

The pointer returned by the previous map call will no longer be valid.

Definition at line 38 of file GrGpuBuffer.cpp.

                        {
    if (this->wasDestroyed()) {
        return;
    }
    SkASSERT(fMapPtr);
    this->onUnmap(this->mapType());
    fMapPtr = nullptr;
}

◆ unref()

void GrGpuBuffer::unref ( ) const

inlinefinalvirtual

Implements GrBuffer.

Definition at line 38 of file GrGpuBuffer.h.

38{ GrGpuResource::unref(); }

GrIORef< GrGpuResource >::unref

void unref() const

Definition: GrGpuResource.h:62

◆ updateData()

bool GrGpuBuffer::updateData	(	const void *	src,
		size_t	offset,
		size_t	size,
		bool	preserve
	)

Updates the buffer data.

The size of the buffer will be preserved. The src data will be placed at offset. If preserve is false then any remaining content before/after the range [offset, offset+size) becomes undefined. Preserving updates will fail if the size and offset are not aligned to GrCaps::bufferUpdateDataPreserveAlignment().

The buffer must not be mapped.

Fails for GrGpuBufferType::kXferGpuToCpu.

Note that buffer updates do not go through GrContext and therefore are not serialized with other operations.

Returns: returns true if the update succeeds, false otherwise.

Definition at line 63 of file GrGpuBuffer.cpp.

                                                                                       {
    SkASSERT(!this->isMapped());
    SkASSERT(size > 0 && offset + size <= fSizeInBytes);
    SkASSERT(src);
 
    if (this->wasDestroyed()) {
        return false;
    }
 
    if (preserve) {
        size_t a = this->getGpu()->caps()->bufferUpdateDataPreserveAlignment();
        if (SkAlignTo(offset, a) != offset || SkAlignTo(size, a) != size) {
            return false;
        }
    }
 
    if (this->intendedType() == GrGpuBufferType::kXferGpuToCpu) {
        return false;
    }
 
    return this->onUpdateData(src, offset, size, preserve);
}

Member Data Documentation

◆ fMapPtr

void* GrGpuBuffer::fMapPtr

protected

Definition at line 119 of file GrGpuBuffer.h.

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

third_party/skia/src/gpu/ganesh/GrGpuBuffer.h
third_party/skia/src/gpu/ganesh/GrGpuBuffer.cpp

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ MapType

Constructor & Destructor Documentation

◆ GrGpuBuffer()

Member Function Documentation

◆ accessPattern()

◆ clearToZero()

◆ ComputeScratchKeyForDynamicBuffer()

◆ intendedType()

◆ isCpuBuffer()

◆ isMapped()

◆ map()

◆ onClearToZero()

◆ onMap()

◆ onUnmap()

◆ onUpdateData()

◆ ref()

◆ size()

◆ unmap()

◆ unref()

◆ updateData()

Member Data Documentation

◆ fMapPtr