SimplePointLightFeatureProcessorInterface provides an interface to acquire, release, and update a point light. More...

#include <SimplePointLightFeatureProcessorInterface.h>

Inherited by AZ::Render::SimplePointLightFeatureProcessor.

Public Types
using	LightHandle = RHI::Handle< uint16_t, class PointLight >

Public Member Functions
	AZ_RTTI (AZ::Render::SimplePointLightFeatureProcessorInterface, "{B6FABD69-ED5B-4D6C-8695-27CB95D13CE4}", AZ::RPI::FeatureProcessor)

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

virtual bool	ReleaseLight (LightHandle &handle)=0
	Releases a LightHandle which removes the point light.

virtual LightHandle	CloneLight (LightHandle handle)=0
	Creates a new LightHandle by copying data from an existing LightHandle.

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

virtual void	SetPosition (LightHandle handle, const AZ::Vector3 &lightPosition)=0
	Sets the position for a given LightHandle.

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

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

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

virtual void	SetLightingChannelMask (LightHandle handle, uint32_t lightingChannelMask)=0
	Sets the lighting channel mask.

virtual const Data::Instance< RPI::Buffer >	GetLightBuffer () const =0
	Returns the buffer containing the light data for all simple point lights.

virtual uint32_t	GetLightCount () const =0
	Returns the number of simple point lights.

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 Attributes
static constexpr PhotometricUnit	PhotometricUnitType = PhotometricUnit::Candela

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

void	DisableSceneNotification ()

Detailed Description

SimplePointLightFeatureProcessorInterface provides an interface to acquire, release, and update a point light.

Member Function Documentation

◆ AcquireLight()

virtual LightHandle AZ::Render::SimplePointLightFeatureProcessorInterface::AcquireLight ( )

pure virtual

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

Implemented in AZ::Render::SimplePointLightFeatureProcessor.

◆ CloneLight()

virtual LightHandle AZ::Render::SimplePointLightFeatureProcessorInterface::CloneLight ( LightHandle handle )

pure virtual

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

Implemented in AZ::Render::SimplePointLightFeatureProcessor.

◆ GetLightBuffer()

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

pure virtual

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

Implemented in AZ::Render::SimplePointLightFeatureProcessor.

◆ GetLightCount()

virtual uint32_t AZ::Render::SimplePointLightFeatureProcessorInterface::GetLightCount ( ) const

pure virtual

Returns the number of simple point lights.

Implemented in AZ::Render::SimplePointLightFeatureProcessor.

◆ ReleaseLight()

virtual bool AZ::Render::SimplePointLightFeatureProcessorInterface::ReleaseLight ( LightHandle & handle )

pure virtual

Releases a LightHandle which removes the point light.

Implemented in AZ::Render::SimplePointLightFeatureProcessor.

◆ SetAffectsGI()

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

pure virtual

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

Implemented in AZ::Render::SimplePointLightFeatureProcessor.

◆ SetAffectsGIFactor()

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

pure virtual

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

Implemented in AZ::Render::SimplePointLightFeatureProcessor.

◆ SetAttenuationRadius()

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

pure virtual

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

Implemented in AZ::Render::SimplePointLightFeatureProcessor.

◆ SetLightingChannelMask()

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

pure virtual

Sets the lighting channel mask.

Implemented in AZ::Render::SimplePointLightFeatureProcessor.

◆ SetPosition()

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

pure virtual

Sets the position for a given LightHandle.

Implemented in AZ::Render::SimplePointLightFeatureProcessor.

◆ SetRgbIntensity()

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

pure virtual

Sets the intensity in RGB candela for a given LightHandle.

Implemented in AZ::Render::SimplePointLightFeatureProcessor.

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

Gems/Atom/Feature/Common/Code/Include/Atom/Feature/CoreLights/SimplePointLightFeatureProcessorInterface.h

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AcquireLight()

◆ CloneLight()

◆ GetLightBuffer()

◆ GetLightCount()

◆ ReleaseLight()

◆ SetAffectsGI()

◆ SetAffectsGIFactor()

◆ SetAttenuationRadius()

◆ SetLightingChannelMask()

◆ SetPosition()

◆ SetRgbIntensity()