Class BufferGeometry<Attributes>

A representation of mesh, line, or point geometry
Includes vertex positions, face indices, normals, colors, UVs, and custom attributes within buffers, reducing the cost of passing all this data to the GPU.

Remarks

To read and edit data in BufferGeometry attributes, see THREE.BufferAttribute | BufferAttribute documentation.

Example

const geometry = new THREE.BufferGeometry();

// create a simple square shape. We duplicate the top left and bottom right
// vertices because each vertex needs to appear once per triangle.
const vertices = new Float32Array( [
  -1.0, -1.0,  1.0, // v0
   1.0, -1.0,  1.0, // v1
   1.0,  1.0,  1.0, // v2

   1.0,  1.0,  1.0, // v3
  -1.0,  1.0,  1.0, // v4
  -1.0, -1.0,  1.0  // v5
] );

// itemSize = 3 because there are 3 values (components) per vertex
geometry.setAttribute( 'position', new THREE.BufferAttribute( vertices, 3 ) );
const material = new THREE.MeshBasicMaterial( { color: 0xff0000 } );
const mesh = new THREE.Mesh( geometry, material );

Example

const geometry = new THREE.BufferGeometry();

const vertices = new Float32Array( [
  -1.0, -1.0,  1.0, // v0
   1.0, -1.0,  1.0, // v1
   1.0,  1.0,  1.0, // v2
  -1.0,  1.0,  1.0, // v3
] );
geometry.setAttribute( 'position', new THREE.BufferAttribute( vertices, 3 ) );

const indices = [
  0, 1, 2,
  2, 3, 0,
];

geometry.setIndex( indices );
geometry.setAttribute( 'position', new THREE.BufferAttribute( vertices, 3 ) );

const material = new THREE.MeshBasicMaterial( { color: 0xff0000 } );
const mesh = new THREE.Mesh( geometry, material );

See

Type Parameters

Attributes extends NormalOrGLBufferAttributes = NormalBufferAttributes

Hierarchy (view full)

EventDispatcher<{
dispose: {};
}>
- BufferGeometry

Constructors

constructor

new BufferGeometry<Attributes>(): BufferGeometry<Attributes>
This creates a new THREE.BufferGeometry | BufferGeometry object.
Type Parameters
- Attributes extends NormalOrGLBufferAttributes = NormalBufferAttributes
Returns BufferGeometry<Attributes>
Overrides EventDispatcher.constructor
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:100

Properties

id

id: number

Unique number for this THREE.BufferGeometry | BufferGeometry instance.

Remarks

Expects a Integer

uuid

uuid: string

UUID of this object instance.

Remarks

This gets automatically assigned and shouldn't be edited.

name

name: string

Optional name for this THREE.BufferGeometry | BufferGeometry instance.

Default Value

''

`Readonly`type

type: string

A Read-only string to check if this object type.

Remarks

Sub-classes will update this value.

Default Value

BufferGeometry

index

index: null | BufferAttribute

Allows for vertices to be re-used across multiple triangles; this is called using "indexed triangles".
Each triangle is associated with the indices of three vertices. This attribute therefore stores the index of each vertex for each triangular face.
If this attribute is not set, the THREE.WebGLRenderer | renderer assumes that each three contiguous positions represent a single triangle.

Default Value

null

attributes

attributes: Attributes

This hashmap has as id the name of the attribute to be set and as value the THREE.BufferAttribute | buffer to set it to. Rather than accessing this property directly,
use .setAttribute and .getAttribute to access attributes of this geometry.

Default Value

{}

morphAttributes

morphAttributes: {
[name: string]: (BufferAttribute | InterleavedBufferAttribute)[];
}

Hashmap of THREE.BufferAttribute | BufferAttributes holding details of the geometry's morph targets.

Remarks

Once the geometry has been rendered, the morph attribute data cannot be changed.
You will have to call .dispose(), and create a new instance of THREE.BufferGeometry | BufferGeometry.

Default Value

{}

morphTargetsRelative

morphTargetsRelative: boolean

Used to control the morph target behavior; when set to true, the morph target data is treated as relative offsets, rather than as absolute positions/normals.

Default Value

false

groups

groups: GeometryGroup[]

Split the geometry into groups, each of which will be rendered in a separate WebGL draw call. This allows an array of materials to be used with the geometry.

Remarks

Every vertex and index must belong to exactly one group — groups must not share vertices or indices, and must not leave vertices or indices unused.

Default Value

[]

boundingBox

boundingBox: null | Box3

Bounding box for the THREE.BufferGeometry | BufferGeometry, which can be calculated with .computeBoundingBox().

