This is the documentation for Enlighten.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 2 Current »

class Enlighten::UE4::UnrealDirectionalLightFunction

    └>Enlighten::InputLightBase

A light type similar to DirectionalLight which uses an approximation of a 2D light function to control the intensity of the lighting.

Classes

Variables

Name Description
const Geo::u32 LevelCountMax = 16

Max Level count of Clipmap for light function.

Geo::v128 m_Direction

World space direction of light.

bool m_HasChanged

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

Geo::v128 m_Intensity

RGB intensity of the light (linear space).

const Geo::u8 * m_LightFunctionClipmap

Clipmap for light function.

Geo::u32 m_LightFunctionClipmapLevelCount

Clipmap level count.

Geo::u32 m_LightFunctionClipmapResolution

Clipmap resolution.

Geo::u32 m_LightFunctionClipmapScale

Clipmap scale for light function.

const eLightType m_LightType

Type of input light corresponding to an eLightType enum value.

float m_MaximumDistance

The maximum distance from the camera at which systems are affected by this light.

Geo::u64 m_Padding

Unused (this class is usually extended by one that starts with multiple v128s)

Geo::v128 m_ViewPosition

Clipmap view position for light function.

VisibilityFormat::Type m_VisibilityType

Visibility type.

Functions

Name Description
DistanceFilter(float)

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

EvaluateLightFunctionClipmap(const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::u8 *, const Geo::v128, const Geo::u32, const Geo::u32, const Geo::u32)

Evaluate light function clipmap.

InputLightBase(eLightType)

Constructor.

InputLightBase(eLightType, bool)

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.


static Geo::v128 Enlighten::UE4::UnrealDirectionalLightFunction::EvaluateLightFunctionClipmap


public: Geo::v128 EvaluateLightFunctionClipmap
(
    const Geo::v128 & positionsX,
    const Geo::v128 & positionsY,
    const Geo::v128 & positionsZ,
    const Geo::u8 * clipmapData,
    const Geo::v128 viewOrigin,
    const Geo::u32 scale,
    const Geo::u32 resolution,
    const Geo::u32 levelCount
)


Evaluate light function clipmap.


Enlighten::InputLightBase::InputLightBase


protected: InputLightBase
(
    eLightType lightType
)


Constructor.


Enlighten::InputLightBase::InputLightBase


protected: InputLightBase
(
    eLightType lightType,
    bool hasChanged
)


Constructor.

  • No labels