Skip to content

Commit

Permalink
OpenXR Specification 1.0.29 (2023-08-25)
Browse files Browse the repository at this point in the history
This release contains several fixes to the specification, as well as
enhancements to the loader documentation/specification to support
architecture and ABI specific active runtime manifest names on Linux and
Android.

-   Registry
    -   Change PFNEGLGETPROCADDRESSPROC (for eglGetProcAddress) to a
        locally defined type to avoid compiler errors. (internal MR
        2468)
    -   Extension reservation: Register author ID and reserve vendor
        extensions for YVR. (internal MR 2832)
    -   New vendor extension: XR_META_passthrough_preferences (internal
        MR 2694)
    -   XR_HTCX_vive_tracker_interaction: Added new role paths for
        wrists and ankles. (internal MR 2728)
-   Specification
    -   Change PFNEGLGETPROCADDRESSPROC (for eglGetProcAddress) to a
        locally defined type to avoid compiler errors. (internal MR
        2468)
    -   Fix specification text mentions of eyeVisibility field in
        Khronos composition layer extensions, to match the XML and
        headers. (internal MR 2878)
    -   Improvement: Add note to OpenXR styleguide to discourage use of
        callback functions in OpenXR extensions. (internal MR 2734)
    -   Loader spec: Clarify and deduplicate the loader specification’s
        listing of android manifest search paths. (internal MR 2829,
        internal issue 2046)
    -   Loader spec: Fix description of <queries> element contents:
        existing description would fail to install. (internal MR 2840,
        internal issue 2053)
    -   Makefile: Remove obsolete cygwin support in spec building
        target, no longer needed and actually caused it to not work
        under MSYS2. (internal MR 2885)
    -   New vendor extension specification:
        XR_META_passthrough_preferences (internal MR 2694)
    -   Style guide: Document the XML schema of xr.xml (internal MR
        2875)
    -   XR_HTCX_vive_tracker_interaction: Added new role paths for
        wrists and ankles. (internal MR 2728)
    -   XR_OPPO_controller_interaction: Fix formatting of path lists.
        (internal MR 2831, OpenXR-Docs issue 156, internal issue 2047)
    -   scripts: Provide better feedback on interface struct erroneously
        having a values attribute. (internal MR 2856)
    -   scripts: Update regex in xrconventions to allow words in type
        naming that succeed digits but start with a “D” (internal MR
        2857)
    -   scripts: Fix formatting of “basetype” (generally typedef) names
        to once again be monospace “code”. (internal MR 2890, internal
        issue 2048)

GitOrigin-RevId: 07acb644ae0a5a42f891120d3172004cb5605ad7
  • Loading branch information
rpavlik committed Aug 25, 2023
1 parent dc9e094 commit 77afb1f
Show file tree
Hide file tree
Showing 33 changed files with 757 additions and 70 deletions.
5 changes: 4 additions & 1 deletion .git-blame-ignore-revs
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@
# and do try to make sure that the bulk change is made
# **separate from a release commit** on all repos.
# See <https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revs-fileltfilegt>
# for how to use this.
# for how to use this, probably something like:
# git config blame.ignoreRevsFile .git-blame-ignore-revs

## Old changes
767537d9523253de1615b01450a8b22c8e2cc6a2

## 1.0.17 - Fix XML indentation

Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ local.properties

# Don't ignore these things
!.*.license
!.artifact-bot.md
!.appveyor.yml
!.azure-pipelines/
!.azure-pipelines/nuget/NugetTemplate/build
Expand Down
28 changes: 13 additions & 15 deletions .reuse/dep5
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@ Upstream-Name: OpenXR
Upstream-Contact: Ryan Pavlik <openxr-speceditor AT khronos DOT org>
Source: https://khronos.org/registry/OpenXR/

