Unigine::StructuredBuffer Class

Header:

#include <UnigineTextures.h>

StructuredBuffer is a buffer for structures: it represents a uniform array of structures.

StructuredBuffer resource can specified via the following flags:

GPU_RESOURCE specifies a resource that can be read and written by the GPU. It also creates a temporary direct staging buffer to copy the data from the main buffer and gets the data by the CPU.
IMMUTABLE specifies a resources that can only be read by the GPU. It also creates a temporary direct staging buffer to copy the data from the main buffer and gets the data by the CPU.
CPU_RESOURCE specifies a resource that is accessible by both the GPU (read only mode) and the CPU (write only mode). It also creates a temporary direct staging buffer to copy the data from the main buffer and gets the data by the CPU.
STAGING specifies a resource that supports direct data transfer from the GPU to CPU.

Methods:

Name	Description View: Sort by:
getD3D11ShaderResourceView	Gets a shader-resource view that specifies the subresources a shader can access during rendering.
getD3D11UnorderedAccessView	Gets a view for an unordered access resource that specifies the parts of a resource the pipeline can access during rendering.
getData	Gets the data from StructuredBuffer instance.
getGLBufferID	Returns the Id of buffer.
bindCompute	Binds the StructuredBuffer to the compute shader type.
unbindCompute	Unbinds the StructuredBuffer from the compute shader type.
bindControl	Binds the StructuredBuffer to the tessellation control (hull) shader type.
unbindControl	Unbinds the StructuredBuffer from the tessellation control (hull) shader type.
bindEvaluate	Binds the StructuredBuffer to the tessellation evaluation (domain) shader type.
unbindEvaluate	Unbinds the StructuredBuffer from the tessellation evaluation (domain) shader type.
bindFragment	Binds the StructuredBuffer to the fragment shader type.
unbindFragment	Unbinds the StructuredBuffer from the fragment shader type.
bindGeometry	Binds the StructuredBuffer to the geometry shader type.
unbindGeometry	Unbinds the StructuredBuffer from the geometry shader type.
bindVertex	Binds the StructuredBuffer to the vertex shader type.
clear	Clears smart pointer.
create	Creates a smart pointer to the StructuredBuffer.
destroy	Destroys smart pointer.
unbindVertex	Unbinds the StructuredBuffer from the vertex shader type.
setDebugName	Sets a friendly name for GPU debugging (RenderDoc, NVIDIA Nsight).
getDebugName	Returns the currently used friendly name for GPU debugging (RenderDoc, NVIDIA Nsight).
clearBuffer	Clears the structured buffer.
copy	Copies the data from the specified source structured buffer.
getNumElements	Returns the number of elements in the structured buffer.

Variables:

Name	Description
CPU_RESOURCE = 2	GPU read-only, CPU write-only + copy staging buffer.
GPU_RESOURCE = 0	GPU read / write + copy staging buffer.
IMMUTABLE = 1	GPU read-only + copy staging buffer.
STAGING = 3	GPU no access + CPU read-only + direct staging buffer.

StructuredBuffer Class

Members

void * getD3D11ShaderResourceView ( ) #

Gets a shader-resource view that specifies the subresources a shader can access during rendering.

Return value

A pointer to D3D11 shader resource view.

void * getD3D11UnorderedAccessView ( ) #

Gets a view for an unordered access resource that specifies the parts of a resource the pipeline can access during rendering.

Return value

A pointer to a D3D11 unordered access view.

int getData ( void * data ) #

Gets the data from StructuredBuffer instance.

Arguments

void * data - A pointer to the data.

Return value

1 if StructuredBuffer data was returned; otherwise, 0.

int getGLBufferID ( ) #

Returns the Id of buffer.

Return value

An Id of the buffer.

void bindCompute ( int unit ) #

Binds the StructuredBuffer to the compute shader type.

Arguments

int unit - Number of the slot.

void unbindCompute ( int unit ) #

Unbinds the StructuredBuffer from the compute shader type.

Arguments

int unit - Number of the slot.

void bindControl ( int unit ) #

Binds the StructuredBuffer to the tessellation control (hull) shader type.

Arguments

int unit - Number of the slot.

void unbindControl ( int unit ) #

Unbinds the StructuredBuffer from the tessellation control (hull) shader type.

Arguments

int unit - Number of the slot.

void bindEvaluate ( int unit ) #

Binds the StructuredBuffer to the tessellation evaluation (domain) shader type.

Arguments

int unit - Number of the slot.

void unbindEvaluate ( int unit ) #

Unbinds the StructuredBuffer from the tessellation evaluation (domain) shader type.

Arguments

int unit - Number of the slot.

void bindFragment ( int unit ) #

Binds the StructuredBuffer to the fragment shader type.

Arguments

int unit - Number of the slot.

void unbindFragment ( int unit ) #

Unbinds the StructuredBuffer from the fragment shader type.

