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

A specialization of Attachment for an image. Provides access to the image. More...

#include <ImageFrameAttachment.h>

Inherits AZ::RHI::FrameAttachment.

Inherited by AZ::RHI::SwapChainFrameAttachment.

Public Member Functions

 AZ_RTTI (ImageFrameAttachment, "{F620A6ED-C33A-4487-9BF7-12F652B8B1E3}", FrameAttachment)
 
 AZ_CLASS_ALLOCATOR (ImageFrameAttachment, SystemAllocator)
 
 ImageFrameAttachment (const AttachmentId &attachmentId, Ptr< Image > image)
 Initialization for imported images.
 
 ImageFrameAttachment (const TransientImageDescriptor &descriptor)
 Initialization for transient images.
 
const ImageScopeAttachment * GetFirstScopeAttachment (int deviceIndex) const
 Returns the first scope attachment in the linked list.
 
ImageScopeAttachment * GetFirstScopeAttachment (int deviceIndex)
 
const ImageScopeAttachment * GetLastScopeAttachment (int deviceIndex) const
 Returns the last scope attachment in the linked list.
 
ImageScopeAttachment * GetLastScopeAttachment (int deviceIndex)
 
const Image * GetImage () const
 
Image * GetImage ()
 
const ImageDescriptor & GetImageDescriptor () const
 Returns the image descriptor for this attachment.
 
ClearValue GetOptimizedClearValue (int deviceIndex) const
 Returns an optimized clear value for the image by traversing the usage chain.
 
- Public Member Functions inherited from AZ::RHI::FrameAttachment
 AZ_RTTI (FrameAttachment, "{F35548B3-4B2C-478C-9ED9-759CAEAE2729}")
 
const AttachmentId & GetId () const
 Returns the attachment id.
 
Resource * GetResource ()
 Returns the resource associated with this frame attachment.
 
const Resource * GetResource () const
 
AttachmentLifetimeType GetLifetimeType () const
 Returns the attachment lifetime type.
 
const ScopeAttachment * GetFirstScopeAttachment (int deviceIndex) const
 
ScopeAttachment * GetFirstScopeAttachment (int deviceIndex)
 
const ScopeAttachment * GetLastScopeAttachment (int deviceIndex) const
 
ScopeAttachment * GetLastScopeAttachment (int deviceIndex)
 
bool HasScopeAttachments () const
 Returns whether there are any scope attachments at all.
 
Scope * GetFirstScope (int deviceIndex) const
 
Scope * GetLastScope (int deviceIndex) const
 
HardwareQueueClassMask GetUsedQueueMask () const
 Returns the mask of all the hardware queues that this attachment is used on.
 
HardwareQueueClassMask GetSupportedQueueMask () const
 Returns the mask of all the hardware queues that this attachment is supported on.
 
void SetResource (Ptr< Resource > resource, int deviceIndex=MultiDevice::InvalidDeviceIndex)
 [Internal] Assigns the resource. This may only be done once.
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RHI::FrameAttachment
 FrameAttachment (const AttachmentId &attachmentId, HardwareQueueClassMask supportedQueueMask, AttachmentLifetimeType lifetimeType)
 
 FrameAttachment (const FrameAttachment &)=delete
 
 FrameAttachment (FrameAttachment &&)=delete
 

Detailed Description

A specialization of Attachment for an image. Provides access to the image.

Member Function Documentation

◆ GetImage()

const Image * AZ::RHI::ImageFrameAttachment::GetImage ( ) const

Returns the image assigned to this attachment. This is not guaranteed to exist until after frame graph compilation.

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