Monado OpenXR Runtime
Loading...
Searching...
No Matches
XRTVROverlay_022.hpp
Go to the documentation of this file.
1// Copyright 2026, Beyley Cardellio
2// SPDX-License-Identifier: BSL-1.0
3/*!
4 * @file
5 * @brief Implementation of the IVROverlay interface version 022.
6 *
7 * @author Beyley Cardellio <ep1cm1n10n123@gmail.com>
8 * @ingroup openvr_interfaces
9 */
10
11#pragma once
12
13#include "common/openvr_logger.hpp"
14
15#include "openvr_interfaces_unified.h"
16#include "openvr_forward_macros.h"
17
18#include "interfaces/XRTVROverlay.hpp"
19#include "XRTVROverlay_026.hpp"
20
21
22namespace xrt::state_trackers::openvr {
23
24using namespace vr;
25
26class XRTVROverlay_022 : public XRTVROverlay_026, public vr::IVROverlay_022
27{
28public:
29 // @todo Remove when clang-format is updated in CI
30 // clang-format off
31 XRTVROverlay_022(XRTVRClientCore_003 *core) : XRTVROverlay_026(core) {};
32 // clang-format on
33
34 FnTable_IVROverlay_022();
35
36 ForwardDeclareBase_IVROverlay(XRTVROverlay_026);
37
38 Forward_IVROverlay_FindOverlay_028();
39 Forward_IVROverlay_CreateOverlay_028();
40 Forward_IVROverlay_DestroyOverlay_028();
41 Forward_IVROverlay_GetOverlayKey_028();
42 Forward_IVROverlay_GetOverlayName_028();
43 Forward_IVROverlay_SetOverlayName();
44 Forward_IVROverlay_GetOverlayImageData_028();
45 Forward_IVROverlay_GetOverlayErrorNameFromEnum_028();
46 Forward_IVROverlay_SetOverlayRenderingPid();
47 Forward_IVROverlay_GetOverlayRenderingPid();
48 Forward_IVROverlay_SetOverlayFlag_028();
49 Forward_IVROverlay_GetOverlayFlag_028();
50 Forward_IVROverlay_GetOverlayFlags();
51 Forward_IVROverlay_SetOverlayColor_028();
52 Forward_IVROverlay_GetOverlayColor_028();
53 Forward_IVROverlay_SetOverlayAlpha_028();
54 Forward_IVROverlay_GetOverlayAlpha_028();
55 Forward_IVROverlay_SetOverlayTexelAspect();
56 Forward_IVROverlay_GetOverlayTexelAspect();
57 Forward_IVROverlay_SetOverlaySortOrder();
58 Forward_IVROverlay_GetOverlaySortOrder();
59 Forward_IVROverlay_SetOverlayWidthInMeters_028();
60 Forward_IVROverlay_GetOverlayWidthInMeters_028();
61 Forward_IVROverlay_SetOverlayCurvature();
62 Forward_IVROverlay_GetOverlayCurvature();
63 Forward_IVROverlay_SetOverlayTextureColorSpace();
64 Forward_IVROverlay_GetOverlayTextureColorSpace();
65 Forward_IVROverlay_SetOverlayTextureBounds_028();
66 Forward_IVROverlay_GetOverlayTextureBounds_028();
67
68 uint32_t
69 GetOverlayRenderModel(vr::VROverlayHandle_t ulOverlayHandle,
70 VR_OUT_STRING() char *pchValue,
71 uint32_t unBufferSize,
72 HmdColor_t *pColor,
73 vr::EVROverlayError *pError) override
74 {
75 openvr_logger logger;
76 OPENVR_LOGGER_INIT(logger);
77
78 SET_ERROR(pError, vr::EVROverlayError::VROverlayError_None);
79
80 OPENVR_LOG_UNIMPLEMENTED_RET(logger,
81 "GetOverlayRenderModel(ulOverlayHandle=%llu, pchValue=%p, "
82 "unBufferSize=%llu, pColor=%p, pError=%p) -> 0",
83 0, static_cast<unsigned long long>(ulOverlayHandle),
84 static_cast<const void *>(pchValue),
85 static_cast<unsigned long long>(unBufferSize),
86 static_cast<const void *>(pColor), static_cast<const void *>(pError));
87 }
88
89 vr::EVROverlayError
90 SetOverlayRenderModel(vr::VROverlayHandle_t ulOverlayHandle,
91 const char *pchRenderModel,
92 const HmdColor_t *pColor) override
93 {
94 openvr_logger logger;
95 OPENVR_LOGGER_INIT(logger);
96
97 OPENVR_LOG_UNIMPLEMENTED_RET(
98 logger, "SetOverlayRenderModel(ulOverlayHandle=%llu, pchRenderModel=%s, pColor=%p) -> 0",
99 vr::EVROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
100 pchRenderModel, static_cast<const void *>(pColor));
101 }
102
103 Forward_IVROverlay_GetOverlayTransformType_028();
104 Forward_IVROverlay_SetOverlayTransformAbsolute_028();
105 Forward_IVROverlay_GetOverlayTransformAbsolute_028();
106 Forward_IVROverlay_SetOverlayTransformTrackedDeviceRelative_028();
107 Forward_IVROverlay_GetOverlayTransformTrackedDeviceRelative_028();
108 Forward_IVROverlay_SetOverlayTransformTrackedDeviceComponent();
109 Forward_IVROverlay_GetOverlayTransformTrackedDeviceComponent_028();
110 Forward_IVROverlay_GetOverlayTransformOverlayRelative();
111 Forward_IVROverlay_SetOverlayTransformOverlayRelative();
112 Forward_IVROverlay_SetOverlayTransformCursor();
113 Forward_IVROverlay_GetOverlayTransformCursor();
114 Forward_IVROverlay_ShowOverlay_028();
115 Forward_IVROverlay_HideOverlay_028();
116 Forward_IVROverlay_IsOverlayVisible();
117 Forward_IVROverlay_GetTransformForOverlayCoordinates();
118 Forward_IVROverlay_PollNextOverlayEvent_028();
119 Forward_IVROverlay_GetOverlayInputMethod_028();
120 Forward_IVROverlay_SetOverlayInputMethod_028();
121 Forward_IVROverlay_GetOverlayMouseScale_028();
122 Forward_IVROverlay_SetOverlayMouseScale_028();
123 Forward_IVROverlay_ComputeOverlayIntersection();
124 Forward_IVROverlay_IsHoverTargetOverlay();
125
126 EVROverlayError
127 SetOverlayDualAnalogTransform(VROverlayHandle_t ulOverlay,
128 EDualAnalogWhich eWhich,
129 const HmdVector2_t *pvCenter,
130 float fRadius) override
131 {
132 openvr_logger logger;
133 OPENVR_LOGGER_INIT(logger);
134
135 OPENVR_LOG_UNIMPLEMENTED_RET(logger,
136 "SetOverlayDualAnalogTransform(ulOverlay=%llu, eWhich=?, pvCenter=%p, "
137 "fRadius=%f) -> VROverlayError_None",
138 EVROverlayError::VROverlayError_None,
139 static_cast<unsigned long long>(ulOverlay),
140 static_cast<const void *>(pvCenter), fRadius);
141 }
142
143 EVROverlayError
144 GetOverlayDualAnalogTransform(VROverlayHandle_t ulOverlay,
145 EDualAnalogWhich eWhich,
146 HmdVector2_t *pvCenter,
147 float *pfRadius) override
148 {
149 openvr_logger logger;
150 OPENVR_LOGGER_INIT(logger);
151
152 OPENVR_LOG_UNIMPLEMENTED_RET(logger,
153 "GetOverlayDualAnalogTransform(ulOverlay=%llu, eWhich=?, pvCenter=%p, "
154 "pfRadius=%p) -> VROverlayError_None",
155 EVROverlayError::VROverlayError_None,
156 static_cast<unsigned long long>(ulOverlay),
157 static_cast<const void *>(pvCenter), static_cast<const void *>(pfRadius));
158 }
159
160 Forward_IVROverlay_SetOverlayIntersectionMask();
161 Forward_IVROverlay_TriggerLaserMouseHapticVibration();
162 Forward_IVROverlay_SetOverlayCursor();
163 Forward_IVROverlay_SetOverlayCursorPositionOverride();
164 Forward_IVROverlay_ClearOverlayCursorPositionOverride();
165 Forward_IVROverlay_SetOverlayTexture_028();
166 Forward_IVROverlay_ClearOverlayTexture_028();
167 Forward_IVROverlay_SetOverlayRaw_028();
168 Forward_IVROverlay_SetOverlayFromFile_028();
169 Forward_IVROverlay_GetOverlayTexture_028();
170 Forward_IVROverlay_ReleaseNativeOverlayHandle();
171 Forward_IVROverlay_GetOverlayTextureSize();
172 Forward_IVROverlay_CreateDashboardOverlay_028();
173 Forward_IVROverlay_IsDashboardVisible();
174 Forward_IVROverlay_IsActiveDashboardOverlay();
175 Forward_IVROverlay_SetDashboardOverlaySceneProcess_028();
176 Forward_IVROverlay_GetDashboardOverlaySceneProcess_028();
177 Forward_IVROverlay_ShowDashboard();
178 Forward_IVROverlay_GetPrimaryDashboardDevice();
179
180 EVROverlayError
181 ShowKeyboard(EGamepadTextInputMode eInputMode,
182 EGamepadTextInputLineMode eLineInputMode,
183 const char *pchDescription,
184 uint32_t unCharMax,
185 const char *pchExistingText,
186 bool bUseMinimalMode,
187 uint64_t uUserValue) override
188 {
189 openvr_logger logger;
190 OPENVR_LOGGER_INIT(logger);
191
192 OPENVR_LOG_UNIMPLEMENTED_RET(
193 logger,
194 "ShowKeyboard(eInputMode=?, eLineInputMode=?, pchDescription=%s, "
195 "unCharMax=%llu, pchExistingText=%s, bUseMinimalMode=%d, uUserValue=%llu) -> VROverlayError_None",
196 EVROverlayError::VROverlayError_None, pchDescription, static_cast<unsigned long long>(unCharMax),
197 pchExistingText, static_cast<int>(bUseMinimalMode), static_cast<unsigned long long>(uUserValue));
198 }
199
200 EVROverlayError
201 ShowKeyboardForOverlay(VROverlayHandle_t ulOverlayHandle,
202 EGamepadTextInputMode eInputMode,
203 EGamepadTextInputLineMode eLineInputMode,
204 const char *pchDescription,
205 uint32_t unCharMax,
206 const char *pchExistingText,
207 bool bUseMinimalMode,
208 uint64_t uUserValue) override
209 {
210 openvr_logger logger;
211 OPENVR_LOGGER_INIT(logger);
212
213 OPENVR_LOG_UNIMPLEMENTED_RET(
214 logger,
215 "ShowKeyboardForOverlay(ulOverlayHandle=%llu, eInputMode=?, eLineInputMode=?, pchDescription=%s, "
216 "unCharMax=%llu, pchExistingText=%s, bUseMinimalMode=%d, uUserValue=%llu) -> VROverlayError_None",
217 EVROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
218 pchDescription, static_cast<unsigned long long>(unCharMax), pchExistingText,
219 static_cast<int>(bUseMinimalMode), static_cast<unsigned long long>(uUserValue));
220 }
221
222 Forward_IVROverlay_GetKeyboardText();
223 Forward_IVROverlay_HideKeyboard();
224 Forward_IVROverlay_SetKeyboardTransformAbsolute();
225 Forward_IVROverlay_SetKeyboardPositionForOverlay();
226 Forward_IVROverlay_ShowMessageOverlay();
227 Forward_IVROverlay_CloseMessageOverlay();
228};
229
230}; // namespace xrt::state_trackers::openvr
XRTVROverlay.hpp
Implementation of the latest IVROverlay_028 interface version.
XRTVROverlay_026.hpp
Implementation of the IVROverlay interface version 026.
xrt::state_trackers::openvr::XRTVRClientCore_003
Definition XRTVRClientCore.hpp:152
xrt::state_trackers::openvr::XRTVROverlay_022
Definition XRTVROverlay_022.hpp:27
xrt::state_trackers::openvr::XRTVROverlay_026
Definition XRTVROverlay_026.hpp:26
vr
Definitions missing from C++ header, present in C.
Definition blockqueue.hpp:15
SET_ERROR
#define SET_ERROR(error_ptr, ERROR)
Helper macro to set an OpenVR error pointer if it's not null.
Definition openvr_error.hpp:23
openvr_logger.hpp
Logging functions.
OPENVR_LOG_UNIMPLEMENTED_RET
#define OPENVR_LOG_UNIMPLEMENTED_RET(logger, fmt, ret,...)
Specialized macro for logging an unimplemented function and returning a value.
Definition openvr_logger.hpp:57
xrt::state_trackers::openvr::openvr_logger
Definition openvr_logger.hpp:30