Open 3D Engine AtomTressFX Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::Render::SrgBufferDescriptor Struct Reference

#include <SharedBuffer.h>

Public Member Functions

 SrgBufferDescriptor (RPI::CommonBufferPoolType poolType, RHI::Format elementFormat, uint32_t elementSize, uint32_t elementCount, Name bufferName, Name paramNameInSrg, uint32_t resourceShaderIndex, uint32_t viewOffsetInBytes)
 

Public Attributes

RPI::CommonBufferPoolType m_poolType
 Pool type to determine how a resource pool should be generated.
 
RHI::Format m_elementFormat
 
uint32_t m_elementSize
 The size in bytes of each element in the stream.
 
uint32_t m_elementCount
 Amount of elements required to create the buffer.
 
Name m_bufferName
 The name used for the buffer view.
 
Name m_paramNameInSrg
 The name used by the shader Srg in the GPU for this shader parameter.
 
uint32_t m_resourceShaderIndex
 The assigned SRG slot in the CPU / GPU for this shader resource.
 
uint32_t m_viewOffsetInBytes
 

Detailed Description

This structure contains information regarding the naming of the buffer on both the CPU and the GPU This structure is also used to determine the maximum alignment required for the buffer when allocating sub-buffers

Member Data Documentation

◆ m_elementFormat

RHI::Format AZ::Render::SrgBufferDescriptor::m_elementFormat

The format used for the buffer Should be Unknown for structured buffers, or R32 for raw buffers.

◆ m_viewOffsetInBytes

uint32_t AZ::Render::SrgBufferDescriptor::m_viewOffsetInBytes

If using a buffer view within a shared buffer, this represents the view offset from the shared buffer origin in bytes.


The documentation for this struct was generated from the following file: