This is the documentation for Enlighten.

class Enlighten BoxSpotlight

class Enlighten::BoxSpotlight

    └>Enlighten::InputLightBase

BoxSpotlight class used by extended input lighting.

Classes

Name Description
Enlighten::BoxSpotlight::CachedData

Cached data for box spotlight.

Variables

Name Description
float m_ConeAngle

Cone angle.

float m_CutOff

The radius outside which intensity is clamped to zero; specified in Enlighten units.

Geo::v128 m_Direction

Forward direction.

const InputLightFalloffTable * m_FalloffTable

Falloff table.

float m_Far

Far plane.

bool m_HasChanged

Whether the light has changed since it was last given to the extended direct lighting api.

float m_InnerConeAngle

Inner cone angle.

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.

float m_Near

Near plane.

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 light.

float m_Radius

The radius inside which intensity is clamped to the given value; specified in Enlighten units.

Geo::v128 m_RightDirection

Right direction.

float m_SecondConeAngle

Second cone angle.

float m_SecondInnerConeAngle

Second inner cone angle.

Geo::v128 m_UpDirection

Up direction.

Functions

Name Description
DistanceFilter(float)

Return true if this light affects a system at the specified distance from the viewer.

InputLightBase(eLightType, bool)

Constructor.

InputLightBase(eLightType)

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,
    bool hasChanged
)


Constructor.


Enlighten::InputLightBase::InputLightBase


protected: InputLightBase
(
    eLightType lightType
)


Constructor.