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.
Public Member Functions | Protected Member Functions | Friends | List of all members
AZ::RHI::ResourceView Class Referenceabstract

#include <ResourceView.h>

Inherits AZ::RHI::DeviceObject, and ResourceInvalidateBus::Handler.

Inherited by AZ::RHI::BufferView, and AZ::RHI::ImageView.

Public Member Functions

const Resource & GetResource () const
 Returns the resource associated with this view.
 
bool IsStale () const
 
virtual bool IsFullView () const =0
 Returns whether the view covers the entire image (i.e. isn't just a subset).
 
 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.
 
Device & GetDevice () const
 
- Public Member Functions inherited from AZ::RHI::Object
 AZ_RTTI (Object, "{E43378F1-2331-4173-94B8-990ED20E6003}")
 
void SetName (const Name &name)
 Sets the name of the object.
 
const Name & GetName () const
 Returns the name set on the object by SetName.
 
uint32_t use_count ()
 Returns the current use count of the object.
 

Protected Member Functions

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.
 
void Shutdown () override
 Clears the current bound device to null.
 
- Protected Member Functions inherited from AZ::RHI::Object
void add_ref () const
 
void release () const
 

Friends

class Resource
 

Additional Inherited Members

- Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int m_useCount = 0
 

Detailed Description

ResourceView is a base class for views which are dependent on a Resource instance.

NOTE: While initialization is separate from creation, explicit shutdown is not allowed for resource views. This is because the cost of dependency tracking with ShaderResourceGroups is too high. Instead, resource views are reference counted.

Member Function Documentation

◆ IsFullView()

virtual bool AZ::RHI::ResourceView::IsFullView ( ) const
pure virtual

Returns whether the view covers the entire image (i.e. isn't just a subset).

Implemented in AZ::RHI::BufferView, and AZ::RHI::ImageView.

◆ IsStale()

bool AZ::RHI::ResourceView::IsStale ( ) const

Returns whether this view is stale (i.e. the original image contents have been shutdown.

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