Open 3D Engine Atom Gem API Reference 23.10.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, const ImageScopeAttachmentDescriptor &descriptor)
const ImageScopeAttachmentDescriptorGetDescriptor () const
const ImageFrameAttachmentGetFrameAttachment () const
 Returns the parent graph attachment referenced by this scope attachment.
ImageFrameAttachmentGetFrameAttachment ()
const ImageScopeAttachmentGetPrevious () const
 Returns the previous scope attachment in the linked list.
ImageScopeAttachmentGetPrevious ()
const ImageScopeAttachmentGetNext () const
 Returns the next scope attachment in the linked list.
ImageScopeAttachmentGetNext ()
const ImageViewGetImageView () const
 Returns the image view set on the scope attachment.
void SetImageView (ConstPtr< ImageView > imageView)
 Assigns an image view to the scope attachment.
bool IsBeingResolved () const
- 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)
bool HasUsage (const ScopeAttachmentUsage usage) const
 Returns true if usage is compatible with how this scopeattachment will be used.
bool HasAccessAndUsage (const ScopeAttachmentUsage usage, const ScopeAttachmentAccess access) const
 Returns true if access is compatible with how this scopeattachment will be accessed.
const AZStd::vector< ScopeAttachmentUsageAndAccess > & GetUsageAndAccess () const
 Returns a vector containing all usage/access data used by this scopeattachment.
const ResourceViewGetResourceView () const
 Returns the resource view.
const ScopeGetScope () const
 Returns the parent scope that this attachment is bound to.
ScopeGetScope ()
const FrameAttachmentGetFrameAttachment () const
 Returns the parent frame graph attachment.
FrameAttachmentGetFrameAttachment ()
const ScopeAttachmentGetPrevious () const
 Returns the previous binding in the linked list.
ScopeAttachmentGetPrevious ()
const ScopeAttachmentGetNext () const
 Returns the next binding in the linked list.
ScopeAttachmentGetNext ()
const char * GetTypeName (const RHI::ScopeAttachmentUsageAndAccess &usageAndAccess) const
 Returns the friendly usage and access type names of this scope attachment (used for logging).
AZStd::string GetUsageTypes () const
AZStd::string GetAccessTypes () const
void AddUsageAndAccess (ScopeAttachmentUsage usage, ScopeAttachmentAccess access)
 Add how the attachment is used by the scope and how it is accessed by the scope.
bool IsSwapChainAttachment () const
 Returns true if this is a SwapChainFrameAttachment.

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.

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