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::RHI::StreamIterator< GeometryViewType, StreamBufferViewType > Class Template Reference

#include <DeviceGeometryView.h>

Public Member Functions

 StreamIterator (const GeometryViewType *geometryView, const StreamBufferIndices &indices)
 
bool HasEnded () const
 Use this in your for loop to check if the iterator has reached the end.
 
void Reset ()
 Can be used to reset the iterator if you want to use it for subsequent loops.
 
bool IsValid ()
 Used to check if the current item is a valid buffer, useful when checking dummy buffers.
 
StreamIterator & operator++ ()
 
StreamIterator operator++ (int)
 
const StreamBufferViewType & operator* ()
 Used to access the current StreamBufferView.
 
const StreamBufferViewType * operator-> ()
 Used to access the current StreamBufferView.
 
const StreamBufferViewType & operator[] (u16 idx) const
 Used for direct indexing, irrespective of the current iterator progress.
 

Detailed Description

template<typename GeometryViewType, typename StreamBufferViewType>
class AZ::RHI::StreamIterator< GeometryViewType, StreamBufferViewType >

Helper class to conveniently iterate through stream buffer views using the StreamBufferIndices class above Takes as input GeometryView* and StreamBufferIndices, then can be used to iterate with ++ operators It also supports direct indexing via myStreamIter[idx] syntax. This class is templated to support both GeometryView and DeviceGeometryView


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