1/**************************************************************************/
2/* openxr_fb_display_refresh_rate_extension.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 OPENXR_FB_DISPLAY_REFRESH_RATE_EXTENSION_H
32#define OPENXR_FB_DISPLAY_REFRESH_RATE_EXTENSION_H
33
34// This extension gives us access to the possible display refresh rates
35// supported by the HMD.
36// While this is an FB extension it has been adopted by most runtimes and
37// will likely become core in the near future.
38
39#include "../openxr_api.h"
40#include "../util.h"
41#include "openxr_extension_wrapper.h"
42
43class OpenXRDisplayRefreshRateExtension : public OpenXRExtensionWrapper {
44public:
45 static OpenXRDisplayRefreshRateExtension *get_singleton();
46
47 OpenXRDisplayRefreshRateExtension();
48 virtual ~OpenXRDisplayRefreshRateExtension() override;
49
50 virtual HashMap<String, bool *> get_requested_extensions() override;
51
52 virtual void on_instance_created(const XrInstance p_instance) override;
53 virtual void on_instance_destroyed() override;
54
55 float get_refresh_rate() const;
56 void set_refresh_rate(float p_refresh_rate);
57
58 Array get_available_refresh_rates() const;
59
60private:
61 static OpenXRDisplayRefreshRateExtension *singleton;
62
63 bool display_refresh_rate_ext = false;
64
65 // OpenXR API call wrappers
66 EXT_PROTO_XRRESULT_FUNC4(xrEnumerateDisplayRefreshRatesFB, (XrSession), session, (uint32_t), displayRefreshRateCapacityInput, (uint32_t *), displayRefreshRateCountOutput, (float *), displayRefreshRates);
67 EXT_PROTO_XRRESULT_FUNC2(xrGetDisplayRefreshRateFB, (XrSession), session, (float *), display_refresh_rate);
68 EXT_PROTO_XRRESULT_FUNC2(xrRequestDisplayRefreshRateFB, (XrSession), session, (float), display_refresh_rate);
69};
70
71#endif // OPENXR_FB_DISPLAY_REFRESH_RATE_EXTENSION_H
72