Open 3D Engine Atom 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::RHI::StreamBufferDescriptor Class Reference

#include <InputStreamLayout.h>

Public Member Functions

 AZ_TYPE_INFO (StreamBufferDescriptor, "{F1295422-9505-45EF-9E0D-47839B755F8C}")
 
 StreamBufferDescriptor (StreamStepFunction stepFunction, uint32_t stepRate, uint32_t byteStride)
 
HashValue64 GetHash (HashValue64 seed=HashValue64{ 0 }) const
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Public Attributes

StreamStepFunction m_stepFunction = StreamStepFunction::PerVertex
 The unit frequency at which data is presented to the vertex shader.
 
uint32_t m_stepRate = 1
 The interval (in per-frequency units) at which the data is pushed to the vertex shader.
 
uint32_t m_byteStride = 0
 

Detailed Description

Describes an instance of a StreamBufferView within the stream layout. Each stream buffer provides new data to the shader at a specified step rate. The byte stride is the total width of a single element in the buffer stream.

Member Data Documentation

◆ m_byteStride

uint32_t AZ::RHI::StreamBufferDescriptor::m_byteStride = 0

The distance in bytes between consecutive vertex entries in the buffer. This will match the stride value in StreamBufferView. It is provided separately here because some platforms may require this information at PSO compile time, while the StreamBufferView is not available until draw time.


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