Inherits AZ::Render::QuadLightFeatureProcessorInterface.

Public Member Functions
	AZ_RTTI (AZ::Render::QuadLightFeatureProcessor, "{F1E50245-5F05-475E-857F-221FB17C7E45}", AZ::Render::QuadLightFeatureProcessorInterface)

void	Activate () override
	Perform any necessary activation and gives access to owning Scene.

void	Deactivate () override
	Perform any necessary deactivation.

void	Simulate (const SimulatePacket &packet) override

void	Render (const RenderPacket &packet) override

LightHandle	AcquireLight () override
	Creates a new quad light which can be referenced by the returned LightHandle. Must be released via ReleaseLight() when no longer needed.

bool	ReleaseLight (LightHandle &handle) override
	Releases a LightHandle which removes the quad light.

LightHandle	CloneLight (LightHandle handle) override
	Creates a new LightHandle by copying data from an existing LightHandle.

void	SetRgbIntensity (LightHandle handle, const PhotometricColor< PhotometricUnitType > &color) override
	Sets the intensity in RGB candela for a given LightHandle.

void	SetPosition (LightHandle handle, const AZ::Vector3 &position) override
	Sets the position for a given LightHandle.

void	SetOrientation (LightHandle handle, const AZ::Quaternion &orientation) override
	Sets the direction for a given LightHandle.

void	SetLightEmitsBothDirections (LightHandle handle, bool lightEmitsBothDirections) override
	Sets if the quad light emits light in both directions for a given LightHandle.

void	SetUseFastApproximation (LightHandle handle, bool useFastApproximation) override
	Sets whether to use a fast approximation instead of the default high quality linearly transformed cosine lighting.

void	SetAttenuationRadius (LightHandle handle, float attenuationRadius) override
	Sets the radius in meters at which the provided LightHandle will no longer have an effect.

void	SetQuadDimensions (LightHandle handle, float width, float height) override
	Sets the quad radius for the provided LightHandle.

void	SetAffectsGI (LightHandle handle, bool affectsGI) override
	Specifies if this light affects the diffuse global illumination in the scene.

void	SetAffectsGIFactor (LightHandle handle, float affectsGIFactor) override
	Specifies the contribution of this light to the diffuse global illumination in the scene.

void	SetLightingChannelMask (LightHandle handle, uint32_t lightingChannelMask) override
	Sets the lighting channel mask.

void	SetQuadData (LightHandle handle, const QuadLightData &data) override
	Sets all of the the quad data for the provided LightHandle.

const Data::Instance< RPI::Buffer >	GetLightBuffer () const override
	Returns the buffer containing the light data for all quad lights.

uint32_t	GetLightCount () const override
	Returns the number of quad lights.

Public Member Functions inherited from AZ::Render::QuadLightFeatureProcessorInterface
	AZ_RTTI (AZ::Render::QuadLightFeatureProcessorInterface, "{D86216E4-92A8-43BE-A5E4-883489C6AF06}", AZ::RPI::FeatureProcessor)

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	ApplyRenderPipelineChange (RenderPipeline *pipeline)

virtual void	AddRenderPasses (RenderPipeline *pipeline)

virtual void	PrepareViews (const PrepareViewsPacket &, AZStd::vector< AZStd::pair< PipelineViewTag, ViewPtr > > &)

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::QuadLightFeatureProcessorInterface
using	LightHandle = RHI::Handle< uint16_t, class QuadLight >

Static Public Attributes inherited from AZ::Render::QuadLightFeatureProcessorInterface
static constexpr PhotometricUnit	PhotometricUnitType = PhotometricUnit::Nit

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

void	DisableSceneNotification ()

Member Function Documentation

◆ AcquireLight()

LightHandle AZ::Render::QuadLightFeatureProcessor::AcquireLight ( )

overridevirtual

Creates a new quad light which can be referenced by the returned LightHandle. Must be released via ReleaseLight() when no longer needed.

Implements AZ::Render::QuadLightFeatureProcessorInterface.

◆ Activate()

void AZ::Render::QuadLightFeatureProcessor::Activate ( )

overridevirtual

Perform any necessary activation and gives access to owning Scene.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ CloneLight()

LightHandle AZ::Render::QuadLightFeatureProcessor::CloneLight ( LightHandle handle )

overridevirtual

Creates a new LightHandle by copying data from an existing LightHandle.

Implements AZ::Render::QuadLightFeatureProcessorInterface.

◆ Deactivate()

void AZ::Render::QuadLightFeatureProcessor::Deactivate ( )

overridevirtual

Perform any necessary deactivation.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ GetLightBuffer()

const Data::Instance< RPI::Buffer > AZ::Render::QuadLightFeatureProcessor::GetLightBuffer ( ) const

overridevirtual

Returns the buffer containing the light data for all quad lights.

Implements AZ::Render::QuadLightFeatureProcessorInterface.

◆ GetLightCount()

uint32_t AZ::Render::QuadLightFeatureProcessor::GetLightCount ( ) const

overridevirtual

Returns the number of quad lights.

Implements AZ::Render::QuadLightFeatureProcessorInterface.

