Open 3D Engine Atom Gem API Reference  2205.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Static Public Attributes | List of all members
AZ::Render::CapsuleLightFeatureProcessorInterface Class Referenceabstract

#include <CapsuleLightFeatureProcessorInterface.h>

Inherits AZ::RPI::FeatureProcessor.

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 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, 0)
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 *)
 Apply changes and add additional render passes to the render pipeline from the feature processors.
virtual void PrepareViews (const PrepareViewsPacket &, AZStd::vector< AZStd::pair< PipelineViewTag, ViewPtr >> &)
virtual void Simulate (const SimulatePacket &)
virtual void Render (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.

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