Open 3D Engine Atom Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::Render::CapsuleLightFeatureProcessorInterface Class Referenceabstract

#include <CapsuleLightFeatureProcessorInterface.h>

Inherits AZ::RPI::FeatureProcessor.

Inherited by AZ::Render::CapsuleLightFeatureProcessor.

Public Types

using LightHandle = RHI::Handle< uint16_t, class CapsuleLight >
 

Public Member Functions

 AZ_RTTI (AZ::Render::CapsuleLightFeatureProcessorInterface, "{41CAF69D-6A0B-461F-BE3D-6367673646D4}", AZ::RPI::FeatureProcessor)
 
virtual LightHandle AcquireLight ()=0
 Creates a new capsule 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 capsule 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 SetCapsuleLineSegment (LightHandle handle, const Vector3 &startPoint, const Vector3 &endPoint)=0
 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.
 
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 SetCapsuleRadius (LightHandle handle, float radius)=0
 Sets the capsule radius for the provided LightHandle.
 
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 SetCapsuleData (LightHandle handle, const CapsuleLightData &data)=0
 Sets all of the the capsule data for the provided LightHandle.
 
- Public Member Functions inherited from AZ::RPI::FeatureProcessor
 AZ_RTTI (FeatureProcessor, "{B8027170-C65C-4237-964D-B557FC9D7575}")
 
 AZ_CLASS_ALLOCATOR (FeatureProcessor, AZ::SystemAllocator)
 
SceneGetParentScene () 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

CapsuleLightFeatureProcessorInterface provides an interface to acquire, release, and update a capsule light. This is necessary for code outside of the Atom features gem to communicate with the CapsuleLightFeatureProcessor.

Member Function Documentation

◆ AcquireLight()

virtual LightHandle AZ::Render::CapsuleLightFeatureProcessorInterface::AcquireLight ( )
pure virtual

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

Implemented in AZ::Render::CapsuleLightFeatureProcessor.

◆ CloneLight()

virtual LightHandle AZ::Render::CapsuleLightFeatureProcessorInterface::CloneLight ( LightHandle  handle)
pure virtual

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

Implemented in AZ::Render::CapsuleLightFeatureProcessor.

◆ ReleaseLight()

virtual bool AZ::Render::CapsuleLightFeatureProcessorInterface::ReleaseLight ( LightHandle handle)
pure virtual

Releases a LightHandle which removes the capsule light.

Implemented in AZ::Render::CapsuleLightFeatureProcessor.

◆ SetAffectsGI()

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

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

Implemented in AZ::Render::CapsuleLightFeatureProcessor.

◆ SetAffectsGIFactor()

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

◆ SetAttenuationRadius()

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

◆ SetCapsuleData()

virtual void AZ::Render::CapsuleLightFeatureProcessorInterface::SetCapsuleData ( LightHandle  handle,
const CapsuleLightData data 
)
pure virtual

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

Implemented in AZ::Render::CapsuleLightFeatureProcessor.

◆ SetCapsuleLineSegment()

virtual void AZ::Render::CapsuleLightFeatureProcessorInterface::SetCapsuleLineSegment ( LightHandle  handle,
const Vector3 &  startPoint,
const Vector3 &  endPoint 
)
pure virtual

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.

Implemented in AZ::Render::CapsuleLightFeatureProcessor.

◆ SetCapsuleRadius()

virtual void AZ::Render::CapsuleLightFeatureProcessorInterface::SetCapsuleRadius ( LightHandle  handle,
float  radius 
)
pure virtual

Sets the capsule radius for the provided LightHandle.

Implemented in AZ::Render::CapsuleLightFeatureProcessor.

◆ SetRgbIntensity()

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

Sets the intensity in RGB candela for a given LightHandle.

Implemented in AZ::Render::CapsuleLightFeatureProcessor.


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