TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

interface ITextureCube in Tinman.AddOns.Rendering

Base interface for cubemap texture resources for rendering.

interface ITextureCube extends ITexture
  base of TextureCube

Attributes

BitsPerTexel

The number of bits per texture pixel.

property BitsPerTexel { get }
type int32
value [>0] The number of bits per pixel.
inherited IBitsPerTexel.BitsPerTexel

Format

The texture format.

property Format { get }
type TextureFormat
value [not-null] The texture format.
inherited ITexture.Format

HasAlpha

Returns if texture pixels carry transparency data.

property HasAlpha { get }
type bool
value true if texture pixels can be transparent, false if all texture pixels will always be fully opaque.
inherited IBitsPerTexel.HasAlpha

IsSrgb

The sRGB behaviour of this texture.

property IsSrgb { get }
type bool
value The sRGB behaviour flag.
inherited ITexture.IsSrgb

Remarks:

When true, the GPU is supposed to do on-the-fly sRGB decompression for the texture object (e.g. in Direct3D 10+ by using DXGI_FORMAT_B8G8R8X8_UNORM_SRGB), so that the GPU shader receives linear color values. Depending on the underlying graphics API, it may be necessary to specify this sRGB behaviour in the shader effect source code (e.g. in a Direct3D 9 '.fx' file via SRGBTexture=true;, to enable the D3DSAMP_SRGBTEXTURE sampler state).

LifecycleState

Returns the lifecycle state of this object.

property LifecycleState { get }
type LifecycleState
value The lifecycle state.
inherited ILifecycleState.LifecycleState

MemoryConsumption

Returns the estimated memory consumption of this object.

property MemoryConsumption { get }
type int64
value [>=0] The estimated memory consumption, in bytes.
inherited IMemoryConsumption.MemoryConsumption

Mipmaps

The number of mipmap levels.

property Mipmaps { get }
type int32
value [>=0] The number of mipmap levels.
inherited ITexture.Mipmaps

NativeHandle

Returns the raw handle value of the native resource that is contained in this object.

property NativeHandle { get }
type IntPtr
value The raw handle value.
inherited INativeHandle.NativeHandle

Remarks:

The documentation of the implementing class will contain information on how to interpret the raw handle value.

Size

The texture cubemap size, in texels.

property Size { get }
type int32
value The cubemap size, in texels.

Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
method AcquireTry ()
type IDisposable
returns this if a new strong reference has been acquired, null if this object is already being disposed.
inherited IDisposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
method Dispose ()
inherited IDisposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

Face

Returns a cubemap face texture.

method Face (CubemapFace face)
type ITexture2D
params face The cubemap face.
returns [not-null] The texture resource.