diff --git a/README.md b/README.md index 3d04ac3a..b246dd18 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Rust bindings for the OpenXR virtual/augmented reality runtime API. Refer to [the -specification](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html) +specification](https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html) for detailed documentation on individual API calls. ## `openxr` diff --git a/openxr/src/display_refresh_rate.rs b/openxr/src/display_refresh_rate.rs index 8136c156..63e0276e 100644 --- a/openxr/src/display_refresh_rate.rs +++ b/openxr/src/display_refresh_rate.rs @@ -2,7 +2,7 @@ //! The extension also includes a new event ([`Event::DisplayRefreshRateChangedFB`]) that gets //! sent when the display refresh rate changes. //! -//! [`XR_FB_display_refresh_rate`]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_FB_display_refresh_rate +//! [`XR_FB_display_refresh_rate`]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XR_FB_display_refresh_rate //! [`Event::DisplayRefreshRateChangedFB`]: crate::Event::DisplayRefreshRateChangedFB use crate::{cvt, Session}; @@ -13,8 +13,8 @@ impl Session { /// [Enumerates] the supported display refresh rates. /// Requires [`XR_FB_display_refresh_rate`] /// - /// [Enumerates]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#xrEnumerateDisplayRefreshRatesFB - /// [`XR_FB_display_refresh_rate`]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_FB_display_refresh_rate + /// [Enumerates]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#xrEnumerateDisplayRefreshRatesFB + /// [`XR_FB_display_refresh_rate`]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XR_FB_display_refresh_rate pub fn enumerate_display_refresh_rates(&self) -> Result> { let ext = self .inner @@ -31,8 +31,8 @@ impl Session { /// Retrieves the [current display refresh rate]. /// Requires [`XR_FB_display_refresh_rate`] /// - /// [current display refresh rate]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#xrGetDisplayRefreshRateFB - /// [`XR_FB_display_refresh_rate`]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_FB_display_refresh_rate + /// [current display refresh rate]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#xrGetDisplayRefreshRateFB + /// [`XR_FB_display_refresh_rate`]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XR_FB_display_refresh_rate pub fn get_display_refresh_rate(&self) -> Result { let ext = self .inner @@ -54,8 +54,8 @@ impl Session { /// [Requests] a change to the `display_refresh_rate`. /// Requires [`XR_FB_display_refresh_rate`] /// - /// [Requests]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#xrRequestDisplayRefreshRateFB - /// [`XR_FB_display_refresh_rate`]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_FB_display_refresh_rate + /// [Requests]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#xrRequestDisplayRefreshRateFB + /// [`XR_FB_display_refresh_rate`]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XR_FB_display_refresh_rate pub fn request_display_refresh_rate(&self, display_refresh_rate: f32) -> Result<()> { let ext = self .inner diff --git a/openxr/src/entry.rs b/openxr/src/entry.rs index 8f25c273..8a19d21a 100644 --- a/openxr/src/entry.rs +++ b/openxr/src/entry.rs @@ -355,7 +355,7 @@ pub struct ApplicationInfo<'a> { } #[derive(Debug, Clone, PartialEq, Eq)] -#[doc = "See [XrApiLayerProperties](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrApiLayerProperties)"] +#[doc = "See [XrApiLayerProperties](https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XrApiLayerProperties)"] pub struct ApiLayerProperties { pub layer_name: String, pub spec_version: Version, diff --git a/openxr/src/graphics/d3d.rs b/openxr/src/graphics/d3d.rs index 5c7a23aa..03bdbcf2 100644 --- a/openxr/src/graphics/d3d.rs +++ b/openxr/src/graphics/d3d.rs @@ -8,7 +8,7 @@ use crate::*; /// /// See [`XR_KHR_d3d11_enable`] for safety details. /// -/// [`XR_KHR_d3d_enable`]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_KHR_D3D11_enable +/// [`XR_KHR_d3d_enable`]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XR_KHR_D3D11_enable pub enum D3D11 {} impl Graphics for D3D11 { @@ -91,7 +91,7 @@ impl Graphics for D3D11 { /// /// See [`XR_KHR_d3d12_enable`] for safety details. /// -/// [`XR_KHR_d3d_enable`]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_KHR_D3D12_enable +/// [`XR_KHR_d3d_enable`]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XR_KHR_D3D12_enable pub enum D3D12 {} impl Graphics for D3D12 { diff --git a/openxr/src/graphics/opengl.rs b/openxr/src/graphics/opengl.rs index 9c9501b3..7972ff89 100644 --- a/openxr/src/graphics/opengl.rs +++ b/openxr/src/graphics/opengl.rs @@ -8,7 +8,7 @@ use crate::*; /// /// See [`XR_KHR_opengl_enable`] for safety details. /// -/// [`XR_KHR_opengl_enable`]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_KHR_opengl_enable +/// [`XR_KHR_opengl_enable`]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XR_KHR_opengl_enable pub enum OpenGL {} impl Graphics for OpenGL { diff --git a/openxr/src/graphics/opengles.rs b/openxr/src/graphics/opengles.rs index fec7a3d4..765df642 100644 --- a/openxr/src/graphics/opengles.rs +++ b/openxr/src/graphics/opengles.rs @@ -9,7 +9,7 @@ use crate::*; /// /// See [`XR_KHR_opengl_es_enable`] for safety details. /// -/// [`XR_KHR_opengl_es_enable`]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_KHR_opengl_es_enable +/// [`XR_KHR_opengl_es_enable`]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XR_KHR_opengl_es_enable pub enum OpenGlEs {} impl Graphics for OpenGlEs { diff --git a/openxr/src/graphics/vulkan.rs b/openxr/src/graphics/vulkan.rs index 656c48c6..8e0d970b 100644 --- a/openxr/src/graphics/vulkan.rs +++ b/openxr/src/graphics/vulkan.rs @@ -8,7 +8,7 @@ use crate::*; /// /// See [`XR_KHR_vulkan_enable2`] for safety details. /// -/// [`XR_KHR_vulkan_enable2`]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_KHR_vulkan_enable2 +/// [`XR_KHR_vulkan_enable2`]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XR_KHR_vulkan_enable2 pub enum Vulkan {} impl Graphics for Vulkan { diff --git a/openxr/src/instance.rs b/openxr/src/instance.rs index 526de155..a2f44568 100644 --- a/openxr/src/instance.rs +++ b/openxr/src/instance.rs @@ -195,7 +195,7 @@ impl Instance { /// /// See [`XR_KHR_vulkan_enable2`]. /// - /// [`XR_KHR_vulkan_enable2`]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#_vulkan_instance_creation + /// [`XR_KHR_vulkan_enable2`]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#_vulkan_instance_creation #[inline] pub unsafe fn create_vulkan_instance( &self, @@ -309,7 +309,7 @@ impl Instance { /// /// See [`XR_KHR_vulkan_enable2`]. /// - /// [`XR_KHR_vulkan_enable2`]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#_vulkan_device_creation + /// [`XR_KHR_vulkan_enable2`]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#_vulkan_device_creation #[inline] pub unsafe fn create_vulkan_device( &self, @@ -591,7 +591,7 @@ impl Instance { /// Allocate a new [`ActionSet`] /// - /// [`ActionSet`]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#input-action-creation + /// [`ActionSet`]: https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#input-action-sets #[inline] pub fn create_action_set( &self, diff --git a/openxr/src/passthrough.rs b/openxr/src/passthrough.rs index 0ab33f6d..b6eee7b9 100644 --- a/openxr/src/passthrough.rs +++ b/openxr/src/passthrough.rs @@ -4,7 +4,7 @@ //! This feature is exclusive to the Oculus Quest 2 as of March 2022. //! //! More details about passthrough can be found in the [Oculus Native SDK documentation](https://developer.oculus.com/documentation/native/android/mobile-passthrough/) -//! as well as in the [OpenXR specification](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPassthroughFB) +//! as well as in the [OpenXR specification](https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XrPassthroughFB) //! //! Not all features are currently implemented. Execution control features are implemented, style-oriented features are not. use crate::{ @@ -21,7 +21,7 @@ use sys::PassthroughLayerFB; /// /// See the [`PassthroughFB struct`]. /// -/// [`XR_FB_passthrough`]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_FB_passthrough +/// [`XR_FB_passthrough`]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XR_FB_passthrough /// [`PassthroughFB struct`]: https://docs.rs/openxr-sys/latest/openxr_sys/struct.PassthroughFB.html /// [passthrough feature]: https://developer.oculus.com/documentation/native/android/mobile-passthrough/#create-and-start-a-passthrough-feature pub struct Passthrough { @@ -86,7 +86,7 @@ impl Drop for Passthrough { /// /// Requires [`XR_FB_passthrough`]. /// -/// [`XR_FB_passthrough`]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_FB_passthrough +/// [`XR_FB_passthrough`]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XR_FB_passthrough /// [passthrough layer]: https://developer.oculus.com/documentation/native/android/mobile-passthrough/#create-and-start-a-passthrough-layer pub struct PassthroughLayer { pub(crate) session: Arc, diff --git a/openxr/src/session.rs b/openxr/src/session.rs index a30bfa5f..69e8b95d 100644 --- a/openxr/src/session.rs +++ b/openxr/src/session.rs @@ -311,14 +311,14 @@ impl Session { #[inline] /// Create a hand tracker /// - /// Requires [`XR_EXT_hand_tracking`](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_EXT_hand_tracking) + /// Requires [`XR_EXT_hand_tracking`](https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XR_EXT_hand_tracking) pub fn create_hand_tracker(&self, hand: Hand) -> Result { HandTracker::create(self, hand) } /// Enumerate the list of supported color spaces for [`Session::set_color_space`] /// - /// Requires [`XR_FB_color_space`](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_FB_color_space) + /// Requires [`XR_FB_color_space`](https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XR_FB_color_space) pub fn enumerate_color_spaces(&self) -> Result> { let ext = self .inner @@ -334,7 +334,7 @@ impl Session { /// Specify the color space used in the final rendered frame /// - /// Requires [`XR_FB_color_space`](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_FB_color_space) + /// Requires [`XR_FB_color_space`](https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XR_FB_color_space) pub fn set_color_space(&self, color_space: sys::ColorSpaceFB) -> Result<()> { let ext = self .inner @@ -434,7 +434,7 @@ impl Session { /// /// Requires [`XR_FB_passthrough`]. /// - /// [`XR_FB_passthrough`]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_FB_passthrough + /// [`XR_FB_passthrough`]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XR_FB_passthrough /// [`Passthrough`]: passthrough/struct.Passthrough.html pub fn create_passthrough(&self, flags: PassthroughFlagsFB) -> Result { Passthrough::create(self, flags) @@ -445,7 +445,7 @@ impl Session { /// /// Requires [`XR_FB_passthrough`]. /// - /// [`XR_FB_passthrough`]: https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_FB_passthrough + /// [`XR_FB_passthrough`]: https://www.khronos.org/registry/OpenXR/specs/1.1/html/xrspec.html#XR_FB_passthrough /// [`PassthroughLayer`]: passthrough/struct.PassthroughLayer.html pub fn create_passthrough_layer( &self,