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::InputStreamLayout Class Reference

#include <InputStreamLayout.h>

Public Member Functions

 AZ_TYPE_INFO (InputStreamLayout, "{2F628C89-76F7-458C-9DCE-2A2FFD4530E1}")
 
void Clear ()
 Clears the descriptor back to an empty state.
 
bool Finalize ()
 Finalizes the descriptor and builds the hash.
 
bool IsFinalized () const
 Returns whether Finalize() was called.
 
void SetTopology (PrimitiveTopology topology)
 Sets the primitive topology to the descriptor.
 
void AddStreamChannel (const StreamChannelDescriptor &descriptor)
 Adds a stream channel to the descriptor.
 
void AddStreamBuffer (const StreamBufferDescriptor &descriptor)
 Adds a stream buffer to the descriptor.
 
const PrimitiveTopology GetTopology () const
 Returns the primitive topology.
 
AZStd::span< const StreamChannelDescriptorGetStreamChannels () const
 Returns the list of stream channels.
 
AZStd::span< const StreamBufferDescriptorGetStreamBuffers () const
 Returns the list of stream buffers.
 
HashValue64 GetHash () const
 Returns the hash computed in Finalize(), which must be called first.
 
bool operator== (const InputStreamLayout &rhs) const
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

Describes the input assembly stream buffer layout for the pipeline state. This is provided to the RHI back-end at PSO compile time as part of the PipelineStateDescriptor.

See InputStreamLayoutBuilder for a convenient way to construct InputStreamLayout objects.


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