three.js / docs

x

Manual

Getting Started

  • Creating a scene
  • Import via modules
  • Browser support
  • WebGL compatibility check
  • How to run things locally
  • Drawing Lines
  • Creating Text
  • Migration Guide
  • Code Style Guide
  • FAQ
  • Useful links

Next Steps

  • How to update things
  • Matrix transformations
  • Animation System

Build Tools

  • Testing with NPM

Reference

Animation

  • AnimationAction
  • AnimationClip
  • AnimationMixer
  • AnimationObjectGroup
  • AnimationUtils
  • KeyframeTrack
  • PropertyBinding
  • PropertyMixer

Animation / Tracks

  • BooleanKeyframeTrack
  • ColorKeyframeTrack
  • NumberKeyframeTrack
  • QuaternionKeyframeTrack
  • StringKeyframeTrack
  • VectorKeyframeTrack

Audio

  • Audio
  • AudioAnalyser
  • AudioContext
  • AudioListener
  • PositionalAudio

Cameras

  • Camera
  • CubeCamera
  • OrthographicCamera
  • PerspectiveCamera
  • StereoCamera

Constants

  • Animation
  • Core
  • CustomBlendingEquation
  • DrawModes
  • Materials
  • Renderer
  • Textures

Core

  • BufferAttribute
  • BufferGeometry
  • Clock
  • DirectGeometry
  • EventDispatcher
  • Face3
  • Geometry
  • InstancedBufferAttribute
  • InstancedBufferGeometry
  • InstancedInterleavedBuffer
  • InterleavedBuffer
  • InterleavedBufferAttribute
  • Layers
  • Object3D
  • Raycaster
  • Uniform

Core / BufferAttributes

  • BufferAttribute Types

Deprecated

  • DeprecatedList

Extras

  • Earcut
  • ShapeUtils

Extras / Core

  • Curve
  • CurvePath
  • Font
  • Interpolations
  • Path
  • Shape
  • ShapePath

Extras / Curves

  • ArcCurve
  • CatmullRomCurve3
  • CubicBezierCurve
  • CubicBezierCurve3
  • EllipseCurve
  • LineCurve
  • LineCurve3
  • QuadraticBezierCurve
  • QuadraticBezierCurve3
  • SplineCurve

Extras / Objects

  • ImmediateRenderObject

Geometries

  • BoxBufferGeometry
  • BoxGeometry
  • CircleBufferGeometry
  • CircleGeometry
  • ConeBufferGeometry
  • ConeGeometry
  • CylinderBufferGeometry
  • CylinderGeometry
  • DodecahedronBufferGeometry
  • DodecahedronGeometry
  • EdgesGeometry
  • ExtrudeBufferGeometry
  • ExtrudeGeometry
  • IcosahedronBufferGeometry
  • IcosahedronGeometry
  • LatheBufferGeometry
  • LatheGeometry
  • OctahedronBufferGeometry
  • OctahedronGeometry
  • ParametricBufferGeometry
  • ParametricGeometry
  • PlaneBufferGeometry
  • PlaneGeometry
  • PolyhedronBufferGeometry
  • PolyhedronGeometry
  • RingBufferGeometry
  • RingGeometry
  • ShapeBufferGeometry
  • ShapeGeometry
  • SphereBufferGeometry
  • SphereGeometry
  • TetrahedronBufferGeometry
  • TetrahedronGeometry
  • TextBufferGeometry
  • TextGeometry
  • TorusBufferGeometry
  • TorusGeometry
  • TorusKnotBufferGeometry
  • TorusKnotGeometry
  • TubeBufferGeometry
  • TubeGeometry
  • WireframeGeometry

Helpers

  • ArrowHelper
  • AxesHelper
  • BoxHelper
  • Box3Helper
  • CameraHelper
  • DirectionalLightHelper
  • FaceNormalsHelper
  • GridHelper
  • PolarGridHelper
  • HemisphereLightHelper
  • PlaneHelper
  • PointLightHelper
  • RectAreaLightHelper
  • SkeletonHelper
  • SpotLightHelper
  • VertexNormalsHelper

Lights

  • AmbientLight
  • DirectionalLight
  • HemisphereLight
  • Light
  • PointLight
  • RectAreaLight
  • SpotLight

Lights / Shadows

  • DirectionalLightShadow
  • LightShadow
  • SpotLightShadow

Loaders

  • AnimationLoader
  • AudioLoader
  • BufferGeometryLoader
  • Cache
  • CompressedTextureLoader
  • CubeTextureLoader
  • DataTextureLoader
  • FileLoader
  • FontLoader
  • ImageBitmapLoader
  • ImageLoader
  • JSONLoader
  • Loader
  • LoaderUtils
  • MaterialLoader
  • ObjectLoader
  • TextureLoader

Loaders / Managers

  • DefaultLoadingManager
  • LoadingManager

Materials

  • LineBasicMaterial
  • LineDashedMaterial
  • Material
  • MeshBasicMaterial
  • MeshDepthMaterial
  • MeshLambertMaterial
  • MeshNormalMaterial
  • MeshPhongMaterial
  • MeshPhysicalMaterial
  • MeshStandardMaterial
  • MeshToonMaterial
  • PointsMaterial
  • RawShaderMaterial
  • ShaderMaterial
  • ShadowMaterial
  • SpriteMaterial

Math

  • Box2
  • Box3
  • Color
  • Cylindrical
  • Euler
  • Frustum
  • Interpolant
  • Line3
  • Math
  • Matrix3
  • Matrix4
  • Plane
  • Quaternion
  • Ray
  • Sphere
  • Spherical
  • Triangle
  • Vector2
  • Vector3
  • Vector4

Math / Interpolants

  • CubicInterpolant
  • DiscreteInterpolant
  • LinearInterpolant
  • QuaternionLinearInterpolant

Objects

  • Bone
  • Group
  • Line
  • LineLoop
  • LineSegments
  • LOD
  • Mesh
  • Points
  • Skeleton
  • SkinnedMesh
  • Sprite

Renderers

  • WebGLRenderer
  • WebGLRenderTarget
  • WebGLRenderTargetCube

Renderers / Shaders

  • ShaderChunk
  • ShaderLib
  • UniformsLib
  • UniformsUtils

Scenes

  • Fog
  • FogExp2
  • Scene

Textures

  • CanvasTexture
  • CompressedTexture
  • CubeTexture
  • DataTexture
  • DepthTexture
  • Texture
  • VideoTexture

Examples

Controls

  • OrbitControls

Geometries

  • ConvexBufferGeometry
  • ConvexGeometry
  • DecalGeometry

Loaders

  • BabylonLoader
  • GLTFLoader
  • MTLLoader
  • OBJLoader
  • OBJLoader2
  • LoaderSupport
  • PCDLoader
  • PDBLoader
  • SVGLoader
  • TGALoader
  • PRWMLoader

Objects

  • Lensflare

Exporters

  • GLTFExporter

Plugins

  • LookupTable
  • SpriteCanvasMaterial

QuickHull

  • Face
  • HalfEdge
  • QuickHull
  • VertexNode
  • VertexList

Renderers

  • CanvasRenderer
  • CSS3DRenderer
  • CSS2DRenderer

Utils

  • BufferGeometryUtils
  • SceneUtils

Developer Reference

Polyfills

  • Polyfills

WebGLRenderer

  • WebGLProgram
  • WebGLShader
  • WebGLState

WebGLRenderer / Plugins

  • SpritePlugin