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 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
  • class Enlighten DirectInputLightingParameters
  • class Enlighten DirectionalLight
  • class Enlighten DirectionalLightMeta
  • class Enlighten Dx9TextureUpdater
  • class Enlighten Dx11TextureUpdater
  • class Enlighten DynamicMaterialWorkspace
  • class Enlighten DynamicObject
  • class Enlighten EnlightenDataBlock
  • class Enlighten EnlightenProfile
  • class Enlighten EnlightenTask
  • class Enlighten EntireProbeSetTask
  • class Enlighten EnvironmentLightMeta
  • class Enlighten ExcludedInstance
  • class Enlighten ExporterCubemap
  • class Enlighten ExporterGeom
  • class Enlighten ExporterGlobalParameters
  • class Enlighten ExporterInstanceParameters
  • class Enlighten ExporterLineWriter
  • class Enlighten ExporterMesh
  • class Enlighten ExporterPaths
  • class Enlighten ExporterProbeRegion
  • class Enlighten ExporterProbeVolume
  • class Enlighten ExporterScene
  • class Enlighten ExporterTransform
  • class Enlighten FitModel
  • class Enlighten FixedTimeLimiter
  • class Enlighten Fp16CpuTextureSampler
  • class Enlighten FrustumLight
  • class Enlighten FunctorCommand
  • class Enlighten GenericColourBuffer
  • class Enlighten GeoClusterNode
  • class Enlighten GeoClusterNodeForest
  • class Enlighten GeoClusterNodeTree
  • class Enlighten GeoDirectionalPoint
  • class Enlighten GeometryDataBlock
  • class Enlighten GeomMeshMeta
  • class Enlighten GeomMeta
  • class Enlighten GeomProperties
  • class Enlighten GeoRayOrigin
  • class Enlighten GlTextureUpdater
  • class Enlighten GpuTextureWrapper
  • class Enlighten IAsyncTask
  • class Enlighten IBake
  • class Enlighten IBakeInputGeometryLightingNormals
  • class Enlighten IBakeInputGeometryTangents
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten Dx11TextureUpdater

    This is the documentation for Enlighten.

    class Enlighten Dx11TextureUpdater

    Nov 21, 2019

    class Enlighten::Dx11TextureUpdater

        └>Enlighten::IGpuTextureUpdater
            └>Geo::IGeoReleasable

    Implementation for managing solver output and Dx11 GPU textures.

    Functions

    Name Description
    Create(ID3D11Resource *)

    Create an updater for a Dx11 2D texture for irradiance solver output.

    Create3D(ID3D11Resource *)

    Create an updater for a Dx11 volume texture for interpolated probe output.

    CreateCubeMap(ID3D11Resource *, Geo::s32)

    Create an updater for a Dx11 cube map texture for cube map solver output.

    GetCpuAccessiblePointer(Geo::s32)

    Returns a CPU pointer to the memory used to update the GPU texture.

    GetCpuAccessiblePointer(Geo::s32)

    Returns a CPU pointer to the memory used to update the GPU texture.

    GetNumMipLevels()

    Returns the number of mip levels in the GPU texture - will only be bigger than 1 for cube maps.

    GetNumMipLevels()

    Returns the number of mip levels in the GPU texture - will only be bigger than 1 for cube maps.

    GetRowPitch()

    Returns the row pitch of the CPU memory associated with this GPU texture.

    GetRowPitch()

    Returns the row pitch of the CPU memory associated with this GPU texture.

    GetSlicePitch()

    Returns the slice pitch of the CPU memory associated with this GPU texture, for 3D textures.

    GetSlicePitch()

    Returns the slice pitch of the CPU memory associated with this GPU texture, for 3D textures.

    IsFormat(TextureFormat)

    Returns true if the format of the GPU texture matches the given Enlighten format.

    IsFormat(TextureFormat)

    Returns true if the format of the GPU texture matches the given Enlighten format.

    Release()

    Free this object that was created within the Enlighten libraries.

    Release()

    Free this object that was created within the Enlighten libraries.

    Update()

    Update the GPU copy of the texture on the render thread.

    Update()

    Update the GPU copy of the texture on the render thread.

    Update(const TextureSubSection &)

    Update the GPU copy of the specified sub-region on the render thread.

    Update(const TextureSubSection &)

    Update the GPU copy of the specified sub-region on the render thread.

    UpdateOnWorkerThread()

    Potentially update the GPU copy of the texture on the worker thread.

    UpdateOnWorkerThread(const TextureSubSection &)

    Equivalent to parameter-less overload, but only update a sub-region of the texture.


    Dx11TextureUpdater * Enlighten::Dx11TextureUpdater::Create

    public: Dx11TextureUpdater * Create
    (
        ID3D11Resource * gpuTexture
    )

    Create an updater for a Dx11 2D texture for irradiance solver output.


    Dx11TextureUpdater * Enlighten::Dx11TextureUpdater::Create3D

    public: Dx11TextureUpdater * Create3D
    (
        ID3D11Resource * gpuTexture
    )

    Create an updater for a Dx11 volume texture for interpolated probe output.


    Dx11TextureUpdater * Enlighten::Dx11TextureUpdater::CreateCubeMap

    public: Dx11TextureUpdater * CreateCubeMap
    (
        ID3D11Resource * gpuTexture,
        Geo::s32 arrayIndex
    )

    Create an updater for a Dx11 cube map texture for cube map solver output.


    virtual void* Enlighten::Dx11TextureUpdater::GetCpuAccessiblePointer

    public: virtual void * GetCpuAccessiblePointer
    (
        Geo::s32 faceIdx
    )

    Returns a CPU pointer to the memory used to update the GPU texture.

    This may point directly to the GPU texture in unified memory architectures. The face index parameter is only relevant to cube maps.


    virtual void* Enlighten::IGpuTextureUpdater::GetCpuAccessiblePointer

    public: void * GetCpuAccessiblePointer
    (
        Geo::s32 faceIdx
    )

    Returns a CPU pointer to the memory used to update the GPU texture.

    This may point directly to the GPU texture in unified memory architectures. The face index parameter is only relevant to cube maps.


    Geo::s32 Enlighten::Dx11TextureUpdater::GetNumMipLevels

    public: virtual Geo::s32 GetNumMipLevels()

    Returns the number of mip levels in the GPU texture - will only be bigger than 1 for cube maps.


    virtual Geo::s32 Enlighten::IGpuTextureUpdater::GetNumMipLevels

    public: Geo::s32 GetNumMipLevels()

    Returns the number of mip levels in the GPU texture - will only be bigger than 1 for cube maps.


    virtual Geo::s32 Enlighten::Dx11TextureUpdater::GetRowPitch

    public: virtual Geo::s32 GetRowPitch()

    Returns the row pitch of the CPU memory associated with this GPU texture.


    virtual Geo::s32 Enlighten::IGpuTextureUpdater::GetRowPitch

    public: Geo::s32 GetRowPitch()

    Returns the row pitch of the CPU memory associated with this GPU texture.


    virtual Geo::s32 Enlighten::Dx11TextureUpdater::GetSlicePitch

    public: virtual Geo::s32 GetSlicePitch()

    Returns the slice pitch of the CPU memory associated with this GPU texture, for 3D textures.

    Returns 0 for 2D textures, and -1 for cube maps.


    virtual Geo::s32 Enlighten::IGpuTextureUpdater::GetSlicePitch

    public: Geo::s32 GetSlicePitch()

    Returns the slice pitch of the CPU memory associated with this GPU texture, for 3D textures.

    Returns 0 for 2D textures, and -1 for cube maps.


    virtual bool Enlighten::Dx11TextureUpdater::IsFormat

    public: virtual bool IsFormat
    (
        TextureFormat format
    )

    Returns true if the format of the GPU texture matches the given Enlighten format.


    virtual bool Enlighten::IGpuTextureUpdater::IsFormat

    public: bool IsFormat
    (
        TextureFormat format
    )

    Returns true if the format of the GPU texture matches the given Enlighten format.


    virtual void Geo::IGeoReleasable::Release

    public: void Release()

    Free this object that was created within the Enlighten libraries.

    Expect this to behave in a similar way to calling 'delete(this)'


    void Enlighten::Dx11TextureUpdater::Release

    public: virtual void Release()

    Free this object that was created within the Enlighten libraries.

    Expect this to behave in a similar way to calling 'delete(this)'


    void Enlighten::Dx11TextureUpdater::Update

    public: virtual void Update()

    Update the GPU copy of the texture on the render thread.


    virtual void Enlighten::IGpuTextureUpdater::Update

    public: void Update()

    Update the GPU copy of the texture on the render thread.


    virtual void Enlighten::IGpuTextureUpdater::Update

    public: void Update
    (
        const TextureSubSection & sub
    )

    Update the GPU copy of the specified sub-region on the render thread.


    void Enlighten::Dx11TextureUpdater::Update

    public: virtual void Update
    (
        const TextureSubSection & sub
    )

    Update the GPU copy of the specified sub-region on the render thread.


    virtual void Enlighten::IGpuTextureUpdater::UpdateOnWorkerThread

    public: virtual void UpdateOnWorkerThread()

    Potentially update the GPU copy of the texture on the worker thread.

    Implementers should use this method when the texture can safely be updated on a thread other than the render thread. The default implementation does nothing, in which case the update should be done in the regular Update function. The update should be performed here or in Update, not both.


    virtual void Enlighten::IGpuTextureUpdater::UpdateOnWorkerThread

    public: virtual void UpdateOnWorkerThread
    (
        const TextureSubSection & sub
    )

    Equivalent to parameter-less overload, but only update a sub-region of the texture.

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