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.
Classes | Public Member Functions | List of all members
AZ::Metal::ClearAttachments Class Reference

#include <ClearAttachments.h>

Inherits AZ::RHI::DeviceObject.

Classes

struct  ClearData
 Information about clearing a render attachment. More...
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (ClearAttachments, AZ::SystemAllocator)
 
RHI::ResultCode Init (RHI::Device &device)
 Initialize the object.
 
void Shutdown () override
 Shutdown the object.
 
RHI::ResultCode Clear (CommandList &cmdList, MTLRenderPassDescriptor *renderpassDesc, const AZStd::vector< ClearData > &clearAttachmentsData)
 
- 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.
 

Additional Inherited Members

- 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
 
- Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int m_useCount = 0
 

Detailed Description

Utility class for clearing render attachments in the middle of a renderpass using a full screen triangle. Metal only supports clearing using a Load action but for subpasses we need to be able to clear an attachment at the beginning of a subpass.

Member Function Documentation

◆ Clear()

RHI::ResultCode AZ::Metal::ClearAttachments::Clear ( CommandList &  cmdList,
MTLRenderPassDescriptor *  renderpassDesc,
const AZStd::vector< ClearData > &  clearAttachmentsData 
)

Clears a group of attachments (color or depth/stencil) from the renderpass. It uses a full screen triangle to do the clearing.

◆ Shutdown()

void AZ::Metal::ClearAttachments::Shutdown ( )
overridevirtual

Shutdown the object.

Reimplemented from AZ::RHI::Object.

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