Skip to content

r3f-xr-widgets / UseVideoXRControlsReturn

Interface: UseVideoXRControlsReturn ​

Defined in: src/hooks/useVideoXRControls.ts:35

Return value from useVideoXRControls hook

Extends ​

Properties ​

isPointerOnTarget ​

isPointerOnTarget: boolean

Defined in: src/hooks/useXRButtons.ts:48

Current pointer state (true if pointer is on target)

Inherited from ​

UseXRButtonsReturn.isPointerOnTarget


onPointerEnter() ​

onPointerEnter: () => void

Defined in: src/hooks/useXRButtons.ts:44

Handler to call on pointer enter events

Returns ​

void

Inherited from ​

UseXRButtonsReturn.onPointerEnter


onPointerLeave() ​

onPointerLeave: () => void

Defined in: src/hooks/useXRButtons.ts:46

Handler to call on pointer leave events

Returns ​

void

Inherited from ​

UseXRButtonsReturn.onPointerLeave


targetRef ​

targetRef: RefObject<Object3D<Object3DEventMap> | null>

Defined in: src/hooks/useXRButtons.ts:42

Ref to attach to the target mesh for pointer tracking

Inherited from ​

UseXRButtonsReturn.targetRef


toggleControlsRef ​

toggleControlsRef: MutableRefObject<() => void | null>

Defined in: src/hooks/useVideoXRControls.ts:37

Ref that can be populated with a toggle function from ControlPanelAutoFade

Released under the MIT License.