Skip to main content

Function: togglePinned()

function togglePinned(mode: DockModeValue): DockModeValue;

Defined in: webxr-uiextensions/src/core/dock-state.ts:113

The "pin" affordance on a window's title bar toggles between following the player and being placed in space. Head-locked and hand-locked windows unpin to world-locked too - pinning something rigidly to the user's face is never the toggle target you want, and a hand menu pinned in place is simply a window again.

Parameters

ParameterType
modeDockModeValue

Returns

DockModeValue