|
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.
|
#include <FrameAttachment.h>
Inherited by AZ::RHI::BufferFrameAttachment, and AZ::RHI::ImageFrameAttachment.
Public Member Functions | |
| 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. | |
Protected Member Functions | |
| FrameAttachment (const AttachmentId &attachmentId, HardwareQueueClassMask supportedQueueMask, AttachmentLifetimeType lifetimeType) | |
| FrameAttachment (const FrameAttachment &)=delete | |
| FrameAttachment (FrameAttachment &&)=delete | |
Friends | |
| class | FrameGraphAttachmentDatabase |
| class | FrameGraphCompiler |
FrameAttachment is the base class for all attachments stored in the frame graph. Attachments are "attached" to scopes via ScopeAttachment instances. These scope attachments form a linked list from the first to last scope. FrameAttachments are associated with a unique AttachmentId.
FrameAttachments are rebuilt every frame, and are created through the FrameGraph.
| Scope* AZ::RHI::FrameAttachment::GetFirstScope | ( | ) | const |
Returns the first / last scope associated with the lifetime of this attachment. The guarantee is that the attachment is not used by any scope with index prior to GetFirstScope or any scope with index after GetLastScope. It does not, however, guarantee that the attachment is actually used by either scope. The scope attachment list must be traversed to determine usage.
1.9.1