Remarks

Bounding boxes aren't computed by default. They need to be explicitly computed, otherwise they are null.

Default Value

null

boundingSphere

boundingSphere: null | Sphere

Bounding sphere for the THREE.BufferGeometry | BufferGeometry, which can be calculated with .computeBoundingSphere().

Remarks

bounding spheres aren't computed by default. They need to be explicitly computed, otherwise they are null.

Default Value

null

drawRange

drawRange: {
start: number;
count: number;
}

Determines the part of the geometry to render. This should not be set directly, instead use .setDrawRange(...).

Remarks

For non-indexed THREE.BufferGeometry | BufferGeometry, count is the number of vertices to render.

Default Value

{ start: 0, count: Infinity }

userData

userData: Record<string, any>

An object that can be used to store custom data about the BufferGeometry. It should not hold references to functions as these will not be cloned.

Default Value

{}

`Readonly`isBufferGeometry

isBufferGeometry: true

Read-only flag to check if a given object is of type BufferGeometry.

Remarks

This is a constant value

Default Value

true

Methods

getIndex

getIndex(): null | BufferAttribute
Return the .index buffer.

Returns null | BufferAttribute
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:205

setIndex

setIndex(index): this
Set the THREE.BufferGeometry.index | .index buffer.
Parameters
- index: null | number[] | BufferAttribute
Returns this
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:211

setAttribute

setAttribute<K>(name, attribute): this
Sets an attribute to this geometry with the specified name.
Type Parameters
- K extends string | number | symbol
Parameters
- name: K
- attribute: Attributes[K]
Returns this
Remarks
Use this rather than the attributes property, because an internal hashmap of .attributes is maintained to speed up iterating over attributes.
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:220

getAttribute

getAttribute<K>(name): Attributes[K]
Returns the attribute with the specified name.
Type Parameters
- K extends string | number | symbol
Parameters
- name: K
Returns Attributes[K]
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:226

deleteAttribute

deleteAttribute(name): this
Deletes the attribute with the specified name.
Parameters
- name: keyof Attributes
Returns this
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:232

hasAttribute

hasAttribute(name): boolean
Returns true if the attribute with the specified name exists.
Parameters
- name: keyof Attributes
Returns boolean
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:238

addGroup

addGroup(start, count, materialIndex?): void
Adds a group to this geometry
Parameters
- start: number
- count: number
- OptionalmaterialIndex: number
Returns void
See
the groups property for details.
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:247

clearGroups

clearGroups(): void
Clears all groups.

Returns void
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:252

setDrawRange

setDrawRange(start, count): void
Set the .drawRange property
Parameters
- start: number
- count: number
  is the number of vertices or indices to render. Expects a Integer
Returns void
Remarks
For non-indexed BufferGeometry, count is the number of vertices to render
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:261

applyMatrix4

applyMatrix4(matrix): this
Applies the matrix transform to the geometry.
Parameters
- matrix: Matrix4
Returns this
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:267

applyQuaternion

applyQuaternion(quaternion): this
Applies the rotation represented by the quaternion to the geometry.
Parameters
- quaternion: Quaternion
Returns this
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:273

rotateX

rotateX(angle): this
Rotate the geometry about the X axis. This is typically done as a one time operation, and not during a loop.
Parameters
- angle: number
  radians. Expects a Float
Returns this
Remarks
Use THREE.Object3D.rotation | Object3D.rotation for typical real-time mesh rotation.
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:280

rotateY

rotateY(angle): this
Rotate the geometry about the Y axis.
Parameters
- angle: number
  radians. Expects a Float
Returns this
Remarks
This is typically done as a one time operation, and not during a loop.
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:288

rotateZ

rotateZ(angle): this
Rotate the geometry about the Z axis.
Parameters
- angle: number
  radians. Expects a Float
Returns this
Remarks
This is typically done as a one time operation, and not during a loop.
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:296

translate

translate(x, y, z): this
Translate the geometry.
Parameters
- x: number
  Expects a Float
- y: number
  Expects a Float
- z: number
  Expects a Float
Returns this
Remarks
This is typically done as a one time operation, and not during a loop.
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:306

scale

scale(x, y, z): this
Scale the geometry data.
Parameters
- x: number
  Expects a Float
- y: number
  Expects a Float
- z: number
  Expects a Float
Returns this
Remarks
This is typically done as a one time operation, and not during a loop.
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:316

lookAt

lookAt(vector): this
Rotates the geometry to face a point in space.
Parameters
- vector: Vector3
  A world vector to look at.
Returns this
Remarks
This is typically done as a one time operation, and not during a loop.
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:324

center