Files: changes/*
Files: changes/conformance/*
changes/registry/*
changes/sdk/*
changes/specification/*
changes/README.md
changes/template.md
HOTFIX
Copyright: 2019-2023, The Khronos Group Inc.
License: CC-BY-4.0

Expand All @@ -29,25 +35,22 @@ Comment: Based on a Material Icons asset ("emoji-people") with added text
Rasterized with Android Studio.

Files: src/external/catch2/*
Copyright: Copyright (c) 2022 Two Blue Cubes Ltd.
Copyright: Copyright (c) 2023 Two Blue Cubes Ltd.
License: BSL-1.0
Comment: Unmodified, vendored copy of Catch2 3.1.1
Comment: Unmodified, vendored copy of Catch2 v3.3.2

Files: src/external/jsoncpp/*
Copyright: 2007-2010 Baptiste Lepilleur and The JsonCpp Authors
License: MIT OR LicenseRef-jsoncpp-public-domain
Comment: Unmodified, vendored copy of jsoncpp 1.9.5

Files: src/external/tinygltf/*
Copyright: 2017 Syoyo Fujita, Aurélien Chatelain and many contributors
Files: src/external/tinygltf/README.md
src/external/tinygltf/tiny_gltf.cc
src/external/tinygltf/tiny_gltf.h
Copyright: 2015-Present, Syoyo Fujita, Aurélien Chatelain and many contributors
License: MIT
Comment: Unmodified, vendored copy of a subset of the tiny-gltf repo v2.8.9

Files: src/external/tinygltf/json.hpp
Copyright: 2013-2017 Niels Lohmann <http://nlohmann.me>
License: MIT
Comment: Unmodified, included in tiny-gltf repo.

Files: src/external/d3dx12/*
Copyright: Copyright (c) Microsoft Corporation.
License: MIT
Expand Down Expand Up @@ -81,11 +84,6 @@ Copyright: 2020, Epic Games, Inc.
License: CC-BY-4.0
Comment: In-line license comments requested, https://gitlab.khronos.org/openxr/openxr/-/issues/1422

Files: specification/sources/chapters/extensions/oculus/oculus_android_session_state_enable.adoc
Copyright: 2019, Oculus VR, LLC.
License: CC-BY-4.0
Comment: In-line license comments requested, https://gitlab.khronos.org/openxr/openxr/-/issues/1418

Files: specification/sources/chapters/extensions/ext/ext_performance_settings.adoc
specification/sources/chapters/extensions/ext/ext_thermal_query.adoc
Copyright: 2017-2023, The Khronos Group Inc.
Expand Down
59 changes: 59 additions & 0 deletions CHANGELOG.Docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,65 @@ any public pull requests that have been accepted.
This changelog only lists changes that affect the registry,
headers, and/or specification text.

## OpenXR Specification 1.0.29 (2023-08-25)

This release contains several fixes to the specification, as well as
enhancements to the loader documentation/specification to support architecture
and ABI specific active runtime manifest names on Linux and Android.

- Registry
- Change `PFNEGLGETPROCADDRESSPROC` (for `eglGetProcAddress`) to a locally
defined type to avoid compiler errors.
([internal MR 2468](https://gitlab.khronos.org/openxr/openxr/merge_requests/2468))
- Extension reservation: Register author ID and reserve vendor extensions for
YVR.
([internal MR 2832](https://gitlab.khronos.org/openxr/openxr/merge_requests/2832))
- New vendor extension: `XR_META_passthrough_preferences`
([internal MR 2694](https://gitlab.khronos.org/openxr/openxr/merge_requests/2694))
- `XR_HTCX_vive_tracker_interaction`: Added new role paths for wrists and ankles.
([internal MR 2728](https://gitlab.khronos.org/openxr/openxr/merge_requests/2728))
- Specification
- Change `PFNEGLGETPROCADDRESSPROC` (for `eglGetProcAddress`) to a locally
defined type to avoid compiler errors.
([internal MR 2468](https://gitlab.khronos.org/openxr/openxr/merge_requests/2468))
- Fix specification text mentions of `eyeVisibility` field in Khronos composition
layer extensions, to match the XML and headers.
([internal MR 2878](https://gitlab.khronos.org/openxr/openxr/merge_requests/2878))
- Improvement: Add note to OpenXR styleguide to discourage use of callback
functions in OpenXR extensions.
([internal MR 2734](https://gitlab.khronos.org/openxr/openxr/merge_requests/2734))
- Loader spec: Clarify and deduplicate the loader specification's listing of
android manifest search paths.
([internal MR 2829](https://gitlab.khronos.org/openxr/openxr/merge_requests/2829),
[internal issue 2046](https://gitlab.khronos.org/openxr/openxr/issues/2046))
- Loader spec: Fix description of `<queries>` element contents: existing
description would fail to install.
([internal MR 2840](https://gitlab.khronos.org/openxr/openxr/merge_requests/2840),
[internal issue 2053](https://gitlab.khronos.org/openxr/openxr/issues/2053))
- Makefile: Remove obsolete cygwin support in spec building target, no longer
needed and actually caused it to not work under MSYS2.
([internal MR 2885](https://gitlab.khronos.org/openxr/openxr/merge_requests/2885))
- New vendor extension specification: `XR_META_passthrough_preferences`
([internal MR 2694](https://gitlab.khronos.org/openxr/openxr/merge_requests/2694))
- Style guide: Document the XML schema of `xr.xml`
([internal MR 2875](https://gitlab.khronos.org/openxr/openxr/merge_requests/2875))
- `XR_HTCX_vive_tracker_interaction`: Added new role paths for wrists and ankles.
([internal MR 2728](https://gitlab.khronos.org/openxr/openxr/merge_requests/2728))
- `XR_OPPO_controller_interaction`: Fix formatting of path lists.
([internal MR 2831](https://gitlab.khronos.org/openxr/openxr/merge_requests/2831),
[OpenXR-Docs issue 156](https://github.com/KhronosGroup/OpenXR-Docs/issues/156),
[internal issue 2047](https://gitlab.khronos.org/openxr/openxr/issues/2047))
- scripts: Provide better feedback on interface struct erroneously having a
values attribute.
([internal MR 2856](https://gitlab.khronos.org/openxr/openxr/merge_requests/2856))
- scripts: Update regex in xrconventions to allow words in type naming that
succeed digits but start with a "D"
([internal MR 2857](https://gitlab.khronos.org/openxr/openxr/merge_requests/2857))
- scripts: Fix formatting of "basetype" (generally typedef) names to once again
be monospace "code".
([internal MR 2890](https://gitlab.khronos.org/openxr/openxr/merge_requests/2890),
[internal issue 2048](https://gitlab.khronos.org/openxr/openxr/issues/2048))

## OpenXR Specification 1.0.28 (2023-07-10)

This release features a number of new extensions, including several multi-vendor
Expand Down
5 changes: 4 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ ifdef::env-github[]
:note-caption: :information_source:
endif::[]

// Copyright (c) 2017-2020 The Khronos Group Inc.
// Copyright (c) 2017-2023, The Khronos Group Inc.
//
// SPDX-License-Identifier: CC-BY-4.0

Expand All @@ -25,13 +25,16 @@ general public.

The directory structure is as follows:

// REUSE-IgnoreStart
```
README.adoc This file
COPYING.md Copyright and licensing information
CODE_OF_CONDUCT.md Code of Conduct
specification/ Specification - files to generate the spec
include/openxr/ Static OpenXR header (not generated from the Registry)
```
// REUSE-IgnoreEnd


== Building the Specification and Reference Pages, and Regenerating Headers

Expand Down
18 changes: 3 additions & 15 deletions specification/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ ifneq (,$(strip $(VERY_STRICT)))
ASCIIDOC := $(ASCIIDOC) --failure-level WARN
endif

SPECREVISION = 1.0.28
SPECREVISION = 1.0.29
REVISION_COMPONENTS = $(subst ., ,$(SPECREVISION))
MAJORMINORVER = $(word 1,$(REVISION_COMPONENTS)).$(word 2,$(REVISION_COMPONENTS))

Expand Down Expand Up @@ -384,26 +384,14 @@ BACKEND_ARGS=--backend html5
$(ASCIIDOCTOR_TARGETS):
$(ECHO) "[asciidoctor] $(SPECSRC) -> $(call MAKE_RELATIVE,$@)"
$(QUIET)$(MKDIR) "$(@D)"
$(QUIET)if [ $$(uname -s | cut -c 1-6) == "CYGWIN" ]; then \
OUTSPEC_DOS=$$(cygpath -w $@) ;\
SPECSRC_DOS=$$(cygpath -w $(SPECSRC)) ;\
ATTRIBOPTS_DOS='$(ATTRIBOPTS)' ;\
ADOCOPTS_DOS="--doctype book -a data-uri -r $$(cygpath -w $(CURDIR)/scripts/spec-macros.rb) $$ATTRIBOPTS_DOS" ;\
BATCH_FILE=$$(cygpath -w $$(mktemp)).bat ;\
echo $(ASCIIDOC) $$ADOCOPTS_DOS $(BACKEND_ARGS) --out-file $$OUTSPEC_DOS $$SPECSRC_DOS > $$BATCH_FILE ;\
CMD /C $$BATCH_FILE ;\
rm -f $$BATCH_FILE ;\
else \
$(ASCIIDOC) $(ADOCOPTS) $(BACKEND_ARGS) --out-file $@ $(SPECSRC) 2>&1 | tee $(LOGFILE) ;\
if [ -s $(LOGFILE) ]; then \
$(QUIET)$(ASCIIDOC) $(ADOCOPTS) $(BACKEND_ARGS) --out-file $@ $(SPECSRC) 2>&1 | tee $(LOGFILE)
$(QUIET)if [ -s $(LOGFILE) ]; then \
echo "Failure: $(LOGFILE) exists and is not empty!"; \
false; \
else \
rm $(LOGFILE); \
fi; \
fi
$(POSTPROCESS)
# TODO: Postprocess step(s) may have broken the Cygwin build. Not sure this matters anymore with WSL, though.


################################################
Expand Down
2 changes: 1 addition & 1 deletion specification/current_version.ini
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@
# Similarly, update specification/scripts/extensionmetadocgenerator.py as well.
MAJOR=1
MINOR=0
PATCH=28
PATCH=29
Loading

0 comments on commit 77afb1f

Please sign in to comment.