Class InstancedBufferAttribute

see https://github.com/mrdoob/three.js/blob/master/src/core/InstancedBufferAttribute.js|src/core/InstancedBufferAttribute.js

Hierarchy

BufferAttribute
- InstancedBufferAttribute

Index

Constructors

Properties

array count isBufferAttribute itemSize meshPerAttribute name normalized onUploadCallback updateRange usage version

Accessors

Constructors

constructor

new InstancedBufferAttribute(array: ArrayLike<number>, itemSize: number, normalized?: boolean, meshPerAttribute?: number): InstancedBufferAttribute
Parameters
- array: ArrayLike<number>
- itemSize: number
- Optional normalized: boolean
- Optional meshPerAttribute: number
Returns InstancedBufferAttribute
Overrides BufferAttribute.constructor
- Defined in node_modules/@types/three/src/core/InstancedBufferAttribute.d.ts:31

Properties

array

array: ArrayLike<number>

count

count: number

Default

0

`Readonly` isBufferAttribute

isBufferAttribute: true

itemSize

itemSize: number

meshPerAttribute

meshPerAttribute: number

Default

1

name

name: string

Default

''

normalized

normalized: boolean

Default

false

onUploadCallback

onUploadCallback: (() => void)

Type declaration

- (): void
- Returns void

updateRange

updateRange: {
count: number;
offset: number;
}

Default

Type declaration

count: number
offset: number

usage

usage: Usage

Default

THREE.StaticDrawUsage

version

version: number

Default

0

Accessors

needsUpdate

