Inherits AZ::Render::CapsuleLightFeatureProcessorInterface.

Public Member Functions
	AZ_RTTI (AZ::Render::CapsuleLightFeatureProcessor, "{0FC290C5-DD28-4194-8C0B-B90C3291BAF6}", AZ::Render::CapsuleLightFeatureProcessorInterface)

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 capsule 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 capsule 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	SetAttenuationRadius (LightHandle handle, float attenuationRadius) override
	Sets the radius in meters at which the provided LightHandle will no longer have an effect.

void	SetCapsuleLineSegment (LightHandle handle, const Vector3 &startPoint, const Vector3 &endPoint) override
	Sets the start point and end point of the interior line segment of the capsule. If these points are equivalent then the capsule is a sphere.

void	SetCapsuleRadius (LightHandle handle, float radius) override
	Sets the capsule 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	SetCapsuleData (LightHandle handle, const CapsuleLightData &data) override
	Sets all of the the capsule data for the provided LightHandle.

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

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

Public Member Functions inherited from AZ::Render::CapsuleLightFeatureProcessorInterface
	AZ_RTTI (AZ::Render::CapsuleLightFeatureProcessorInterface, "{41CAF69D-6A0B-461F-BE3D-6367673646D4}", 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::CapsuleLightFeatureProcessorInterface
using	LightHandle = RHI::Handle< uint16_t, class CapsuleLight >

Static Public Attributes inherited from AZ::Render::CapsuleLightFeatureProcessorInterface
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::CapsuleLightFeatureProcessor::AcquireLight ( )

overridevirtual

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

Implements AZ::Render::CapsuleLightFeatureProcessorInterface.

◆ Activate()

void AZ::Render::CapsuleLightFeatureProcessor::Activate ( )

overridevirtual

Perform any necessary activation and gives access to owning Scene.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ CloneLight()

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

overridevirtual

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

Implements AZ::Render::CapsuleLightFeatureProcessorInterface.

◆ Deactivate()

void AZ::Render::CapsuleLightFeatureProcessor::Deactivate ( )

overridevirtual

Perform any necessary deactivation.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ GetLightBuffer()

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

overridevirtual

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

Implements AZ::Render::CapsuleLightFeatureProcessorInterface.

◆ GetLightCount()

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

overridevirtual

Returns the number of capsule lights.

Implements AZ::Render::CapsuleLightFeatureProcessorInterface.

◆ ReleaseLight()

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

overridevirtual

Releases a LightHandle which removes the capsule light.

Implements AZ::Render::CapsuleLightFeatureProcessorInterface.

◆ Render()

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

overridevirtual

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

Implements AZ::Render::CapsuleLightFeatureProcessorInterface.

◆ SetAffectsGIFactor()

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

overridevirtual

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

Implements AZ::Render::CapsuleLightFeatureProcessorInterface.

◆ SetAttenuationRadius()

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

◆ SetCapsuleData()

void AZ::Render::CapsuleLightFeatureProcessor::SetCapsuleData	(	LightHandle	handle,
		const CapsuleLightData &	data
	)

overridevirtual

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

Implements AZ::Render::CapsuleLightFeatureProcessorInterface.

◆ SetCapsuleLineSegment()

void AZ::Render::CapsuleLightFeatureProcessor::SetCapsuleLineSegment	(	LightHandle	handle,
		const Vector3 &	startPoint,
		const Vector3 &	endPoint
	)

overridevirtual

Sets the start point and end point of the interior line segment of the capsule. If these points are equivalent then the capsule is a sphere.

Implements AZ::Render::CapsuleLightFeatureProcessorInterface.

◆ SetCapsuleRadius()

void AZ::Render::CapsuleLightFeatureProcessor::SetCapsuleRadius	(	LightHandle	handle,
		float	radius
	)

overridevirtual

Sets the capsule radius for the provided LightHandle.

Implements AZ::Render::CapsuleLightFeatureProcessorInterface.

◆ SetLightingChannelMask()

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

overridevirtual

Sets the lighting channel mask.

Implements AZ::Render::CapsuleLightFeatureProcessorInterface.

◆ SetRgbIntensity()

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

overridevirtual

Sets the intensity in RGB candela for a given LightHandle.

Implements AZ::Render::CapsuleLightFeatureProcessorInterface.

◆ Simulate()

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

◆ SetCapsuleData()

◆ SetCapsuleLineSegment()

◆ SetCapsuleRadius()

◆ SetLightingChannelMask()

◆ SetRgbIntensity()

◆ Simulate()