Open 3D Engine Atom Gem API Reference 25.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::BufferScopeAttachment Class Referencefinal

#include <BufferScopeAttachment.h>

Inherits AZ::RHI::ScopeAttachment.

Public Member Functions

 AZ_RTTI (BufferScopeAttachment, "{48A21F94-985B-40EE-A75A-8E960E935321}", ScopeAttachment)
 
 AZ_CLASS_ALLOCATOR (BufferScopeAttachment, SystemAllocator)
 
 BufferScopeAttachment (Scope &scope, FrameAttachment &attachment, ScopeAttachmentUsage usage, ScopeAttachmentAccess access, ScopeAttachmentStage stage, const BufferScopeAttachmentDescriptor &descriptor)
 
const BufferScopeAttachmentDescriptorGetDescriptor () const
 
const BufferFrameAttachmentGetFrameAttachment () const
 Returns the parent graph attachment referenced by this scope attachment.
 
BufferFrameAttachmentGetFrameAttachment ()
 
const BufferScopeAttachmentGetPrevious () const
 Returns the previous scope attachment in the linked list.
 
BufferScopeAttachmentGetPrevious ()
 
const BufferScopeAttachmentGetNext () const
 Returns the next scope attachment in the linked list.
 
BufferScopeAttachmentGetNext ()
 
const AZ::RHI::BufferViewGetBufferView () const
 Returns the buffer view set on the scope attachment.
 
void SetBufferView (ConstPtr< BufferView > bufferView)
 Assigns a buffer view to the scope attachment.
 
const ScopeAttachmentDescriptorGetScopeAttachmentDescriptor () 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 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
 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 buffers. Provides access to the buffer view and buffer scope attachment descriptor.

Member Function Documentation

◆ GetScopeAttachmentDescriptor()

const ScopeAttachmentDescriptor & AZ::RHI::BufferScopeAttachment::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: