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’           Direct3D 11 (Windows-only)
27
28              ‘D3D12’           Direct3D 12 (Windows-only)
29
30              ‘OpenGLES’
31
32              ‘OpenGL’
33
34              ‘Vulkan’
35
36     -ff | --formfactor form_factor
37              Specify the form factor to use.  (Note that you need a suitable
38              XR system and a runtime supporting a given form factor for it to
39              work.)  The parameter form_factor must be one of the following
40              (case-insensitive):
41
42              ‘Hmd’             Head-mounted display (default)
43
44              ‘Handheld’
45
46     -vc | --viewconfig view_config
47              Specify the view configuration to use.  (Note that you need a
48              suitable XR system and a runtime supporting a given view config‐
49              uration for it to work.)  The parameter view_config must be one
50              of the following (case-insensitive):
51
52              ‘Mono’
53
54              ‘Stereo’          (default)
55
56     -bm | --blendmode blend_mode
57              Specify the environment blend mode to use.  (Note that you need
58              a suitable XR system and a runtime supporting a given environ‐
59              ment blend mode for it to work.)  The parameter blend_mode must
60              be one of the following (case-insensitive):
61
62              ‘Opaque’
63
64              ‘Additive’
65
66              ‘AlphaBlend’
67
68     -s | --space space
69              Specify the space to use.  The parameter space must be one of
70              the following (case-insensitive):
71
72              ‘View’
73
74              ‘Local’
75
76              ‘Stage’
77
78     -v | --verbose
79              Enable verbose logging output from the hello_xr application
80              itself.
81

EXIT STATUS

83     The hello_xr utility exits 0 on success, and >0 if an error occurs.
84

SEE ALSO

86     openxr_runtime_list(1), https://www.khronos.org/registry/OpenXR/ ,
87     https://github.com/KhronosGroup/OpenXR-SDK-Source/tree/mas‐
88     ter/src/tests/hello_xr
89
90BSD                             March 06, 2020                             BSD
Impressum