◆ ReleaseLight()

bool AZ::Render::QuadLightFeatureProcessor::ReleaseLight ( LightHandle & handle )

overridevirtual

Releases a LightHandle which removes the quad light.

Implements AZ::Render::QuadLightFeatureProcessorInterface.

◆ Render()

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

◆ SetAffectsGI()

void AZ::Render::QuadLightFeatureProcessor::SetAffectsGI	(	LightHandle	handle,
		bool	affectsGI
	)

overridevirtual

Specifies if this light affects the diffuse global illumination in the scene.

Implements AZ::Render::QuadLightFeatureProcessorInterface.

◆ SetAffectsGIFactor()

void AZ::Render::QuadLightFeatureProcessor::SetAffectsGIFactor	(	LightHandle	handle,
		float	affectsGIFactor
	)

overridevirtual

Specifies the contribution of this light to the diffuse global illumination in the scene.

Implements AZ::Render::QuadLightFeatureProcessorInterface.

◆ SetAttenuationRadius()

void AZ::Render::QuadLightFeatureProcessor::SetAttenuationRadius	(	LightHandle	handle,
		float	attenuationRadius
	)

overridevirtual

Sets the radius in meters at which the provided LightHandle will no longer have an effect.

Implements AZ::Render::QuadLightFeatureProcessorInterface.

◆ SetLightEmitsBothDirections()

void AZ::Render::QuadLightFeatureProcessor::SetLightEmitsBothDirections	(	LightHandle	handle,
		bool	lightEmitsBothDirections
	)

overridevirtual

Sets if the quad light emits light in both directions for a given LightHandle.

Implements AZ::Render::QuadLightFeatureProcessorInterface.

◆ SetLightingChannelMask()

void AZ::Render::QuadLightFeatureProcessor::SetLightingChannelMask	(	LightHandle	handle,
		uint32_t	lightingChannelMask
	)

overridevirtual

Sets the lighting channel mask.

Implements AZ::Render::QuadLightFeatureProcessorInterface.

◆ SetOrientation()

void AZ::Render::QuadLightFeatureProcessor::SetOrientation	(	LightHandle	handle,
		const AZ::Quaternion &	lightOrientation
	)

overridevirtual

Sets the direction for a given LightHandle.

Implements AZ::Render::QuadLightFeatureProcessorInterface.

◆ SetPosition()

void AZ::Render::QuadLightFeatureProcessor::SetPosition	(	LightHandle	handle,
		const AZ::Vector3 &	lightPosition
	)

overridevirtual

Sets the position for a given LightHandle.

Implements AZ::Render::QuadLightFeatureProcessorInterface.

◆ SetQuadData()

void AZ::Render::QuadLightFeatureProcessor::SetQuadData	(	LightHandle	handle,
		const QuadLightData &	data
	)

overridevirtual

Sets all of the the quad data for the provided LightHandle.

Implements AZ::Render::QuadLightFeatureProcessorInterface.

◆ SetQuadDimensions()

void AZ::Render::QuadLightFeatureProcessor::SetQuadDimensions	(	LightHandle	handle,
		float	width,
		float	height
	)

overridevirtual

Sets the quad radius for the provided LightHandle.

Implements AZ::Render::QuadLightFeatureProcessorInterface.

◆ SetRgbIntensity()

void AZ::Render::QuadLightFeatureProcessor::SetRgbIntensity	(	LightHandle	handle,
		const PhotometricColor< PhotometricUnitType > &	lightColor
	)

overridevirtual

Sets the intensity in RGB candela for a given LightHandle.

Implements AZ::Render::QuadLightFeatureProcessorInterface.

◆ SetUseFastApproximation()

void AZ::Render::QuadLightFeatureProcessor::SetUseFastApproximation	(	LightHandle	handle,
		bool	useFastApproximation
	)

overridevirtual

Sets whether to use a fast approximation instead of the default high quality linearly transformed cosine lighting.

Implements AZ::Render::QuadLightFeatureProcessorInterface.

◆ Simulate()

void AZ::Render::QuadLightFeatureProcessor::Simulate ( const SimulatePacket & )

overridevirtual

The feature processor should perform any internal simulation at this point - For instance, updating a particle system or animation. Not every feature processor will need to implement this.

This may not be called every frame.
This may be called in parallel with other feature processors.

Reimplemented from AZ::RPI::FeatureProcessor.

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

Gems/Atom/Feature/Common/Code/Source/CoreLights/QuadLightFeatureProcessor.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ AcquireLight()

◆ Activate()

◆ CloneLight()

◆ Deactivate()

◆ GetLightBuffer()

◆ GetLightCount()

◆ ReleaseLight()

◆ Render()

◆ SetAffectsGI()

◆ SetAffectsGIFactor()

◆ SetAttenuationRadius()

◆ SetLightEmitsBothDirections()

◆ SetLightingChannelMask()

◆ SetOrientation()

◆ SetPosition()

◆ SetQuadData()

◆ SetQuadDimensions()

◆ SetRgbIntensity()

◆ SetUseFastApproximation()

◆ Simulate()