vtkWebXR.h File Reference

Minimal WebXR Device API wrapper. More...

#include "vtkABINamespace.h"

Include dependency graph for vtkWebXR.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	WebXRRigidTransform
	WebXR rigid transform. More...
struct	WebXRView
	WebXR view. More...
struct	WebXRInputSource
struct	WebXRGamepadButton
struct	WebXRGamepad
	WebXR Gamepad see https://www.w3.org/TR/2024/WD-webxr-gamepads-module-1-20240409/#xr-standard-heading. More...

Macros
#define	webxr_init   VTK_ABI_NAMESPACE_MANGLE(webxr_init)
#define	webxr_is_session_supported   VTK_ABI_NAMESPACE_MANGLE(webxr_is_session_supported)
#define	webxr_request_session   VTK_ABI_NAMESPACE_MANGLE(webxr_request_session)
#define	webxr_request_exit   VTK_ABI_NAMESPACE_MANGLE(webxr_request_exit)
#define	webxr_get_viewer_pose   VTK_ABI_NAMESPACE_MANGLE(webxr_get_viewer_pose)
#define	webxr_get_views   VTK_ABI_NAMESPACE_MANGLE(webxr_get_views)
#define	webxr_get_framebuffer_size   VTK_ABI_NAMESPACE_MANGLE(webxr_get_framebuffer_size)
#define	webxr_get_framebuffer()   VTK_ABI_NAMESPACE_MANGLE(webxr_get_framebuffer)
	Get WebXR framebuffer ID.
#define	webxr_get_input_sources   VTK_ABI_NAMESPACE_MANGLE(webxr_get_input_sources)
#define	webxr_get_input_pose   VTK_ABI_NAMESPACE_MANGLE(webxr_get_input_pose)
#define	webxr_get_input_gamepad   VTK_ABI_NAMESPACE_MANGLE(webxr_get_input_gamepad)
#define	WEBXR_SESSION_FEATURE_LOCAL   0x01
	WebXR 'XRSessionFeatures'.
#define	WEBXR_SESSION_FEATURE_LOCAL_FLOOR   0x02
#define	WEBXR_SESSION_FEATURE_BOUNDED_FLOOR   0x04
#define	WEBXR_SESSION_FEATURE_UNBOUNDED   0x08
#define	WEBXR_SESSION_FEATURE_HIT_TEST   0x10

Typedefs
typedef struct WebXRRigidTransform	WebXRRigidTransform
	WebXR rigid transform.
typedef struct WebXRView	WebXRView
	WebXR view.
typedef struct WebXRInputSource	WebXRInputSource
typedef struct WebXRGamepadButton	WebXRGamepadButton
typedef struct WebXRGamepad	WebXRGamepad
	WebXR Gamepad see https://www.w3.org/TR/2024/WD-webxr-gamepads-module-1-20240409/#xr-standard-heading.
typedef void(*	webxr_error_callback_func) (void *userData, int error)
	Callback for errors.
typedef void(*	webxr_frame_callback_func) (void *userData, int time)
	Callback for frame rendering.
typedef void(*	webxr_session_callback_func) (void *userData, int mode)
	Callback for VR session start.
typedef void(*	webxr_session_supported_callback_func) (int mode, int supported)
	Callback for webxr_is_session_supported.

Enumerations
enum	WebXRHandedness { WEBXR_HANDEDNESS_NONE = -1 , WEBXR_HANDEDNESS_LEFT = 0 , WEBXR_HANDEDNESS_RIGHT = 1 }
	WebXR handedness. More...
enum	WebXRTargetRayMode { WEBXR_TARGET_RAY_MODE_GAZE = 0 , WEBXR_TARGET_RAY_MODE_TRACKED_POINTER = 1 , WEBXR_TARGET_RAY_MODE_SCREEN = 2 }
	WebXR target ray mode. More...
enum	WebXRSessionMode { WEBXR_SESSION_MODE_INLINE = 0 , WEBXR_SESSION_MODE_IMMERSIVE_VR = 1 , WEBXR_SESSION_MODE_IMMERSIVE_AR = 2 }
	WebXR 'XRSessionMode' enum. More...
