GrVertexBufferAllocPool Class Reference

#include <GrBufferAllocPool.h>

Inheritance diagram for GrVertexBufferAllocPool:

Public Member Functions
	GrVertexBufferAllocPool (GrGpu *gpu, sk_sp< CpuBufferCache > cpuBufferCache)
void *	makeSpace (size_t vertexSize, int vertexCount, sk_sp< const GrBuffer > *buffer, int *startVertex)
void *	makeSpaceAtLeast (size_t vertexSize, int minVertexCount, int fallbackVertexCount, sk_sp< const GrBuffer > *buffer, int *startVertex, int *actualVertexCount)
Public Member Functions inherited from GrBufferAllocPool
void	unmap ()
void	reset ()
void	putBack (size_t bytes)

Additional Inherited Members
Static Public Attributes inherited from GrBufferAllocPool
static constexpr size_t	kDefaultBufferSize = 1 << 15
Protected Member Functions inherited from GrBufferAllocPool
	GrBufferAllocPool (GrGpu *gpu, GrGpuBufferType bufferType, sk_sp< CpuBufferCache > cpuBufferCache)
virtual	~GrBufferAllocPool ()
void *	makeSpace (size_t size, size_t alignment, sk_sp< const GrBuffer > *buffer, size_t *offset)
void *	makeSpaceAtLeast (size_t minSize, size_t fallbackSize, size_t alignment, sk_sp< const GrBuffer > *buffer, size_t *offset, size_t *actualSize)
sk_sp< GrBuffer >	getBuffer (size_t size)

Detailed Description

A GrBufferAllocPool of vertex buffers

Definition at line 177 of file GrBufferAllocPool.h.

Constructor & Destructor Documentation

GrVertexBufferAllocPool()

GrVertexBufferAllocPool::GrVertexBufferAllocPool	(	GrGpu *	gpu,
		sk_sp< CpuBufferCache >	cpuBufferCache
	)

Constructor

Parameters

gpu	The GrGpu used to create the vertex buffers.
cpuBufferCache	If non-null a cache for client side array buffers or staging buffers used before data is uploaded to GPU buffer objects.

Definition at line 431 of file GrBufferAllocPool.cpp.

        : GrBufferAllocPool(gpu, GrGpuBufferType::kVertex, std::move(cpuBufferCache)) {}

Member Function Documentation

makeSpace()

void * GrVertexBufferAllocPool::makeSpace	(	size_t	vertexSize,
		int	vertexCount,
		sk_sp< const GrBuffer > *	buffer,
		int *	startVertex
	)

Returns a block of memory to hold vertices. A buffer designated to hold the vertices given to the caller. The buffer may or may not be locked. The returned ptr remains valid until any of the following: *makeSpace is called again. *unmap is called. *reset is called. *this object is destroyed.

Once unmap on the pool is called the vertices are guaranteed to be in the buffer at the offset indicated by startVertex. Until that time they may be in temporary storage and/or the buffer may be locked.

Parameters

vertexSize	specifies size of a vertex to allocate space for
vertexCount	number of vertices to allocate space for
buffer	returns the vertex buffer that will hold the vertices.
startVertex	returns the offset into buffer of the first vertex. In units of the size of a vertex from layout param.

Returns

pointer to first vertex.

Definition at line 434 of file GrBufferAllocPool.cpp.

                                                           {
    SkASSERT(vertexCount >= 0);
    SkASSERT(buffer);
    SkASSERT(startVertex);
 
    size_t offset SK_INIT_TO_AVOID_WARNING;
    void* ptr = INHERITED::makeSpace(SkSafeMath::Mul(vertexSize, vertexCount),
                                     vertexSize,
                                     buffer,
                                     &offset);
 
    SkASSERT(0 == offset % vertexSize);
    *startVertex = static_cast<int>(offset / vertexSize);
    return ptr;
}

makeSpaceAtLeast()

void * GrVertexBufferAllocPool::makeSpaceAtLeast	(	size_t	vertexSize,
		int	minVertexCount,
		int	fallbackVertexCount,
		sk_sp< const GrBuffer > *	buffer,
		int *	startVertex,
		int *	actualVertexCount
	)

Returns a block of memory to hold vertices. A buffer designated to hold the vertices given to the caller. The buffer may or may not be locked. The returned ptr remains valid until any of the following: *makeSpace is called again. *unmap is called. *reset is called. *this object is destroyed.

Once unmap on the pool is called the vertices are guaranteed to be in the buffer at the offset indicated by startVertex. Until that time they may be in temporary storage and/or the buffer may be locked.

The caller requests a minimum number of vertices, but the block may be (much) larger. Assuming that a new block must be allocated, it will be sized to hold fallbackVertexCount vertices. The actual block size (in vertices) is returned in actualVertexCount.

Parameters

vertexSize	specifies size of a vertex to allocate space for
minVertexCount	minimum number of vertices to allocate space for
fallbackVertexCount	number of vertices to allocate space for if a new block is needed
buffer	returns the vertex buffer that will hold the vertices.
startVertex	returns the offset into buffer of the first vertex. In units of the size of a vertex from layout param.
actualVertexCount	returns the capacity of the block (in vertices)

Returns

pointer to first vertex.

Definition at line 453 of file GrBufferAllocPool.cpp.

                                                                        {
    SkASSERT(minVertexCount >= 0);
    SkASSERT(fallbackVertexCount >= minVertexCount);
    SkASSERT(buffer);
    SkASSERT(startVertex);
    SkASSERT(actualVertexCount);
 
    size_t offset SK_INIT_TO_AVOID_WARNING;
    size_t actualSize SK_INIT_TO_AVOID_WARNING;
    void* ptr = INHERITED::makeSpaceAtLeast(SkSafeMath::Mul(vertexSize, minVertexCount),
                                            SkSafeMath::Mul(vertexSize, fallbackVertexCount),
                                            vertexSize,
                                            buffer,
                                            &offset,
                                            &actualSize);
 
    SkASSERT(0 == offset % vertexSize);
    *startVertex = static_cast<int>(offset / vertexSize);
 
    SkASSERT(0 == actualSize % vertexSize);
    SkASSERT(actualSize >= vertexSize * minVertexCount);
    *actualVertexCount = static_cast<int>(actualSize / vertexSize);
 
    return ptr;
}

---

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

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