StructuredBuffer Class
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
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.
See Also#
- StructuredBuffer C++ sample provided in the Samples (Samples -> C++ -> Render) section of UNIGINE SDK Browser.
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 ( ) #
Gets the data from StructuredBuffer instance.Arguments
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.StructuredBuffer create ( ) #
Creates a smart pointer to the StructuredBuffer.Source code (C++)
StructuredBufferPtr input_buffer = StructuredBuffer::create();int create ( int flags ) #
Arguments
- int flags - StructuredBuffer flag.
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 ( string 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
- string name - Friendly debug name to be set.
string 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 ( StructuredBuffer src ) #
Copies the data from the specified source structured buffer.Arguments
- 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:
2020-07-31
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)