struct SampleLayout in Tinman.Terrain.Imaging

Describes the layout of the samples of a raw pixel.

struct

SampleLayout

implements

IEquatable<SampleLayout>

Configuration

Config

The configurator object for this type.

public static property	Config { get }
type	IConfigurator<SampleLayout>
value	[not-null]	The configurator object.

ConfigSampleType

The configurator object for SampleType.

public static readonly field	ConfigSampleType
type	IConfigurator<SampleType>

Public / Attributes

BitDepth

public property	BitDepth { get }
type	int32
value

Endianess

Byte order of multibyte sample value.

public readonly field	Endianess
type	ByteOrder

Float32BE

32-bit big-endian floating point value.

public static readonly field	Float32BE
type	SampleLayout

Float32LE

32-bit little-endian floating point value.

public static readonly field	Float32LE
type	SampleLayout

Int16BE

Signed 16-bit big-endian integer.

public static readonly field	Int16BE
type	SampleLayout

Int16LE

Signed 16-bit little-endian integer.

public static readonly field	Int16LE
type	SampleLayout

Int8

Signed 8-bit integer.

public static readonly field	Int8
type	SampleLayout

IsFloat

public property	IsFloat { get }
type	bool
value

IsInteger

public property	IsInteger { get }
type	bool
value

IsSigned

public property	IsSigned { get }
type	bool
value

IsUnsigned

public property	IsUnsigned { get }
type	bool
value

IsValid

Is this raw sample layout valid?

public property	IsValid { get }
type	bool
value		true if the layout is valid, false if not.

PixelFormat

Returns the image pixel format for this raw sample layout.

public property	PixelFormat { get }
type	PixelFormat
value		The image pixel format.

SampleAlpha

Zero-based index of sample that maps to the alpha channel.

public readonly field	SampleAlpha
type	int32

Remarks:

If -1, no value is output to the alpha channel.

SampleBlue

Zero-based index of sample that maps to the blue channel.

public readonly field	SampleBlue
type	int32

Remarks:

If -1, no value is output to the blue channel.

SampleCount

Number of raw samples per pixel.

public readonly field	SampleCount
type	int32

SampleGreen

Zero-based index of sample that maps to the green channel.

public readonly field	SampleGreen
type	int32

Remarks:

If -1, no value is output to the green channel.

SampleRed

Zero-based index of sample that maps to the red channel.

public readonly field	SampleRed
type	int32

Remarks:

If -1, no value is output to the red channel.

Type

The sample data type.

public readonly field	Type
type	SampleType

UInt16BE

Unsigned 16-bit big-endian integer.

public static readonly field	UInt16BE
type	SampleLayout

UInt16LE

Unsigned 16-bit little-endian integer.

public static readonly field	UInt16LE
type	SampleLayout

UInt8

Unsigned 8-bit integer.

public static readonly field	UInt8
type	SampleLayout

Unknown

public static readonly field	Unknown
type	SampleLayout

Public / Methods

Equals

public method	Equals (SampleLayout other)
type	bool
params	other

Grayscale

Configures the mapping between raw sample values and pixel channels (i.e. red, green, blue and alpha).

[Pure]
public method	Grayscale (int32 sampleCount = 1, int32 sampleIntensity = 0, int32 sampleAlpha = -1)
type	SampleLayout
params	sampleCount	[>0]	Number of raw sample values per pixel. Defaults to 1.
	sampleIntensity	[-1..sampleCount-1]	Index of raw sample value that maps to the grayscale intensity channel or -1 if no mapping shall be done. Defaults to 0.
	sampleAlpha	[-1..sampleCount-1]	Index of raw sample value that maps to the alpha channel or -1 if no mapping shall be done. Defaults to -1.
returns			The resulting sample layout.

SameBinaryType

Checks if the given raw sample layout has the same binary format as this one.

public method	SameBinaryType (SampleLayout other)
type	bool
params	other		The other layout.
returns			true if both layouts have the same binary format, false if not.

Truecolor

Configures the mapping between raw sample values and pixel channels (i.e. red, green, blue and alpha).

public method	Truecolor (int32 sampleCount = 3, int32 sampleRed = 0, int32 sampleGreen = 1, int32 sampleBlue = 2, int32 sampleAlpha = -1)
type	SampleLayout
params	sampleCount	[>0]	Number of raw sample values per pixel. Defaults to 3.
	sampleRed	[-1..sampleCount-1]	Index of raw sample value that maps to the red channel or -1 if no mapping shall be done. Defaults to 0.
	sampleGreen	[-1..sampleCount-1]	Index of raw sample value that maps to the green channel or -1 if no mapping shall be done. Defaults to 1.
	sampleBlue	[-1..sampleCount-1]	Index of raw sample value that maps to the blue channel or -1 if no mapping shall be done. Defaults to 2.
	sampleAlpha	[-1..sampleCount-1]	Index of raw sample value that maps to the alpha channel or -1 if no mapping shall be done. Defaults to -1.
returns			The resulting sample layout.