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 | Protected Member Functions | Friends | List of all members
AZ::RHI::ScopeProducer Class Referenceabstract

Inherited by AZ::RHI::ScopeProducerEmpty, AZ::RHI::ScopeProducerFunction< UserData, PrepareFunction, CompileFunction, ExecuteFunction >, AZ::RPI::ImageAttachmentCopy, AZ::RPI::ImageAttachmentPreviewPass, and AZ::RPI::RenderPass.

Public Member Functions

 ScopeProducer (const ScopeId &scopeId)
 
const ScopeId & GetScopeId () const
 
const ScopeGetScope () const
 

Protected Member Functions

 ScopeProducer ()
 
void SetHardwareQueueClass (HardwareQueueClass hardwareQueueClass)
 
void SetScopeId (const ScopeId &scopeId)
 
void InitScope (const ScopeId &scopeId, HardwareQueueClass hardwareQueueClass=HardwareQueueClass::Graphics)
 

Friends

class FrameScheduler
 

Constructor & Destructor Documentation

◆ ScopeProducer()

AZ::RHI::ScopeProducer::ScopeProducer ( )
protected

Protected default constructor for classes that inherit from ScopeProducer but that can't supply a ScopeId at construction.

Member Function Documentation

◆ GetScope()

const Scope* AZ::RHI::ScopeProducer::GetScope ( ) const

Returns the scope associated with this scope producer.

◆ GetScopeId()

const ScopeId& AZ::RHI::ScopeProducer::GetScopeId ( ) const

Returns the scope id associated with this scope producer.

◆ InitScope()

void AZ::RHI::ScopeProducer::InitScope ( const ScopeId &  scopeId,
HardwareQueueClass  hardwareQueueClass = HardwareQueueClass::Graphics 
)
protected

Initializes the scope with a ScopeId and HardwareQueueClass. Used by classes that inherit from ScopeProducer but can't supply a ScopeId at construction.

◆ SetHardwareQueueClass()

void AZ::RHI::ScopeProducer::SetHardwareQueueClass ( HardwareQueueClass  hardwareQueueClass)
protected

Sets the HardwareQueueClass on the scope

◆ SetScopeId()

void AZ::RHI::ScopeProducer::SetScopeId ( const ScopeId &  scopeId)
protected

DEPRECATED.

Deprecated:
Use InitScope instead

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