Skip to content

Commit

Permalink
Update urls to openxr specification
Browse files Browse the repository at this point in the history
  • Loading branch information
rasmusgo committed May 15, 2024
1 parent f96c98d commit 4681a25
Show file tree
Hide file tree
Showing 10 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
14 changes: 7 additions & 7 deletions openxr/src/display_refresh_rate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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};
Expand All @@ -13,8 +13,8 @@ impl<G> Session<G> {
/// [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<Vec<f32>> {
let ext = self
.inner
Expand All @@ -31,8 +31,8 @@ impl<G> Session<G> {
/// 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<f32> {
let ext = self
.inner
Expand All @@ -54,8 +54,8 @@ impl<G> Session<G> {
/// [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
Expand Down
2 changes: 1 addition & 1 deletion openxr/src/entry.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions openxr/src/graphics/d3d.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion openxr/src/graphics/opengl.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion openxr/src/graphics/opengles.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion openxr/src/graphics/vulkan.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
6 changes: 3 additions & 3 deletions openxr/src/instance.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down
6 changes: 3 additions & 3 deletions openxr/src/passthrough.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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::{
Expand All @@ -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 {
Expand Down Expand Up @@ -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<session::SessionInner>,
Expand Down
10 changes: 5 additions & 5 deletions openxr/src/session.rs
Original file line number Diff line number Diff line change
Expand Up @@ -311,14 +311,14 @@ impl<G> Session<G> {
#[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> {
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<Vec<sys::ColorSpaceFB>> {
let ext = self
.inner
Expand All @@ -334,7 +334,7 @@ impl<G> Session<G> {

/// 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
Expand Down Expand Up @@ -434,7 +434,7 @@ impl<G: Graphics> Session<G> {
///
/// 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> {
Passthrough::create(self, flags)
Expand All @@ -445,7 +445,7 @@ impl<G: Graphics> Session<G> {
///
/// 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,
Expand Down

0 comments on commit 4681a25

Please sign in to comment.