enum	WebXRInputPoseMode { WEBXR_INPUT_POSE_GRIP = 0 , WEBXR_INPUT_POSE_TARGET_RAY = 1 }
	WebXR 'XRSessionMode' enum. More...
enum	WebXRGamepadButtonMapping {   WEBXR_BUTTON_PRIMARY_TRIGGER = 0 , WEBXR_BUTTON_PRIMARY_SQUEEZE = 1 , WEBXR_BUTTON_PRIMARY_TOUCHPAD = 2 , WEBXR_BUTTON_PRIMARY_THUMBSTICK = 3 ,   WEBXR_BUTTON_1 = 4 , WEBXR_BUTTON_2 = 5 , WEBXR_BUTTON_3 = 6 , WEBXR_BUTTON_4 = 7 ,   WEBXR_INTERNAL_HANDPOSE = 8 }
enum	WebXRGamepadAxisMapping {   WEBXR_AXIS_PRIMARY_TOUCHPAD_X = 0 , WEBXR_AXIS_PRIMARY_TOUCHPAD_Y = 1 , WEBXR_AXIS_PRIMARY_THUMBSTICK_X = 2 , WEBXR_AXIS_PRIMARY_THUMBSTICK_Y = 3 ,   WEBXR_AXIS_1 = 4 , WEBXR_AXIS_2 = 5 , WEBXR_AXIS_3 = 6 , WEBXR_AXIS_4 = 7 }

Functions
void	webxr_init (webxr_frame_callback_func frameCallback, webxr_session_callback_func sessionStartCallback, webxr_session_callback_func sessionEndCallback, webxr_error_callback_func errorCallback, void *userData)
	Init WebXR rendering.
void	webxr_is_session_supported (WebXRSessionMode mode, webxr_session_supported_callback_func supportedCallback)
void	webxr_request_session (WebXRSessionMode mode, unsigned int requiredFeatures, unsigned int optionalFeatures)
bool	webxr_get_viewer_pose (WebXRRigidTransform *pose)
	Get viewer (hmd) pose.
bool	webxr_get_views (WebXRView *views, int *viewCount, int maxViews)
	Get views.
bool	webxr_get_framebuffer_size (int *width, int *height)
	Get framebuffer width and height.
int	webxr_get_input_sources (WebXRInputSource *outArray, int max, int *outCount)
	WebXR Input.
int	webxr_get_input_pose (WebXRInputSource *source, WebXRRigidTransform *outPose, WebXRInputPoseMode mode=WEBXR_INPUT_POSE_GRIP)
	Get input pose.
int	webxr_get_input_gamepad (WebXRInputSource *source, WebXRGamepad *outGamepad)
	Get input gamepad.

Detailed Description

Minimal WebXR Device API wrapper.

Definition in file vtkWebXR.h.

Macro Definition Documentation

webxr_init

#define webxr_init   VTK_ABI_NAMESPACE_MANGLE(webxr_init)

Definition at line 18 of file vtkWebXR.h.

webxr_is_session_supported

#define webxr_is_session_supported   VTK_ABI_NAMESPACE_MANGLE(webxr_is_session_supported)

Definition at line 19 of file vtkWebXR.h.

webxr_request_session

#define webxr_request_session   VTK_ABI_NAMESPACE_MANGLE(webxr_request_session)

Definition at line 20 of file vtkWebXR.h.

webxr_request_exit

void webxr_request_exit   VTK_ABI_NAMESPACE_MANGLE(webxr_request_exit)

Definition at line 21 of file vtkWebXR.h.

webxr_get_viewer_pose

#define webxr_get_viewer_pose   VTK_ABI_NAMESPACE_MANGLE(webxr_get_viewer_pose)

Definition at line 22 of file vtkWebXR.h.

webxr_get_views

#define webxr_get_views   VTK_ABI_NAMESPACE_MANGLE(webxr_get_views)

Definition at line 23 of file vtkWebXR.h.

webxr_get_framebuffer_size

#define webxr_get_framebuffer_size   VTK_ABI_NAMESPACE_MANGLE(webxr_get_framebuffer_size)

Definition at line 24 of file vtkWebXR.h.

webxr_get_framebuffer

unsigned int webxr_get_framebuffer   VTK_ABI_NAMESPACE_MANGLE(webxr_get_framebuffer)

