File: README.md

package info (click to toggle)
gxr 0.15.1-2~bpo10+1
  • links: PTS, VCS
  • area: main
  • in suites: buster-backports
  • size: 1,728 kB
  • sloc: ansic: 15,256; sh: 72; xml: 71; awk: 35; makefile: 12
file content (71 lines) | stat: -rw-r--r-- 1,673 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
gxr
===

A GLib XR library utilizing the OpenXR and OpenVR APIs.

## Build

#### Configure the project
```
$ meson build
```

#### Compile the project
```
$ ninja -C build
```

#### Build the docs
```
meson build -Dapi_doc=true
$ ninja -C build gxr-doc
```

## Run

#### Run the cube locally
```
$ GXR_BACKEND_DIR=build/src/ GXR_API=openxr ./build/examples/cube/gxr-cube
```

#### Run the overlay examples (OpenVR only)
```
$ GXR_BACKEND_DIR=build/src/ GXR_API=openvr ./build/examples/overlay_pixbuf
$ GXR_BACKEND_DIR=build/src/ GXR_API=openvr ./build/examples/overlay_cairo_vulkan_animation
$ GXR_BACKEND_DIR=build/src/ GXR_API=openvr ./build/examples/overlay_pixbuf_vulkan_multi
```

#### Run the tests
Run all tests.
```
$ ninja -C build test
```

Don't run tests that require a running XR runtime.
```
meson test -C build/ --no-suite gxr:xr
```

Since meson `0.46` the project name can be omitted from the test suite:
```
meson test -C build/ --no-suite xr

```

## Code of Conduct

Please note that this project is released with a Contributor Code of Conduct.
By participating in this project you agree to abide by its terms.

We follow the standard freedesktop.org code of conduct,
available at <https://www.freedesktop.org/wiki/CodeOfConduct/>,
which is based on the [Contributor Covenant](https://www.contributor-covenant.org).

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting:

* First-line project contacts:
  * Lubosz Sarnecki <lubosz.sarnecki@collabora.com>
  * Christoph Haag <christoph.haag@collabora.com>
* freedesktop.org contacts: see most recent list at <https://www.freedesktop.org/wiki/CodeOfConduct/>