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

Inherits AZ::Render::DiskLightFeatureProcessorInterface.

Public Member Functions

 AZ_RTTI (AZ::Render::DiskLightFeatureProcessor,"{F69C0188-2C1C-47A5-8187-17433C34AC2B}", AZ::Render::DiskLightFeatureProcessorInterface)
 
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 disk 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 disk 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 SetPosition (LightHandle handle, const AZ::Vector3 &lightPosition) override
 Sets the position for a given LightHandle.
 
void SetDirection (LightHandle handle, const AZ::Vector3 &lightDirection) override
 Sets the direction 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 SetDiskRadius (LightHandle handle, float radius) override
 Sets the disk radius for the provided LightHandle.
 
void SetConstrainToConeLight (LightHandle handle, bool useCone) override
 Sets whether the disk should constrain its light to a cone. (use SetInnerConeAngle and SetOuterConeAngle to set cone angle parameters)
 
void SetConeAngles (LightHandle handle, float innerDegrees, float outerDegrees) override
 Sets the inner and outer cone angles in radians.
 
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 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 SetDiskData (LightHandle handle, const DiskLightData &data) override
 Sets all of the the disk data for the provided LightHandle.
 
const DiskLightDataGetDiskData (LightHandle handle) const override
 Get a read only copy of a disk lights data, useful for debug rendering.
 
const Data::Instance< RPI::BufferGetLightBuffer () const
 
uint32_t GetLightCount () const
 
- Public Member Functions inherited from AZ::Render::DiskLightFeatureProcessorInterface
 AZ_RTTI (AZ::Render::DiskLightFeatureProcessorInterface,"{A78A8FBD-1494-4EF9-9C05-AF153FDB1F17}", 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)
 
SceneGetParentScene () const
 
virtual void ApplyRenderPipelineChange ([[maybe_unused]] RenderPipeline *pipeline)
 
virtual void AddRenderPasses ([[maybe_unused]] RenderPipeline *pipeline)
 
virtual void PrepareViews (const PrepareViewsPacket &, AZStd::vector< AZStd::pair< PipelineViewTag, ViewPtr >> &)
 
virtual void OnRenderEnd ()
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Additional Inherited Members

- Public Types inherited from AZ::Render::DiskLightFeatureProcessorInterface
using LightHandle = RHI::Handle< uint16_t, class DiskLight >
 
- Static Public Attributes inherited from AZ::Render::DiskLightFeatureProcessorInterface
static constexpr PhotometricUnit PhotometricUnitType = PhotometricUnit::Candela
 
- Protected Member Functions inherited from AZ::RPI::FeatureProcessor
void EnableSceneNotification ()
 
void DisableSceneNotification ()
 

Member Function Documentation

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

Reimplemented from AZ::RPI::FeatureProcessor.

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