openxr 0.21.1

High-level, mostly-safe OpenXR bindings
Documentation 
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

use std::ptr;

use sys::platform::*;

use crate::sys::Handle as _;
use crate::*;

/// The OpenGL graphics API
///
/// See [`XR_KHR_opengl_enable`] for safety details.
///
/// [`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 {
    type Requirements = Requirements;
    type SessionCreateInfo = SessionCreateInfo;
    type Format = u32;
    type SwapchainImage = u32;

    fn raise_format(x: i64) -> u32 {
        x as _
    }
    fn lower_format(x: u32) -> i64 {
        x.into()
    }

    fn requirements(inst: &Instance, system: SystemId) -> Result<Requirements> {
        let out = unsafe {
            let mut x = sys::GraphicsRequirementsOpenGLKHR::out(ptr::null_mut());
            cvt((inst.opengl().get_open_gl_graphics_requirements)(
                inst.as_raw(),
                system,
                x.as_mut_ptr(),
            ))?;
            x.assume_init()
        };
        Ok(Requirements {
            min_api_version_supported: out.min_api_version_supported,
            max_api_version_supported: out.max_api_version_supported,
        })
    }

    unsafe fn create_session(
        instance: &Instance,
        system: SystemId,
        info: &Self::SessionCreateInfo,
    ) -> Result<sys::Session> {
        unsafe {
            match *info {
                #[cfg(windows)]
                SessionCreateInfo::Windows { h_dc, h_glrc } => {
                    let binding = sys::GraphicsBindingOpenGLWin32KHR {
                        ty: sys::GraphicsBindingOpenGLWin32KHR::TYPE,
                        next: ptr::null(),
                        h_dc,
                        h_glrc,
                    };
                    let info = sys::SessionCreateInfo {
                        ty: sys::SessionCreateInfo::TYPE,
                        next: &binding as *const _ as *const _,
                        create_flags: Default::default(),
                        system_id: system,
                    };
                    let mut out = sys::Session::NULL;
                    cvt((instance.fp().create_session)(
                        instance.as_raw(),
                        &info,
                        &mut out,
                    ))?;
                    Ok(out)
                }
                SessionCreateInfo::Xlib {
                    x_display,
                    visualid,
                    glx_fb_config,
                    glx_drawable,
                    glx_context,
                } => {
                    let binding = sys::GraphicsBindingOpenGLXlibKHR {
                        ty: sys::GraphicsBindingOpenGLXlibKHR::TYPE,
                        next: ptr::null(),
                        x_display,
                        visualid,
                        glx_fb_config,
                        glx_drawable,
                        glx_context,
                    };
                    let info = sys::SessionCreateInfo {
                        ty: sys::SessionCreateInfo::TYPE,
                        next: &binding as *const _ as *const _,
                        create_flags: Default::default(),
                        system_id: system,
                    };
                    let mut out = sys::Session::NULL;
                    cvt((instance.fp().create_session)(
                        instance.as_raw(),
                        &info,
                        &mut out,
                    ))?;
                    Ok(out)
                }
                SessionCreateInfo::Wayland { display } => {
                    let binding = sys::GraphicsBindingOpenGLWaylandKHR {
                        ty: sys::GraphicsBindingOpenGLWaylandKHR::TYPE,
                        next: ptr::null(),
                        display,
                    };
                    let info = sys::SessionCreateInfo {
                        ty: sys::SessionCreateInfo::TYPE,
                        next: &binding as *const _ as *const _,
                        create_flags: Default::default(),
                        system_id: system,
                    };
                    let mut out = sys::Session::NULL;
                    cvt((instance.fp().create_session)(
                        instance.as_raw(),
                        &info,
                        &mut out,
                    ))?;
                    Ok(out)
                }
            }
        }
    }

    fn enumerate_swapchain_images(
        swapchain: &Swapchain<Self>,
    ) -> Result<Vec<Self::SwapchainImage>> {
        let images = get_arr_init(
            sys::SwapchainImageOpenGLKHR {
                ty: sys::SwapchainImageOpenGLKHR::TYPE,
                next: ptr::null_mut(),
                image: 0,
            },
            |capacity, count, buf| unsafe {
                (swapchain.instance().fp().enumerate_swapchain_images)(
                    swapchain.as_raw(),
                    capacity,
                    count,
                    buf as *mut _,
                )
            },
        )?;
        Ok(images.into_iter().map(|x| x.image).collect())
    }
}

#[derive(Copy, Clone)]
pub struct Requirements {
    pub min_api_version_supported: Version,
    pub max_api_version_supported: Version,
}

pub enum SessionCreateInfo {
    Xlib {
        x_display: *mut Display,
        visualid: u32,
        glx_fb_config: GLXFBConfig,
        glx_drawable: GLXDrawable,
        glx_context: GLXContext,
    },
    Wayland {
        display: *mut wl_display,
    },
    #[cfg(windows)]
    Windows {
        h_dc: HDC,
        h_glrc: HGLRC,
    },
}