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.
AZ::RHI::ImageScopeAttachment Class Reference

#include <ImageScopeAttachment.h>

Inherits AZ::RHI::ScopeAttachment.

Inherited by AZ::RHI::ResolveScopeAttachment.

Public Member Functions

 AZ_RTTI (ImageScopeAttachment, "{C2268A3B-BAED-4A63-BB49-E3FF762BA8F0}", ScopeAttachment)
 
 AZ_CLASS_ALLOCATOR (ImageScopeAttachment, SystemAllocator)
 
 ImageScopeAttachment (Scope &scope, FrameAttachment &attachment, ScopeAttachmentUsage usage, ScopeAttachmentAccess access, ScopeAttachmentStage stage, const ImageScopeAttachmentDescriptor &descriptor)
 
const ImageScopeAttachmentDescriptor & GetDescriptor () const
 
const ImageFrameAttachment & GetFrameAttachment () const
 Returns the parent graph attachment referenced by this scope attachment.
 
ImageFrameAttachment & GetFrameAttachment ()
 
const ImageScopeAttachment * GetPrevious () const
 Returns the previous scope attachment in the linked list.
 
ImageScopeAttachment * GetPrevious ()
 
const ImageScopeAttachment * GetNext () const
 Returns the next scope attachment in the linked list.
 
ImageScopeAttachment * GetNext ()
 
const AZ::RHI::ImageView * GetImageView () const
 Returns the image view set on the scope attachment.
 
void SetImageView (ConstPtr< AZ::RHI::ImageView > imageView)
 Assigns an image view to the scope attachment.
 
bool IsBeingResolved () const
 
const ScopeAttachmentDescriptor & GetScopeAttachmentDescriptor () const override
 Return the ScopeAttachmentDescriptor used by this attachment.
 
- Public Member Functions inherited from AZ::RHI::ScopeAttachment
 AZ_RTTI (ScopeAttachment, "{6BB50E92-5A15-4C50-8717-F7B05AB98BD9}")
 
 ScopeAttachment (Scope &scope, FrameAttachment &attachment, ScopeAttachmentUsage usage, ScopeAttachmentAccess access, ScopeAttachmentStage stage)
 
ScopeAttachmentUsage GetUsage () const
 Returns the usage.
 
ScopeAttachmentAccess GetAccess () const
 Returns the access.
 
ScopeAttachmentStage GetStage () const
 Returns the pipeline stage.
 
const ResourceView * GetResourceView () const
 Returns the resource view.
 
const Scope & GetScope () const
 Returns the parent scope that this attachment is bound to.
 
Scope & GetScope ()
 
const FrameAttachment & GetFrameAttachment () const
 Returns the parent frame graph attachment.
 
FrameAttachment & GetFrameAttachment ()
 
const ScopeAttachment * GetPrevious () const
 Returns the previous binding in the linked list.
 
ScopeAttachment * GetPrevious ()
 
const ScopeAttachment * GetNext () const
 Returns the next binding in the linked list.
 
ScopeAttachment * GetNext ()
 
const char * GetTypeName () const
 Returns the friendly usage and access type names of this scope attachment (used for logging).
 
bool IsSwapChainAttachment () const
 Returns true if this is a SwapChainFrameAttachment.
 

Friends

class FrameGraphCompiler
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RHI::ScopeAttachment
void SetResourceView (ConstPtr< ResourceView > resourceView)
 Assigns the resource view to this scope attachment.
 

Detailed Description

A specialization of a scope attachment for images. Provides access to the image view and image scope attachment descriptor.

Member Function Documentation

◆ GetScopeAttachmentDescriptor()

const ScopeAttachmentDescriptor & AZ::RHI::ImageScopeAttachment::GetScopeAttachmentDescriptor ( ) const
overridevirtual

Return the ScopeAttachmentDescriptor used by this attachment.

Implements AZ::RHI::ScopeAttachment.


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