Class Conventions

Conventions used for a specific render backend.

Index

Constructors

Properties

_matrixOrder _ndcyAxis _uvyAxis

Accessors

matrixOrder ndcyAxis uvyAxis

Methods

assign clone isEqual isEqual

Constructors

constructor

new Conventions(
    uvyAxis?: EnumValue<AxisConvention>,
    ndcyAxis?: EnumValue<AxisConvention>,
    matrixOrder?: EnumValue<MatrixOrder>,
): Conventions
Parameters
- OptionaluvyAxis: EnumValue<AxisConvention>
- OptionalndcyAxis: EnumValue<AxisConvention>
- OptionalmatrixOrder: EnumValue<MatrixOrder>
Returns Conventions

Properties

`Protected`_matrixOrder

_matrixOrder: EnumValue<MatrixOrder>

`Protected`_ndcyAxis

_ndcyAxis: EnumValue<AxisConvention>

`Protected`_uvyAxis

_uvyAxis: EnumValue<AxisConvention>

Accessors

matrixOrder

get matrixOrder(): EnumValue<MatrixOrder>

Determines the order in which matrices are laid out in GPU programs.

Returns EnumValue<MatrixOrder>
set matrixOrder(value: EnumValue<MatrixOrder>): void
Parameters
- value: EnumValue<MatrixOrder>
Returns void

ndcyAxis

get ndcyAxis(): EnumValue<AxisConvention>

Determines the direction of the Y axis in normalized device coordinate (NDC) space.

Returns EnumValue<AxisConvention>
set ndcyAxis(value: EnumValue<AxisConvention>): void
Parameters
- value: EnumValue<AxisConvention>
Returns void

uvyAxis

get uvyAxis(): EnumValue<AxisConvention>

Determines the direction of the Y axis in UV (texture mapping) space.

Returns EnumValue<AxisConvention>
set uvyAxis(value: EnumValue<AxisConvention>): void
Parameters
- value: EnumValue<AxisConvention>
Returns void

Methods

assign

assign(other: Immutable<Conventions>): Conventions
Copies all properties defined by the prototype of Conventions from other to this instance.
Parameters
- other: Immutable<Conventions>
Returns Conventions

clone

clone(): Conventions

Clones this instance and returns a new Conventions with identical values.

Returns Conventions

isEqual

isEqual(this: Immutable<Conventions>, other: Immutable<Conventions>): boolean
Determines if this Conventions instance is equal to the other instance.
Parameters
- this: Immutable<Conventions>
- other: Immutable<Conventions>
Returns boolean

`Static`isEqual

isEqual(lhs: Immutable<Conventions>, rhs: Immutable<Conventions>): boolean
Determines if both Conventions instances are equal.
Parameters
- lhs: Immutable<Conventions>
- rhs: Immutable<Conventions>
Returns boolean