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 4.03 Documentation
Results will update as you type.
  • class Enlighten PipelineTransform
  • class Enlighten PipelineUnlitInstance
  • class Enlighten PipelineVolumeProbeRegion
  • class Enlighten PointLight
  • class Enlighten PointProjection
  • class Enlighten PointProjectionOptions
  • class Enlighten PointProjectionScratchMem
  • class Enlighten PointProjectionSurface
  • class Enlighten PointProjectionVersion
  • class Enlighten PppiWorld
  • class Enlighten PrecompInputFace
  • class Enlighten PrecompInputInstance
  • class Enlighten PrecompInputVertex
  • class Enlighten PrecompMaterialInfo
  • class Enlighten PrecompMeshInstanceView
  • class Enlighten PrecompMeshProperties
  • class Enlighten PrecompOctreeNode
  • class Enlighten PrecompOctreeProbeKey
  • class Enlighten PrecomputedVisibilityData
  • class Enlighten PrecomputedVisibilityWorkspace
  • class Enlighten PrecomputeParameters
  • class Enlighten PrecomputePipeline
  • class Enlighten PrecompVoxelId
  • class Enlighten PrecompVoxelOctree
  • class Enlighten PrecompVoxelOctreePath
  • class Enlighten PrecompVoxelOctreeVolume
  • class Enlighten ProbeInterpolant
  • class Enlighten ProbeInterpolationTask
  • class Enlighten ProbeSetManagerOctree
  • class Enlighten ProbeSetOctreeNode
  • class Enlighten ProbeSetVirtualProbe
  • class Enlighten ProfileHistory
  • class Enlighten QuadIterator
  • class Enlighten QuadShader
  • class Enlighten QuickFlatClusterShader
  • class Enlighten QuickQuadShader
  • class Enlighten R9G9B9E5CpuTextureSampler
  • class Enlighten R11G11B10CpuTextureSampler
  • class Enlighten RadCubeMapCore
  • class Enlighten RadCubeMapMetaData
  • class Enlighten RadCubeMapTask
  • class Enlighten RadDataBlock
  • class Enlighten RadDebugBucketSelectionTask
  • class Enlighten RadDebugColouringTask
  • class Enlighten RadDebugPixelInfo
  • class Enlighten RadiosityInputTree
  • class Enlighten RadIrradianceTask
  • class Enlighten RadProbeSetCore
  • class Enlighten RadProbeSetMetaData
  • class Enlighten RadProbeTask
  • class Enlighten RadSystemCore
  • class Enlighten RadSystemMetaData
  • class Enlighten RawBuffer
  • class Enlighten ReadInputLightingBufferInfo
  • class Enlighten RectangleLight
  • class Enlighten RefTextureAllocator
  • class Enlighten RefTextureUpdater
  • class Enlighten ReleaseSystemSolutionSpacesInfo
  • class Enlighten RemoveInfo
  • class Enlighten ResampleBounceParameters
  • class Enlighten ResampleTextureParameters
  • class Enlighten Rgba64Linear
  • class Enlighten RgbaCpuTextureSampler
  • class Enlighten RgbmCpuTextureSampler
  • class Enlighten SetLightBankUpdateCounterInfo
  • class Enlighten SetParameterCommand
  • class Enlighten SetProbeSetTransformInfo
  • class Enlighten SetTransparencySamplePositionOffsetInfo
  • class Enlighten SetVisibilityBitsInfo
  • class Enlighten SolveBounceTask
  • class Enlighten SortedLights
  • class Enlighten SphereVolume
  • class Enlighten Spotlight
  • class Enlighten SystemAlbedoData
  • class Enlighten SystemDependencies
  • class Enlighten SystemGrouping
  • class Enlighten TaskProcessor
  • class Enlighten TransparencyWorkspace
  • class Enlighten Triangle2D
  • class Enlighten TriggerVolumeTransparencyGeneric
  • class Enlighten UpdateEnvironmentInfo
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten RadCubeMapTask

    This is the documentation for Enlighten.

    class Enlighten RadCubeMapTask

    Sept 09, 2025

    class Enlighten::RadCubeMapTask

    Structure describing a task to generate a cube map.

    The cube map layout follows the DirectX definition, described here: http://msdn.microsoft.com/en-us/library/windows/desktop/bb204881(v=vs.85).aspx

    The output textures should match the face indexing shown in the image. 

                      |-------------|
                  |             |
                  |  face 2     |
                  |             |
                  |     +y      |
                  |             |
    |-------------|-------------|-------------|-------------|
    |             |             |             |             |
    |  face 1     |  face 4     |  face 0     |  face 5     |
    |             |             |             |             |
    |     -x      |    +z       |     +x      |     -z      |
    |             |             |             |             |
    |-------------|-------------|-------------|-------------|
                  |             |
                  |  face 3     |
                  |             |
                  |    -y       |
                  |             |
                  |-------------|

    Note

    In this release, the temporal coherence optimisation has not been implemented for cube maps, but parameters for it exist in the API. These are ignored but will be supported in a future release. We recommend you leave them at default values.

    Variables

    Name Description
    bool m_ComputeMipMaps

    If TRUE then a full mip chain will be computed.

    const RadCubeMapCore * m_CoreCubeMap

    Precompute data for cube map solved in this task.

    eCubemapFilterMode m_CubemapFilterMode

    Decide how cubemap mipmap is generate.

    const InputLightingBuffer * m_Environment

    Emissive environment for the task to read from. Must be 16-byte aligned, although may be NULL.

    const InputLightingBuffer ** m_InputLighting

    Ordered list of input lighting buffers that the task can read from.

    Geo::u32 m_OutputFormat

    Output format: one of the OUTPUT_FORMAT_* constants.

    eOutputFormatByteOrder m_OutputFormatByteOrder

    Whether to output 8-bit-per-pixel data in BGRA (DX9) or RGBA (DX11) byte order.

    float m_OutputScale

    Constant to premultiply by before format conversion. Defaults to 1 (no scale).

    void * m_OutputTextures[6]

    Cube map output.

    const BounceBuffer ** m_RadiosityOnlyLighting

    Ordered list of bounce buffers. If not NULL, the solver will compute radiosity-only cube map output.

    float m_TemporalCoherenceEpsilon

    (Not implemented in this release) Small bias value added to the lighting intensity to ensure stable computation.

    float m_TemporalCoherenceThreshold

    (Not implemented in this release) The threshold value for temporal coherence.

    Functions

    Name Description
    RadCubeMapTask()

    Default constructor.


    Enlighten::RadCubeMapTask::RadCubeMapTask

    public: RadCubeMapTask()

    Default constructor.

    , multiple selections available,
    {"serverDuration": 10, "requestCorrelationId": "3dba5b9944e146278f0d70e5189d487b"}