HELLO_XR(1)

💖 HELLO_XR 💖

okay so bestie, you know how the manual is General Commands Manual, section 1, and this whole thing is literally called hello_xr? yeah. that's the one. let's get into it 🦋

✨ NAME ✨

hello_xr — a sample OpenXR application. that's it, that's the girl. a lil demo app written using the OpenXR API, here to show you the ropes 👑

🌸 SYNOPSIS 🌸

hello_xr [-h | --help]
hello_xr -g | --graphics graphics_api [-ff | --formfactor form_factor]
         [-vc | --viewconfig view_config] [-bm | --blendmode blend_mode]
         [-s | --space space] [-v | --verbose]

💅 DESCRIPTION 💅

hello_xr is a sample application written using the OpenXR API. it's giving "reference implementation but make it cute" ✨

The arguments are as follows:

• -h, --help — show brief usage instructions. short and sweet, no notes 💖
• -g, --graphics graphics_api — required, bestie. you have to tell it which graphics API to use. (quick heads up tho: not all graphics APIs are necessarily available on all systems, so don't come for her if yours isn't there 🙈) The parameter graphics_api must be one of the following, and it's case-insensitive:
  • D3D11 — Direct3D 11 (Windows-only 🪟)
  • D3D12 — Direct3D 12 (Windows-only 🪟)
  • OpenGLES
  • OpenGL
  • Vulkan
• -ff, --formfactor form_factor — specify the form factor to use. (and ngl, you need a suitable XR system and a runtime that supports the form factor you pick, or it's just not gonna work 😭) The parameter form_factor must be one of the following, case-insensitive:
  • Hmd — head-mounted display (default 🎀)
  • Handheld
• -vc, --viewconfig view_config — specify the view configuration to use. (same deal, you need a suitable XR system and a runtime that supports the given view configuration for it to actually work 🫶) The parameter view_config must be one of the following, case-insensitive:
  • Mono
  • Stereo — (default 👑)
• -bm, --blendmode blend_mode — specify the environment blend mode to use. (again — suitable XR system, runtime that supports the given environment blend mode, or it's a no 💀) The parameter blend_mode must be one of the following, case-insensitive:
  • Opaque
  • Additive
  • AlphaBlend
• -s, --space space — specify the space to use. The parameter space must be one of the following, case-insensitive:
  • View
  • Local
  • Stage
• -v, --verbose — enable verbose logging output from the hello_xr application itself. she's chatty, she's telling you everything, we love that for her 🔥

🌈 EXIT STATUS 🌈

The hello_xr utility exits 0 on success, and >0 if an error occurs. so like — zero is the slay, anything above zero is the "something went wrong bestie" 😭

🧚 SEE ALSO 🧚

• openxr_runtime_list(1)
• <https://registry.khronos.org/OpenXR/>
• <https://github.com/KhronosGroup/OpenXR-SDK-Source/tree/main/src/tests/hello_xr>

that's the whole vibe check, bestie — go forth and XR 💜

signed, sealed, delivered by Debian, dated March 06, 2020 — this page is officially iconic and you can quote me on that 💅✨