Class TextureSurface

References a subset of surfaces within a texture.

Index

Constructors

Properties

_face _facesCount _isBoundAsArray _mipLevel _mipLevelsCount

Accessors

face facesCount isBoundAsArray mipLevel mipLevelsCount

Methods

assign clone isEqual isEqual

Constructors

constructor

new TextureSurface(
    mipLevel?: number,
    mipLevelsCount?: number,
    face?: number,
    facesCount?: number,
    isBoundAsArray?: boolean,
): TextureSurface
Parameters
- OptionalmipLevel: number
- OptionalmipLevelsCount: number
- Optionalface: number
- OptionalfacesCount: number
- OptionalisBoundAsArray: boolean
Returns TextureSurface

Properties

`Protected`_face

_face: number

`Protected`_facesCount

_facesCount: number

`Protected`_isBoundAsArray

_isBoundAsArray: boolean

`Protected`_mipLevel

_mipLevel: number

`Protected`_mipLevelsCount

_mipLevelsCount: number

Accessors

face

get face(): number

First face to reference. Face can represent a single cubemap face, or a single array entry in a texture array. If cubemaps are laid out in a texture array then every six sequential faces represent a single array entry.

Returns number
set face(value: number): void
Parameters
- value: number
Returns void

facesCount

get facesCount(): number

Number of faces to reference, if the texture has more than one.

Returns number
set facesCount(value: number): void
Parameters
- value: number
Returns void

isBoundAsArray

get isBoundAsArray(): boolean

If the texture is a cubemap or a 3D texture this will force it to be bound as a 2D texture array.

Returns boolean
set isBoundAsArray(value: boolean): void
Parameters
- value: boolean
Returns void

mipLevel

get mipLevel(): number

First mip level to reference.

Returns number
set mipLevel(value: number): void
Parameters
- value: number
Returns void

mipLevelsCount

get mipLevelsCount(): number

Number of mip levels to reference. Must be greater than zero.

Returns number
set mipLevelsCount(value: number): void
Parameters
- value: number
Returns void

Methods

assign

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

clone

clone(): TextureSurface

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

Returns TextureSurface

isEqual

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

`Static`isEqual

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