class Enlighten IGpuTextureUpdater

This is the documentation for Enlighten.

class Enlighten IGpuTextureUpdater

class Enlighten::IGpuTextureUpdater

    └>Geo::IGeoReleasable

IGpuTextureUpdater is the interface used by the HLRT to manage Enlighten solver output and associated GPU texture resources.

Functions

Name

Description

Name

Description

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.

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.

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.

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.

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.



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.



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::IGpuTextureUpdater::GetRowPitch


public: Geo::s32 GetRowPitch()


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



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::IGpuTextureUpdater::IsFormat