@pixi/3d
Website
GitHub
Discord
Preparing search index...
@pixi/3d
getting-started
Introduction
Installation
Quick start
Porting from Three.js
core-concepts
Scene graph and transforms
View3D and 2D content
Resources and cleanup
WebGL and WebGPU
How a frame renders
Performance
scene
Overview
AmbientLight
BatchedMesh3D
BatchInstanceData
BatchMatrices
Camera3D
Container3D
DirectionalLight
Light
Mesh3D
Model3D
ParticleContainer3D
ParticleMaterial
PointLight
Skeleton
SpotLight
Sprite3D
View3D
MAX_LIGHTS
particleAlphaOverLifeBit
particleColorOverLifeBit
particleFlipbookOverLifeBit
particleFlipbookRateBit
particleLifetimeBit
particleMotionBit
particleSizeOverLifeBit
particleSpinBit
getParticleBit
packParticleColor
packParticleFrames
AmbientLightOptions
BatchedMesh3DOptions
BatchedMesh3DSlot
Camera3DOptions
Container3DEvents
Container3DOptions
DirectionalLightOptions
InstanceDataField
LightOptions
LightShadow
LightShadowBoundsOptions
LightShadowCascadesOptions
LightShadowCommonOptions
Mesh3DOptions
Model3DOptions
ParticleBitOptions
ParticleBuiltInValues
ParticleContainer3DOptions
ParticleContainerViews
ParticleMaterialOptions
PointLightOptions
Size3D
SkeletonOptions
SpotLightOptions
Sprite3DOptions
View3DFromOptions
View3DOptions
BillboardMode
CameraMode
CullMode
Destroy3DOptions
InstanceDataOptions
InstanceDataType
LightShadowOptions
LightType
MaterialOverrides
ParticleAttributeValue
ParticleBillboardMode
ParticleBlendMode
ParticleDeclaredValues
ParticleSpace
ParticleValueFor
ParticleValues
materials
Overview
BaseMaterial3D
FlatMaterial
Material3D
PhongMaterial
linearToSrgb
srgbToLinear
stateFor3D
AnisotropyOptions
AnisotropyProps
BaseMaterial3DOptions
ClearcoatOptions
ClearcoatProps
EmissiveOptions
EmissiveProps
IridescenceOptions
IridescenceProps
Material3DData
Material3DOptions
Material3DTextures
MaterialData
MaterialTextures
PassDescriptor
PassDescriptorOptions
PhongData
PhongMaterialOptions
PhongMaterialTextures
SheenOptions
SheenProps
SpecularOptions
SpecularProps
TransmissionOptions
TransmissionProps
AlphaMode
ColorSpace
FlatMaterialOptions
environment
Environment and IBL
Fog
Hemisphere
FogType
ToneMapping
assets
Loading models
Scene3DSource
dracoDecoderUrls
loadCubemap
loadGlb
loadGltf
loadHdr
setDracoDecoderPath
HdrAssetData
Scene3DEntry
animation
Animation
Animation
AnimationPlayer
AnimationState
NumberTrack
QuaternionTrack
Track
Vector3Track
AnimationOptions
AnimationPlayerOptions
TrackOptions
InterpolationMode
events
Interaction
EventBoundary3D
createRaycastHit3D
Event3DFields
Federated3DOptions
HitResult3D
IFederatedContainer3D
IHitVolume3D
IView3DEvents
Pointer3DEvent
RaycastHit3D
Wheel3DEvent
FederatedEventMap3D
GlobalFederatedEventMap3D
HitVolume3DInput
Pointer3DEventHandler
Wheel3DEventHandler
rendering
Rendering 2D into 3D
BackgroundPass
BlendedRefractionPass
ColorCubeTexture
ContainerSource
ContainerTexture
CopyDepthPass
CopyOpaquePass
ForwardRenderPass
FullscreenPass
MeshPass
OutputPass
Pass3D
PassBuilder
RenderGraph
RenderPass
ShaderDescriptor
TransmissionRenderPass
alphaMaskBit
instanceFetchBitGl
mathConstantsBit
passthroughFragment
RenderPassBit
screenSpaceFuncsBit
uvTransformBit
createDefaultGraph3D
createLightingBit
BackgroundPassOptions
BlendedRefractionPassOptions
ContainerSourceOptions
CopyDepthPassOptions
CopyOpaquePassOptions
CreateLightingBitOptions
DefaultGraph3DHandles
DefaultGraph3DOptions
ForwardRenderPassOptions
FullscreenPassOptions
GlobalTextureBindings
GraphRenderPass
MeshPassOptions
OutputPassOptions
Pass3DOptions
PassContext
RenderGraphOptions
RenderPassOptions
RenderSession
ResourceAccess
ResourceHandle
SceneOutput
ShaderBitTemplate
ShaderDescriptorOptions
TextureBinding
TransientTextureOptions
TransmissionRenderPassOptions
AccessMode
BindingGroup
BindingSpec
BindingType
BindingVisibility
ColorHandle
ContainerTextureOptions
DepthHandle
EffectStage
FragmentOutputType
InterStage
InterStageType
PassStage
ReadonlyRect
ResourceKind
ResourceType
SceneOutputPass
SceneStage
ShaderBit
ShaderOverrideDef
ShaderOverrideType
ShadowFilter
ShadowQuality
StructDefinition
TemplateBindGroup
UniformBufferType
UniformGroupBindings
extras:post-processing
Post-processing
BloomEffect
ExtractPass
FxaaEffect
MotionBlurEffect
OutlinePass
PortalPass
SsaoEffect
TiltShiftEffect
TintEffect
WireframePass
normalOutput
velocityOutput
mirrorCameraThroughPortal
portalExitClipPlane
solidMeshDescriptor
BloomEffectOptions
ExtractPassOptions
FxaaEffectOptions
MotionBlurEffectOptions
OutlinePassOptions
PortalPassOptions
SolidMeshDescriptorOptions
SsaoEffectOptions
TiltShiftEffectOptions
TintEffectOptions
WireframePassOptions
extras:particles
Particles
BoxShape
ConeShape
ParticleSystem3D
PointShape
SphereShape
BoxShapeOptions
ConeShapeOptions
EmitterShape
ParticleBurst
ParticleSpawnBuiltInOverrides
ParticleSystem3DOptions
ParticleSystemValues
SphereShapeOptions
ParticleFrameMode
ParticleSpawnOverrides
ParticleSpawnValue
ParticleSpread
maths
Math
Box
Cylindrical
Frustum
Matrix3
Matrix4
ObservableQuaternion
ObservableVector3
Plane
Quaternion
Ray
Sphere
Spherical
Vector2
Vector3
Vector4
seededRandom
PointData3D
PointData4D
PointLike3D
PointLike4D
QuaternionData
SHAPE_PRIMITIVE_3D
TypedFixedArray
geometry
CapsuleGeometry
ConeGeometry
CubeGeometry
CylinderGeometry
Geometry3D
IcosahedronGeometry
PlaneGeometry
SphereGeometry
TorusGeometry
TorusKnotGeometry
getAttributeData
CapsuleGeometryOptions
ConeGeometryOptions
CubeGeometryOptions
CylinderGeometryOptions
Geometry3DOptions
IcosahedronGeometryOptions
PlaneGeometryOptions
SphereGeometryOptions
TorusGeometryOptions
TorusKnotGeometryOptions
extras:camera
FPSCamera
OrbitCamera
FPSCameraOptions
OrbitCameraOptions
OrbitMouseButtons
OrbitTouches
OrbitMouseAction
OrbitTouchAction
extras:materials
PortalMaterial
ToonMaterial
dissolveBit
glossBit
toonLightingBit
toonMaterialBit
PortalData
PortalMaterialOptions
PortalMaterialTextures
ToonData
ToonMaterialOptions
extras:debug
Debugging
DepthMapViewer
GeometryThumbnailGenerator
GraphDebugOverlay
GraphDebugRecording
RenderGraphDebugger
VelocityViewer
GRAPH_DEBUG_RECORDING_VERSION
GRAPH_DEBUG_SNAPSHOT_VERSION
captureGraphDebugSnapshot
DepthMapViewerOptions
GeometryThumbnailGeneratorOptions
GeometryThumbnailReady
GeometryThumbnailUnsupported
GraphDebugAccessSnapshot
GraphDebugBatchPassSnapshot
GraphDebugBatchSnapshot
GraphDebugBundleCause
GraphDebugBundleSnapshot
GraphDebugDrawBuildSnapshot
GraphDebugDrawRebuildCause
GraphDebugDrawSnapshot
GraphDebugGeometrySnapshot
GraphDebugGraphSnapshot
GraphDebugMaterialSnapshot
GraphDebugMeshSnapshot
GraphDebugOverlayOptions
GraphDebugPassSnapshot
GraphDebugRecordedFrame
GraphDebugRecordingOptions
GraphDebugRecordingSnapshot
GraphDebugResourceSnapshot
GraphDebugSnapshot
GraphDebugSummarySnapshot
GraphDebugTextureBindingSnapshot
GraphDebugTextureSnapshot
RenderGraphDebuggerOptions
VelocityViewerOptions
GeometryThumbnailResult
GeometryThumbnailUnsupportedReason
GraphDebugBundleCauseCode
GraphDebugDrawRebuildCauseCode
GraphDebugRecordingStopReason
GraphDebugRecordResult
GraphDebugScenePassKind
RenderGraphDebugSource
filters
PostEffect
EffectFragment
EffectIO
PostEffectOptions
Settings
Member Visibility
Inherited
Advanced
Theme
OS
Light
Dark
On This Page
getting-started
Introduction
Installation
Quick start
Porting from
Three.js
core-concepts
Scene graph and transforms
View3
D and 2
D content
Resources and cleanup
Web
GL and
Web
GPU
How a frame renders
Performance
scene
Overview
Ambient
Light
Batched
Mesh3
D
Batch
Instance
Data
Batch
Matrices
Camera3
D
Container3
D
Directional
Light
Light
Mesh3
D
Model3
D
Particle
Container3
D
Particle
Material
Point
Light
Skeleton
Spot
Light
Sprite3
D
View3
D
MAX_
LIGHTS
particle
Alpha
Over
Life
Bit
particle
Color
Over
Life
Bit
particle
Flipbook
Over
Life
Bit
particle
Flipbook
Rate
Bit
particle
Lifetime
Bit
particle
Motion
Bit
particle
Size
Over
Life
Bit
particle
Spin
Bit
get
Particle
Bit
pack
Particle
Color
pack
Particle
Frames
Ambient
Light
Options
Batched
Mesh3
D
Options
Batched
Mesh3
D
Slot
Camera3
D
Options
Container3
D
Events
Container3
D
Options
Directional
Light
Options
Instance
Data
Field
Light
Options
Light
Shadow
Light
Shadow
Bounds
Options
Light
Shadow
Cascades
Options
Light
Shadow
Common
Options
Mesh3
D
Options
Model3
D
Options
Particle
Bit
Options
Particle
Built
In
Values
Particle
Container3
D
Options
Particle
Container
Views
Particle
Material
Options
Point
Light
Options
Size3
D
Skeleton
Options
Spot
Light
Options
Sprite3
D
Options
View3
D
From
Options
View3
D
Options
Billboard
Mode
Camera
Mode
Cull
Mode
Destroy3
D
Options
Instance
Data
Options
Instance
Data
Type
Light
Shadow
Options
Light
Type
Material
Overrides
Particle
Attribute
Value
Particle
Billboard
Mode
Particle
Blend
Mode
Particle
Declared
Values
Particle
Space
Particle
Value
For
Particle
Values
materials
Overview
Base
Material3
D
Flat
Material
Material3
D
Phong
Material
linear
To
Srgb
srgb
To
Linear
state
For3
D
Anisotropy
Options
Anisotropy
Props
Base
Material3
D
Options
Clearcoat
Options
Clearcoat
Props
Emissive
Options
Emissive
Props
Iridescence
Options
Iridescence
Props
Material3
D
Data
Material3
D
Options
Material3
D
Textures
Material
Data
Material
Textures
Pass
Descriptor
Pass
Descriptor
Options
Phong
Data
Phong
Material
Options
Phong
Material
Textures
Sheen
Options
Sheen
Props
Specular
Options
Specular
Props
Transmission
Options
Transmission
Props
Alpha
Mode
Color
Space
Flat
Material
Options
environment
Environment and
IBL
Fog
Hemisphere
Fog
Type
Tone
Mapping
assets
Loading models
Scene3
D
Source
draco
Decoder
Urls
load
Cubemap
load
Glb
load
Gltf
load
Hdr
set
Draco
Decoder
Path
Hdr
Asset
Data
Scene3
D
Entry
animation
Animation
Animation
Animation
Player
Animation
State
Number
Track
Quaternion
Track
Track
Vector3
Track
Animation
Options
Animation
Player
Options
Track
Options
Interpolation
Mode
events
Interaction
Event
Boundary3
D
create
Raycast
Hit3
D
Event3
D
Fields
Federated3
D
Options
Hit
Result3
D
I
Federated
Container3
D
I
Hit
Volume3
D
I
View3
D
Events
Pointer3
D
Event
Raycast
Hit3
D
Wheel3
D
Event
Federated
Event
Map3
D
Global
Federated
Event
Map3
D
Hit
Volume3
D
Input
Pointer3
D
Event
Handler
Wheel3
D
Event
Handler
rendering
Rendering 2
D into 3
D
Background
Pass
Blended
Refraction
Pass
Color
Cube
Texture
Container
Source
Container
Texture
Copy
Depth
Pass
Copy
Opaque
Pass
Forward
Render
Pass
Fullscreen
Pass
Mesh
Pass
Output
Pass
Pass3
D
Pass
Builder
Render
Graph
Render
Pass
Shader
Descriptor
Transmission
Render
Pass
alpha
Mask
Bit
instance
Fetch
Bit
Gl
math
Constants
Bit
passthrough
Fragment
Render
Pass
Bit
screen
Space
Funcs
Bit
uv
Transform
Bit
create
Default
Graph3
D
create
Lighting
Bit
Background
Pass
Options
Blended
Refraction
Pass
Options
Container
Source
Options
Copy
Depth
Pass
Options
Copy
Opaque
Pass
Options
Create
Lighting
Bit
Options
Default
Graph3
D
Handles
Default
Graph3
D
Options
Forward
Render
Pass
Options
Fullscreen
Pass
Options
Global
Texture
Bindings
Graph
Render
Pass
Mesh
Pass
Options
Output
Pass
Options
Pass3
D
Options
Pass
Context
Render
Graph
Options
Render
Pass
Options
Render
Session
Resource
Access
Resource
Handle
Scene
Output
Shader
Bit
Template
Shader
Descriptor
Options
Texture
Binding
Transient
Texture
Options
Transmission
Render
Pass
Options
Access
Mode
Binding
Group
Binding
Spec
Binding
Type
Binding
Visibility
Color
Handle
Container
Texture
Options
Depth
Handle
Effect
Stage
Fragment
Output
Type
Inter
Stage
Inter
Stage
Type
Pass
Stage
Readonly
Rect
Resource
Kind
Resource
Type
Scene
Output
Pass
Scene
Stage
Shader
Bit
Shader
Override
Def
Shader
Override
Type
Shadow
Filter
Shadow
Quality
Struct
Definition
Template
Bind
Group
Uniform
Buffer
Type
Uniform
Group
Bindings
extras:post-processing
Post-
processing
Bloom
Effect
Extract
Pass
Fxaa
Effect
Motion
Blur
Effect
Outline
Pass
Portal
Pass
Ssao
Effect
Tilt
Shift
Effect
Tint
Effect
Wireframe
Pass
normal
Output
velocity
Output
mirror
Camera
Through
Portal
portal
Exit
Clip
Plane
solid
Mesh
Descriptor
Bloom
Effect
Options
Extract
Pass
Options
Fxaa
Effect
Options
Motion
Blur
Effect
Options
Outline
Pass
Options
Portal
Pass
Options
Solid
Mesh
Descriptor
Options
Ssao
Effect
Options
Tilt
Shift
Effect
Options
Tint
Effect
Options
Wireframe
Pass
Options
extras:particles
Particles
Box
Shape
Cone
Shape
Particle
System3
D
Point
Shape
Sphere
Shape
Box
Shape
Options
Cone
Shape
Options
Emitter
Shape
Particle
Burst
Particle
Spawn
Built
In
Overrides
Particle
System3
D
Options
Particle
System
Values
Sphere
Shape
Options
Particle
Frame
Mode
Particle
Spawn
Overrides
Particle
Spawn
Value
Particle
Spread
maths
Math
Box
Cylindrical
Frustum
Matrix3
Matrix4
Observable
Quaternion
Observable
Vector3
Plane
Quaternion
Ray
Sphere
Spherical
Vector2
Vector3
Vector4
seeded
Random
Point
Data3
D
Point
Data4
D
Point
Like3
D
Point
Like4
D
Quaternion
Data
SHAPE_
PRIMITIVE_
3
D
Typed
Fixed
Array
geometry
Capsule
Geometry
Cone
Geometry
Cube
Geometry
Cylinder
Geometry
Geometry3
D
Icosahedron
Geometry
Plane
Geometry
Sphere
Geometry
Torus
Geometry
Torus
Knot
Geometry
get
Attribute
Data
Capsule
Geometry
Options
Cone
Geometry
Options
Cube
Geometry
Options
Cylinder
Geometry
Options
Geometry3
D
Options
Icosahedron
Geometry
Options
Plane
Geometry
Options
Sphere
Geometry
Options
Torus
Geometry
Options
Torus
Knot
Geometry
Options
extras:camera
FPS
Camera
Orbit
Camera
FPS
Camera
Options
Orbit
Camera
Options
Orbit
Mouse
Buttons
Orbit
Touches
Orbit
Mouse
Action
Orbit
Touch
Action
extras:materials
Portal
Material
Toon
Material
dissolve
Bit
gloss
Bit
toon
Lighting
Bit
toon
Material
Bit
Portal
Data
Portal
Material
Options
Portal
Material
Textures
Toon
Data
Toon
Material
Options
extras:debug
Debugging
Depth
Map
Viewer
Geometry
Thumbnail
Generator
Graph
Debug
Overlay
Graph
Debug
Recording
Render
Graph
Debugger
Velocity
Viewer
GRAPH_
DEBUG_
RECORDING_
VERSION
GRAPH_
DEBUG_
SNAPSHOT_
VERSION
capture
Graph
Debug
Snapshot
Depth
Map
Viewer
Options
Geometry
Thumbnail
Generator
Options
Geometry
Thumbnail
Ready
Geometry
Thumbnail
Unsupported
Graph
Debug
Access
Snapshot
Graph
Debug
Batch
Pass
Snapshot
Graph
Debug
Batch
Snapshot
Graph
Debug
Bundle
Cause
Graph
Debug
Bundle
Snapshot
Graph
Debug
Draw
Build
Snapshot
Graph
Debug
Draw
Rebuild
Cause
Graph
Debug
Draw
Snapshot
Graph
Debug
Geometry
Snapshot
Graph
Debug
Graph
Snapshot
Graph
Debug
Material
Snapshot
Graph
Debug
Mesh
Snapshot
Graph
Debug
Overlay
Options
Graph
Debug
Pass
Snapshot
Graph
Debug
Recorded
Frame
Graph
Debug
Recording
Options
Graph
Debug
Recording
Snapshot
Graph
Debug
Resource
Snapshot
Graph
Debug
Snapshot
Graph
Debug
Summary
Snapshot
Graph
Debug
Texture
Binding
Snapshot
Graph
Debug
Texture
Snapshot
Render
Graph
Debugger
Options
Velocity
Viewer
Options
Geometry
Thumbnail
Result
Geometry
Thumbnail
Unsupported
Reason
Graph
Debug
Bundle
Cause
Code
Graph
Debug
Draw
Rebuild
Cause
Code
Graph
Debug
Recording
Stop
Reason
Graph
Debug
Record
Result
Graph
Debug
Scene
Pass
Kind
Render
Graph
Debug
Source
filters
Post
Effect
Effect
Fragment
Effect
IO
Post
Effect
Options
Website
GitHub
Discord
@pixi/3d
Loading...