This is the documentation for Enlighten.

class Enlighten EnvironmentLightMeta

class Enlighten::EnvironmentLightMeta

Public interface for querying common metadata of a single environment light.

Functions

Name Description
GetColour()

Gets the colour of this environment light.

GetEnabled()

Checks if this environment light is enabled.

GetFilePath()

Gets the file path of the cube map texture for this environment light.

GetGuid()

Gets the GUID of this environment light.

GetIntensity()

Gets the intensity of this environment light.

IsTextureSrgb()

Checks if the cube map texture of this environment light is in sRGB space.

IsValid()

Some accessors return an 'invalid' object to represent nothing or not-found.


const Geo::v128& Enlighten::EnvironmentLightMeta::GetColour


public: const Geo::v128 & GetColour() const


Gets the colour of this environment light.


bool Enlighten::EnvironmentLightMeta::GetEnabled


public: bool GetEnabled() const


Checks if this environment light is enabled.


const char* Enlighten::EnvironmentLightMeta::GetFilePath


public: const char * GetFilePath() const


Gets the file path of the cube map texture for this environment light.


const Geo::GeoGuid& Enlighten::EnvironmentLightMeta::GetGuid


public: const Geo::GeoGuid & GetGuid() const


Gets the GUID of this environment light.


float Enlighten::EnvironmentLightMeta::GetIntensity


public: float GetIntensity() const


Gets the intensity of this environment light.


bool Enlighten::EnvironmentLightMeta::IsTextureSrgb


public: bool IsTextureSrgb() const


Checks if the cube map texture of this environment light is in sRGB space.


bool Enlighten::EnvironmentLightMeta::IsValid


public: bool IsValid() const


Some accessors return an 'invalid' object to represent nothing or not-found.