Buffer

Internals of the Buffer module. More...

Collaboration diagram for Buffer:

Files
file	buffer.c
file	buffer_p.h

Classes
struct	SRPVertexBuffer
SRPVertexBuffer *	srpNewVertexBuffer ()
void	srpVertexBufferCopyData (SRPVertexBuffer *this, size_t nBytesPerVertex, size_t nBytesData, const void *data)
void	srpFreeVertexBuffer (SRPVertexBuffer *this)
void	srpDrawVertexBuffer (const SRPVertexBuffer *this, const SRPFramebuffer *fb, const SRPShaderProgram *sp, SRPPrimitive primitive, size_t startIndex, size_t count)
SRPVertex *	indexVertexBuffer (const SRPVertexBuffer *this, size_t index)
SRPIndexBuffer *	srpNewIndexBuffer ()
void	srpIndexBufferCopyData (SRPIndexBuffer *this, SRPType indicesType, size_t nBytesData, const void *data)
void	srpFreeIndexBuffer (SRPIndexBuffer *this)
uint64_t	indexIndexBuffer (const SRPIndexBuffer *this, size_t index)
void	srpDrawIndexBuffer (const SRPIndexBuffer *this, const SRPVertexBuffer *vb, const SRPFramebuffer *fb, const SRPShaderProgram *sp, SRPPrimitive primitive, size_t startIndex, size_t count)

Detailed Description

Internals of the Buffer module.

See also

Buffer

Function Documentation

indexIndexBuffer()

uint64_t indexIndexBuffer	(	const SRPIndexBuffer *	this,
		size_t	ibIndex
	)

Get an element stored in SRPIndexBuffer. Needed because SRPIndexBuffer stores opaque index types.

Parameters

[in]	this	Pointer to SRPIndexBuffer
[in]	ibIndex	Index of the element in the SRPIndexBuffer

Returns

Element upcasted to uint64_t

indexVertexBuffer()

SRPVertex * indexVertexBuffer	(	const SRPVertexBuffer *	this,
		size_t	index
	)

Get a vertex stored in SRPVertexBuffer.

Parameters

[in]	this	Pointer to SRPVertexBuffer
[in]	index	Index of the vertex to get

Returns

Requested vertex

srpDrawIndexBuffer()

void srpDrawIndexBuffer	(	const SRPIndexBuffer *	this,
		const SRPVertexBuffer *	vb,
		const SRPFramebuffer *	fb,
		const SRPShaderProgram *	sp,
		SRPPrimitive	primitive,
		size_t	startIndex,
		size_t	count
	)

Draw vertices using both vertex and index buffers

Parameters

[in]	this	The index buffer to read the indices from
[in]	vb	The vertex buffer to read the vertex data from
[in]	fb	The framebuffer to draw to
[in]	sp	The shader program to use
[in]	primitive	Specifies the primitive to draw
[in]	startIndex	Specifies from what index buffer's index to start drawing
[in]	count	Specifies how many indices to draw

srpDrawVertexBuffer()

void srpDrawVertexBuffer	(	const SRPVertexBuffer *	this,
		const SRPFramebuffer *	fb,
		const SRPShaderProgram *	sp,
		SRPPrimitive	primitive,
		size_t	startIndex,
		size_t	count
	)

Draw vertices from vertex buffer

Parameters

[in]	this	The pointer to vertex buffer to read the vertex data from
[in]	fb	The framebuffer to draw to
[in]	sp	The shader program to use
[in]	primitive	Specifies the primitive to draw
[in]	startIndex	Specifies from what index to start drawing
[in]	count	Specifies how many vertices to draw

srpFreeIndexBuffer()

void srpFreeIndexBuffer

(

SRPIndexBuffer *

this

)

Free the index buffer

Parameters

[in]

this

The pointer to index buffer, as returned from srpNewIndexBuffer()

srpFreeVertexBuffer()

void srpFreeVertexBuffer

(

SRPVertexBuffer *

this

)

Free the vertex buffer

Parameters

[in]

this

The pointer to vertex buffer, as returned from srpNewVertexBuffer()

srpIndexBufferCopyData()

void srpIndexBufferCopyData	(	SRPIndexBuffer *	this,
		SRPType	indicesType,
		size_t	nBytesData,
		const void *	data
	)

Copy the vertex data over to vertex buffer

Parameters

[in]	this	The pointer to index buffer
[in]	indicesType	The type of indices passed by data. Must be one of SRP_UINT8, SRP_UINT16, SRP_UINT32, SRP_UINT64
[in]	nBytesData	The size of index data
[in]	data	The pointer to an array of indices of type indicesType

srpNewIndexBuffer()

SRPIndexBuffer * srpNewIndexBuffer

(

)

Construct the index buffer

Returns

A pointer to constructed index buffer

srpNewVertexBuffer()

SRPVertexBuffer * srpNewVertexBuffer

(

)

Construct the vertex buffer.

See also

srpVertexBufferCopyData()

Returns

A pointer to constructed vertex buffer

srpVertexBufferCopyData()

void srpVertexBufferCopyData	(	SRPVertexBuffer *	this,
		size_t	nBytesPerVertex,
		size_t	nBytesData,
		const void *	data
	)

Copy the vertex data over to vertex buffer

Parameters

[in]	this	The pointer to vertex buffer
[in]	nBytesPerVertex	The size of one vertex, in bytes
[in]	nBytesData	The size of vertex data, in bytes
[in]	data	The pointer to vertex data