center(): this
Center the geometry based on the bounding box.

Returns this
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:329

setFromPoints

setFromPoints(points): this
Sets the attributes for this BufferGeometry from an array of points.
Parameters
- points: Vector3[] | Vector2[]
Returns this
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:335

computeBoundingBox

computeBoundingBox(): void
Computes the bounding box of the geometry, and updates the .boundingBox attribute. The bounding box is
not computed by the engine; it must be computed by your app. You may need to recompute the bounding box if the
geometry vertices are modified.

Returns void
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:342

computeBoundingSphere

computeBoundingSphere(): void
Computes the bounding sphere of the geometry, and updates the .boundingSphere attribute. The engine
automatically computes the bounding sphere when it is needed, e.g., for ray casting or view frustum culling. You
may need to recompute the bounding sphere if the geometry vertices are modified.

Returns void
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:349

computeTangents

computeTangents(): void
Calculates and adds a tangent attribute to this geometry.
The computation is only supported for indexed geometries and if position, normal, and uv attributes are defined

Returns void
Remarks
When using a tangent space normal map, prefer the MikkTSpace algorithm provided by
BufferGeometryUtils.computeMikkTSpaceTangents instead.
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:358

computeVertexNormals

computeVertexNormals(): void
Computes vertex normals for the given vertex data. For indexed geometries, the method sets each vertex normal to
be the average of the face normals of the faces that share that vertex. For non-indexed geometries, vertices are
not shared, and the method sets each vertex normal to be the same as the face normal.

Returns void
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:365

normalizeNormals

normalizeNormals(): void
Every normal vector in a geometry will have a magnitude of 1

Returns void
Remarks
This will correct lighting on the geometry surfaces.
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:371

toNonIndexed

toNonIndexed(): BufferGeometry<NormalBufferAttributes>
Return a non-index version of an indexed BufferGeometry.

Returns BufferGeometry<NormalBufferAttributes>
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:376

toJSON

toJSON(): {}
Convert the buffer geometry to three.js JSON Object/Scene format.

Returns {}
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:381

clone

clone(): this
Creates a clone of this BufferGeometry

Returns this
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:386

copy

copy(source): this
Copies another BufferGeometry to this BufferGeometry.
Parameters
- source: BufferGeometry<NormalBufferAttributes>
Returns this
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:392

dispose

dispose(): void
Frees the GPU-related resources allocated by this instance.

Returns void
Remarks
Call this method whenever this instance is no longer used in your app.
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:398

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{
  dispose: {};
  }[T], T, BufferGeometry<Attributes>>
  The function that gets called when the event is fired.
Returns void
Inherited from EventDispatcher.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:52
addEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, BufferGeometry<Attributes>>
Returns void
Inherited from EventDispatcher.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:56

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{
  dispose: {};
  }[T], T, BufferGeometry<Attributes>>
  The function that gets called when the event is fired.
Returns boolean
Inherited from EventDispatcher.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:63
hasEventListener<T>(type, listener): boolean
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, BufferGeometry<Attributes>>
Returns boolean
Inherited from EventDispatcher.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:67

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<{
  dispose: {};
  }[T], T, BufferGeometry<Attributes>>
  The listener function that gets removed.
Returns void
Inherited from EventDispatcher.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:74
removeEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, BufferGeometry<Attributes>>
Returns void
Inherited from EventDispatcher.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:78

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends "dispose"
Parameters
- event: BaseEvent<T> & {
  dispose: {};
  }[T]
  The event that gets fired.
Returns void
Inherited from EventDispatcher.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:84

Class BufferGeometry<Attributes>

Remarks

Example

Example

See

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns BufferGeometry<Attributes>

Properties

id

Remarks

uuid

Remarks

name

Default Value

Readonlytype

Remarks

Default Value

index

Default Value

attributes

Default Value

morphAttributes

Remarks

Default Value

morphTargetsRelative

Default Value

groups

Remarks

Default Value

boundingBox

Remarks

Default Value

boundingSphere

Remarks

Default Value

drawRange

Remarks

Default Value

userData

Default Value

ReadonlyisBufferGeometry

Remarks

Default Value

Methods

getIndex

Returns null | BufferAttribute

setIndex

Parameters

Returns this

setAttribute

Type Parameters

Parameters

Returns this

Remarks

getAttribute

Type Parameters

Parameters

Returns Attributes[K]

deleteAttribute

Parameters

Returns this

hasAttribute

Parameters

Returns boolean

addGroup

Parameters

Returns void

See

clearGroups

Returns void

setDrawRange

Parameters

`Readonly`type

`Readonly`isBufferGeometry