AZ::RHI::StreamBufferView Class Reference

#include <StreamBufferView.h>

Public Member Functions
	StreamBufferView (const Buffer &buffer, uint32_t byteOffset, uint32_t byteCount, uint32_t byteStride)
HashValue64	GetHash () const
	Returns the hash of the view. This hash is precomputed at creation time.
const Buffer *	GetBuffer () const
	Returns the buffer associated with the view.
uint32_t	GetByteOffset () const
	Returns the byte offset into the buffer.
uint32_t	GetByteCount () const
	Returns the number of bytes in the view.
uint32_t	GetByteStride () const

Detailed Description

Provides a view into a buffer, to be used as vertex stream. The content of the view is a contiguous list of input vertex data. It is provided to the RHI back-end at draw time.

Note that the buffer is further described in InputStreamLayout, through StreamChannelDescriptors and a StreamBufferDescriptor, which is provided to the RHI back-end at PSO compile time.

• The view will be associated with one or more StreamChannelDescriptors to describe its specific content. Channels maybe be stored in separate StreamBufferViews (each view having a separate StreamChannelDescriptor) or interleaved in a single StreamBufferView (one view having multiple StreamChannelDescriptors).
• The view will correspond to a single StreamBufferDescriptor.

Member Function Documentation

GetByteStride()

uint32_t AZ::RHI::StreamBufferView::GetByteStride

(

)

const

Returns the distance in bytes between consecutive vertex entries in the buffer. This must match the stride value in StreamBufferDescriptor.

---

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

• Gems/Atom/RHI/Code/Include/Atom/RHI/StreamBufferView.h