Open 3D Engine Atom Gem API Reference  2205.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
AZ::RHI::FrameGraphCompileContext Class Reference

#include <FrameGraphCompileContext.h>

Public Member Functions

 FrameGraphCompileContext (const ScopeId &scopeId, const FrameGraphAttachmentDatabase &attachmentDatabase)
 
const ScopeId & GetScopeId () const
 Returns the scope id associated with this context.
 
bool IsAttachmentValid (const AttachmentId &attachmentId) const
 Returns whether the given attachment id is valid within the current frame.
 
const size_t GetScopeAttachmentCount (const AttachmentId &attachmentId) const
 Returns the number of scope attachments used by the current scope for the given attachment.
 
const BufferViewGetBufferView (const ScopeAttachment *scopeAttachment) const
 Returns the buffer view associated with the scope attachment.
 
const BufferViewGetBufferView (const AttachmentId &attachmentId) const
 Returns the buffer view associated with the attachmentId.
 
const BufferViewGetBufferView (const AttachmentId &attachmentId, RHI::ScopeAttachmentUsage attachmentUsage) const
 Returns the buffer view associated with attachmentId and the attachmentUsage on the current scope.
 
const BufferGetBuffer (const AttachmentId &attachmentId) const
 Returns the buffer associated with attachmentId.
 
const ImageViewGetImageView (const ScopeAttachment *scopeAttacment) const
 Returns the image view associated with the scope attachment.
 
const ImageViewGetImageView (const AttachmentId &attachmentId, const ImageViewDescriptor &imageViewDescriptor, const RHI::ScopeAttachmentUsage attachmentUsage) const
 Returns the image view associated with attachmentId, attachmentUsage and imageViewDescriptor on the current scope.
 
const ImageViewGetImageView (const AttachmentId &attachmentId) const
 Returns the image view associated with the attachmentId.
 
const ImageGetImage (const AttachmentId &attachmentId) const
 Returns the image associated with the attachmentId.
 
BufferDescriptor GetBufferDescriptor (const AttachmentId &attachmentId) const
 Returns the buffer descriptor for the given attachment id.
 
ImageDescriptor GetImageDescriptor (const AttachmentId &attachmentId) const
 Returns the image descriptor for the given attachment id.
 

Detailed Description

FrameGraphCompileContext provides access to compiled image and buffer views associated with the provided scope id, along with other query methods for accessing attachment resource data. This information can be used to compile ShaderResourceGroups.


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