Arguments

int unit - Number of the slot.

void bindGeometry ( int unit ) #

Binds the StructuredBuffer to the geometry shader type.

Arguments

int unit - Number of the slot.

void unbindGeometry ( int unit ) #

Unbinds the StructuredBuffer from the geometry shader type.

Arguments

int unit - Number of the slot.

void bindVertex ( int unit ) #

Binds the StructuredBuffer to the vertex shader type.

Arguments

int unit - Number of the slot.

void clear ( ) #

Clears smart pointer.

Ptr<StructuredBuffer> create ( ) #

Creates a smart pointer to the StructuredBuffer.

Source code (C++)

StructuredBufferPtr input_buffer = StructuredBuffer::create();

int create ( int flags, void * data, unsigned int structure_size, unsigned int num_elements ) #

Creates a StructuredBuffer instance with specified parameters.

Source code (C++)

#define NUMBERS_COUNT 4096 * 8192

// Input data structure
struct InputDataStructure {
	vec4 vector0;
	vec4 vector1;
};

// Source data
InputDataStructure *source_data = new InputDataStructure[NUMBERS_COUNT];

// Create immutable structure buffer (gpu_read-only) and store initial values
StructuredBufferPtr input_buffer = StructuredBuffer::create();
input_buffer->create(StructuredBuffer::IMMUTABLE, source_data, sizeof(InputDataStructure), NUMBERS_COUNT);

Arguments

int flags - StructuredBuffer flag.
void * data - Pointer to the source data.
unsigned int structure_size - The size of the structured buffer.
unsigned int num_elements - Number of elements in the structured buffer.

Return value

1 if the StructuredBuffer was created successfully; otherwise, 0.

int create ( int flags, unsigned int structure_size, unsigned int num_elements ) #

Constructor. Creates a new structured buffer with the specified parameters.

Arguments

int flags - StructuredBuffer flag.
unsigned int structure_size - The size of the structured buffer.
unsigned int num_elements - Number of elements in the structured buffer.

Return value

1 if the StructuredBuffer was created successfully; otherwise, 0.

void destroy ( ) #

Destroys smart pointer.

void unbindVertex ( int unit ) #

Unbinds the StructuredBuffer from the vertex shader type.

Arguments

int unit - Number of the slot.

void setDebugName ( const char * name ) #

Sets a friendly name for GPU debugging (RenderDoc, NVIDIA Nsight). It can be used to help you determine if the corresponding object interface pointer caused the leak. Memory leaks are reported by the debug software layer by outputting a list of object interface pointers along with their friendly names.

Arguments

const char * name - Friendly debug name to be set.

const char * getDebugName ( ) #

Returns the currently used friendly name for GPU debugging (RenderDoc, NVIDIA Nsight). It can be used to help you determine if the corresponding object interface pointer caused the leak. Memory leaks are reported by the debug software layer by outputting a list of object interface pointers along with their friendly names.

Return value

Friendly debug name.

void clearBuffer ( ) #

Clears the structured buffer.

void copy ( const Ptr<StructuredBuffer> & src ) #

Copies the data from the specified source structured buffer.

Arguments

const Ptr<StructuredBuffer> & src - Source structured buffer to copy data from.

int getNumElements ( ) #

Returns the number of elements in the structured buffer.

Return value

Number of elements in the structured buffer.

Last update: 2021-04-09

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

Unigine::StructuredBuffer Class

See Also#

Methods:

Variables:

StructuredBuffer Class

Members

void * getD3D11ShaderResourceView ( ) #

Return value

void * getD3D11UnorderedAccessView ( ) #

Return value

int getData ( void * data ) #

Arguments

Return value

int getGLBufferID ( ) #

Return value

void bindCompute ( int unit ) #

Arguments

void unbindCompute ( int unit ) #

Arguments

void bindControl ( int unit ) #

Arguments

void unbindControl ( int unit ) #

Arguments

void bindEvaluate ( int unit ) #

Arguments

void unbindEvaluate ( int unit ) #

Arguments

void bindFragment ( int unit ) #

Arguments

void unbindFragment ( int unit ) #

Arguments

void bindGeometry ( int unit ) #

Arguments

void unbindGeometry ( int unit ) #

Arguments

void bindVertex ( int unit ) #

Arguments

void clear ( ) #

Ptr<StructuredBuffer> create ( ) #

int create ( int flags, void * data, unsigned int structure_size, unsigned int num_elements ) #

Arguments

Return value

int create ( int flags, unsigned int structure_size, unsigned int num_elements ) #

Arguments

Return value

void destroy ( ) #

void unbindVertex ( int unit ) #

Arguments

void setDebugName ( const char * name ) #

Arguments

const char * getDebugName ( ) #

Return value

void clearBuffer ( ) #

void copy ( const Ptr<StructuredBuffer> & src ) #

Arguments

int getNumElements ( ) #

Return value