1HELLO_XR(1)               BSD General Commands Manual              HELLO_XR(1)
2

NAME

4     hello_xr — A sample OpenXR application.
5

SYNOPSIS

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

DESCRIPTION

13     hello_xr is a sample application written using the OpenXR API.
14
15     The arguments are as follows:
16
17     -h | --help
18              Show brief usage instructions.
19
20     g | --graphics graphics_api
21              Required: specify the graphics API to use.  (Note that not that
22              not all graphics APIs are necessarily available on all systems.)
23              The parameter graphics_api must be one of the following (case-
24              insensitive):
25
26              ‘D3D11’
27                      Direct3D 11 (Windows-only)
28
29              ‘D3D12’
30                      Direct3D 12 (Windows-only)
31
32              ‘OpenGLES’
33
34              ‘OpenGL’
35
36              ‘Vulkan’
37
38     -ff | --formfactor form_factor
39              Specify the form factor to use.  (Note that you need a suitable
40              XR system and a runtime supporting a given form factor for it to
41              work.)  The parameter form_factor must be one of the following
42              (case-insensitive):
43
44              ‘Hmd’   Head-mounted display (default)
45
46              ‘Handheld’
47
48     -vc | --viewconfig view_config
49              Specify the view configuration to use.  (Note that you need a
50              suitable XR system and a runtime supporting a given view config‐
51              uration for it to work.)  The parameter view_config must be one
52              of the following (case-insensitive):
53
54              ‘Mono’
55
56              ‘Stereo’
57                      (default)
58
59     -bm | --blendmode blend_mode
60              Specify the environment blend mode to use.  (Note that you need
61              a suitable XR system and a runtime supporting a given environ‐
62              ment blend mode for it to work.)  The parameter blend_mode must
63              be one of the following (case-insensitive):
64
65              ‘Opaque’
66
67              ‘Additive’
68
69              ‘AlphaBlend’
70
71     -s | --space space
72              Specify the space to use.  The parameter space must be one of
73              the following (case-insensitive):
74
75              ‘View’
76
77              ‘Local’
78
79              ‘Stage’
80
81     -v | --verbose
82              Enable verbose logging output from the hello_xr application it‐
83              self.
84

EXIT STATUS

86     The hello_xr utility exits 0 on success, and >0 if an error occurs.
87

SEE ALSO

89     openxr_runtime_list(1), https://www.khronos.org/registry/OpenXR/ ,
90     https://github.com/KhronosGroup/OpenXR-SDK-
91     Source/tree/main/src/tests/hello_xr
92
93BSD                             March 06, 2020                             BSD
Impressum