SimpleSpotLightFeatureProcessorInterface provides an interface to acquire, release, and update a simple spot light. More...
#include <SimpleSpotLightFeatureProcessorInterface.h>
Inherits AZ::RPI::FeatureProcessor.
Inherited by AZ::Render::SimpleSpotLightFeatureProcessor.
Public Types | |
using | LightHandle = RHI::Handle< uint16_t, class SimpleSpotLight > |
Public Member Functions | |
AZ_RTTI (AZ::Render::SimpleSpotLightFeatureProcessorInterface, "{1DE04BF2-DD8F-437C-9B6D-4BDAC4BE2BAC}", AZ::RPI::FeatureProcessor) | |
virtual LightHandle | AcquireLight ()=0 |
Creates a new spot 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 spot 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 | SetDirection (LightHandle handle, const AZ::Vector3 &lightDirection)=0 |
Sets the direction 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 | SetConeAngles (LightHandle handle, float innerRadians, float outerRadians)=0 |
Sets the inner and outer cone angles in radians. | |
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. | |
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 () |
SimpleSpotLightFeatureProcessorInterface provides an interface to acquire, release, and update a simple spot light.
|
pure virtual |
Creates a new spot light which can be referenced by the returned LightHandle. Must be released via ReleaseLight() when no longer needed.
Implemented in AZ::Render::SimpleSpotLightFeatureProcessor.
|
pure virtual |
Creates a new LightHandle by copying data from an existing LightHandle.
Implemented in AZ::Render::SimpleSpotLightFeatureProcessor.
|
pure virtual |
Releases a LightHandle which removes the spot light.
Implemented in AZ::Render::SimpleSpotLightFeatureProcessor.
|
pure virtual |
Specifies if this light affects the diffuse global illumination in the scene.
Implemented in AZ::Render::SimpleSpotLightFeatureProcessor.
|
pure virtual |
Specifies the contribution of this light to the diffuse global illumination in the scene.
Implemented in AZ::Render::SimpleSpotLightFeatureProcessor.
|
pure virtual |
Sets the radius in meters at which the provided LightHandle will no longer have an effect.
Implemented in AZ::Render::SimpleSpotLightFeatureProcessor.
|
pure virtual |
Sets the inner and outer cone angles in radians.
Implemented in AZ::Render::SimpleSpotLightFeatureProcessor.
|
pure virtual |
Sets the direction for a given LightHandle.
Implemented in AZ::Render::SimpleSpotLightFeatureProcessor.
|
pure virtual |
Sets the position for a given LightHandle.
Implemented in AZ::Render::SimpleSpotLightFeatureProcessor.
|
pure virtual |
Sets the intensity in RGB candela for a given LightHandle.
Implemented in AZ::Render::SimpleSpotLightFeatureProcessor.