IModelTexture

Description

[ShutdownSurvive]
interface Tinman.Engine.Models.IModelTexture

Derived from: IPreloadingResourceHandle
IConfigurable
Extended by: IModelTextureDynamic
ModelTexture ^abstract

Base interface for classes that represent textures for 3D models.

IModelTexture objects act as resource handles and produce ITexture2D resource objects.

Public / Methods

Invert

public method Invert → (1)

channels ⁱⁿ : int32: The channels to invert:

1 : red
2 : green
4 : blue
8 : alpha

returns → IModelTexture: The resulting model texture.

Inverts the given channels of this model texture.

ReadElevation

public method ReadElevation → (1)

range ⁱⁿ : PixelRange: The pixel range to use (see ISampleBuffer.ScanlineRange).
returns → ElevationBuffer: The elevation data.

Reads elevation data.

IOException: If an I/O error has occurred while reading the pixel data.

ReadPixels

public method ReadPixels → ()

returns → ColorBuffer: The pixel data.

Reads pixel data.

IOException: If an I/O error has occurred while reading the pixel data.

ReadTexels

[OwnerReturn]
public method ReadTexels → ()

returns → TexelBuffer: The texture data.

Reads texture data.

IOException: If an I/O error has occurred while reading the texture data.

Swizzle

public method Swizzle → (4)

red ⁱⁿ : int32: [-5..5]
Swizzle operand that outputs the red channel.
green ⁱⁿ : int32: [-5..5]
Swizzle operand that outputs the green channel.
blue ⁱⁿ : int32: [-5..5]
Swizzle operand that outputs the blue channel.
alpha ⁱⁿ : int32: [-5..5]
Swizzle operand that outputs the alpha channel.
returns → IModelTexture: The resulting model texture.

Swizzles the color channels of this texture.

For each channel of the resulting texture, one of the following swizzle operands may be specified:

-5 : use constant minimum value
-4 : use inverse alpha channel of input
-3 : use inverse blue channel of input
-2 : use inverse green channel of input
-1 : use inverse red channel of input
0 : use grayscale intensity of input
1 : use red channel of input
2 : use green channel of input
3 : use blue channel of input
4 : use alpha channel of input
5 : use constant maximum value

Public / Attributes

PreferredTextureFormat

public attribute PreferredTextureFormat → (get)

value : TextureFormat: The preferred texture format or null.

The preferred format to use for this model texture.

Extensions

NormalMap

public static method NormalMap → (1)

height ^opt : float64 = 0.01: The relative bump height (see remarks).
returns → IModelTexture: The resulting model texture.

Interprets this model texture as a bump map and computes a normal map from it.

Black pixels lie in the XY plane (see figure), white pixels are at the given height ^opt. The height is specified relative to the size of this texture (i.e. maximum of width and height), e.g. a value of 1 would turn the cuboid below into a cube.

     .............
    .:          .:
Z+ . :         . :
| .  +--------.--+-- X+
|.  /        .  /
.............  /
: /         : /
:/          :/
+-----------+
           /
          Y+