Class TextureCopyInformation

Structure used for specifying information about a texture copy operation.

Index

Constructors

Properties

_destinationFace _destinationMip _destinationPosition _faceCount _sourceFace _sourceMip _sourceVolume

Accessors

destinationFace destinationMip destinationPosition faceCount sourceFace sourceMip sourceVolume

Methods

assign clone isEqual isEqual

Constructors

constructor

new TextureCopyInformation(
    sourceFace?: number,
    sourceMip?: number,
    sourceVolume?: Immutable<PixelVolume>,
    destinationFace?: number,
    destinationMip?: number,
    faceCount?: number,
    destinationPosition?: Immutable<Vector3>,
): TextureCopyInformation
Parameters
- OptionalsourceFace: number
- OptionalsourceMip: number
- OptionalsourceVolume: Immutable<PixelVolume>
- OptionaldestinationFace: number
- OptionaldestinationMip: number
- OptionalfaceCount: number
- OptionaldestinationPosition: Immutable<Vector3>
Returns TextureCopyInformation

Properties

`Protected`_destinationFace

_destinationFace: number

`Protected`_destinationMip

_destinationMip: number

`Protected`_destinationPosition

_destinationPosition: Vector3

`Protected`_faceCount

_faceCount: number

`Protected`_sourceFace

_sourceFace: number

`Protected`_sourceMip

_sourceMip: number

`Protected`_sourceVolume

_sourceVolume: PixelVolume

Accessors

destinationFace

get destinationFace(): number

Face to which to copy. This can be an entry in an array of textures, or a single face of a cube map. If cubemap array, then each array entry takes up six faces.

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

destinationMip

get destinationMip(): number

Mip level to which to copy.

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

destinationPosition

get destinationPosition(): Vector3

Coordinates to write the source pixels to. The destination texture must have enough pixels to fit the entire source volume.

Returns Vector3
set destinationPosition(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

faceCount

get faceCount(): number

Number of faces to copy.

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

sourceFace

get sourceFace(): number

Face from which to copy. This can be an entry in an array of textures, or a single face of a cube map. If cubemap array, then each array entry takes up six faces.

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

sourceMip

get sourceMip(): number

Mip level from which to copy.

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

sourceVolume

get sourceVolume(): PixelVolume

Pixel volume from which to copy from. This defaults to all pixels of the face.

Returns PixelVolume
set sourceVolume(value: Immutable<PixelVolume>): void
Parameters
- value: Immutable<PixelVolume>
Returns void

Methods

assign

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

clone

clone(): TextureCopyInformation

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

Returns TextureCopyInformation

isEqual

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

`Static`isEqual

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