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.
Public Member Functions | Protected Member Functions | Friends | List of all members
AZ::RPI::ImageAttachmentCopy Class Referencefinal

A scope producer to copy the input attachment and output a copy of this attachment. More...

#include <ImageAttachmentPreviewPass.h>

Inherits AZ::RHI::ScopeProducer.

Public Member Functions

 AZ_RTTI (ImageAttachmentCopy, "{27E35230-48D1-4950-8489-F301A45D4A0B}", RHI::ScopeProducer)
 
 AZ_CLASS_ALLOCATOR (ImageAttachmentCopy, SystemAllocator)
 
void SetImageAttachment (RHI::AttachmentId srcAttachmentId, RHI::AttachmentId destAttachmentId)
 
void FrameBegin (Pass::FramePrepareParams params)
 
void Reset ()
 
void InvalidateDestImage ()
 
- Public Member Functions inherited from AZ::RHI::ScopeProducer
 ScopeProducer (const ScopeId &scopeId)
 
const ScopeId & GetScopeId () const
 Returns the scope id associated with this scope producer.
 
const Scope * GetScope () const
 Returns the scope associated with this scope producer.
 

Protected Member Functions

void SetupFrameGraphDependencies (RHI::FrameGraphInterface frameGraph) override
 
void CompileResources (const RHI::FrameGraphCompileContext &context) override
 
void BuildCommandList (const RHI::FrameGraphExecuteContext &context) override
 
- Protected Member Functions inherited from AZ::RHI::ScopeProducer
 ScopeProducer ()
 
void SetHardwareQueueClass (HardwareQueueClass hardwareQueueClass)
 Sets the HardwareQueueClass on the scope.
 
void SetScopeId (const ScopeId &scopeId)
 
void InitScope (const ScopeId &scopeId, HardwareQueueClass hardwareQueueClass=HardwareQueueClass::Graphics)
 

Friends

class ImageAttachmentPreviewPass
 

Detailed Description

A scope producer to copy the input attachment and output a copy of this attachment.

Member Function Documentation

◆ BuildCommandList()

void AZ::RPI::ImageAttachmentCopy::BuildCommandList ( const RHI::FrameGraphExecuteContext &  context)
overrideprotectedvirtual

This function is called at command list recording time and may be called multiple times if the schedule decides to split work items across command lists. In this case, each invocation will provide a command list and invocation index.

Reimplemented from AZ::RHI::ScopeProducer.

◆ CompileResources()

void AZ::RPI::ImageAttachmentCopy::CompileResources ( const RHI::FrameGraphCompileContext &  context)
overrideprotectedvirtual

This function is called after compilation of the frame graph, but before execution. The provided FrameGraphAttachmentContext allows you to access RHI views associated with attachment ids. This is the method to build ShaderResourceGroups from transient attachment views.

Reimplemented from AZ::RHI::ScopeProducer.

◆ SetupFrameGraphDependencies()

void AZ::RPI::ImageAttachmentCopy::SetupFrameGraphDependencies ( RHI::FrameGraphInterface  frameGraph)
overrideprotectedvirtual

This function is called during the schedule setup phase. The client is expected to declare attachments using the provided

Parameters
frameGraph.

Implements AZ::RHI::ScopeProducer.

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