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::ScopeProducerFunction< UserData, PrepareFunction, CompileFunction, ExecuteFunction > Class Template Reference

#include <ScopeProducerFunction.h>

Inherits AZ::RHI::ScopeProducer.

Public Member Functions

 AZ_CLASS_ALLOCATOR (ScopeProducerFunction, SystemAllocator)
 
template<typename UserDataParam >
 ScopeProducerFunction (const ScopeId &scopeId, UserDataParam &&userData, PrepareFunction prepareFunction, CompileFunction compileFunction=CompileFunction(), ExecuteFunction executeFunction=ExecuteFunction())
 
UserData & GetUserData ()
 
const UserData & GetUserData () const
 
- 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 ScopeGetScope () const
 Returns the scope associated with this scope producer.
 

Additional Inherited Members

- 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)
 

Detailed Description

template<typename UserData, typename PrepareFunction, typename CompileFunction = EmptyCompileFunction<UserData>, typename ExecuteFunction = EmptyExecuteFunction<UserData>>
class AZ::RHI::ScopeProducerFunction< UserData, PrepareFunction, CompileFunction, ExecuteFunction >

This specialized scope producer provides a simple functional model for managing a scope. It may help reduce boilerplate in cases where a very simple scope is required and it becomes impractical to marshal data from a parent class.


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