Inherits AZ::Render::SimpleSpotLightFeatureProcessorInterface.

Public Member Functions
	AZ_RTTI (AZ::Render::SimpleSpotLightFeatureProcessor, "{01610AD4-0872-4F80-9F12-22FB7CCF6866}", AZ::Render::SimpleSpotLightFeatureProcessorInterface)

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 spot 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 spot light.

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

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

void	SetTransform (LightHandle handle, const AZ::Transform &transform) override
	Sets the light's transformation for a given LightHandle.

void	SetConeAngles (LightHandle handle, float innerRadians, float outerRadians) override
	Sets the inner and outer cone angles in radians.

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

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	SetShadowsEnabled (LightHandle handle, bool enabled) override
	Sets if shadows are enabled.

void	SetShadowBias (LightHandle handle, float bias) override
	Sets the shadow bias.

void	SetNormalShadowBias (LightHandle handle, float bias) override
	Sets the normal shadow bias.

void	SetShadowmapMaxResolution (LightHandle handle, ShadowmapSize shadowmapSize) override
	Sets the shadowmap size (width and height) of the light.

void	SetShadowFilterMethod (LightHandle handle, ShadowFilterMethod method) override
	Specifies filter method of shadows.

void	SetFilteringSampleCount (LightHandle handle, uint16_t count) override
	Sets sample count for filtering of shadow boundary (up to 64)

void	SetEsmExponent (LightHandle handle, float esmExponent) override
	Sets the Esm exponent to use. Higher values produce a steeper falloff in the border areas between light and shadow.

void	SetUseCachedShadows (LightHandle handle, bool useCachedShadows) override
	Sets if this shadow should be rendered every frame (not cached) or only when it detects a change (cached).

void	SetGoboTexture (LightHandle handle, AZ::Data::Instance< AZ::RPI::Image > goboTexture) override
	Set a gobo texture to the light.

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

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

void	OnRenderPipelinePersistentViewChanged (RPI::RenderPipeline *renderPipeline, RPI::PipelineViewTag viewTag, RPI::ViewPtr newView, RPI::ViewPtr previousView) override

