class Enlighten RefTextureUpdater

This is the documentation for Enlighten.

class Enlighten RefTextureUpdater

class Enlighten::RefTextureUpdater

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

Reference texture updater.

Functions

Name

Description

Name

Description

~RefTextureUpdater()

Destructor.

Create(Geo::s32, Geo::s32, Geo::s32)

Create 2D texture.

Create3D(Geo::s32, Geo::s32, Geo::s32, Geo::s32)

Create 3D.

CreateCubeMap(Geo::s32, Geo::s32, bool)

Create Cube Map.

GetCpuAccessiblePointer(Geo::s32)

Get a CPU accessible pointer to the texture data.

GetCpuAccessiblePointer(Geo::s32)

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

GetNumMipLevels()

Get the number of mipmap levels.

GetNumMipLevels()

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

GetRowPitch()

Get the texture row pitch.

GetRowPitch()

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

GetSlicePitch()

Get the texture slice pitch.

GetSlicePitch()

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

IsFormat(TextureFormat)

Check the 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()

Release.

Update()

Update the texture.

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 texture sub-section.

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.



Enlighten::RefTextureUpdater::~RefTextureUpdater


protected: virtual ~RefTextureUpdater()


Destructor.



RefTextureUpdater * Enlighten::RefTextureUpdater::Create


public: RefTextureUpdater * Create
(
    Geo::s32 width,
    Geo::s32 height,
    Geo::s32 bytesPerPixel
)