TexelBuffer

Description

abstract class Tinman.Terrain.Rendering.TexelBuffer

Derived from

Disposable abstract
IMemoryConsumption
IEquatable<TexelBuffer>
IBufferCodec
ITexelBufferInfo
IDisposableGeneric<TexelBuffer>
IConfigurable

Extended by

Example_TexelBuffer sealed
TexelBufferBitPattern abstract

TexelBuffer objects are used to generate texel data for updating textures.

See also

ITexture2D

Public / Constructors

From​Base85

[OwnerReturn]
public static method FromBase85 → (1)

value in : string

[not-null]
The base-85 encoded TXB file.

returns → TexelBuffer

The decoded buffer.

Decodes a buffer from the given base-85 encoded TXB file.

IOException

If value in is malformed.

See also

TexelBuffer.ToBase85

Read​TXB

3 overloads

[OwnerReturn]
public static method ReadTXB1 → (2)

file in : Path

[not-null]
The input file.

gamma opt : bool = true

Perform gamma correction?

returns → TexelBuffer

The TexelBuffer object.

Reads a texel buffer in TXB file format from the given file.

IOException

If an I/O error has occurred.

[OwnerReturn]
public static method ReadTXB2 → (2)

stream in : IDataStream own

[not-null]
The input data stream.

gamma opt : bool = true

Perform gamma correction?

returns → TexelBuffer

The TexelBuffer object.

Reads a texel buffer in TXB file format from the given data stream.

IOException

If an I/O error has occurred.

[OwnerReturn]
public static method ReadTXB3 → (3)

reader in : IBinaryReader

[not-null]
The binary reader.

pathInfo opt : IPathInfo = null

Optional IPathInfo object to use for error reporting.

gamma opt : bool = true

Perform gamma correction?

returns → TexelBuffer

The TexelBuffer object.

Reads a texel buffer in TXB file format from the given binary reader.

IOException

If an I/O error has occurred.

Public / Methods

Convert

[OwnerReturn] [OwnerThis]
public method Convert → (1)

format in : TextureFormat

[not-null]
The target format.

returns → TexelBuffer

The converted texel buffer.

Converts this texel buffer to the given format.

Copy​Bytes

public method CopyBytes → (6)

target in : ByteBuffer

[not-null]
The target buffer.

targetBlockStride in : int32

[>0]
The target buffer stride, in bytes. This value gives the distance between two adjacent texel block rows.

targetX opt : int32 = 0

[>=0]
X-coordinate of top-left texel in target buffer.

targetY opt : int32 = 0

[>=0]
Y-coordinate of top-left texel in target buffer.

sourceY opt : int32 = 0

[>=0]
Index of first texel block row in source buffer.

sourceN opt : int32 = -1

[>=-1]
Number of texel blocks rows in source buffer. If negative, all remaining texel block rows are used.

Copies texel data to the given buffer.

The given target X- and Y-coordinates must be a multiple of the texture format block size (see TextureFormat.BlockSize).

Copy​Texels

public method CopyTexels → (3)

target in : TexelBuffer

[not-null]
The target buffer.

targetX opt : int32 = 0

[0..target.Width-ITexelBufferInfo.Width]
X-coordinate to top-left corner of target region.

targetY opt : int32 = 0

[0..target.Height-ITexelBufferInfo.Height]
Y-coordinate to top-left corner of target region.

Copies all samples from this buffer to the given one.

The given target X- and Y-coordinates must be a multiple of the texture format block size (see TextureFormat.BlockSize).

From​Config​Embedded

public static method FromConfigEmbedded → (1)

value in : ConfigValue

[not-null]
The config value.

returns → int8 [ ]

The embedded TXB file.

Returns the embedded TXB file from the given config value.

ConfigException

If value in is invalid.

IOException

If the embedded TXB data is invalid.

See also

TexelBuffer.ToConfigEmbedded

Import​Pixels

[OwnerReturn]
public static method ImportPixels → (5)

input in : IImage

[not-null]
The input image.

format in : TextureFormat

[not-null]
The texture format.

mipmaps opt : int32 = 0

[>=0]
Number of mipmap levels to compute. If 0, all mipmap levels will be computed.

path opt : Path = null

Output path of texture file. If null, the file path of input in will be used, having the file suffix replaced with .txb.

srgb opt : bool = true

The ISrgb.Srgb flag of the importing texel buffer.

returns → IOperation

The import operation.

Returns an operation that imports image pixels into a TXB texture file.

Pixel​Decode

public method PixelDecode → (3)

target in : ColorBuffer

[not-null]
The color buffer that holds the decoded pixels.

targetX opt : int32 = 0

