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 | Static Public Member Functions | List of all members
AZ::Render::CubeMapCaptureFeatureProcessor Class Referencefinal

Inherits AZ::Render::CubeMapCaptureFeatureProcessorInterface.

Public Member Functions

 AZ_RTTI (AZ::Render::CubeMapCaptureFeatureProcessor, "{821039A3-AF40-4E69-A7EF-D44D81EAF1FA}", AZ::Render::CubeMapCaptureFeatureProcessorInterface)
 
CubeMapCaptureHandle AddCubeMapCapture (const AZ::Transform &transform) override
 
void RemoveCubeMapCapture (CubeMapCaptureHandle &cubeMapCapture) override
 
void SetTransform (const CubeMapCaptureHandle &cubeMapCapture, const AZ::Transform &transform) override
 
void SetExposure (const CubeMapCaptureHandle &cubeMapCapture, float exposure) override
 
void SetRelativePath (const CubeMapCaptureHandle &cubeMapCapture, const AZStd::string &relativePath) override
 
void RenderCubeMap (const CubeMapCaptureHandle &cubeMapCapture, RenderCubeMapCallback callback, const AZStd::string &relativePath) override
 
bool IsCubeMapReferenced (const AZStd::string &relativePath) override
 
void Activate () override
 Perform any necessary activation and gives access to owning Scene.
 
void Deactivate () override
 Perform any necessary deactivation.
 
void Simulate (const FeatureProcessor::SimulatePacket &packet) override
 
void OnRenderEnd () override
 
- Public Member Functions inherited from AZ::Render::CubeMapCaptureFeatureProcessorInterface
 AZ_RTTI (AZ::Render::CubeMapCaptureFeatureProcessorInterface, "{77C6838D-6693-4CF4-9FFC-8110C4551761}", AZ::RPI::FeatureProcessor)
 
virtual CubeMapCaptureHandle AddCubeMapCapture (const AZ::Transform &transform)=0
 
virtual void RemoveCubeMapCapture (CubeMapCaptureHandle &cubeMapCapture)=0
 
virtual void SetTransform (const CubeMapCaptureHandle &cubeMapCapture, const AZ::Transform &transform)=0
 
virtual void SetExposure (const CubeMapCaptureHandle &cubeMapCapture, float exposure)=0
 
virtual void SetRelativePath (const CubeMapCaptureHandle &cubeMapCapture, const AZStd::string &relativePath)=0
 
virtual void RenderCubeMap (const CubeMapCaptureHandle &cubeMapCapture, RenderCubeMapCallback callback, const AZStd::string &relativePath)=0
 
virtual bool IsCubeMapReferenced (const AZStd::string &relativePath)=0
 
- Public Member Functions inherited from AZ::RPI::FeatureProcessor
 AZ_RTTI (FeatureProcessor, "{B8027170-C65C-4237-964D-B557FC9D7575}")
 
 AZ_CLASS_ALLOCATOR (FeatureProcessor, AZ::SystemAllocator)
 
Scene * GetParentScene () const
 
virtual void Activate ()
 Perform any necessary activation and gives access to owning Scene.
 
virtual void Deactivate ()
 Perform any necessary deactivation.
 
virtual void ApplyRenderPipelineChange (RenderPipeline *pipeline)
 
virtual void AddRenderPasses (RenderPipeline *pipeline)
 
virtual void PrepareViews (const PrepareViewsPacket &, AZStd::vector< AZStd::pair< PipelineViewTag, ViewPtr > > &)
 
virtual void Simulate (const SimulatePacket &)
 
virtual void Render (const RenderPacket &)
 
virtual void OnEndCulling (const RenderPacket &)
 
virtual void OnRenderEnd ()
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RPI::FeatureProcessor
void EnableSceneNotification ()
 
void DisableSceneNotification ()
 

Member Function Documentation

◆ Activate()

void AZ::Render::CubeMapCaptureFeatureProcessor::Activate ( )
overridevirtual

Perform any necessary activation and gives access to owning Scene.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ AddCubeMapCapture()

CubeMapCaptureHandle AZ::Render::CubeMapCaptureFeatureProcessor::AddCubeMapCapture ( const AZ::Transform &  transform)
overridevirtual

Implements AZ::Render::CubeMapCaptureFeatureProcessorInterface.

◆ Deactivate()

void AZ::Render::CubeMapCaptureFeatureProcessor::Deactivate ( )
overridevirtual

Perform any necessary deactivation.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ IsCubeMapReferenced()

bool AZ::Render::CubeMapCaptureFeatureProcessor::IsCubeMapReferenced ( const AZStd::string &  relativePath)
overridevirtual

Implements AZ::Render::CubeMapCaptureFeatureProcessorInterface.

◆ OnRenderEnd()

void AZ::Render::CubeMapCaptureFeatureProcessor::OnRenderEnd ( )
overridevirtual

The feature processor may do clean up when the current render frame is finished

  • This is called every RPI::RenderTick.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ RemoveCubeMapCapture()

void AZ::Render::CubeMapCaptureFeatureProcessor::RemoveCubeMapCapture ( CubeMapCaptureHandle &  cubeMapCapture)
overridevirtual

Implements AZ::Render::CubeMapCaptureFeatureProcessorInterface.

◆ RenderCubeMap()

void AZ::Render::CubeMapCaptureFeatureProcessor::RenderCubeMap ( const CubeMapCaptureHandle &  cubeMapCapture,
RenderCubeMapCallback  callback,
const AZStd::string &  relativePath 
)
overridevirtual

Implements AZ::Render::CubeMapCaptureFeatureProcessorInterface.

◆ SetExposure()

void AZ::Render::CubeMapCaptureFeatureProcessor::SetExposure ( const CubeMapCaptureHandle &  cubeMapCapture,
float  exposure 
)
overridevirtual

Implements AZ::Render::CubeMapCaptureFeatureProcessorInterface.

◆ SetRelativePath()

void AZ::Render::CubeMapCaptureFeatureProcessor::SetRelativePath ( const CubeMapCaptureHandle &  cubeMapCapture,
const AZStd::string &  relativePath 
)
overridevirtual

Implements AZ::Render::CubeMapCaptureFeatureProcessorInterface.

◆ SetTransform()

void AZ::Render::CubeMapCaptureFeatureProcessor::SetTransform ( const CubeMapCaptureHandle &  cubeMapCapture,
const AZ::Transform &  transform 
)
overridevirtual

Implements AZ::Render::CubeMapCaptureFeatureProcessorInterface.

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