This is the documentation for Enlighten.

class Enlighten InputLightBase

class Enlighten::InputLightBase

A base class all light types must derive from to work with any input lighting API.

This is separate from InputLight in order to make it easier for users of the SDK to add new light types.

See Also

EnlightenCustomerLights.h

Variables

Name Description
bool m_HasChanged

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

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)

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.