This is the documentation for Enlighten.

class Enlighten UE4 RectLight

class Enlighten::UE4::RectLight

    └>Enlighten::InputLightBase

A UE4 Rect Light.

The implementation matches the UE4 shader.

Classes

Name Description
Enlighten::UE4::RectLight::CachedData

Cached data for RectLight.

Variables

Name Description
float BarnDoorCosAngle

Cosine of the angle of the barn doors.

float BarnDoorLength

Length of the barn doors.

Geo::v128 Direction

XYZ: World space x axis of light space.

Geo::v128 Intensity

RGB intensity.

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)

Geo::v128 Position

World space position of the light.

float Radius

attenuation radius

Geo::v128 RightDirection

XYZ: World space y axis of light space.

float SourceLength

Half height of the rectangle.

float SourceRadius

Half width of the rectangle.

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.