Get WebXR framebuffer ID.

Definition at line 25 of file vtkWebXR.h.

webxr_get_input_sources

#define webxr_get_input_sources   VTK_ABI_NAMESPACE_MANGLE(webxr_get_input_sources)

Definition at line 26 of file vtkWebXR.h.

webxr_get_input_pose

#define webxr_get_input_pose   VTK_ABI_NAMESPACE_MANGLE(webxr_get_input_pose)

Definition at line 27 of file vtkWebXR.h.

webxr_get_input_gamepad

#define webxr_get_input_gamepad   VTK_ABI_NAMESPACE_MANGLE(webxr_get_input_gamepad)

Definition at line 28 of file vtkWebXR.h.

WEBXR_SESSION_FEATURE_LOCAL

#define WEBXR_SESSION_FEATURE_LOCAL   0x01

WebXR 'XRSessionFeatures'.

Definition at line 68 of file vtkWebXR.h.

WEBXR_SESSION_FEATURE_LOCAL_FLOOR

#define WEBXR_SESSION_FEATURE_LOCAL_FLOOR   0x02

Definition at line 69 of file vtkWebXR.h.

WEBXR_SESSION_FEATURE_BOUNDED_FLOOR

#define WEBXR_SESSION_FEATURE_BOUNDED_FLOOR   0x04

Definition at line 70 of file vtkWebXR.h.

WEBXR_SESSION_FEATURE_UNBOUNDED

#define WEBXR_SESSION_FEATURE_UNBOUNDED   0x08

Definition at line 71 of file vtkWebXR.h.

WEBXR_SESSION_FEATURE_HIT_TEST

#define WEBXR_SESSION_FEATURE_HIT_TEST   0x10

Definition at line 72 of file vtkWebXR.h.

Typedef Documentation

WebXRRigidTransform

typedef struct WebXRRigidTransform WebXRRigidTransform

WebXR rigid transform.

WebXRView

typedef struct WebXRView WebXRView

WebXR view.

WebXRInputSource

typedef struct WebXRInputSource WebXRInputSource

WebXRGamepadButton

typedef struct WebXRGamepadButton WebXRGamepadButton

WebXRGamepad

typedef struct WebXRGamepad WebXRGamepad

WebXR Gamepad see https://www.w3.org/TR/2024/WD-webxr-gamepads-module-1-20240409/#xr-standard-heading.

webxr_error_callback_func

typedef void(* webxr_error_callback_func) (void *userData, int error)

Callback for errors.

Parameters

userData	User pointer passed to init_webxr()
error	Error code

Definition at line 159 of file vtkWebXR.h.

webxr_frame_callback_func

typedef void(* webxr_frame_callback_func) (void *userData, int time)

Callback for frame rendering.

Parameters

userData	User pointer passed to init_webxr()
time	Current frame time

Definition at line 167 of file vtkWebXR.h.

webxr_session_callback_func

typedef void(* webxr_session_callback_func) (void *userData, int mode)

Callback for VR session start.

Parameters

userData	User pointer passed to set_session_start_callback
mode	The session mode

Definition at line 175 of file vtkWebXR.h.

webxr_session_supported_callback_func

typedef void(* webxr_session_supported_callback_func) (int mode, int supported)

Callback for webxr_is_session_supported.

Parameters

mode	The session mode that was requested
supported	Whether given mode is supported by this device

Definition at line 183 of file vtkWebXR.h.

Enumeration Type Documentation

WebXRHandedness

enum WebXRHandedness

WebXR handedness.

Enumerator
WEBXR_HANDEDNESS_NONE
WEBXR_HANDEDNESS_LEFT
WEBXR_HANDEDNESS_RIGHT

Definition at line 44 of file vtkWebXR.h.

WebXRTargetRayMode

enum WebXRTargetRayMode

WebXR target ray mode.

Enumerator
WEBXR_TARGET_RAY_MODE_GAZE
WEBXR_TARGET_RAY_MODE_TRACKED_POINTER
WEBXR_TARGET_RAY_MODE_SCREEN

Definition at line 52 of file vtkWebXR.h.

WebXRSessionMode

enum WebXRSessionMode

WebXR 'XRSessionMode' enum.

