class TextureCube in Tinman.AddOns.Rendering

abstract class	TextureCube	extends	Disposable
		implements	ITextureCube

Public / Attributes

BitsPerTexel

The number of bits per texture pixel.

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

Format

The texture format.

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

HasAlpha

Returns if texture pixels carry transparency data.

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

IsSrgb

The sRGB behaviour of this texture.

public property	IsSrgb { get }
type	bool
value		The sRGB behaviour flag.
implements	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.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	Disposable.LifecycleState

MemoryConsumption

Returns the estimated memory consumption of this object.

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

Mipmaps

The number of mipmap levels.

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

NativeHandle

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

public abstract property	NativeHandle { get }
type	IntPtr
value		The raw handle value.
implements	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.

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

Public / Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
public method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	Disposable.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]
public method	Dispose ()
inherited	Disposable.Dispose

Remarks:

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

Face

Returns a cubemap face texture.

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

Protected / Attributes

format

The texture format.

protected field	format
type	TextureFormat

mipmaps

The number of mipmap levels.

protected readonly field	mipmaps
type	int32

size

The texture size.

protected readonly field	size
type	int32

Protected / Constructors

TextureCube

Creates a new instance of TextureCube.

protected constructor	TextureCube (int32 size, int32 mipmaps, TextureFormat format, bool srgb)
params	size	[>0]	The texture size, in texels.
	mipmaps	[>=0]	The number of mipmap levels.If 0 the number of levels will be inferred from size.
	format	[not-null]	The texture format.
	srgb		The sRGB behaviour.

Protected / Methods

DisposeManaged

Disposes the managed resources held by a concrete subclass. This method will be called at most once per subclass.

protected override method	DisposeManaged ()
overrides	Disposable.DisposeManaged

Remarks:

This method will only be called when a disposable object is explicitly destroyed by user code calling the Dispose method. It will not be called when the object is collected as garbage by the system.

Overriding methods must call the DisposeManaged method of their base class. The base call should be the last statement.

The DisposeManaged method is called before the DisposeUnmanaged method.

DisposeUnmanaged

Disposes the unmanaged resources held by a concrete subclass. This method will be called exactly once per subclass.

protected virtual method	DisposeUnmanaged ()
inherited	Disposable.DisposeUnmanaged

Remarks:

Overriding methods must call the DisposeUnmanaged method of their base class. The base call should be the last statement.

The DisposeUnmanaged method is called after the DisposeManaged method.