Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Enlighten API 3.10 Documentation
Results will update as you type.
  • Modules
  • Namespaces
    • namespace Enlighten
      • class Enlighten A8CpuTextureSampler
      • class Enlighten Alpha8Normalised
      • class Enlighten AsyncTaskThreadGroup
      • class Enlighten AutoProbeVolumes
      • class Enlighten BakedProbeOutputInfo
      • class Enlighten BakeInputLight
      • class Enlighten BakeInputMeshInfo
      • class Enlighten BakeMaterialInfo
      • class Enlighten BaseAlbedoHandler
      • class Enlighten BaseCubeMap
      • class Enlighten BaseDynamicObject
      • class Enlighten BaseEnvironment
      • class Enlighten BaseLightMeta
      • class Enlighten BaseProbeSet
      • class Enlighten BaseSystem
      • class Enlighten BaseSystemSolutionSpace
      • class Enlighten BaseUpdateManager
      • class Enlighten BaseWorker
      • class Enlighten BoundingBox2D
      • class Enlighten BoxSpotlight
      • class Enlighten BoxVolume
      • class Enlighten CallableEnqueueFunctorCommand
      • class Enlighten ClusterAlbedoWorkspaceMaterialData
      • class Enlighten ClusterMaterialComponent
      • class Enlighten ClusterMaterials
      • class Enlighten ClusterProbeBounceSampleData
      • class Enlighten ClusterProbeSample
      • class Enlighten ClusterProbeTransparencySampleData
      • class Enlighten ClusterRange
      • class Enlighten Command
      • class Enlighten ConstLightValueIterator
      • class Enlighten CopyAlbedoBufferInfo
      • class Enlighten CopyBounceBufferInfo
      • class Enlighten CopyEmissiveBufferInfo
      • class Enlighten CopyEmissiveEnvironmentInfo
      • class Enlighten CopyInputLightingBufferInfo
      • class Enlighten CopyProbeOutputInfo
      • class Enlighten CopyRawOutputInfo
      • class Enlighten CopyTransparencyBufferInfo
      • class Enlighten CopyVisibilityBufferInfo
      • class Enlighten CpuAlbedoHandler
      • class Enlighten CpuCubeMap
      • class Enlighten CpuDynamicObject
      • class Enlighten CpuEnvironment
      • class Enlighten CpuSystem
      • class Enlighten CpuSystemSolutionSpace
      • class Enlighten CpuTextureSamplerBase
      • class Enlighten CpuUpdateManager
      • class Enlighten CpuWorker
      • class Enlighten CubeMapDataBlock
      • class Enlighten CubeMapMeta
      • class Enlighten DefaultGeometryTransparencySampler
      • class Enlighten DefaultThreadGroup
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten BaseLightMeta

    This is the documentation for Enlighten.

    class Enlighten BaseLightMeta

    Nov 21, 2019

    class Enlighten::BaseLightMeta

    Public interface for querying common metadata of a single light (shared by spotlights, point lights etc.).

    Variables

    Name Description
    const MetaBlock::BaseLightData * m_Data

    The internal data (inside MetaBlock).

    Functions

    Name Description
    BaseLightMeta(const MetaBlock::BaseLightData *)

    Constructs a BaseLightMeta from the given internal data.

    GetCastsShadows()

    Checks if this light casts shadows.

    GetEnabled()

    Checks if this light is enabled.

    GetGuid()

    Gets the GUID of this light.

    GetIntensity()

    Gets the intensity of this light.

    GetNormalisedColour()

    Gets the normalised colour of this light.

    GetRadiosityMultiplier()

    Gets the radiosity multiplier of this light.

    IsValid()

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


    Enlighten::BaseLightMeta::BaseLightMeta

    protected: BaseLightMeta
    (
        const MetaBlock::BaseLightData * data
    )

    Constructs a BaseLightMeta from the given internal data.


    bool Enlighten::BaseLightMeta::GetCastsShadows

    public: bool GetCastsShadows() const

    Checks if this light casts shadows.


    bool Enlighten::BaseLightMeta::GetEnabled

    public: bool GetEnabled() const

    Checks if this light is enabled.


    const Geo::GeoGuid& Enlighten::BaseLightMeta::GetGuid

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

    Gets the GUID of this light.


    float Enlighten::BaseLightMeta::GetIntensity

    public: float GetIntensity() const

    Gets the intensity of this light.


    const Geo::v128& Enlighten::BaseLightMeta::GetNormalisedColour

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

    Gets the normalised colour of this light.


    float Enlighten::BaseLightMeta::GetRadiosityMultiplier

    public: float GetRadiosityMultiplier() const

    Gets the radiosity multiplier of this light.


    bool Enlighten::BaseLightMeta::IsValid

    public: bool IsValid() const

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

    , multiple selections available,
    {"serverDuration": 10, "requestCorrelationId": "ae018748f5e94610926a19fca7f5aeb8"}