[0..target.Width-ITexelBufferInfo.Width]
X-coordinate of top-left target pixel.

targetY opt : int32 = 0

[0..target.Height-ITexelBufferInfo.Height]
Y-coordinate of top-left target pixel.

Decodes the texels in this buffer into the given pixel buffer.

See also

ISrgb.Srgb

Pixel​Encode

public method PixelEncode → (3)

source in : ColorBuffer

[not-null]
The color buffer that holds the source pixels.

sourceX opt : int32 = 0

[0..source.Width-ITexelBufferInfo.Width]
X-coordinate of top-left source pixel.

sourceY opt : int32 = 0

[0..source.Height-ITexelBufferInfo.Height]
Y-coordinate of top-left source pixel.

Encodes a block of pixels into this texel buffer.

See also

ISrgb.Srgb

Pixel​Encode​Mipmaps

public method PixelEncodeMipmaps → (2)

pixels in : ColorBuffer

[not-null]
The pixel buffer.

filter opt : DownsampleFilter = DownsampleFilter.Average

The filter to use for downsampling.

Encodes the given pixels and fills all texels in all mipmap levels.

See also

ISrgb.Srgb

Raw​Texels​Size

[Pure]
public method RawTexelsSize → (2)

stride opt : int32 = 0

[>=0]
The stride, in bytes. If 0, RawTexelsStride will be used.

blocks opt : int32 = 0

[>=0]
The number of block rows. If 0, the total number of block rows will be used.

returns → int32

The texel buffer size, in bytes.

Returns the size of the texel buffer.

See also

TexelBuffer.RawTexels
TexelBuffer.RawTexelsStride

Read​TXBInfo

3 overloads

public static method ReadTXBInfo1 → (1)

file in : Path

[not-null]
The input file.

returns → ITexelBufferInfo

The texel buffer metadata.

Reads a texel buffer metadata in TXB file format from the given file.

IOException

If an I/O error has occurred.

public static method ReadTXBInfo2 → (1)

stream in : IDataStream own

[not-null]
The input data stream.

returns → ITexelBufferInfo

The texel buffer metadata.

Reads a texel buffer metadata in TXB file format from the given data stream.

IOException

If an I/O error has occurred.

public static method ReadTXBInfo3 → (2)

reader in : IBinaryReader

[not-null]
The binary reader.

pathInfo opt : IPathInfo = null

Optional IPathInfo object to use for error reporting.

returns → ITexelBufferInfo

The texel buffer metadata.

Reads a texel buffer metadata in TXB file format from the given binary reader.

IOException

If an I/O error has occurred.

Scale

[OwnerReturn] [OwnerThis]
public method Scale → (3)

width in : int32

[>0]
The new width, in texels.

height in : int32

[>0]
The new height, in texels.

format opt : TextureFormat = null

The target format or null to use the format of this texel buffer.

returns → TexelBuffer

The scaled texel buffer.

Scales this texel buffer to the given dimensions.

To​Base85

public method ToBase85 → ()

returns → string

The encoded base-85 string.

Encodes this buffer as a TXB file with base-85.

See also

TexelBuffer.FromBase85

To​Color​Buffer

public method ToColorBuffer → ()

returns → ColorBuffer

The color buffer.

Helper method that converts this texel buffer into a new compact color buffer.

See also

TexelBuffer.PixelDecode

To​Color​Buffer​Own

[OwnerThis]
public method ToColorBufferOwn → ()

returns → ColorBuffer

The color buffer.

Helper method that converts this texel buffer into a new compact color buffer.

See also

TexelBuffer.PixelDecode

To​Config​Embedded

public static method ToConfigEmbedded → (1)

txb in : int8 [ ]

[not-null]
The embedded TXB file.

returns → ConfigValue

The config value.

Returns a config value for an embedded TXB file.

See also

TexelBuffer.FromConfigEmbedded

Write​TXB

3 overloads

public method WriteTXB1 → (1)

file in : Path

[not-null]
The output file.

Writes the texel data in this buffer to the given file, using the TXB file format.

IOException

If an I/O error has occurred.

public method WriteTXB2 → (1)

stream in : IDataStream own

[not-null]
The output data stream.

Writes the texel data in this buffer to the given data stream, using the TXB file format.

IOException

If an I/O error has occurred.

public method WriteTXB3 → (1)

writer in : IBinaryWriter

[not-null]
The output data stream.

Writes the texel data in this buffer to the given binary writer, using the TXB file format.

IOException

If an I/O error has occurred.

Public / Attributes

Height​Aligned

public attribute HeightAligned → (get)

value : int32

[>0]
The buffer height, always a multiple of the block size.

The texel buffer height aligned with the format block size.

Mipmap

