|
Open 3D Engine Atom Gem API Reference
24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
|
|
Open 3D Engine Atom Gem API Reference
24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
|
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 () const |
| Returns the first scope attachment in the linked list. | |
| ImageScopeAttachment * | GetFirstScopeAttachment () |
| const ImageScopeAttachment * | GetLastScopeAttachment () const |
| Returns the last scope attachment in the linked list. | |
| ImageScopeAttachment * | GetLastScopeAttachment () |
| const Image * | GetImage () const |
| Image * | GetImage () |
| const ImageDescriptor & | GetImageDescriptor () const |
| Returns the image descriptor for this attachment. | |
| ClearValue | GetOptimizedClearValue () 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 () const |
| Returns the first scope attachment in the linked list. | |
| ScopeAttachment * | GetFirstScopeAttachment () |
| const ScopeAttachment * | GetLastScopeAttachment () const |
| Returns the last scope attachment in the linked list. | |
| ScopeAttachment * | GetLastScopeAttachment () |
| Scope * | GetFirstScope () const |
| Scope * | GetLastScope () 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) |
| [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 | |
A specialization of Attachment for an image. Provides access to the image.
| 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.
1.9.1