1/**************************************************************************/
2/* webxr_interface.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef WEBXR_INTERFACE_H
32#define WEBXR_INTERFACE_H
33
34#include "servers/xr/xr_interface.h"
35#include "servers/xr/xr_positional_tracker.h"
36
37/**
38 The WebXR interface is a VR/AR interface that can be used on the web.
39*/
40
41class WebXRInterface : public XRInterface {
42 GDCLASS(WebXRInterface, XRInterface);
43
44protected:
45 static void _bind_methods();
46
47public:
48 enum TargetRayMode {
49 TARGET_RAY_MODE_UNKNOWN,
50 TARGET_RAY_MODE_GAZE,
51 TARGET_RAY_MODE_TRACKED_POINTER,
52 TARGET_RAY_MODE_SCREEN,
53 };
54
55 virtual void is_session_supported(const String &p_session_mode) = 0;
56 virtual void set_session_mode(String p_session_mode) = 0;
57 virtual String get_session_mode() const = 0;
58 virtual void set_required_features(String p_required_features) = 0;
59 virtual String get_required_features() const = 0;
60 virtual void set_optional_features(String p_optional_features) = 0;
61 virtual String get_optional_features() const = 0;
62 virtual void set_requested_reference_space_types(String p_requested_reference_space_types) = 0;
63 virtual String get_requested_reference_space_types() const = 0;
64 virtual String get_reference_space_type() const = 0;
65 virtual bool is_input_source_active(int p_input_source_id) const = 0;
66 virtual Ref<XRPositionalTracker> get_input_source_tracker(int p_input_source_id) const = 0;
67 virtual TargetRayMode get_input_source_target_ray_mode(int p_input_source_id) const = 0;
68 virtual String get_visibility_state() const = 0;
69 virtual float get_display_refresh_rate() const = 0;
70 virtual void set_display_refresh_rate(float p_refresh_rate) = 0;
71 virtual Array get_available_display_refresh_rates() const = 0;
72};
73
74VARIANT_ENUM_CAST(WebXRInterface::TargetRayMode);
75
76#endif // WEBXR_INTERFACE_H
77