Open 3D Engine Atom Gem API Reference  22.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Protected Attributes | List of all members
AZ::RHI::BufferView Class Reference

#include <BufferView.h>

Inherits AZ::RHI::ResourceView.

Public Member Functions

 AZ_RTTI (BufferView, "{3012F770-1DD7-4CEC-A5D0-E2FC807548C1}", ResourceView)
ResultCode Init (const Buffer &buffer, const BufferViewDescriptor &viewDescriptor)
 Initializes the buffer view with the provided buffer and view descriptor.
const BufferViewDescriptorGetDescriptor () const
 Returns the view descriptor used at initialization time.
const BufferGetBuffer () const
 Returns the buffer associated with this view.
bool IsFullView () const override final
 Returns whether the view maps to the full buffer.
bool IgnoreFrameAttachmentValidation () const
HashValue64 GetHash () const
 Returns the hash of the view.
- Public Member Functions inherited from AZ::RHI::ResourceView
const ResourceGetResource () const
 Returns the resource associated with this view.
bool IsStale () const
 AZ_RTTI (ResourceView, "{7F50934E-A2F3-4989-BB8C-F3AFE33BEBDD}", Object)
- Public Member Functions inherited from AZ::RHI::DeviceObject
 AZ_RTTI (DeviceObject, "{17D34F71-944C-4AF5-9823-627474C4C0A6}", Object)
bool IsInitialized () const
 Returns whether the device object is initialized.
DeviceGetDevice () const
- Public Member Functions inherited from AZ::RHI::Object
 AZ_RTTI (Object, "{E43378F1-2331-4173-94B8-990ED20E6003}")
void SetName (const Name &name)
const Name & GetName () const

Protected Attributes

HashValue64 m_hash = HashValue64{ 0 }

Additional Inherited Members

- Protected Member Functions inherited from AZ::RHI::ResourceView
ResultCode Init (const Resource &resource)
 The derived class should call this method at Init time.
- Protected Member Functions inherited from AZ::RHI::DeviceObject
void Init (Device &device)
 The derived class should call this method to assign the device.

Detailed Description

BufferView is contains a platform-specific descriptor mapping to a linear sub-region of a specific buffer resource. It associates 1-to-1 with a BufferViewDescriptor.

Member Function Documentation

◆ IgnoreFrameAttachmentValidation()

bool AZ::RHI::BufferView::IgnoreFrameAttachmentValidation ( ) const

Tells the renderer to ignore any validation related to this buffer's state and scope attachments. Assumes that the programmer is manually managing the Read/Write state of the buffer correctly.

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