public attribute Mipmap → (get)

value : TexelBuffer

The next smaller mipmap level buffer or null if this texel buffer is the last one in the mipmap chain.

Returns the next smaller mipmap level of this texel buffer.

Raw​Texels

public attribute RawTexels → (get)

value : IntPtr

Pointer to first texel.

Returns a pointer to the first texel.

See also

TexelBuffer.RawTexelsSize
TexelBuffer.RawTexelsStride

Raw​Texels​Stride

public attribute RawTexelsStride → (get)

value : int32

[>0]
The stride, in bytes.

Returns the stride of RawTexels.

The stride is the byte size of one row of texel blocks (see TextureFormat.BlockSize).

See also

TexelBuffer.RawTexels
TexelBuffer.RawTexelsSize

Width​Aligned

public attribute WidthAligned → (get)

value : int32

[>0]
The buffer width, always a multiple of the block size.

The texel buffer width, aligned with the format block size.

Protected / Constructors

Texel​Buffer

protected constructor TexelBuffer → (4)

width in : int32

[>0]
The buffer width, in texels.

height in : int32

[>0]
The buffer height, in texels.

format in : TextureFormat

[not-null]
The texture format.

mipmap in : TexelBuffer own

Texel buffer of next mipmap or null.

Creates a new instance of TexelBuffer.

Protected / Methods

Buffer​Decode​Internal

protected abstract method BufferDecodeInternal → (6)

input in : ByteBuffer

The encoded input texture data.

x in : int32

X-coordinate of top-left output texel.

y in : int32

Y-coordinate of top-left output texel.

width in : int32

Width of output texel block.

height in : int32

Height of output texel block.

temp in : ByteBuffer

A temporary byte buffer that has been returned by BufferTemp, may be null.

Decodes a block of texels from the storage format.

IOException

If the binary format input in is malformed.

Buffer​Encode​Internal

protected abstract method BufferEncodeInternal → (6)

output in : ByteBuffer

The encoded output texture data.

x in : int32

X-coordinate of top-left input texel.

y in : int32

Y-coordinate of top-left input texel.

width in : int32

Width of input texel block.

height in : int32

Height of input texel block.

temp in : ByteBuffer

A temporary byte buffer that has been returned by BufferTemp, may be null.

returns → int32

>0 : The number of bytes that have been written to output in.
<0 : The output buffer is too small, at least -1-n bytes are required, where n is the return value.

Encodes a block of texels into the storage format.

The storage format must be dependent on the native byte-order (see ByteBuffer.NativeOrder). The storage format may include additional compression techniques, for example RangeCompression.

Buffer​Temp

[OwnerReturn]
protected virtual method BufferTemp → ()

returns → ByteBuffer

The temporary buffer or null.

Creates the temporary buffer to use for BufferDecodeInternal resp. BufferEncodeInternal.

The default implementation returns null.

Pixel​Decode​Internal

protected abstract method PixelDecodeInternal → (3)

target in : ColorBuffer

The color buffer that holds the decoded pixels.

targetX in : int32

X-coordinate of top-left target pixel.

targetY in : int32

Y-coordinate of top-left target pixel.

Decodes the texels in this buffer into the given pixel buffer.

See also

ISrgb.Srgb

Pixel​Encode​Internal

protected abstract method PixelEncodeInternal → (3)

source in : ColorBuffer

The color buffer that holds the source pixels.

sourceX in : int32

X-coordinate of top-left source pixel.

sourceY in : int32

Y-coordinate of top-left source pixel.

Encodes a block of pixels into this texel buffer.

See also

ISrgb.Srgb

Protected / Attributes

bits​Per​Texel

protected readonly attribute bitsPerTexel → (int32)

Number of bits per texel.

format

protected attribute format → (TextureFormat)

The texture format.

height

protected readonly attribute height → (int32)

The buffer height, in texels.

height​Aligned

protected readonly attribute heightAligned → (int32)

The buffer height, aligned with the block size, in texels.

mipmaps

protected readonly attribute mipmaps → (int32)

The number of mipmap levels (including this).

srgb

protected attribute srgb → (bool)

Does this texel buffer store compressed sRGB pixel channel values?

stride

protected readonly attribute stride → (int32)

Distance between scanlines, in bytes.

texels

[Owner]
protected attribute texels → (ByteBuffer)

The texel buffer.

width

protected readonly attribute width → (int32)

The buffer width, in texels.

width​Aligned

protected readonly attribute widthAligned → (int32)

The buffer width, aligned with the block size, in texels.

Configuration

Config

public static attribute Config → (get)

value : IConfigurator<TexelBuffer>

[not-null]
The configurator object.

The configurator object for this type.