API
Babylon Lite API|
XrHandTrackingOptions

Interface XrHandTrackingOptions

Options for handTracking / createXrHandTracking.

interface XrHandTrackingOptions {
    handAlpha?: number;
    handColor?: readonly [number, number, number];
    handMeshBaseUrl?: string;
    handMeshes?: boolean;
    handMeshLeftFilename?: string;
    handMeshRightFilename?: string;
    jointColor?: readonly [number, number, number];
    jointMeshFactory?: XrHandJointMeshFactory;
    jointScale?: number;
}
Index
handAlpha? handColor? handMeshBaseUrl? handMeshes? handMeshLeftFilename? handMeshRightFilename? jointColor? jointMeshFactory? jointScale?
handAlpha?: number

Hand-mesh alpha (< 1 = translucent). Default 1 (opaque). A translucent hand shows its own far fingers through the near ones (nearer fragments can't occlude farther ones once alpha blending disables depth writes), so the default is solid.

handColor?: readonly [number, number, number]

Hand-mesh diffuse tint. Default Babylon's hand purple.

handMeshBaseUrl?: string

Base URL the hand GLBs are fetched from (must end in /). Defaults to Babylon's CDN.

handMeshes?: boolean

Load Babylon.js's rigged hand mesh (skinned to the joints) instead of only the joint spheres. Default true. The spheres still show while the mesh loads and if it can't be loaded. Set false for the lightweight dots-only visual.

handMeshLeftFilename?: string

Left-hand GLB filename. Default l_hand_rhs.glb.

handMeshRightFilename?: string

Right-hand GLB filename. Default r_hand_rhs.glb.

jointColor?: readonly [number, number, number]

Diffuse colour of the default joint spheres. Defaults to a light blue-white.

jointMeshFactory?: XrHandJointMeshFactory

Custom per-joint mesh builder (see XrHandJointMeshFactory). Defaults to a low-poly lit sphere. The returned mesh is scaled to the joint radius each frame.

jointScale?: number

Multiplier on each joint's reported radius, to fatten/thin the dots. Default 1.