Public Member Functions inherited from AZ::Render::SimpleSpotLightFeatureProcessorInterface
	AZ_RTTI (AZ::Render::SimpleSpotLightFeatureProcessorInterface, "{1DE04BF2-DD8F-437C-9B6D-4BDAC4BE2BAC}", 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::SimpleSpotLightFeatureProcessorInterface
using	LightHandle = RHI::Handle< uint16_t, class SimpleSpotLight >

Static Public Attributes inherited from AZ::Render::SimpleSpotLightFeatureProcessorInterface
static constexpr PhotometricUnit	PhotometricUnitType = PhotometricUnit::Candela

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

void	DisableSceneNotification ()

Member Function Documentation

◆ AcquireLight()

LightHandle AZ::Render::SimpleSpotLightFeatureProcessor::AcquireLight ( )

overridevirtual

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

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ Activate()

void AZ::Render::SimpleSpotLightFeatureProcessor::Activate ( )

overridevirtual

Perform any necessary activation and gives access to owning Scene.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ CloneLight()

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

overridevirtual

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

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ Deactivate()

void AZ::Render::SimpleSpotLightFeatureProcessor::Deactivate ( )

overridevirtual

Perform any necessary deactivation.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ GetLightBuffer()

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

overridevirtual

Returns the buffer containing the light data for all simple spot lights.

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ GetLightCount()

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

overridevirtual

Returns the number of simple spot lights.

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ ReleaseLight()

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

overridevirtual

Releases a LightHandle which removes the spot light.

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ Render()

void AZ::Render::SimpleSpotLightFeatureProcessor::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::SimpleSpotLightFeatureProcessor::SetAffectsGI	(	LightHandle	handle,
		bool	affectsGI
	)

overridevirtual

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

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ SetAffectsGIFactor()

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

overridevirtual

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

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ SetAttenuationRadius()

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

◆ SetConeAngles()

void AZ::Render::SimpleSpotLightFeatureProcessor::SetConeAngles	(	LightHandle	handle,
		float	innerRadians,
		float	outerRadians
	)

overridevirtual

Sets the inner and outer cone angles in radians.

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ SetEsmExponent()

void AZ::Render::SimpleSpotLightFeatureProcessor::SetEsmExponent	(	LightHandle	handle,
		float	exponent
	)

overridevirtual

Sets the Esm exponent to use. Higher values produce a steeper falloff in the border areas between light and shadow.

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ SetFilteringSampleCount()

void AZ::Render::SimpleSpotLightFeatureProcessor::SetFilteringSampleCount	(	LightHandle	handle,
		uint16_t	count
	)

overridevirtual

Sets sample count for filtering of shadow boundary (up to 64)

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ SetGoboTexture()

void AZ::Render::SimpleSpotLightFeatureProcessor::SetGoboTexture	(	LightHandle	handle,
		AZ::Data::Instance< AZ::RPI::Image >	goboTexture
	)

overridevirtual

Set a gobo texture to the light.

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ SetLightingChannelMask()

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

overridevirtual

Sets the lighting channel mask.

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ SetNormalShadowBias()

void AZ::Render::SimpleSpotLightFeatureProcessor::SetNormalShadowBias	(	LightHandle	handle,
		float	bias
	)

overridevirtual

Sets the normal shadow bias.

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ SetRgbIntensity()

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

overridevirtual

Sets the intensity in RGB candela for a given LightHandle.

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ SetShadowBias()

void AZ::Render::SimpleSpotLightFeatureProcessor::SetShadowBias	(	LightHandle	handle,
		float	bias
	)

overridevirtual

Sets the shadow bias.

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ SetShadowFilterMethod()

void AZ::Render::SimpleSpotLightFeatureProcessor::SetShadowFilterMethod	(	LightHandle	handle,
		ShadowFilterMethod	method
	)

overridevirtual

Specifies filter method of shadows.

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ SetShadowmapMaxResolution()

void AZ::Render::SimpleSpotLightFeatureProcessor::SetShadowmapMaxResolution	(	LightHandle	handle,
		ShadowmapSize	shadowmapSize
	)

overridevirtual

Sets the shadowmap size (width and height) of the light.

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ SetShadowsEnabled()

void AZ::Render::SimpleSpotLightFeatureProcessor::SetShadowsEnabled	(	LightHandle	handle,
		bool	enabled
	)

overridevirtual

Sets if shadows are enabled.

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ SetTransform()

void AZ::Render::SimpleSpotLightFeatureProcessor::SetTransform	(	LightHandle	handle,
		const AZ::Transform &	transform
	)

overridevirtual

Sets the light's transformation for a given LightHandle.

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ SetUseCachedShadows()

void AZ::Render::SimpleSpotLightFeatureProcessor::SetUseCachedShadows	(	LightHandle	handle,
		bool	useCachedShadows
	)

overridevirtual

Sets if this shadow should be rendered every frame (not cached) or only when it detects a change (cached).

Implements AZ::Render::SimpleSpotLightFeatureProcessorInterface.

◆ Simulate()

void AZ::Render::SimpleSpotLightFeatureProcessor::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/SimpleSpotLightFeatureProcessor.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()

◆ SetConeAngles()

◆ SetEsmExponent()

◆ SetFilteringSampleCount()

◆ SetGoboTexture()

◆ SetLightingChannelMask()

◆ SetNormalShadowBias()

◆ SetRgbIntensity()

◆ SetShadowBias()

◆ SetShadowFilterMethod()

◆ SetShadowmapMaxResolution()

◆ SetShadowsEnabled()

◆ SetTransform()

◆ SetUseCachedShadows()

◆ Simulate()