This is the documentation for Enlighten.
class Enlighten Spotlight
class Enlighten::Spotlight
Spotlight class used by extended input lighting.
Classes
| Name | Description |
|---|---|
| Enlighten::Spotlight::CachedData | Cached data for spotlights. |
Variables
| Name | Description |
|---|---|
| float m_ConeAngle | The cone angle of the spot light in radians; Measures the angle swept by the entire cone. |
| float m_CutOff | The radius outside which intensity is clamped to zero; specified in Enlighten units. |
| Geo::v128 m_Direction | World space direction of spotlight. |
| const InputLightFalloffTable * m_FalloffTable | Falloff table. |
| bool m_HasChanged | Whether the light has changed since it was last given to the extended direct lighting api. |
| float m_InnerConeAngle | The inner cone angle of the spot light in radians. |
| Geo::v128 m_Intensity | RGB intensity of the light (linear space). |
| const eLightType m_LightType | Type of input light corresponding to an eLightType enum value. |
| Geo::u64 m_Padding | Unused (this class is usually extended by one that starts with multiple v128s) |
| Geo::v128 m_Position | World space position of spotlight. |
| float m_Radius | The radius inside which intensity is clamped to the given value; specified in Enlighten units. |
Functions
| Name | Description |
|---|---|
| DistanceFilter(float) | Return true if this light affects a system at the specified distance from the viewer. |
| InputLightBase(eLightType) | Constructor. |
| InputLightBase(eLightType, bool) | Constructor. |
| Spotlight() | Constructor. |
GEO_CONTROLLED_INLINE bool Enlighten::InputLightBase::DistanceFilter
public: GEO_CONTROLLED_INLINE bool DistanceFilter
(
float viewDistance
) const
Return true if this light affects a system at the specified distance from the viewer.
Enlighten::InputLightBase::InputLightBase
protected: InputLightBase
(
eLightType lightType
)
Constructor.
Enlighten::InputLightBase::InputLightBase
protected: InputLightBase
(
eLightType lightType,
bool hasChanged
)
Constructor.
Enlighten::Spotlight::Spotlight
public: Spotlight()
Constructor.