set needsUpdate(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from BufferAttribute.needsUpdate
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:43

Methods

applyMatrix3

applyMatrix3(m: Matrix3): InstancedBufferAttribute
Parameters
- m: Matrix3
Returns InstancedBufferAttribute
Inherited from BufferAttribute.applyMatrix3
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:58

applyMatrix4

applyMatrix4(m: Matrix4): InstancedBufferAttribute
Parameters
- m: Matrix4
Returns InstancedBufferAttribute
Inherited from BufferAttribute.applyMatrix4
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:59

applyNormalMatrix

applyNormalMatrix(m: Matrix3): InstancedBufferAttribute
Parameters
- m: Matrix3
Returns InstancedBufferAttribute
Inherited from BufferAttribute.applyNormalMatrix
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:60

clone

clone(): InstancedBufferAttribute
Returns InstancedBufferAttribute
Inherited from BufferAttribute.clone
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:50

copy

copy(source: BufferAttribute): InstancedBufferAttribute
Parameters
- source: BufferAttribute
Returns InstancedBufferAttribute
Inherited from BufferAttribute.copy
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:51

copyArray

copyArray(array: ArrayLike<number>): InstancedBufferAttribute
Parameters
- array: ArrayLike<number>
Returns InstancedBufferAttribute
Inherited from BufferAttribute.copyArray
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:53

copyAt

copyAt(index1: number, attribute: BufferAttribute, index2: number): InstancedBufferAttribute
Parameters
- index1: number
- attribute: BufferAttribute
- index2: number
Returns InstancedBufferAttribute
Inherited from BufferAttribute.copyAt
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:52

copyColorsArray

copyColorsArray(colors: {
    b: number;
    g: number;
    r: number;
}[]): InstancedBufferAttribute
Parameters
- colors: {
      b: number;
      g: number;
      r: number;
  }[]
Returns InstancedBufferAttribute
Inherited from BufferAttribute.copyColorsArray
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:54

copyVector2sArray

copyVector2sArray(vectors: {
x: number;
y: number;
}[]): InstancedBufferAttribute
Parameters
- vectors: {
  x: number;
  y: number;
  }[]
Returns InstancedBufferAttribute
Inherited from BufferAttribute.copyVector2sArray
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:55

copyVector3sArray

copyVector3sArray(vectors: {
    x: number;
    y: number;
    z: number;
}[]): InstancedBufferAttribute
Parameters
- vectors: {
      x: number;
      y: number;
      z: number;
  }[]
Returns InstancedBufferAttribute
Inherited from BufferAttribute.copyVector3sArray
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:56

copyVector4sArray

copyVector4sArray(vectors: {
    w: number;
    x: number;
    y: number;
    z: number;
}[]): InstancedBufferAttribute
Parameters
- vectors: {
      w: number;
      x: number;
      y: number;
      z: number;
  }[]
Returns InstancedBufferAttribute
Inherited from BufferAttribute.copyVector4sArray
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:57

getW

getW(index: number): number
Parameters
- index: number
Returns number
Inherited from BufferAttribute.getW
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:69

getX

getX(index: number): number
Parameters
- index: number
Returns number
Inherited from BufferAttribute.getX
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:63

getY

getY(index: number): number
Parameters
- index: number
Returns number
Inherited from BufferAttribute.getY
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:65

getZ

getZ(index: number): number
Parameters
- index: number
Returns number
Inherited from BufferAttribute.getZ
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:67

onUpload

onUpload(callback: (() => void)): InstancedBufferAttribute
Parameters
- callback: (() => void)
  - - (): void
    - Returns void
Returns InstancedBufferAttribute
Inherited from BufferAttribute.onUpload
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:48

set

set(value: ArrayBufferView | ArrayLike<number>, offset?: number): InstancedBufferAttribute
Parameters
- value: ArrayBufferView | ArrayLike<number>
- Optional offset: number
Returns InstancedBufferAttribute
Inherited from BufferAttribute.set
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:62

setUsage

setUsage(usage: Usage): InstancedBufferAttribute
Parameters
- usage: Usage
Returns InstancedBufferAttribute
Inherited from BufferAttribute.setUsage
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:49

setW

setW(index: number, z: number): InstancedBufferAttribute
Parameters
- index: number
- z: number
Returns InstancedBufferAttribute
Inherited from BufferAttribute.setW
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:70

setX

setX(index: number, x: number): InstancedBufferAttribute
Parameters
- index: number
- x: number
Returns InstancedBufferAttribute
Inherited from BufferAttribute.setX
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:64

setXY

setXY(index: number, x: number, y: number): InstancedBufferAttribute
Parameters
- index: number
- x: number
- y: number
Returns InstancedBufferAttribute
Inherited from BufferAttribute.setXY
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:71

setXYZ

setXYZ(index: number, x: number, y: number, z: number): InstancedBufferAttribute
Parameters
- index: number
- x: number
- y: number
- z: number
Returns InstancedBufferAttribute
Inherited from BufferAttribute.setXYZ
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:72

setXYZW

setXYZW(index: number, x: number, y: number, z: number, w: number): InstancedBufferAttribute
Parameters
- index: number
- x: number
- y: number
- z: number
- w: number
Returns InstancedBufferAttribute
Inherited from BufferAttribute.setXYZW
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:73

setY

setY(index: number, y: number): InstancedBufferAttribute
Parameters
- index: number
- y: number
Returns InstancedBufferAttribute
Inherited from BufferAttribute.setY
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:66

setZ

setZ(index: number, z: number): InstancedBufferAttribute
Parameters
- index: number
- z: number
Returns InstancedBufferAttribute
Inherited from BufferAttribute.setZ
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:68

toJSON

toJSON(): {
    array: number[];
    itemSize: number;
    normalized: boolean;
    type: string;
}
Returns {
    array: number[];
    itemSize: number;
    normalized: boolean;
    type: string;
}
- array: number[]
- itemSize: number
- normalized: boolean
- type: string
Inherited from BufferAttribute.toJSON
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:74

transformDirection

transformDirection(m: Matrix4): InstancedBufferAttribute
Parameters
- m: Matrix4
Returns InstancedBufferAttribute
Inherited from BufferAttribute.transformDirection
- Defined in node_modules/@types/three/src/core/BufferAttribute.d.ts:61

Generated using TypeDoc