Open 3D Engine Atom Gem API Reference 26.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::Render::StreamBufferViewsBuilderInterface Class Referenceabstract

Inherited by AZ::Render::ShaderStreamBufferViewsBuilder.

Public Member Functions

 AZ_RTTI (AZ::Render::StreamBufferViewsBuilderInterface, "{B0004EA8-C829-427D-8F3B-0FBB060CB385}")
 
virtual bool AddStream (const char *semanticName, AZ::RHI::Format streamFormat, bool isOptional)=0
 All streams that need to be queried must be added before calling BuildShaderStreamBufferViews();.
 
virtual AZ::u8 GetStreamCount () const =0
 Returns the number of streams that were successfully added via @AddStream(...)
 
virtual AZStd::unique_ptr< ShaderStreamBufferViewsInterfaceBuildShaderStreamBufferViews (uint32_t lodIndex, uint32_t meshIndex)=0
 
virtual const MeshFeatureProcessorInterface::MeshHandleGetMeshHandle () const =0
 For informational purposes. Gets a reference to the MeshHandle used when this builder was created.
 

Member Function Documentation

◆ AddStream()

virtual bool AZ::Render::StreamBufferViewsBuilderInterface::AddStream ( const char *  semanticName,
AZ::RHI::Format  streamFormat,
bool  isOptional 
)
pure virtual

All streams that need to be queried must be added before calling BuildShaderStreamBufferViews();.

Implemented in AZ::Render::ShaderStreamBufferViewsBuilder.

◆ BuildShaderStreamBufferViews()

virtual AZStd::unique_ptr< ShaderStreamBufferViewsInterface > AZ::Render::StreamBufferViewsBuilderInterface::BuildShaderStreamBufferViews ( uint32_t  lodIndex,
uint32_t  meshIndex 
)
pure virtual

If @AddStream() is never called, the returned @ShaderStreamBufferViewsInterface may only be useful for GetIndexBufferView(). The returned ShaderStreamBufferViewsInterface can only get the Streams on the particular @meshIndex within the @lodIndex.

Implemented in AZ::Render::ShaderStreamBufferViewsBuilder.

◆ GetMeshHandle()

virtual const MeshFeatureProcessorInterface::MeshHandle & AZ::Render::StreamBufferViewsBuilderInterface::GetMeshHandle ( ) const
pure virtual

For informational purposes. Gets a reference to the MeshHandle used when this builder was created.

Implemented in AZ::Render::ShaderStreamBufferViewsBuilder.

◆ GetStreamCount()

virtual AZ::u8 AZ::Render::StreamBufferViewsBuilderInterface::GetStreamCount ( ) const
pure virtual

Returns the number of streams that were successfully added via @AddStream(...)

Implemented in AZ::Render::ShaderStreamBufferViewsBuilder.


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