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. | |
![]() | |
AZ_RTTI (AZ::Render::CapsuleLightFeatureProcessorInterface, "{41CAF69D-6A0B-461F-BE3D-6367673646D4}", 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 | |
![]() | |
using | LightHandle = RHI::Handle< uint16_t, class CapsuleLight > |
![]() | |
static constexpr PhotometricUnit | PhotometricUnitType = PhotometricUnit::Candela |
![]() | |
void | EnableSceneNotification () |
void | DisableSceneNotification () |
|
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.
|
overridevirtual |
Perform any necessary activation and gives access to owning Scene.
Reimplemented from AZ::RPI::FeatureProcessor.
|
overridevirtual |
Creates a new LightHandle by copying data from an existing LightHandle.
Implements AZ::Render::CapsuleLightFeatureProcessorInterface.
|
overridevirtual |
Perform any necessary deactivation.
Reimplemented from AZ::RPI::FeatureProcessor.
|
overridevirtual |
Returns the buffer containing the light data for all capsule lights.
Implements AZ::Render::CapsuleLightFeatureProcessorInterface.
|
overridevirtual |
Returns the number of capsule lights.
Implements AZ::Render::CapsuleLightFeatureProcessorInterface.
|
overridevirtual |
Releases a LightHandle which removes the capsule light.
Implements AZ::Render::CapsuleLightFeatureProcessorInterface.
|
overridevirtual |
The feature processor should enqueue draw packets to relevant draw lists.
Reimplemented from AZ::RPI::FeatureProcessor.
|
overridevirtual |
Specifies if this light affects the diffuse global illumination in the scene.
Implements AZ::Render::CapsuleLightFeatureProcessorInterface.
|
overridevirtual |
Specifies the contribution of this light to the diffuse global illumination in the scene.
Implements AZ::Render::CapsuleLightFeatureProcessorInterface.
|
overridevirtual |
Sets the radius in meters at which the provided LightHandle will no longer have an effect.
Implements AZ::Render::CapsuleLightFeatureProcessorInterface.
|
overridevirtual |
Sets all of the the capsule data for the provided LightHandle.
Implements AZ::Render::CapsuleLightFeatureProcessorInterface.
|
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.
|
overridevirtual |
Sets the capsule radius for the provided LightHandle.
Implements AZ::Render::CapsuleLightFeatureProcessorInterface.
|
overridevirtual |
Sets the lighting channel mask.
Implements AZ::Render::CapsuleLightFeatureProcessorInterface.
|
overridevirtual |
Sets the intensity in RGB candela for a given LightHandle.
Implements AZ::Render::CapsuleLightFeatureProcessorInterface.
|
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.
Reimplemented from AZ::RPI::FeatureProcessor.