Enumerator
WEBXR_SESSION_MODE_INLINE
WEBXR_SESSION_MODE_IMMERSIVE_VR
WEBXR_SESSION_MODE_IMMERSIVE_AR

Definition at line 60 of file vtkWebXR.h.

WebXRInputPoseMode

enum WebXRInputPoseMode

WebXR 'XRSessionMode' enum.

Enumerator
WEBXR_INPUT_POSE_GRIP
WEBXR_INPUT_POSE_TARGET_RAY

Definition at line 75 of file vtkWebXR.h.

WebXRGamepadButtonMapping

enum WebXRGamepadButtonMapping

Enumerator
WEBXR_BUTTON_PRIMARY_TRIGGER
WEBXR_BUTTON_PRIMARY_SQUEEZE
WEBXR_BUTTON_PRIMARY_TOUCHPAD
WEBXR_BUTTON_PRIMARY_THUMBSTICK
WEBXR_BUTTON_1
WEBXR_BUTTON_2
WEBXR_BUTTON_3
WEBXR_BUTTON_4
WEBXR_INTERNAL_HANDPOSE

Definition at line 114 of file vtkWebXR.h.

WebXRGamepadAxisMapping

enum WebXRGamepadAxisMapping

Enumerator
WEBXR_AXIS_PRIMARY_TOUCHPAD_X
WEBXR_AXIS_PRIMARY_TOUCHPAD_Y
WEBXR_AXIS_PRIMARY_THUMBSTICK_X
WEBXR_AXIS_PRIMARY_THUMBSTICK_Y
WEBXR_AXIS_1
WEBXR_AXIS_2
WEBXR_AXIS_3
WEBXR_AXIS_4

Definition at line 127 of file vtkWebXR.h.

Function Documentation

webxr_init()

void webxr_init ( webxr_frame_callback_func frameCallback, webxr_session_callback_func sessionStartCallback, webxr_session_callback_func sessionEndCallback, webxr_error_callback_func errorCallback, void * userData )

extern

Init WebXR rendering.

Parameters

frameCallback	Callback called every frame
sessionStartCallback	Callback called when session is started
sessionEndCallback	Callback called when session ended
errorCallback	Callback called every frame
userData	User data passed to the callbacks

webxr_is_session_supported()

void webxr_is_session_supported ( WebXRSessionMode mode, webxr_session_supported_callback_func supportedCallback )

extern

webxr_request_session()

void webxr_request_session ( WebXRSessionMode mode, unsigned int requiredFeatures, unsigned int optionalFeatures )

extern

webxr_get_viewer_pose()

bool webxr_get_viewer_pose ( WebXRRigidTransform * pose )

extern

Get viewer (hmd) pose.

webxr_get_views()

bool webxr_get_views ( WebXRView * views, int * viewCount, int maxViews )

extern

Get views.

webxr_get_framebuffer_size()

bool webxr_get_framebuffer_size ( int * width, int * height )

extern

Get framebuffer width and height.

webxr_get_input_sources()

int webxr_get_input_sources ( WebXRInputSource * outArray, int max, int * outCount )

extern

WebXR Input.

Get input sources.

Parameters

outArray	WebXRInputSource array to fill.
max	Size of outArray (in elements).
outCount	Will receive the number of input sources valid in outArray.

Returns

false if getting the input sources failed, true otherwise.

webxr_get_input_pose()

int webxr_get_input_pose ( WebXRInputSource * source, WebXRRigidTransform * outPose, WebXRInputPoseMode mode = WEBXR_INPUT_POSE_GRIP )

extern

Get input pose.

Can only be called during the frame callback.

Parameters

source	The source to get the pose for.
outPose	Where to store the pose.
mode	Input pose mode, whether WEBXR_INPUT_POSE_GRIP or WEBXR_INPUT_POSE_TARGET_RAY

Returns

false if updating the pose failed, true otherwise.

webxr_get_input_gamepad()

int webxr_get_input_gamepad ( WebXRInputSource * source, WebXRGamepad * outGamepad )

extern

Get input gamepad.

Can only be called during the frame callback.

Parameters

source	The source to get the gamepad for.
outGamepad	Where to store the gamepad.

Returns

false if updating the gamepad failed, true otherwise