Open 3D Engine Atom Gem API Reference 25.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::Render::RayTracingDebugFeatureProcessor Class Reference

#include <RayTracingDebugFeatureProcessor.h>

Inherits AZ::Render::RayTracingDebugFeatureProcessorInterface.

Public Member Functions

 AZ_RTTI (RayTracingDebugFeatureProcessor, "{283382D4-536D-4770-931D-84F033E18636}", RayTracingDebugFeatureProcessorInterface)
 
RayTracingDebugSettingsInterfaceGetSettingsInterface () override
 Retrieves existing settings. If none found, returns nullptr.
 
void OnRayTracingDebugComponentAdded () override
 Called when a ray tracing debug level component is added.
 
void OnRayTracingDebugComponentRemoved () override
 Called when a ray tracing debug level component is removed.
 
void Activate () override
 Perform any necessary activation and gives access to owning Scene.
 
void Deactivate () override
 Perform any necessary deactivation.
 
void AddRenderPasses (RPI::RenderPipeline *pipeline) override
 
void Render (const RenderPacket &packet) override
 
- Public Member Functions inherited from AZ::Render::RayTracingDebugFeatureProcessorInterface
 AZ_RTTI (RayTracingDebugFeatureProcessorInterface, "{873F5D8A-5A0D-41F3-BADF-57394F8542D8}", RPI::FeatureProcessor)
 
- Public Member Functions inherited from AZ::RPI::FeatureProcessor
 AZ_RTTI (FeatureProcessor, "{B8027170-C65C-4237-964D-B557FC9D7575}")
 
 AZ_CLASS_ALLOCATOR (FeatureProcessor, AZ::SystemAllocator)
 
SceneGetParentScene () const
 
virtual void ApplyRenderPipelineChange (RenderPipeline *pipeline)
 
virtual void PrepareViews (const PrepareViewsPacket &, AZStd::vector< AZStd::pair< PipelineViewTag, ViewPtr > > &)
 
virtual void Simulate (const SimulatePacket &)
 
virtual void OnEndCulling (const RenderPacket &)
 
virtual void OnRenderEnd ()
 

Static Public Member Functions

static void Reflect (ReflectContext *context)
 

Additional Inherited Members

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

Detailed Description

FeatureProcessor for handling debug ray tracing information, such as adding/removing the ray tracing debug pass to the render pipeline and uploading the debug configuration data to the GPU

Member Function Documentation

◆ Activate()

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

Perform any necessary activation and gives access to owning Scene.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ AddRenderPasses()

void AZ::Render::RayTracingDebugFeatureProcessor::AddRenderPasses ( RPI::RenderPipeline pipeline)
overridevirtual

Add additional render passes to the render pipeline before it's finalized The render pipeline must have m_allowModification set to true (see Scene::TryApplyRenderPipelineChanges() function) This function is called when the render pipeline is added or rebuilt

Reimplemented from AZ::RPI::FeatureProcessor.

◆ Deactivate()

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

Perform any necessary deactivation.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ GetSettingsInterface()

RayTracingDebugSettingsInterface * AZ::Render::RayTracingDebugFeatureProcessor::GetSettingsInterface ( )
overridevirtual

Retrieves existing settings. If none found, returns nullptr.

Implements AZ::Render::RayTracingDebugFeatureProcessorInterface.

◆ OnRayTracingDebugComponentAdded()

void AZ::Render::RayTracingDebugFeatureProcessor::OnRayTracingDebugComponentAdded ( )
overridevirtual

Called when a ray tracing debug level component is added.

Implements AZ::Render::RayTracingDebugFeatureProcessorInterface.

◆ OnRayTracingDebugComponentRemoved()

void AZ::Render::RayTracingDebugFeatureProcessor::OnRayTracingDebugComponentRemoved ( )
overridevirtual

Called when a ray tracing debug level component is removed.

Implements AZ::Render::RayTracingDebugFeatureProcessorInterface.

◆ Render()

void AZ::Render::RayTracingDebugFeatureProcessor::Render ( const RenderPacket )
overridevirtual

The feature processor should enqueue draw packets to relevant draw lists.

  • This is called every frame.
  • This may be called in parallel with other feature processors.
  • This may be called in parallel with culling

Reimplemented from AZ::RPI::FeatureProcessor.


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