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.
  • 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 SourceMeshInstanceMeta
  • class Enlighten SphereVolume
  • class Enlighten Spotlight
  • class Enlighten SpotlightMeta
  • class Enlighten SystemAlbedoData
  • class Enlighten SystemDataBlock
  • class Enlighten SystemDependencies
  • class Enlighten SystemGrouping
  • class Enlighten SystemMeta
  • class Enlighten TaskProcessor
  • class Enlighten TransparencyWorkspace
  • class Enlighten Triangle2D
  • class Enlighten TriggerVolumeTransparencyGeneric
  • class Enlighten UpdateEnvironmentInfo
  • class Enlighten UpdateLightCommandGeneric
  • class Enlighten UpdateLightInfo
  • class Enlighten UpdateLightOptions
  • class Enlighten UpdateManagerLight
  • class Enlighten UpdateManagerProperties
  • class Enlighten UpdateManagerWorkerProperties
  • class Enlighten Vertex2D
  • class Enlighten VisibilityBuffer
  • class Enlighten WorkerFunctionCommand
  • class Enlighten WorkerFunctionParameterCommand
  • class Enlighten WorkerFunctionTwoParametersCommand
  • class Enlighten WorkerFunctorCommand
  • class Enlighten WorkerObjectFunctionCommand
  • class Enlighten WorkerThreadData
  • class Enlighten WorkspaceAllocator
  • class Enlighten XmlWriter
  • namespace Enlighten Errors
  • namespace Enlighten Helpers
    • struct Enlighten Helpers Hasher
  • namespace Enlighten Iff
  • namespace Enlighten InputLightingValidation
  • namespace Enlighten Itt
  • namespace Enlighten OutputTextureState
  • namespace Enlighten UE4
  • namespace Enlighten Version
  • struct Enlighten AllFilter
  • struct Enlighten BakeInputTexture
  • struct Enlighten CachedLightSelector
  • struct Enlighten CachedLightWriter
  • struct Enlighten CanQuickShade
  • struct Enlighten CanQuickShade< LIGHT_TYPE_DIRECTIONAL_LIGHT >
  • struct Enlighten CountLightSizeVisitor
  • struct Enlighten CullCluster
  • struct Enlighten CullClusterGroup
  • struct Enlighten CullingIterator
  • struct Enlighten CullingIterator< LIGHT_TYPE_INVALID, Culler >
  • struct Enlighten CullSystem
  • struct Enlighten eMetaLightingType
  • struct Enlighten ExcludeQuickShadeFilter
  • struct Enlighten ExporterAxes
  • struct Enlighten ExporterMaterial
  • struct Enlighten ExporterMaterialProperties
  • struct Enlighten HashLightVisitor
  • struct Enlighten IndirectionTextureRegions
  • struct Enlighten InstanceDescMinimal
  • struct Enlighten InstanceProperties
  • struct Enlighten LightSelector
  • struct Enlighten LightTypeInfo
  • struct Enlighten LinearColor
  • struct Enlighten NullSurroundingsSampler
  • struct Enlighten OctreeNode
  • struct Enlighten PipelineMaterial
  • struct Enlighten PipelineRadiosityProperties
  • struct Enlighten PipelineWorldAxes
  • struct Enlighten PixelBarycentricWeights
  • struct Enlighten PixelCoord
  • struct Enlighten PointProjectionVertex
  • struct Enlighten PppiClipmapVolumeTextureInfo
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
namespace Enlighten Helpers

    This is the documentation for Enlighten.

    namespace Enlighten Helpers

    Nov 21, 2019

    Enlighten::Helpers

    Classes

    Name Description
    Enlighten::Helpers::Hasher

    Hashes data.

    Functions

    Name Description
    ConstructLightViewProjTransposed(const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, float, float, float, float, float, Geo::v128 &, Geo::v128 &, Geo::v128 &)

    Constructs a transposed light view projection matrix for the given light parameters.

    ExtractDusterVisibility(const Geo::u8 *, const Geo::u32, const Geo::u32)

    Extracts 4 consecutive bits into an XYZW mask from the given visibility data based on the given quad index.

    ExtractIndexedXyValues(const Geo::v128 *, const Geo::v128 &, Geo::v128 &, Geo::v128 &)

    Extracts the indexed X and Y values from a vector table, based on the input indices.

    ExtractSampleVisibility(const Geo::u8 *, const Geo::u32, const Geo::u32)

    Extracts 4 consecutive bits into an XYZW mask from the given visibility data given an arbitrary sample index.

    QuadDotProduct(const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &)

    Determine dot product of four 3-component vectors packed into x, y and z against another 4 vectors packed into normalsX, normalsY and normalsZ.

    QuadDotProduct(const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &)

    Determine dot product of four 3-component vectors packed into x, y and z against another vector.

    QuadLengthSquared(const Geo::v128 &, const Geo::v128 &, const Geo::v128 &)

    Determine length squared of four 3-component vectors packed into x, y and z.

    VisibilityMask(const void *)

    Determine the mask to be used based on the visibility pointer.


    Geo::Matrix Enlighten::Helpers::ConstructLightViewProjTransposed

    public: Geo::Matrix ConstructLightViewProjTransposed
    (
        const Geo::v128 & rightVec,
        const Geo::v128 & upVec,
        const Geo::v128 & dirVec,
        const Geo::v128 & position,
        float coneAngle,
        float secondConeAngle,
        float nearDist,
        float far,
        float cutoff,
        Geo::v128 & sinOut,
        Geo::v128 & cosOut,
        Geo::v128 & tanOut
    )

    Constructs a transposed light view projection matrix for the given light parameters.

    Parameters
    [in] rightVec

    - The 'right' vector of light basis in world space

    [in] upVec

    - The 'up' vector of light basis in world space

    [in] dirVec

    -The 'forward' vector of light basis in world space

    [in] position

    - The world space position of the light

    [in] coneAngle

    - The cone angle of the light

    [in] secondConeAngle

    - The second cone angle of the light

    [in] nearDist

    - The light near plane distance

    [in] far

    - The light far plane distance

    [in] cutoff

    - The radius outside which the intensity of the light is clamped to zero

    [out] sinOut

    - The computed sin of the light cone angle

    [out] cosOut

    - The computed cosine of the light cone angle

    [out] tanOut

    - The computed tangent of the light cone angle

    Returns

    The transposed light view projection matrix


    Geo::v128 Enlighten::Helpers::ExtractDusterVisibility

    public: Geo::v128 ExtractDusterVisibility
    (
        const Geo::u8 * visibility,
        const Geo::u32 quadIndex,
        const Geo::u32 indexMask
    )

    Extracts 4 consecutive bits into an XYZW mask from the given visibility data based on the given quad index.

    Parameters
    [in] visibility

    - The packed duster visibility data

    [in] quadIndex

    - The index into the packed duster visibility data

    [in] indexMask

    - The index mask

    Returns

    The XYZW duster visibility mask


    void Enlighten::Helpers::ExtractIndexedXyValues

    public: void ExtractIndexedXyValues
    (
        const Geo::v128 * table,
        const Geo::v128 & vIndices,
        Geo::v128 & xValues,
        Geo::v128 & yValues
    )

    Extracts the indexed X and Y values from a vector table, based on the input indices.

    Parameters
    [in] table

    - The table to index

    [in] vIndices

    - The floating point indices (truncated before doing the lookup)

    [out] xValues

    - The X values

    [out] yValues

    - The Y values


    Geo::v128 Enlighten::Helpers::ExtractSampleVisibility

    public: Geo::v128 ExtractSampleVisibility
    (
        const Geo::u8 * visibility,
        const Geo::u32 sampleIdx,
        const Geo::u32 indexMask
    )

    Extracts 4 consecutive bits into an XYZW mask from the given visibility data given an arbitrary sample index.

    Parameters
    [in] visibility

    - The packed sample visibility data

    [in] sampleIdx

    - The index into the packed sample visibility data

    [in] indexMask

    - The index mask

    Returns

    The XYZW sample visibility mask


    GEO_CONTROLLED_INLINE Geo::v128 Enlighten::Helpers::QuadDotProduct

    public: GEO_CONTROLLED_INLINEGeo::v128 QuadDotProduct
    (
        const Geo::v128 & x,
        const Geo::v128 & y,
        const Geo::v128 & z,
        const Geo::v128 & normalsX,
        const Geo::v128 & normalsY,
        const Geo::v128 & normalsZ
    )

    Determine dot product of four 3-component vectors packed into x, y and z against another 4 vectors packed into normalsX, normalsY and normalsZ.

    Parameters
    [in] x

    - contains the x component of 4 vectors

    [in] y

    - contains the y component of 4 vectors

    [in] z

    - contains the z component of 4 vectors

    [in] normalsX

    - contains the x component of 4 normals

    [in] normalsY

    - contains the y component of 4 normals

    [in] normalsZ

    - contains the z component of 4 normals


    GEO_CONTROLLED_INLINE Geo::v128 Enlighten::Helpers::QuadDotProduct

    public: GEO_CONTROLLED_INLINEGeo::v128 QuadDotProduct
    (
        const Geo::v128 & x,
        const Geo::v128 & y,
        const Geo::v128 & z,
        const Geo::v128 & normal
    )

    Determine dot product of four 3-component vectors packed into x, y and z against another vector.

    Parameters
    [in] x

    - contains the x component of 4 vectors

    [in] y

    - contains the y component of 4 vectors

    [in] z

    - contains the z component of 4 vectors

    [in] normal

    - vector to do the dot product against for the 4 packed vectors


    GEO_CONTROLLED_INLINE Geo::v128 Enlighten::Helpers::QuadLengthSquared

    public: GEO_CONTROLLED_INLINEGeo::v128 QuadLengthSquared
    (
        const Geo::v128 & x,
        const Geo::v128 & y,
        const Geo::v128 & z
    )

    Determine length squared of four 3-component vectors packed into x, y and z.

    Parameters
    [in] x

    - contains the x component of 4 vectors

    [in] y

    - contains the y component of 4 vectors

    [in] z

    - contains the z component of 4 vectors


    GEO_CONTROLLED_INLINE Geo::u32 Enlighten::Helpers::VisibilityMask

    public: GEO_CONTROLLED_INLINEGeo::u32 VisibilityMask
    (
        const void * visibilityPointer
    )

    Determine the mask to be used based on the visibility pointer.

    Parameters
    [in] visibilityPointer

    - Pointer to the visibility buffer

    , multiple selections available,
    {"serverDuration": 11, "requestCorrelationId": "f9219410c2b64db785622a23aa97f7f0"}