Documentation / scene
scene
A modern, modular 3D rendering framework built on top of the @zephyr3d/device API.
Remarks
This package provides a complete, extensible rendering stack targeting WebGPU/WebGL backends through @zephyr3d/device. It offers scene graph management, materials and shaders, forward-plus style lighting passes, shadow mapping, post-processing, GPU picking, animation, and a robust app/runtime layer to orchestrate rendering and resource lifecycles.
Enumerations
- ConstraintType
- ColliderForce
- HumanoidBodyRig
- HumanoidHandRig
- PostEffectLayer
- OctreePlacement
- MaterialVaryingFlags
Classes
- AnimationClip
- AnimationController
- AnimationPlayback
- AnimationSet
- AnimationTimeline
- AnimationTimelineRunner
- AnimationTrack
- GPUClothComponent
- GPUClothSystem
- NodeEulerRotationTrack
- FixedGeometryCacheTrack
- GPUHairSimulation
- CCDSolver
- FABRIKSolver
- IKAngleConstraint
- IKChain
- IKConstraint
- IKSolver
- TwoBoneIKSolver
- IKModifier
- JointDynamicsSystemController
- JointDynamicsSystem
- JointDynamicsModifier
- MorphTargetGroupTrack
- MorphTargetTrack
- PCAGeometryCacheTrack
- PropertyTrack
- NodeRotationTrack
- NodeScaleTrack
- SkeletonRig
- SkinBinding
- Skeleton
- SkeletonModifier
- MultiChainSpringSystem
- SpringChain
- SpringSystem
SpringModifier- NodeTranslationTrack
- Application
- Engine
- InputManager
- RuntimeScript
- ScreenAdapter
- ScriptingSystem
- ScriptRegistry
- AssetManager
- NamedObject
- AssetHierarchyNode
- AssetSkeleton
- AssetScene
- SharedModel
- AvatarOutfitInstance
- AvatarWardrobe
- Blitter
- BoxFilterBlitter
- CopyBlitter
- GaussianBlurBlitter
- BaseCameraController
- Camera
- FPSCameraController
- OrbitCameraController
- OrthoCamera
- PerspectiveCamera
- BlinnMaterial
- EyeMaterial
- GrassMaterial
- HairMaterial
- HairStrandMaterial
- HairStrandData
- LambertMaterial
- Material
- MeshMaterial
- MToonMaterial
- ParticleMaterial
- PBRBluePrintMaterial
- PBRBluePrintMaterialInstance
- PBRMetallicRoughnessMaterial
- PBRSpecularGlossinessMaterial
- ShaderHelper
- SkinMaterial
- SpriteMaterial
- StandardSpriteMaterial
- SpriteBlueprintMaterial
- SubsurfaceProfile
- ClipmapTerrainMaterial
- UnlitMaterial
- Bloom
- ColorAdjust
- Compositor
- FXAA
- Grayscale
- AbstractPostEffect
- SAO
- SkinSSS
- SSGI
- Tonemap
- ABufferOIT
- CullVisitor
- DepthPass
- DualDepthPeelingOIT
- EnvironmentLighting
- EnvShIBL
- EnvConstantAmbient
- EnvHemisphericAmbient
- FBMWaveGenerator
- FFTWaveGenerator
- GerstnerWaveGenerator
- OIT
- Primitive
- InstanceBindGroupAllocator
- RenderQueue
- RGBlackboard
- DevicePoolAllocator
- RenderGraphExecutor
- HistoryResourceManager
- OrderingScope
- RenderPipeline
- RenderGraph
- RGTextureAffinityCache
- RGHandle
- RGSubpass
- RenderPass
- RenderTarget
- ScreenRenderTarget
- ShadowMapPass
- SkyRenderer
- WaterDisturber
- WaterInteraction
- WeightedBlendedOIT
- BaseSprite
- BatchGroup
- EnvLightWrapper
- Environment
- GraphNode
- HairNode
- BaseLight
- PunctualLight
- DirectionalLight
- PointLight
- SpotLight
- RectLight
- Mesh
- ProxyDrawableBase
- ProxyDrawable
- MeshDrawableBase
- MeshDrawable
- MSDFText
- MSDFTextSprite
- OctreeNode
- OctreeNodeChunk
- Octree
- ParticleSystem
- RaycastVisitor
- Scene
- SceneNode
- ScriptAttachment
- Sprite
- GrassLayer
- GrassRenderer
- ClipmapTerrain
- TextSprite
- Water
- WaterSurfaceSampler
- ShadowRegion
- ShadowMapper
- BoxShape
- BoxFrameShape
- CapsuleShape
- CylinderShape
- PlaneShape
- Shape
- SphereShape
- TetrahedronShape
- TetrahedronFrameShape
- TorusShape
- FontAsset
- MSDFTextAtlasManager
- AABBTree
- ConstantScalarNode
- ConstantBooleanNode
- ConstantVec2Node
- ConstantBVec2Node
- ConstantVec3Node
- ConstantBVec3Node
- ConstantVec4Node
- ConstantBVec4Node
- MakeVectorNode
- SwizzleNode
- CompComparisonNode
- AnyConditionNode
- AllConditionNode
- SelectionNode
- TransformNode
- RotateAboutAxisNode
- GenericMathNode
- Degrees2RadiansNode
- Radians2DegreesNode
- SinNode
- CosNode
- TanNode
- ArcSinNode
- ArcCosNode
- ArcTanNode
- ArcTan2Node
- SinHNode
- CosHNode
- TanHNode
- ArcsineHNode
- ArccosineHNode
- ArctangentHNode
- ExpNode
- Exp2Node
- LogNode
- Log2Node
- SqrtNode
- InvSqrtNode
- AbsNode
- SignNode
- FloorNode
- CeilNode
- FractNode
- DDXNode
- DDYNode
- FWidthNode
- CompAddNode
- CompSubNode
- CompMulNode
- CompDivNode
- ModNode
- MinNode
- MaxNode
- PowNode
- StepNode
- SmoothStepNode
- FmaNode
- ClampNode
- SaturateNode
- MixNode
- NormalizeNode
- FaceForwardNode
- ReflectNode
- RefractNode
- LengthNode
- DistanceNode
- LogicallyAndNode
- LogicallyOrNode
- EqualNode
- NotEqualNode
- DotProductNode
- CrossProductNode
- SimplexNoise2DNode
- PerlinNoise2DNode
- Hash1Node
- Hash2Node
- Hash3Node
- FunctionCallNode
- FunctionInputNode
- FunctionOutputNode
- VertexOutputNode
- VertexIndexNode
- InstanceIndexNode
- VertexColorNode
- VertexUVNode
- VertexPositionNode
- PixelWorldPositionNode
- VertexNormalNode
- PixelNormalNode
- VertexTangentNode
- VertexBinormalNode
- ProjectionMatrixNode
- ViewMatrixNode
- ViewProjMatrixNode
- InvProjMatrixNode
- InvViewProjMatrixNode
- BillboardMatrixNode
- ElapsedTimeNode
- CameraPositionNode
- CameraVectorNode
- SkyEnvTextureNode
- CameraNearFarNode
- ResolveVertexPositionNode
- ResolveVertexNormalNode
- ResolveVertexTangentNode
- MaterialBlueprintIR
- PBRBlockNode
- VertexBlockNode
- SpriteBlockNode
- BaseTextureNode
- ConstantTexture2DNode
- ConstantTexture2DArrayNode
- ConstantTextureCubeNode
- PannerNode
- TextureSampleNode
- TexturePropertyNode
- ChannelSDFMaskNode
- MorphBlurNode
- TextureSampleGrad
- BaseGraphNode
- BoundingBox
- BuoyancyVolume
- FloatingBody
- DracoMeshDecoder
- ResourceManager
- CubemapSHProjector
Interfaces
- TwistConstraint
- IKJoint
- CollisionResult
- LineCollisionResult
- SurfaceCheckResult
- NearestPointsResult
- ConstraintBuildOptions
- PhysicsCurves
- ControllerConfig
- JointDynamicsColliderHandle
- JointDynamicsFlatPlaneHandle
- JointDynamicsGrabberHandle
- JointDynamicsColliderSnapshot
- JointDynamicsFlatPlaneSnapshot
- JointDynamicsGrabberSnapshot
- SimulationParams
- ApplyResultOutput
- PointR
- PointRW
- Constraint
- ColliderR
- ColliderRW
- GrabberR
- GrabberRW
- AngleLimitConfig
- FlatPlane
- PointInit
- TransformAccess
- BoneNode
- SkinnedBoundingBox
- InterChainConstraint
- MultiChainSpringSystemOptions
- SpringPoseReinitializeOptions
- SpringCollider
- SphereCollider
- CapsuleCollider
- PlaneCollider
- SpringConstraint
- SpringParticle
- SpringSystemOptions
- AppOptions
- AppCreationOptions
- IRenderable
- IRenderHook
- IAttachedScript
- ModelLoader
- AssetSamplerInfo
- AssetImageInfo
- AssetVertexBufferInfo
- AssetPrimitiveInfo
- AssetTextureInfo
- MaterialTextureInfo
- AssetMaterialCommon
- AssetMaterial
- AssetUnlitMaterial
- AssetMToonMaterial
- AssetMaterialSheen
- AssetMaterialClearcoat
- AssetMaterialTransmission
- AssetMaterialIridescence
- AssetPBRMaterialCommon
- AssetPBRMaterialMR
- AssetPBRMaterialSG
- AssetSubMeshData
- AssetMeshData
- AssetMorphTargetBinding
- AssetMorphTargetGroup
- AssetAnimationTrack
- AssetGeometryCacheFrame
- AssetFixedGeometryCacheAnimationTrack
- AssetPCAGeometryCacheAnimationTrack
- AssetAnimationData
- AssetSkeletalAnimationTrack
- AssetRotationTrack
- AssetTranslationTrack
- AssetScaleTrack
- AssetSpringBoneCollider
- AssetSpringBoneColliderGroup
- AssetSpringBoneJoint
- AssetSpringBone
- AssetJointDynamicsCollider
- AssetJointDynamicsChain
- AssetJointDynamicsFlatPlane
- AssetJointDynamicsSpringBone
- IBaseEvent
- IModKey
- IControllerMouseEvent
- IControllerPointerDownEvent
- IControllerPointerUpEvent
- IControllerPointerMoveEvent
- IControllerPointerCancelEvent
- IControllerWheelEvent
- IControllerKeyboardEvent
- IControllerKeydownEvent
- IControllerKeyupEvent
- IControllerKeypressEvent
- FPSCameraControllerOptions
- OrbitCameraControllerOptions
- IMixinFoliage
- IMixinVertexColor
- PBRBlueprintOutputInputs
- PBRBluePrintMaterialInstanceDiscardedOverrides
- CompositorBuildLayerOptions
- CompositorBuildLayerResult
- PostEffectHistoryRead
- PostEffectOutput
- PostEffectSetupContext
- DrawContext
- Drawable
- BatchDrawable
- InstanceData
- RenderQueueItem
- RenderItemListInfo
- RenderItemListBundle
- RenderItemList
- RenderQueueRef
- DrawableInstanceInfo
- ForwardPlusOptions
- ForwardPlusModuleContext
- FrameGraphContext
- FrameResourceRequirements
- RenderContext
- RenderModuleReadDescriptor
- RenderModulePreparation
- RenderModule
- SceneRenderOptions
- SceneRenderQueueBuilder
- PersistentSceneQueue
- SceneRenderContext
- RGTextureDesc
- RGExecuteContext
- RGWriteOptions
- RGPassBuilder
- RGResourceLifetime
- CompiledRenderGraph
- RGProfilingOptions
- RenderGraphExecutorOptions
- RenderGraphExecutionBindings
- RGProfileScopeResult
- RGProfileResult
- RGResolvedSize
- RGFramebufferDesc
- RGTextureAllocator
- UnderwaterState
- WaveGenerator
- MorphBoundingInfo
- MorphSourceDescriptor
- MorphTargetSourceData
- SceneMorphTargetBinding
- SceneMorphTargetGroup
- SerializedMorphTargetBinding
- SerializedMorphTargetGroup
- Visitor
- SurfacePointHit
- WaterSurfaceSource
- WaterSurfaceSamplerOptions
- BoxCreationOptions
- CapsuleCreationOptions
- CylinderCreationOptions
- PlaneCreationOptions
- ShapeCreationOptions
- SphereCreationOptions
- TetrahedronCreationOptions
- TorusCreationOptions
- IRUniformValue
- BluePrintUniformValue
- IRUniformTexture
- BluePrintUniformTexture
- BluePrintEditorState
- MaterialBlueprintIRBehaviors
- NodeConnection
- GraphStructure
- BlueprintDAG
- IGraphNode
- BoundingVolume
- BuoyancyVolumeOptions
- FloatingBodyOptions
- Metadata
Type Aliases
- AnimationTimeRef
- AnimationMarker
- AnimationControllerStateDefinition
- AnimationControllerSetStateOptions
- AnimationControllerEventMap
- SkeletalAnimationMaskRootMotionMode
- SkeletalAnimationMaskUnsupportedTrackMode
- HumanoidSkeletalAnimationMaskPreset
- JointNameMatcher
- SkeletalAnimationMaskCommonOptions
- HumanoidSkeletalAnimationMaskOptions
- NamedJointsSkeletalAnimationMaskOptions
- SkeletalAnimationMaskOptions
- AnimationPlaybackSyncMode
- AnimationPlaybackSyncOptions
- PlayAnimationOptions
- StopAnimationOptions
- AnimationPlaybackState
- AnimationStopReason
- AnimationPlaybackEvent
- AnimationMarkerEvent
- AnimationFrameEvent
- AnimationPlaybackStopEvent
- AnimationPlaybackEventMap
- AnimationSetEventMap
- HumanoidRootMotionMode
- HumanoidRootMotionScaleMode
- HumanoidHipsTranslationMode
- HumanoidRetargetAxisLocks
- CopyHumanoidAnimationOptions
- AnimationTimelineActiveDisposition
- AnimationTimelineStateReturnTarget
- AnimationTimelineEventTarget
- AnimationTimelineEventPolicy
- AnimationTimelineEventResult
- AnimationTimelineEventResponse
- AnimationTimelineStep
- AnimationTimelineDefinition
- AnimationTimelineRunnerEventMap
- AnimationTimelineRunnerState
- GPUClothColliderConfig
- GPUClothWrapTargetConfig
- GPUClothComponentConfig
- GPUClothSystemOptions
- GPUClothWrapBindingData
- GPUClothWrapBindingTarget
- FixedGeometryCacheFrame
- FixedGeometryCacheState
- GeometryCacheFrame
- GeometryCacheState
- GeometryCacheMeshBinding
- GPUHairSimulationOptions
- ControllerConfigUpdate
- JointChainConfig
- JointDynamicSystemConfig
- MorphState
- PCAGeometryCacheTrackData
- PCAGeometryCacheState
- HumanoidJointMapping
- SkeletonBindPose
- SkeletonRigOptions
- EditorMode
- LogMode
- RenderFunc
- InputEventHandler
- RuntimeScriptPropertyType
- RuntimeScriptValueType
- RuntimeScriptPropertyOptions
- RuntimeScriptValueDeclaration
- RuntimeScriptObjectFieldDeclaration
- RuntimeScriptObjectDeclaration
- RuntimeScriptArrayElementDeclaration
- RuntimeScriptArrayDeclaration
- RuntimeScriptPropertyDeclaration
- RuntimeScriptPropertyInfo
- RuntimeScriptConfig
- ScreenScaleMode
- ScreenConfig
- PointTransform
- ResolutionTransform
- Host
- ScriptingSystemOptions
- BaseFetchOptions
- FontAssetFetchOptions
- TextureFetchOptions
- ModelFetchOptions
- ModelInfo
- ZHairBufferRef
- ZHairStrandSetJSON
- ZHairFileJSON
- ParsedZHair
- ZHairStrandSetSource
- ZHairEncodeOptions
- ZHairLoadOptions
- AssetGeometryCacheAnimationTrack
- AssetSpringBoneColliderShape
- SaveOptions
- AvatarSlotId
- AvatarBindMode
- AvatarFitMode
- AvatarOutfitSource
- AvatarBodyRegionTarget
- AvatarBodyRegions
- AvatarJointMap
- AvatarSlotOptions
- AvatarWardrobeOptions
- AvatarEquipOptions
- AvatarOutfitValidation
- BlitType
- PickResult
- CameraHistoryData
- RenderPath
- CameraOITMode
- SSSDebugView
- SSSQualityPreset
- SSSResolvedSettings
- SSGIQualityPreset
- SSGIResolvedSettings
- HairStrandDirection
- HairShadingModel
- HairStrandSource
- BlendMode
- ExtractMixinReturnType
- ExtractMixinType
- InstanceUniformType
- IMixinAlbedoColor
- IMixinBlinnPhong
- IMixinLambert
- IMixinPBRBluePrint
- PBRReflectionMode
- IMixinPBRMetallicRoughness
- IMixinPBRSpecularGlossiness
- IMixinLight
- IMixinPBRCommon
- ToMixedTextureType
- TextureMixinTypes
- TextureMixinInstanceTypes
- TextureProp
- TexturePropUniforms
- MToonOutlineWidthMode
- PBRBlueprintOutputName
- PBRBlueprintOutputMap
- SubsurfaceProfilePreset
- TerrainDebugMode
- WaterMediumMode
- WaterRefractionMode
- WaterDebugOutput
- PickTarget
- MorphData
- SkinInfluenceData
- MorphInfo
- EnvLightType
- CachedBindGroup
- FrameResourceKey
RenderModuleContext- RenderModuleRead
- RGSizeMode
- RGHandleKind
- RGTextureHandle
- RGFramebufferHandle
- RGTokenHandle
- RGExecuteFn
- RGProfileScopeType
- RGTextureAttachment
- SkyType
- FogType
- WaterInteractionFollowMode
- WaterDisturberShape
- MeshUpdateCallback
- EmitterShape
- EmitterBehavior
- NodeIterateFunc
- SceneNodeVisible
- ScriptAttachmentConfig
- ShadowMode
- ShadowQualityPreset
- ShapeType
- ShapeOptionType
- FontAssetMSDFAtlasSettings
- PairAdjustment
- GlyphPoint
- GlyphContour
- GlyphData
- FontMetrics
- MSDFOptions
- MSDFBitmap
- EdgeColor
- ColoredLineEdge
- ColoredQuadraticEdge
- ColoredEdge
- MSDFShape
- ComparisonMode
- GraphNodeInput
- GraphNodeOutput
- WaveHeightFn
- SamplerType
- LightingMode
- CameraProjectionMode
- CameraSensorFit
- PropertyType
- PropertyToType
- PropertyValue
- PropEdit
- PropertySceneNodeOptions
- PropertyAccessorOptions
- PropertyAccessor
- SerializableClass
Variables
- EPSILON
- ZHAIR_VERSION
- MAX_CAUSTIC_WATERS
- SKIN_SSS_LDR_ENCODE_RANGE
- FrameResources
- ForwardPlusModules
- RGHistoryResources
- TAA_DEBUG_NONE
- TAA_DEBUG_CURRENT_COLOR
- TAA_DEBUG_HISTORY_COLOR
- TAA_DEBUG_VELOCITY
- TAA_DEBUG_EDGE
- TAA_DEBUG_ALAPH
- TAA_DEBUG_MOTION_VECTOR
- TAA_DEBUG_STRENGTH
- STANDARD_GRAVITY
- PHYSICAL_BAKE_EXPOSURE
- RENDER_PASS_TYPE_LIGHT
- RENDER_PASS_TYPE_SHADOWMAP
- RENDER_PASS_TYPE_DEPTH
- RENDER_PASS_TYPE_OBJECT_COLOR
- BUILTIN_ASSET_TEXTURE_SHEEN_LUT
- BUILTIN_ASSET_TEST_CUBEMAP
- LIGHT_TYPE_NONE
- LIGHT_TYPE_DIRECTIONAL
- LIGHT_TYPE_POINT
- LIGHT_TYPE_SPOT
- LIGHT_TYPE_RECT
- MAX_SHADOW_MASK_LIGHTS
- QUEUE_OPAQUE
- QUEUE_TRANSPARENT
- MORPH_TARGET_POSITION
- MORPH_TARGET_NORMAL
- MORPH_TARGET_TANGENT
- MORPH_TARGET_COLOR
- MORPH_TARGET_TEX0
- MORPH_TARGET_TEX1
- MORPH_TARGET_TEX2
- MORPH_TARGET_TEX3
- MAX_MORPH_ATTRIBUTES
- DEFAULT_MORPH_TARGET_LIMIT
- DEFAULT_ACTIVE_MORPH_TARGET_LIMIT
- MAX_MORPH_TARGETS
- DEFAULT_SKIN_INFLUENCE_LIMIT
- MAX_SKIN_INFLUENCES
- MAX_SKIN_EXTRA_INFLUENCE_PAIRS
- MORPH_WEIGHTS_VECTOR_COUNT
- MORPH_ATTRIBUTE_VECTOR_COUNT
- MAX_TERRAIN_MIPMAP_LEVELS
- MAX_GERSTNER_WAVE_COUNT
- ATMOSPHERIC_FOG_BIT
- HEIGHT_FOG_BIT
Functions
- normalizeGPUClothComponentConfig
- isGPUClothSupported
- createGPUClothWrapBindingData
- createGeometryCacheState
- mixGeometryCacheBoundingBox
- ensureGeometryCacheMeshBinding
- restoreGeometryCacheMeshBinding
- isHairSimulationSupported
- pushoutFromSphere
- pushoutFromCollider
- pushoutFromCapsule
- pushInFromSphere
- pushInFromCollider
- pushInFromCapsule
- collisionDetectionSphere
- collisionDetectionCapsule
- collisionDetection
- pushInCollisionDetection
- computeNearestPoints
- checkSurfaceCollision
- buildConstraints
- buildSurfaceFaces
- computeMaxDepth
- sortRootPointsByProximity
- createTransformAccess
- simulate
- applyResult
- applyAngleLimits
- createSphereCollider
- createCapsuleCollider
- createPlaneCollider
- resolveSphereCollision
- resolveCapsuleCollision
- resolvePlaneCollision
- updateColliderFromNode
- createSpringConstraint
- createSpringParticle
- getApp
- tryGetApp
- getEngine
- getDevice
- getInput
- scriptProp
- getRuntimeScriptProperties
- normalizeRuntimeScriptConfig
- applyRuntimeScriptConfig
- encodeZHair
- parseZHair
- isZHair
- readZHairFloats
- readZHairUints
- loadZHairStrandSources
- mergeHairStrandSources
- applyMeshMorphMetadata
- createMorphSourceDataFromSubMesh
- applyMeshMorphData
- applyMeshSkinInfluenceData
- applyMaterialMixins
- mixinAlbedoColor
- mixinFoliage
- mixinBlinnPhong
- mixinLambert
- mixinPBRBluePrint
- mixinPBRMetallicRoughness
- mixinPBRSpecularGlossness
- mixinLight
- mixinPBRCommon
- mixinTextureProps
- mixinVertexColor
- createForwardPlusPipeline
- getDefaultForwardPlusPipeline
- buildForwardPlusGraph
- executeForwardPlusGraph
- mergeFrameResourceRequirements
- resolveModuleOrder
- createSceneRenderer
- normalizeScriptAttachmentConfig
- normalizeScriptAttachments
- decodeFloatFromRGBA
- encodeFloatToRGBA
- decodeNormalizedFloatFromRGBA
- encodeNormalizedFloatToRGBA
- encode2HalfToRGBA
- decode2HalfFromRGBA
- encodeRGBM
- decodeRGBM
- gammaToLinear
- linearToGamma
- hash11
- hash21
- hash31
- hash12
- hash22
- hash32
- hash13
- hash23
- hash33
- whiteNoise
- valueNoise
- gradient
- perlinNoise2D
- perlinNoise3D
- worleyNoise
- worleyFBM
- noise3D
- smoothNoise3D
- interleavedGradientNoise
- temporalResolve
- generateMSDF
- buildMSDFShape
- getDefaultTexture2D
- getDefaultTexture2DArray
- getDefaultTextureCube
- fetchSampler
- getSamplerOptions
- panoramaToCubemap
- calculateEV100
- calculatePhysicalExposure
- calculateVerticalFov
- prefilterCubemap
- defineProps
- normalizeMorphTargetLimit
- getMorphTargetLimit
- setMorphTargetLimit
- normalizeActiveMorphTargetLimit
- getActiveMorphTargetLimit
- setActiveMorphTargetLimit
- normalizeSkinInfluenceLimit
- getSkinInfluenceLimit
- setSkinInfluenceLimit