Unigine.StructuredBuffer Class

USAGE_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.
USAGE_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.
USAGE_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.
USAGE_STAGING specifies a resource that supports direct data transfer from the GPU to CPU.
USAGE_SHARED specifies that a resource is accessible by an external graphics API.

Properties:

Name	Description
string DebugName	The friendly name of the structured buffer used for GPU debugging (RenderDoc, NVIDIA Nsight).
int NumElements	The number of elements in the structured buffer.
bool IsUsageShared	The value indicating if the resource has the USAGE_SHARED flag enabled.
bool IsUsageStaging	The value indicating if the resource has the USAGE_STAGING flag enabled.
bool IsUsageCPUResource	The value indicating if the resource has the USAGE_CPU_RESOURCE flag enabled.
bool IsUsageImmutable	The value indicating if the resource has the USAGE_IMMUTABLE flag enabled.
bool IsUsageGPUResource	The value indicating if the resource has the USAGE_GPU_RESOURCE flag enabled.

Methods:

Name	Description View: Sort by:
StructuredBuffer	Constructor.
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.
Clear	Clears smart pointer.
Create
Destroy	Destroys smart pointer.
ClearBuffer	Clears the structured buffer.
Copy	Copies the data from the specified source structured buffer.
GetResourceExternalMemory	Returns the resource in video memory.

Variables:

Name	Description
USAGE_SHARED = 1 << 4	Accessible by the external graphics API.
USAGE_STAGING = 1 << 3	GPU no access + CPU read-only + direct staging buffer.
USAGE_CPU_RESOURCE = 1 << 2	GPU read-only, CPU write-only + copy staging buffer.
USAGE_IMMUTABLE = 1 << 1	GPU read-only + copy staging buffer.
USAGE_GPU_RESOURCE = 1 << 0	GPU read / write + copy staging buffer.

StructuredBuffer Class

Properties

string DebugName#

The friendly name of the structured buffer used 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.

int NumElements#

The number of elements in the structured buffer.

bool IsUsageShared#

The value indicating if the resource has the USAGE_SHARED flag enabled.

bool IsUsageStaging#

The value indicating if the resource has the USAGE_STAGING flag enabled.

bool IsUsageCPUResource#

The value indicating if the resource has the USAGE_CPU_RESOURCE flag enabled.

bool IsUsageImmutable#

The value indicating if the resource has the USAGE_IMMUTABLE flag enabled.

bool IsUsageGPUResource#

The value indicating if the resource has the USAGE_GPU_RESOURCE flag enabled.

Members

StructuredBuffer ( ) #

Constructor. Creates a new structured buffer.

Source code (C++)

StructuredBufferPtr input_buffer = StructuredBuffer::create();

IntPtr 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.

IntPtr 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 ( IntPtr data ) #

Gets the data from StructuredBuffer instance.

Arguments

IntPtr 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 Clear ( ) #

Clears smart pointer.

int Create ( int flags, IntPtr data, uint structure_size, uint num_elements ) #

Arguments

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

Return value

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

int Create ( int flags, uint structure_size, uint num_elements ) #

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

Arguments

int flags - StructuredBuffer flag.
uint structure_size - The size of the structured buffer.
uint 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 ClearBuffer ( ) #

Clears the structured buffer.

void Copy ( StructuredBuffer src ) #

Copies the data from the specified source structured buffer.

Arguments

StructuredBuffer src - Source structured buffer to copy data from.

ResourceExternalMemory GetResourceExternalMemory ( ) #

Returns the resource in video memory. If the USAGE_SHARED flag is not enabled for the resource, this method returns NULL.

Return value

The resource in video memory. If the USAGE_SHARED flag is not enabled for the resource, this method returns NULL.

Last update: 2024-04-04

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

In This Article:

See Also
#

Properties:

Methods:

Variables:

StructuredBuffer Class

Properties

string DebugName#

int NumElements#

bool IsUsageShared#

bool IsUsageStaging#

bool IsUsageCPUResource#

bool IsUsageImmutable#

bool IsUsageGPUResource#

Members

StructuredBuffer ( ) #

IntPtr GetD3D11ShaderResourceView ( ) #

Return value

IntPtr GetD3D11UnorderedAccessView ( ) #

Return value

int GetData ( IntPtr data ) #

Arguments

Return value

int GetGLBufferID ( ) #

Return value

void Clear ( ) #

int Create ( int flags, IntPtr data, uint structure_size, uint num_elements ) #

Arguments

Return value

int Create ( int flags, uint structure_size, uint num_elements ) #

Arguments

Return value

void Destroy ( ) #

void ClearBuffer ( ) #

void Copy ( StructuredBuffer src ) #

Arguments

ResourceExternalMemory GetResourceExternalMemory ( ) #

Return value

Unigine.StructuredBuffer Class

In This Article:

See Also#

Properties:

Methods:

Variables:

StructuredBuffer Class

Properties

string DebugName#

int NumElements#

bool IsUsageShared#

bool IsUsageStaging#

bool IsUsageCPUResource#

bool IsUsageImmutable#

bool IsUsageGPUResource#

Members

StructuredBuffer ( ) #

IntPtr GetD3D11ShaderResourceView ( ) #

Return value

IntPtr GetD3D11UnorderedAccessView ( ) #

Return value

int GetData ( IntPtr data ) #

Arguments

Return value

int GetGLBufferID ( ) #

Return value

void Clear ( ) #

int Create ( int flags, IntPtr data, uint structure_size, uint num_elements ) #

Arguments

Return value

int Create ( int flags, uint structure_size, uint num_elements ) #

Arguments

Return value

void Destroy ( ) #

void ClearBuffer ( ) #

void Copy ( StructuredBuffer src ) #

Arguments

ResourceExternalMemory GetResourceExternalMemory ( ) #

Return value

See Also
#