Monado OpenXR Runtime
Loading...
Searching...
No Matches
XRTVROverlay_006.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 006.
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_008.hpp"
20
21
22namespace xrt::state_trackers::openvr {
23
24using namespace vr;
25
26class XRTVROverlay_006 : public XRTVROverlay_008, public vr::IVROverlay_006
27{
28public:
29 // @todo Remove when clang-format is updated in CI
30 // clang-format off
31 XRTVROverlay_006(XRTVRClientCore_003 *core) : XRTVROverlay_008(core) {};
32 // clang-format on
33
34 void *
35 getFnTable()
36 {
37 // No FnTable available for IVROverlay_006.
38 return nullptr;
39 }
40
41 ForwardDeclareBase_IVROverlay(XRTVROverlay_008);
42
43 VROverlayError
44 FindOverlay(const char *pchOverlayKey, VROverlayHandle_t *pOverlayHandle) override
45 {
46 openvr_logger logger;
47 OPENVR_LOGGER_INIT(logger);
48
49 OPENVR_LOG_UNIMPLEMENTED_RET(
50 logger, "FindOverlay(pchOverlayKey=%s, pOverlayHandle=%p) -> VROverlayError_None",
51 VROverlayError::VROverlayError_None, pchOverlayKey, static_cast<const void *>(pOverlayHandle));
52 }
53
54 VROverlayError
55 CreateOverlay(const char *pchOverlayKey,
56 const char *pchOverlayFriendlyName,
57 VROverlayHandle_t *pOverlayHandle) override
58 {
59 openvr_logger logger;
60 OPENVR_LOGGER_INIT(logger);
61
62 OPENVR_LOG_UNIMPLEMENTED_RET(logger,
63 "CreateOverlay(pchOverlayKey=%s, pchOverlayFriendlyName=%s, "
64 "pOverlayHandle=%p)-> VROverlayError_None",
65 VROverlayError::VROverlayError_None, pchOverlayKey, pchOverlayFriendlyName,
66 static_cast<const void *>(pOverlayHandle));
67 }
68
69 VROverlayError
70 DestroyOverlay(VROverlayHandle_t ulOverlayHandle) override
71 {
72 openvr_logger logger;
73 OPENVR_LOGGER_INIT(logger);
74
75 OPENVR_LOG_UNIMPLEMENTED_RET(logger, "DestroyOverlay(ulOverlayHandle=%llu)-> VROverlayError_None",
76 VROverlayError::VROverlayError_None,
77 static_cast<unsigned long long>(ulOverlayHandle));
78 }
79
80 VROverlayError
81 SetHighQualityOverlay(VROverlayHandle_t ulOverlayHandle) override
82 {
83 openvr_logger logger;
84 OPENVR_LOGGER_INIT(logger);
85
86 OPENVR_LOG_UNIMPLEMENTED_RET(
87 logger, "SetHighQualityOverlay(ulOverlayHandle=%llu)-> VROverlayError_None",
88 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle));
89 }
90
91 Forward_IVROverlay_GetHighQualityOverlay();
92
93 uint32_t
94 GetOverlayKey(VROverlayHandle_t ulOverlayHandle,
95 VR_OUT_STRING() char *pchValue,
96 uint32_t unBufferSize,
97 VROverlayError *pError = 0L) override
98 {
99 openvr_logger logger;
100 OPENVR_LOGGER_INIT(logger);
101
102 OPENVR_LOG_UNIMPLEMENTED_RET(
103 logger,
104 "GetOverlayKey(ulOverlayHandle=%llu, pchValue=%p, unBufferSize=%llu, pError=%p)-> "
105 "VROverlayError_None",
106 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
107 static_cast<const void *>(pchValue), static_cast<unsigned long long>(unBufferSize),
108 static_cast<const void *>(pError));
109 }
110
111 uint32_t
112 GetOverlayName(VROverlayHandle_t ulOverlayHandle,
113 VR_OUT_STRING() char *pchValue,
114 uint32_t unBufferSize,
115 VROverlayError *pError = 0L) override
116 {
117 openvr_logger logger;
118 OPENVR_LOGGER_INIT(logger);
119
120 OPENVR_LOG_UNIMPLEMENTED_RET(
121 logger,
122 "GetOverlayName(ulOverlayHandle=%llu, pchValue=%p, unBufferSize=%llu, pError=%p)-> "
123 "VROverlayError_None",
124 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
125 static_cast<const void *>(pchValue), static_cast<unsigned long long>(unBufferSize),
126 static_cast<const void *>(pError));
127 }
128
129 VROverlayError
130 GetOverlayImageData(VROverlayHandle_t ulOverlayHandle,
131 void *pvBuffer,
132 uint32_t unBufferSize,
133 uint32_t *punWidth,
134 uint32_t *punHeight) override
135 {
136 openvr_logger logger;
137 OPENVR_LOGGER_INIT(logger);
138
139 OPENVR_LOG_UNIMPLEMENTED_RET(logger,
140 "GetOverlayImageData(ulOverlayHandle=%llu, pvBuffer=%p, "
141 "unBufferSize=%llu, punWidth=%p, punHeight=%p)",
142 {}, static_cast<unsigned long long>(ulOverlayHandle),
143 static_cast<const void *>(pvBuffer),
144 static_cast<unsigned long long>(unBufferSize),
145 static_cast<const void *>(punWidth), static_cast<const void *>(punHeight));
146 }
147
148 const char *
149 GetOverlayErrorNameFromEnum(VROverlayError error) override
150 {
151 openvr_logger logger;
152 OPENVR_LOGGER_INIT(logger);
153
154 OPENVR_LOG_UNIMPLEMENTED_RET(logger, "GetOverlayErrorNameFromEnum(error=%d)",
155 "TODO: GetOverlayErrorNameFromEnum", static_cast<int>(error));
156 }
157
158 VROverlayError
159 SetOverlayFlag(VROverlayHandle_t ulOverlayHandle, VROverlayFlags eOverlayFlag, bool bEnabled) override
160 {
161 openvr_logger logger;
162 OPENVR_LOGGER_INIT(logger);
163
164 OPENVR_LOG_UNIMPLEMENTED_RET(
165 logger, "SetOverlayFlag(ulOverlayHandle=%llu, eOverlayFlag=?, bEnabled=%d)-> VROverlayError_None",
166 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
167 static_cast<int>(bEnabled));
168 }
169
170 VROverlayError
171 GetOverlayFlag(VROverlayHandle_t ulOverlayHandle, VROverlayFlags eOverlayFlag, bool *pbEnabled) override
172 {
173 openvr_logger logger;
174 OPENVR_LOGGER_INIT(logger);
175
176 OPENVR_LOG_UNIMPLEMENTED_RET(
177 logger, "GetOverlayFlag(ulOverlayHandle=%llu, eOverlayFlag=?, pbEnabled=%p)-> VROverlayError_None",
178 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
179 static_cast<const void *>(pbEnabled));
180 }
181
182 VROverlayError
183 SetOverlayColor(VROverlayHandle_t ulOverlayHandle, float fRed, float fGreen, float fBlue) override
184 {
185 openvr_logger logger;
186 OPENVR_LOGGER_INIT(logger);
187
188 OPENVR_LOG_UNIMPLEMENTED_RET(
189 logger, "SetOverlayColor(ulOverlayHandle=%llu, fRed=%f, fGreen=%f, fBlue=%f)-> VROverlayError_None",
190 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle), fRed, fGreen,
191 fBlue);
192 }
193
194 VROverlayError
195 GetOverlayColor(VROverlayHandle_t ulOverlayHandle, float *pfRed, float *pfGreen, float *pfBlue) override
196 {
197 openvr_logger logger;
198 OPENVR_LOGGER_INIT(logger);
199
200 OPENVR_LOG_UNIMPLEMENTED_RET(
201 logger,
202 "GetOverlayColor(ulOverlayHandle=%llu, pfRed=%p, pfGreen=%p, pfBlue=%p)-> VROverlayError_None",
203 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
204 static_cast<const void *>(pfRed), static_cast<const void *>(pfGreen),
205 static_cast<const void *>(pfBlue));
206 }
207
208 VROverlayError
209 SetOverlayAlpha(VROverlayHandle_t ulOverlayHandle, float fAlpha) override
210 {
211 openvr_logger logger;
212 OPENVR_LOGGER_INIT(logger);
213
214 OPENVR_LOG_UNIMPLEMENTED_RET(
215 logger, "SetOverlayAlpha(ulOverlayHandle=%llu, fAlpha=%f)-> VROverlayError_None",
216 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle), fAlpha);
217 }
218
219 VROverlayError
220 GetOverlayAlpha(VROverlayHandle_t ulOverlayHandle, float *pfAlpha) override
221 {
222 openvr_logger logger;
223 OPENVR_LOGGER_INIT(logger);
224
225 OPENVR_LOG_UNIMPLEMENTED_RET(
226 logger, "GetOverlayAlpha(ulOverlayHandle=%llu, pfAlpha=%p)-> VROverlayError_None",
227 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
228 static_cast<const void *>(pfAlpha));
229 }
230
231 VROverlayError
232 SetOverlayGamma(VROverlayHandle_t ulOverlayHandle, float fGamma) override
233 {
234 openvr_logger logger;
235 OPENVR_LOGGER_INIT(logger);
236
237 OPENVR_LOG_UNIMPLEMENTED_RET(
238 logger, "SetOverlayGamma(ulOverlayHandle=%llu, fGamma=%f)-> VROverlayError_None",
239 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle), fGamma);
240 }
241
242 VROverlayError
243 GetOverlayGamma(VROverlayHandle_t ulOverlayHandle, float *pfGamma) override
244 {
245 openvr_logger logger;
246 OPENVR_LOGGER_INIT(logger);
247
248 OPENVR_LOG_UNIMPLEMENTED_RET(
249 logger, "GetOverlayGamma(ulOverlayHandle=%llu, pfGamma=%p)-> VROverlayError_None",
250 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
251 static_cast<const void *>(pfGamma));
252 }
253
254 VROverlayError
255 SetOverlayWidthInMeters(VROverlayHandle_t ulOverlayHandle, float fWidthInMeters) override
256 {
257 openvr_logger logger;
258 OPENVR_LOGGER_INIT(logger);
259
260 OPENVR_LOG_UNIMPLEMENTED_RET(logger, "SetOverlayWidthInMeters(ulOverlayHandle=%llu, fWidthInMeters=%f)",
261 {}, static_cast<unsigned long long>(ulOverlayHandle), fWidthInMeters);
262 }
263
264 VROverlayError
265 GetOverlayWidthInMeters(VROverlayHandle_t ulOverlayHandle, float *pfWidthInMeters) override
266 {
267 openvr_logger logger;
268 OPENVR_LOGGER_INIT(logger);
269
270 OPENVR_LOG_UNIMPLEMENTED_RET(
271 logger, "GetOverlayWidthInMeters(ulOverlayHandle=%llu, pfWidthInMeters=%p)-> VROverlayError_None",
272 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
273 static_cast<const void *>(pfWidthInMeters));
274 }
275
276 VROverlayError
277 SetOverlayAutoCurveDistanceRangeInMeters(VROverlayHandle_t ulOverlayHandle,
278 float fMinDistanceInMeters,
279 float fMaxDistanceInMeters) override
280 {
281 openvr_logger logger;
282 OPENVR_LOGGER_INIT(logger);
283
284 OPENVR_LOG_UNIMPLEMENTED_RET(logger,
285 "SetOverlayAutoCurveDistanceRangeInMeters(ulOverlayHandle=%llu, "
286 "fMinDistanceInMeters=%f, fMaxDistanceInMeters=%f)",
287 {}, static_cast<unsigned long long>(ulOverlayHandle), fMinDistanceInMeters,
288 fMaxDistanceInMeters);
289 }
290
291 VROverlayError
292 GetOverlayAutoCurveDistanceRangeInMeters(VROverlayHandle_t ulOverlayHandle,
293 float *pfMinDistanceInMeters,
294 float *pfMaxDistanceInMeters) override
295 {
296 openvr_logger logger;
297 OPENVR_LOGGER_INIT(logger);
298
299 OPENVR_LOG_UNIMPLEMENTED_RET(logger,
300 "GetOverlayAutoCurveDistanceRangeInMeters(ulOverlayHandle=%llu, "
301 "pfMinDistanceInMeters=%p, pfMaxDistanceInMeters=%p)",
302 {}, static_cast<unsigned long long>(ulOverlayHandle),
303 static_cast<const void *>(pfMinDistanceInMeters),
304 static_cast<const void *>(pfMaxDistanceInMeters));
305 }
306
307 VROverlayError
308 SetOverlayTextureBounds(VROverlayHandle_t ulOverlayHandle,
309 const VRTextureBounds_t *pOverlayTextureBounds) override
310 {
311 openvr_logger logger;
312 OPENVR_LOGGER_INIT(logger);
313
314 OPENVR_LOG_UNIMPLEMENTED_RET(
315 logger,
316 "SetOverlayTextureBounds(ulOverlayHandle=%llu, pOverlayTextureBounds=%p)-> VROverlayError_None",
317 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
318 static_cast<const void *>(pOverlayTextureBounds));
319 }
320
321 VROverlayError
322 GetOverlayTextureBounds(VROverlayHandle_t ulOverlayHandle, VRTextureBounds_t *pOverlayTextureBounds) override
323 {
324 openvr_logger logger;
325 OPENVR_LOGGER_INIT(logger);
326
327 OPENVR_LOG_UNIMPLEMENTED_RET(
328 logger,
329 "GetOverlayTextureBounds(ulOverlayHandle=%llu, pOverlayTextureBounds=%p)-> VROverlayError_None",
330 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
331 static_cast<const void *>(pOverlayTextureBounds));
332 }
333
334 VROverlayError
335 GetOverlayTransformType(VROverlayHandle_t ulOverlayHandle, VROverlayTransformType *peTransformType) override
336 {
337 openvr_logger logger;
338 OPENVR_LOGGER_INIT(logger);
339
340 OPENVR_LOG_UNIMPLEMENTED_RET(
341 logger, "GetOverlayTransformType(ulOverlayHandle=%llu, peTransformType=%p)-> VROverlayError_None",
342 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
343 static_cast<const void *>(peTransformType));
344 }
345
346 VROverlayError
347 SetOverlayTransformAbsolute(VROverlayHandle_t ulOverlayHandle,
348 TrackingUniverseOrigin eTrackingOrigin,
349 const HmdMatrix34_t *pmatTrackingOriginToOverlayTransform) override
350 {
351 openvr_logger logger;
352 OPENVR_LOGGER_INIT(logger);
353
354 OPENVR_LOG_UNIMPLEMENTED_RET(logger,
355 "SetOverlayTransformAbsolute(ulOverlayHandle=%llu, eTrackingOrigin=?, "
356 "pmatTrackingOriginToOverlayTransform=%p)",
357 {}, static_cast<unsigned long long>(ulOverlayHandle),
358 static_cast<const void *>(pmatTrackingOriginToOverlayTransform));
359 }
360
361 VROverlayError
362 GetOverlayTransformAbsolute(VROverlayHandle_t ulOverlayHandle,
363 TrackingUniverseOrigin *peTrackingOrigin,
364 HmdMatrix34_t *pmatTrackingOriginToOverlayTransform) override
365 {
366 openvr_logger logger;
367 OPENVR_LOGGER_INIT(logger);
368
369 OPENVR_LOG_UNIMPLEMENTED_RET(logger,
370 "GetOverlayTransformAbsolute(ulOverlayHandle=%llu, peTrackingOrigin=%p, "
371 "pmatTrackingOriginToOverlayTransform=%p)",
372 {}, static_cast<unsigned long long>(ulOverlayHandle),
373 static_cast<const void *>(peTrackingOrigin),
374 static_cast<const void *>(pmatTrackingOriginToOverlayTransform));
375 }
376
377 VROverlayError
378 SetOverlayTransformTrackedDeviceRelative(VROverlayHandle_t ulOverlayHandle,
379 TrackedDeviceIndex_t unTrackedDevice,
380 const HmdMatrix34_t *pmatTrackedDeviceToOverlayTransform) override
381 {
382 openvr_logger logger;
383 OPENVR_LOGGER_INIT(logger);
384
385 OPENVR_LOG_UNIMPLEMENTED_RET(
386 logger,
387 "SetOverlayTransformTrackedDeviceRelative(ulOverlayHandle=%llu, unTrackedDevice=%llu, "
388 "pmatTrackedDeviceToOverlayTransform=%p)",
389 {}, static_cast<unsigned long long>(ulOverlayHandle),
390 static_cast<unsigned long long>(unTrackedDevice),
391 static_cast<const void *>(pmatTrackedDeviceToOverlayTransform));
392 }
393
394 VROverlayError
395 GetOverlayTransformTrackedDeviceRelative(VROverlayHandle_t ulOverlayHandle,
396 TrackedDeviceIndex_t *punTrackedDevice,
397 HmdMatrix34_t *pmatTrackedDeviceToOverlayTransform) override
398 {
399 openvr_logger logger;
400 OPENVR_LOGGER_INIT(logger);
401
402 OPENVR_LOG_UNIMPLEMENTED_RET(
403 logger,
404 "GetOverlayTransformTrackedDeviceRelative(ulOverlayHandle=%llu, punTrackedDevice=%p, "
405 "pmatTrackedDeviceToOverlayTransform=%p)",
406 {}, static_cast<unsigned long long>(ulOverlayHandle), static_cast<const void *>(punTrackedDevice),
407 static_cast<const void *>(pmatTrackedDeviceToOverlayTransform));
408 }
409
410 VROverlayError
411 ShowOverlay(VROverlayHandle_t ulOverlayHandle) override
412 {
413 openvr_logger logger;
414 OPENVR_LOGGER_INIT(logger);
415
416 OPENVR_LOG_UNIMPLEMENTED_RET(logger, "ShowOverlay(ulOverlayHandle=%llu)-> VROverlayError_None",
417 VROverlayError::VROverlayError_None,
418 static_cast<unsigned long long>(ulOverlayHandle));
419 }
420
421 VROverlayError
422 HideOverlay(VROverlayHandle_t ulOverlayHandle) override
423 {
424 openvr_logger logger;
425 OPENVR_LOGGER_INIT(logger);
426
427 OPENVR_LOG_UNIMPLEMENTED_RET(logger, "HideOverlay(ulOverlayHandle=%llu)-> VROverlayError_None",
428 VROverlayError::VROverlayError_None,
429 static_cast<unsigned long long>(ulOverlayHandle));
430 }
431
432 Forward_IVROverlay_IsOverlayVisible();
433 Forward_IVROverlay_PollNextOverlayEvent_008();
434
435 VROverlayError
436 GetOverlayInputMethod(VROverlayHandle_t ulOverlayHandle, VROverlayInputMethod *peInputMethod) override
437 {
438 openvr_logger logger;
439 OPENVR_LOGGER_INIT(logger);
440
441 OPENVR_LOG_UNIMPLEMENTED_RET(logger, "GetOverlayInputMethod(ulOverlayHandle=%llu, peInputMethod=%p)",
442 {}, static_cast<unsigned long long>(ulOverlayHandle),
443 static_cast<const void *>(peInputMethod));
444 }
445
446 VROverlayError
447 SetOverlayInputMethod(VROverlayHandle_t ulOverlayHandle, VROverlayInputMethod eInputMethod) override
448 {
449 openvr_logger logger;
450 OPENVR_LOGGER_INIT(logger);
451
452 OPENVR_LOG_UNIMPLEMENTED_RET(
453 logger, "SetOverlayInputMethod(ulOverlayHandle=%llu, eInputMethod=?)-> VROverlayError_None",
454 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle));
455 }
456
457 VROverlayError
458 GetOverlayMouseScale(VROverlayHandle_t ulOverlayHandle, HmdVector2_t *pvecMouseScale) override
459 {
460 openvr_logger logger;
461 OPENVR_LOGGER_INIT(logger);
462
463 OPENVR_LOG_UNIMPLEMENTED_RET(logger, "GetOverlayMouseScale(ulOverlayHandle=%llu, pvecMouseScale=%p)",
464 {}, static_cast<unsigned long long>(ulOverlayHandle),
465 static_cast<const void *>(pvecMouseScale));
466 }
467
468 VROverlayError
469 SetOverlayMouseScale(VROverlayHandle_t ulOverlayHandle, const HmdVector2_t *pvecMouseScale) override
470 {
471 openvr_logger logger;
472 OPENVR_LOGGER_INIT(logger);
473
474 OPENVR_LOG_UNIMPLEMENTED_RET(logger, "SetOverlayMouseScale(ulOverlayHandle=%llu, pvecMouseScale=%p)",
475 {}, static_cast<unsigned long long>(ulOverlayHandle),
476 static_cast<const void *>(pvecMouseScale));
477 }
478
479 Forward_IVROverlay_ComputeOverlayIntersection();
480 Forward_IVROverlay_HandleControllerOverlayInteractionAsMouse_017();
481 Forward_IVROverlay_IsHoverTargetOverlay();
482 Forward_IVROverlay_GetGamepadFocusOverlay();
483
484 VROverlayError
485 SetGamepadFocusOverlay(VROverlayHandle_t ulNewFocusOverlay) override
486 {
487 openvr_logger logger;
488 OPENVR_LOGGER_INIT(logger);
489
490 OPENVR_LOG_UNIMPLEMENTED_RET(
491 logger, "SetGamepadFocusOverlay(ulNewFocusOverlay=%llu)-> VROverlayError_None",
492 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulNewFocusOverlay));
493 }
494
495 VROverlayError
496 SetOverlayNeighbor(EOverlayDirection eDirection, VROverlayHandle_t ulFrom, VROverlayHandle_t ulTo) override
497 {
498 openvr_logger logger;
499 OPENVR_LOGGER_INIT(logger);
500
501 OPENVR_LOG_UNIMPLEMENTED_RET(
502 logger, "SetOverlayNeighbor(eDirection=?, ulFrom=%llu, ulTo=%llu)-> VROverlayError_None",
503 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulFrom),
504 static_cast<unsigned long long>(ulTo));
505 }
506
507 VROverlayError
508 MoveGamepadFocusToNeighbor(EOverlayDirection eDirection, VROverlayHandle_t ulFrom) override
509 {
510 openvr_logger logger;
511 OPENVR_LOGGER_INIT(logger);
512
513 OPENVR_LOG_UNIMPLEMENTED_RET(
514 logger, "MoveGamepadFocusToNeighbor(eDirection=?, ulFrom=%llu)-> VROverlayError_None",
515 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulFrom));
516 }
517
518 VROverlayError
519 SetOverlayTexture(VROverlayHandle_t ulOverlayHandle,
520 GraphicsAPIConvention eTextureType,
521 void *pTexture) override
522 {
523 openvr_logger logger;
524 OPENVR_LOGGER_INIT(logger);
525
526 OPENVR_LOG_UNIMPLEMENTED_RET(
527 logger,
528 "SetOverlayTexture(ulOverlayHandle=%llu, eTextureType=?, pTexture=%p)-> VROverlayError_None",
529 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
530 static_cast<const void *>(pTexture));
531 }
532
533 VROverlayError
534 ClearOverlayTexture(VROverlayHandle_t ulOverlayHandle) override
535 {
536 openvr_logger logger;
537 OPENVR_LOGGER_INIT(logger);
538
539 OPENVR_LOG_UNIMPLEMENTED_RET(logger, "ClearOverlayTexture(ulOverlayHandle=%llu)-> VROverlayError_None",
540 VROverlayError::VROverlayError_None,
541 static_cast<unsigned long long>(ulOverlayHandle));
542 }
543
544 VROverlayError
545 SetOverlayRaw(VROverlayHandle_t ulOverlayHandle,
546 void *pvBuffer,
547 uint32_t unWidth,
548 uint32_t unHeight,
549 uint32_t unDepth) override
550 {
551 openvr_logger logger;
552 OPENVR_LOGGER_INIT(logger);
553
554 OPENVR_LOG_UNIMPLEMENTED_RET(
555 logger,
556 "SetOverlayRaw(ulOverlayHandle=%llu, pvBuffer=%p, unWidth=%llu, unHeight=%llu, unDepth=%llu)-> "
557 "VROverlayError_None",
558 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
559 static_cast<const void *>(pvBuffer), static_cast<unsigned long long>(unWidth),
560 static_cast<unsigned long long>(unHeight), static_cast<unsigned long long>(unDepth));
561 }
562
563 VROverlayError
564 SetOverlayFromFile(VROverlayHandle_t ulOverlayHandle, const char *pchFilePath) override
565 {
566 openvr_logger logger;
567 OPENVR_LOGGER_INIT(logger);
568
569 OPENVR_LOG_UNIMPLEMENTED_RET(
570 logger, "SetOverlayFromFile(ulOverlayHandle=%llu, pchFilePath=%s)-> VROverlayError_None",
571 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle), pchFilePath);
572 }
573
574 VROverlayError
575 CreateDashboardOverlay(const char *pchOverlayKey,
576 const char *pchOverlayFriendlyName,
577 VROverlayHandle_t *pMainHandle,
578 VROverlayHandle_t *pThumbnailHandle) override
579 {
580 openvr_logger logger;
581 OPENVR_LOGGER_INIT(logger);
582
583 OPENVR_LOG_UNIMPLEMENTED_RET(logger,
584 "CreateDashboardOverlay(pchOverlayKey=%s, pchOverlayFriendlyName=%s, "
585 "pMainHandle=%p, pThumbnailHandle=%p)",
586 {}, pchOverlayKey, pchOverlayFriendlyName,
587 static_cast<const void *>(pMainHandle),
588 static_cast<const void *>(pThumbnailHandle));
589 }
590
591 Forward_IVROverlay_IsDashboardVisible();
592 Forward_IVROverlay_IsActiveDashboardOverlay();
593
594 VROverlayError
595 SetDashboardOverlaySceneProcess(VROverlayHandle_t ulOverlayHandle, uint32_t unProcessId) override
596 {
597 openvr_logger logger;
598 OPENVR_LOGGER_INIT(logger);
599
600 OPENVR_LOG_UNIMPLEMENTED_RET(
601 logger,
602 "SetDashboardOverlaySceneProcess(ulOverlayHandle=%llu, unProcessId=%llu)-> VROverlayError_None",
603 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
604 static_cast<unsigned long long>(unProcessId));
605 }
606
607 VROverlayError
608 GetDashboardOverlaySceneProcess(VROverlayHandle_t ulOverlayHandle, uint32_t *punProcessId) override
609 {
610 openvr_logger logger;
611 OPENVR_LOGGER_INIT(logger);
612
613 OPENVR_LOG_UNIMPLEMENTED_RET(
614 logger,
615 "GetDashboardOverlaySceneProcess(ulOverlayHandle=%llu, punProcessId=%p)-> VROverlayError_None",
616 VROverlayError::VROverlayError_None, static_cast<unsigned long long>(ulOverlayHandle),
617 static_cast<const void *>(punProcessId));
618 }
619
620 Forward_IVROverlay_ShowDashboard();
621
622 VROverlayError
623 ShowKeyboard(EGamepadTextInputMode eInputMode,
624 EGamepadTextInputLineMode eLineInputMode,
625 const char *pchDescription,
626 uint32_t unCharMax,
627 const char *pchExistingText,
628 bool bUseMinimalMode,
629 uint64_t uUserValue) override
630 {
631 openvr_logger logger;
632 OPENVR_LOGGER_INIT(logger);
633
634 OPENVR_LOG_UNIMPLEMENTED_RET(logger,
635 "ShowKeyboard(eInputMode=?, eLineInputMode=?, pchDescription=%s, "
636 "unCharMax=%llu, pchExistingText=%s, bUseMinimalMode=%d, uUserValue=%llu)",
637 {}, pchDescription, static_cast<unsigned long long>(unCharMax),
638 pchExistingText, static_cast<int>(bUseMinimalMode),
639 static_cast<unsigned long long>(uUserValue));
640 }
641
642 VROverlayError
643 ShowKeyboardForOverlay(VROverlayHandle_t ulOverlayHandle,
644 EGamepadTextInputMode eInputMode,
645 EGamepadTextInputLineMode eLineInputMode,
646 const char *pchDescription,
647 uint32_t unCharMax,
648 const char *pchExistingText,
649 bool bUseMinimalMode,
650 uint64_t uUserValue) override
651 {
652 openvr_logger logger;
653 OPENVR_LOGGER_INIT(logger);
654
655 OPENVR_LOG_UNIMPLEMENTED_RET(
656 logger,
657 "ShowKeyboardForOverlay(ulOverlayHandle=%llu, eInputMode=?, eLineInputMode=?, pchDescription=%s, "
658 "unCharMax=%llu, pchExistingText=%s, bUseMinimalMode=%d, uUserValue=%llu)",
659 {}, static_cast<unsigned long long>(ulOverlayHandle), pchDescription,
660 static_cast<unsigned long long>(unCharMax), pchExistingText, static_cast<int>(bUseMinimalMode),
661 static_cast<unsigned long long>(uUserValue));
662 }
663
664 Forward_IVROverlay_GetKeyboardText();
665 Forward_IVROverlay_HideKeyboard();
666};
667
668}; // namespace xrt::state_trackers::openvr
XRTVROverlay.hpp
Implementation of the latest IVROverlay_028 interface version.
XRTVROverlay_008.hpp
Implementation of the IVROverlay interface version 008.
xrt::state_trackers::openvr::XRTVRClientCore_003
Definition XRTVRClientCore.hpp:152
xrt::state_trackers::openvr::XRTVROverlay_006
Definition XRTVROverlay_006.hpp:27
xrt::state_trackers::openvr::XRTVROverlay_008
Definition XRTVROverlay_008.hpp:27
vr
Definitions missing from C++ header, present in C.
Definition blockqueue.hpp:15
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