Interface IFloatMatrix

Namespace

Gamelogic.Fx

Assembly

Gamelogic.Fx.dll

Represents a read-only view of a two-dimensional matrix of float values.

public interface IFloatMatrix

Properties

Height

Gets the height of the matrix.

int Height { get; }

Property Value

int

this[int, int]

Gets the value at the specified column and row.

float this[int x, int y] { get; }

Parameters

x int

The column index.

y int

The row index.

Property Value

float

this[int2]

Gets the value at the specified 2D index.

float this[int2 index] { get; }

Parameters

index int2

The column (x) and row (y) index.

Property Value

float

Length

Gets the total number of values in the matrix.

int Length { get; }

Property Value

int

Values

Gets the matrix values as a flat, row-major sequence.

IEnumerable<float> Values { get; }

Property Value

IEnumerable<float>

Width

Gets the width of the matrix.

int Width { get; }

Property Value

int

Methods

IsValid()

Returns whether this matrix is in a valid state (dimensions and value array are consistent).

bool IsValid()

Returns

bool

Normalize()

Returns a copy of this matrix with all values scaled so that the maximum value is 1.

IFloatMatrix Normalize()

Returns

IFloatMatrix

A normalized copy, or this matrix unchanged if all values are zero.

SetFrom(IFloatMatrix)

Sets the values and dimensions of this matrix from another matrix.

void SetFrom(IFloatMatrix other)

Parameters

other IFloatMatrix

The source matrix to copy from.