AZ::Render::SkyAtmosphereFeatureProcessor Class Reference

#include <SkyAtmosphereFeatureProcessor.h>

Inherits AZ::Render::SkyAtmosphereFeatureProcessorInterface.

Public Member Functions
	AZ_RTTI (AZ::Render::SkyAtmosphereFeatureProcessor, "{FB3155E9-BA3C-487B-B251-EB4BF3465E02}", AZ::Render::SkyAtmosphereFeatureProcessorInterface)
void	Activate () override
	FeatureProcessor.
void	Deactivate () override
	Perform any necessary deactivation.
void	AddRenderPasses (RPI::RenderPipeline *renderPipeline) override
void	Render (const RenderPacket &packet) override
AtmosphereId	CreateAtmosphere () override
	SkyAtmosphereFeatureProcessorInterface.
void	ReleaseAtmosphere (AtmosphereId id) override
void	SetAtmosphereParams (AtmosphereId id, const SkyAtmosphereParams &params) override
void	SetAtmosphereEnabled (AtmosphereId id, bool enabled) override
bool	GetAtmosphereEnabled (AtmosphereId id) override
Public Member Functions inherited from AZ::Render::SkyAtmosphereFeatureProcessorInterface
	AZ_RTTI (AZ::Render::SkyAtmosphereFeatureProcessorInterface, "{00C9FD3D-2A1B-49EA-97E3-952EF6C1C451}")
virtual AtmosphereId	CreateAtmosphere ()=0
virtual void	ReleaseAtmosphere (AtmosphereId id)=0
virtual void	SetAtmosphereParams (AtmosphereId id, const SkyAtmosphereParams &params)=0
virtual void	SetAtmosphereEnabled (AtmosphereId id, bool enabled)=0
virtual bool	GetAtmosphereEnabled (AtmosphereId id)=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
Public Types inherited from AZ::Render::SkyAtmosphereFeatureProcessorInterface
using	AtmosphereId = RHI::Handle< uint16_t, SkyAtmosphereFeatureProcessorInterface >
Protected Member Functions inherited from AZ::RPI::FeatureProcessor
void	EnableSceneNotification ()
void	DisableSceneNotification ()

Detailed Description

This feature processor manages drawing sky atmospheres. Use CreateAtmosphere() to create a new atmosphere

Member Function Documentation

Activate()

void AZ::Render::SkyAtmosphereFeatureProcessor::Activate ( )

overridevirtual

FeatureProcessor.

Reimplemented from AZ::RPI::FeatureProcessor.

AddRenderPasses()

void AZ::Render::SkyAtmosphereFeatureProcessor::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.

CreateAtmosphere()

AtmosphereId AZ::Render::SkyAtmosphereFeatureProcessor::CreateAtmosphere ( )

overridevirtual

SkyAtmosphereFeatureProcessorInterface.

Implements AZ::Render::SkyAtmosphereFeatureProcessorInterface.

Deactivate()

void AZ::Render::SkyAtmosphereFeatureProcessor::Deactivate ( )

overridevirtual

Perform any necessary deactivation.

Reimplemented from AZ::RPI::FeatureProcessor.

GetAtmosphereEnabled()

bool AZ::Render::SkyAtmosphereFeatureProcessor::GetAtmosphereEnabled ( AtmosphereId  id )

overridevirtual

Implements AZ::Render::SkyAtmosphereFeatureProcessorInterface.

ReleaseAtmosphere()

void AZ::Render::SkyAtmosphereFeatureProcessor::ReleaseAtmosphere ( AtmosphereId  id )

overridevirtual

Implements AZ::Render::SkyAtmosphereFeatureProcessorInterface.

Render()

void AZ::Render::SkyAtmosphereFeatureProcessor::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.

SetAtmosphereEnabled()

void AZ::Render::SkyAtmosphereFeatureProcessor::SetAtmosphereEnabled ( AtmosphereId  id, bool  enabled  )

overridevirtual

Implements AZ::Render::SkyAtmosphereFeatureProcessorInterface.

SetAtmosphereParams()

void AZ::Render::SkyAtmosphereFeatureProcessor::SetAtmosphereParams ( AtmosphereId  id, const SkyAtmosphereParams &  params  )

overridevirtual

Implements AZ::Render::SkyAtmosphereFeatureProcessorInterface.

---

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

• Gems/Atom/Feature/Common/Code/Source/SkyAtmosphere/SkyAtmosphereFeatureProcessor.h