Expand description
Ports of three.js/src/objects (plus Scene and the renderer’s QuadMesh).
Re-exports§
pub use batched_mesh::BatchCamera;pub use batched_mesh::BatchedMesh;pub use batched_mesh::CustomSort;pub use batched_mesh::GeometryInfo;pub use batched_mesh::MultiDrawItem;pub use batched_mesh::SortContext;
Structs§
- Batch
Camera - The camera state
onBeforeRender()needs. - Batched
Mesh BatchedMesh extends Mesh.- Bone
class Bone extends Object3D.- Clipping
Group ClippingGroup— aGroupwhose clipping planes clip every descendant, which is howWebGPURendererencodes clipping in the scene graph (Material.clippingPlanesandrenderer.clippingPlanesare WebGL-only).- Fog
Fog— linear fog: none beforenear, all fog fromfaron.- FogExp2
FogExp2— exponential squared fog of onedensity.- Geometry
Info - One entry of
_geometryInfo. - Group
Group— anObject3Dthat exists only to hold children, withtype = 'Group'andisGroup = true. three.js implements it as a subclass with no extra state, so here it is a constructor returning aObjectRef.- Instanced
Buffer Attribute new InstancedBufferAttribute( new Float32Array( count * 16 ), 16 ).- Instanced
Mesh InstancedMesh extends Mesh: one geometry and material, drawncounttimes with a per-instance transform (and optionally colour).- Line
- The state
Lineadds toObject3D:geometryandmaterial, exactly asMeshhas them. It lives in a node’sPayload— seedocs/scene-graph.md. - Line
Segments class LineSegments extends Line— a series of lines drawn between pairs of vertices, i.e.line-listrather thanline-strip. The only state it adds isisLineSegments, so it is a constructor onLine’s payload rather than a payload of its own.- Mesh
- The state
Meshadds toObject3D. It lives in a node’sPayloadrather than wrapping anObject3D, because the renderer finds meshes by walking the tree — seedocs/scene-graph.md. - Multi
Draw Item - One entry of
MultiDrawRenderList.list. - Points
- The state
Pointsadds toObject3D:geometryandmaterial, plus the non-standardcountthe compute examples set. - Quad
Mesh QuadMesh— draws one oversized triangle covering the full screen, for a post-processing pass.- Scene
Scene extends Object3D.- Skeleton
class Skeleton.- Skinned
Mesh class SkinnedMesh extends Mesh.- Sort
Context - What the page’s
sortFunctionreads offthisandcamera. three.js calls the custom sort withthisbound to the mesh and the camera as the second argument; the port hands it only the two values any sort on the ladder uses. - Sprite
- The state
Spriteadds toObject3D. It lives in a node’sPayload, asMesh’s does — seedocs/scene-graph.md.
Enums§
- Background
Scene.background. three.js accepts aColor, aTextureor aCubeTexture;Background.update()branches on which one it is — a colour becomes the clear value, anything else becomes the skybox mesh.- Bind
Mode AttachedBindMode/DetachedBindModefromsrc/constants.js.- Payload
- The subclass state of one
crate::core::Object3D. - Scene
Fog - What
scene.fogmay hold: aFogor aFogExp2.
Functions§
- is_bone
object.isBone.
Type Aliases§
- Custom
Sort BatchedMesh.customSort.