bevy_oxr 0.3.0

Community crate for OpenXR in Bevy
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
use std::sync::atomic::AtomicBool;
use std::sync::{Arc, Mutex};

// use anyhow::Context;
use bevy::math::uvec2;
use bevy::prelude::*;
use bevy::render::renderer::{
    RenderAdapter, RenderAdapterInfo, RenderDevice, RenderQueue, WgpuWrapper,
};
use bevy::window::RawHandleWrapper;
use eyre::{Context, ContextCompat};
use openxr as xr;
use wgpu::Instance;
use wgpu_hal::{api::Dx12, Api};
use wgpu_hal::{Adapter as HalAdapter, Instance as HalInstance};
use winapi::shared::dxgiformat::{self, DXGI_FORMAT};
use winapi::um::{d3d12 as winapi_d3d12, d3dcommon};
use xr::EnvironmentBlendMode;

use crate::graphics::extensions::XrExtensions;
use crate::input::XrInput;

use crate::resources::{
    OXrSessionSetupInfo, Swapchain, SwapchainInner, XrEnvironmentBlendMode, XrFormat, XrFrameState,
    XrFrameWaiter, XrInstance, XrResolution, XrSession, XrSessionRunning, XrSwapchain, XrViews,
};

#[cfg(all(feature = "d3d12", windows))]
use crate::resources::D3D12OXrSessionSetupInfo;
#[cfg(feature = "vulkan")]
use crate::resources::VulkanOXrSessionSetupInfo;

use super::{XrAppInfo, XrPreferdBlendMode};
use crate::VIEW_TYPE;

pub fn initialize_xr_instance(
    window: Option<RawHandleWrapper>,
    xr_entry: xr::Entry,
    reqeusted_extensions: XrExtensions,
    available_extensions: XrExtensions,
    prefered_blend_mode: XrPreferdBlendMode,
    app_info: XrAppInfo,
) -> eyre::Result<(
    XrInstance,
    OXrSessionSetupInfo,
    XrEnvironmentBlendMode,
    RenderDevice,
    RenderQueue,
    RenderAdapterInfo,
    RenderAdapter,
    Instance,
)> {
    #[cfg(target_os = "android")]
    xr_entry.initialize_android_loader()?;

    assert!(available_extensions.raw().khr_d3d12_enable);
    //info!("available xr exts: {:#?}", available_extensions);

    let mut enabled_extensions: xr::ExtensionSet =
        (available_extensions & reqeusted_extensions).into();
    enabled_extensions.khr_d3d12_enable = true;

    let available_layers = xr_entry.enumerate_layers()?;
    //info!("available xr layers: {:#?}", available_layers);

    let xr_instance = xr_entry.create_instance(
        &xr::ApplicationInfo {
            application_name: &app_info.name,
            engine_name: "Bevy",
            ..Default::default()
        },
        &enabled_extensions,
        &[],
    )?;
    info!("created OpenXR instance");
    let instance_props = xr_instance.properties()?;
    let xr_system_id = xr_instance.system(xr::FormFactor::HEAD_MOUNTED_DISPLAY)?;
    info!("created OpenXR system");
    let system_props = xr_instance.system_properties(xr_system_id).unwrap();
    info!(
        "loaded OpenXR runtime: {} {} {}",
        instance_props.runtime_name,
        instance_props.runtime_version,
        if system_props.system_name.is_empty() {
            "<unnamed>"
        } else {
            &system_props.system_name
        }
    );

    let blend_modes = xr_instance.enumerate_environment_blend_modes(xr_system_id, VIEW_TYPE)?;
    let blend_mode: EnvironmentBlendMode = match prefered_blend_mode {
        XrPreferdBlendMode::Opaque if blend_modes.contains(&EnvironmentBlendMode::OPAQUE) => {
            bevy::log::info!("Using Opaque");
            EnvironmentBlendMode::OPAQUE
        }
        XrPreferdBlendMode::Additive if blend_modes.contains(&EnvironmentBlendMode::ADDITIVE) => {
            bevy::log::info!("Using Additive");
            EnvironmentBlendMode::ADDITIVE
        }
        XrPreferdBlendMode::AlphaBlend
            if blend_modes.contains(&EnvironmentBlendMode::ALPHA_BLEND) =>
        {
            bevy::log::info!("Using AlphaBlend");
            EnvironmentBlendMode::ALPHA_BLEND
        }
        _ => {
            bevy::log::info!("Using Opaque");
            EnvironmentBlendMode::OPAQUE
        }
    };

    let reqs = xr_instance.graphics_requirements::<xr::D3D12>(xr_system_id)?;

    let instance_descriptor = &wgpu_hal::InstanceDescriptor {
        name: &app_info.name,
        dx12_shader_compiler: wgpu::util::dx12_shader_compiler_from_env().unwrap_or(
            wgpu::Dx12Compiler::Dxc {
                dxil_path: None,
                dxc_path: None,
            },
        ),
        flags: wgpu::InstanceFlags::from_build_config().with_env(),
        gles_minor_version: Default::default(),
    };
    let wgpu_raw_instance: wgpu_hal::dx12::Instance =
        unsafe { wgpu_hal::dx12::Instance::init(instance_descriptor)? };
    let wgpu_adapters: Vec<wgpu_hal::ExposedAdapter<wgpu_hal::dx12::Api>> =
        unsafe { wgpu_raw_instance.enumerate_adapters() };
    let wgpu_exposed_adapter = wgpu_adapters
        .into_iter()
        .find(|a| {
            let mut desc = unsafe { std::mem::zeroed() };
            unsafe { a.adapter.raw_adapter().GetDesc1(&mut desc) };
            desc.AdapterLuid.HighPart == reqs.adapter_luid.HighPart
                && desc.AdapterLuid.LowPart == reqs.adapter_luid.LowPart
        })
        .context("failed to find DXGI adapter matching LUID provided by runtime")?;

    let wgpu_instance =
        unsafe { wgpu::Instance::from_hal::<wgpu_hal::api::Dx12>(wgpu_raw_instance) };

    let wgpu_features = wgpu::Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES
        | wgpu::Features::MULTIVIEW
        | wgpu::Features::MULTI_DRAW_INDIRECT_COUNT
        | wgpu::Features::MULTI_DRAW_INDIRECT;

    let wgpu_limits = wgpu::Limits {
        max_bind_groups: 8,
        max_storage_buffer_binding_size: wgpu_exposed_adapter
            .capabilities
            .limits
            .max_storage_buffer_binding_size,
        max_push_constant_size: 4,
        ..Default::default()
    };

    let wgpu_open_device = unsafe {
        wgpu_exposed_adapter
            .adapter
            .open(wgpu_features, &wgpu_limits)?
    };

    let device_supported_feature_level: d3d12::FeatureLevel =
        get_device_feature_level(wgpu_open_device.device.raw_device());

    if (device_supported_feature_level as u32) < (reqs.min_feature_level as u32) {
        panic!(
            "OpenXR runtime requires D3D12 feature level >= {}",
            reqs.min_feature_level
        );
    }

    let (session, frame_wait, frame_stream) = unsafe {
        xr_instance.create_session::<xr::D3D12>(
            xr_system_id,
            &xr::d3d::SessionCreateInfoD3D12 {
                device: wgpu_open_device.device.raw_device().as_mut_ptr().cast(),
                queue: wgpu_open_device.device.raw_queue().as_mut_ptr().cast(),
            },
        )
    }?;

    let wgpu_adapter = unsafe { wgpu_instance.create_adapter_from_hal(wgpu_exposed_adapter) };
    let raw_device = wgpu_open_device.device.raw_device().as_mut_ptr();
    let raw_queue = wgpu_open_device.device.raw_queue().as_mut_ptr();
    let (wgpu_device, wgpu_queue) = unsafe {
        wgpu_adapter.create_device_from_hal(
            wgpu_open_device,
            &wgpu::DeviceDescriptor {
                label: Some("bevy_oxr device"),
                required_features: wgpu_features,
                required_limits: wgpu_limits,
            },
            None,
        )?
    };

    Ok((
        xr_instance.into(),
        OXrSessionSetupInfo::D3D12(D3D12OXrSessionSetupInfo {
            raw_device,
            raw_queue,
            xr_system_id,
        }),
        blend_mode.into(),
        wgpu_device.into(),
        RenderQueue(Arc::new(WgpuWrapper::new(wgpu_queue))),
        RenderAdapterInfo(WgpuWrapper::new(wgpu_adapter.get_info())),
        RenderAdapter(Arc::new(WgpuWrapper::new(wgpu_adapter))),
        wgpu_instance.into(),
    ))
}

pub fn start_xr_session(
    window: Option<RawHandleWrapper>,
    ptrs: &OXrSessionSetupInfo,
    xr_instance: &XrInstance,
    render_device: &RenderDevice,
    render_adapter: &RenderAdapter,
    wgpu_instance: &Instance,
) -> eyre::Result<(
    XrSession,
    XrResolution,
    XrFormat,
    XrSessionRunning,
    XrFrameWaiter,
    XrSwapchain,
    XrInput,
    XrViews,
    XrFrameState,
)> {
    let wgpu_device = render_device.wgpu_device();
    let wgpu_adapter = &render_adapter.0;

    #[allow(unreachable_patterns)]
    let setup_info = match ptrs {
        OXrSessionSetupInfo::D3D12(v) => v,
        _ => eyre::bail!("Wrong Graphics Api"),
    };
    let (session, frame_wait, frame_stream) = unsafe {
        xr_instance.create_session::<xr::D3D12>(
            setup_info.xr_system_id,
            &xr::d3d::SessionCreateInfoD3D12 {
                device: setup_info.raw_device.cast(),
                queue: setup_info.raw_queue.cast(),
            },
        )
    }?;

    let views =
        xr_instance.enumerate_view_configuration_views(setup_info.xr_system_id, VIEW_TYPE)?;
    let surface = window.map(|wrapper| unsafe {
        // SAFETY: Plugins should be set up on the main thread.
        let handle = wrapper.get_handle();
        wgpu_instance
            .create_surface(handle)
            .expect("Failed to create wgpu surface")
    });
    let swapchain_format = surface
        .as_ref()
        .map(|surface| surface.get_capabilities(wgpu_adapter).formats[0])
        .unwrap_or(wgpu::TextureFormat::Rgba8UnormSrgb);

    // TODO: Log swapchain format

    let resolution = uvec2(
        views[0].recommended_image_rect_width,
        views[0].recommended_image_rect_height,
    );

    let handle = session
        .create_swapchain(&xr::SwapchainCreateInfo {
            create_flags: xr::SwapchainCreateFlags::EMPTY,
            usage_flags: xr::SwapchainUsageFlags::COLOR_ATTACHMENT
                | xr::SwapchainUsageFlags::SAMPLED,
            format: wgpu_to_d3d12(swapchain_format).expect("Unsupported texture format"),
            // The Vulkan graphics pipeline we create is not set up for multisampling,
            // so we hardcode this to 1. If we used a proper multisampling setup, we
            // could set this to `views[0].recommended_swapchain_sample_count`.
            sample_count: 1,
            width: resolution.x,
            height: resolution.y,
            face_count: 1,
            array_size: 2,
            mip_count: 1,
        })
        .unwrap();

    let images = handle.enumerate_images().unwrap();

    let buffers = images
        .into_iter()
        .map(|color_image| {
            info!("image map swapchain");
            let wgpu_hal_texture = unsafe {
                <Dx12 as Api>::Device::texture_from_raw(
                    d3d12::ComPtr::from_raw(color_image as *mut _),
                    swapchain_format,
                    wgpu::TextureDimension::D2,
                    wgpu::Extent3d {
                        width: resolution.x,
                        height: resolution.y,
                        depth_or_array_layers: 2,
                    },
                    1,
                    1,
                )
            };
            let texture = unsafe {
                wgpu_device.create_texture_from_hal::<Dx12>(
                    wgpu_hal_texture,
                    &wgpu::TextureDescriptor {
                        label: Some("bevy_openxr swapchain"),
                        size: wgpu::Extent3d {
                            width: resolution.x,
                            height: resolution.y,
                            depth_or_array_layers: 2,
                        },
                        mip_level_count: 1,
                        sample_count: 1,
                        dimension: wgpu::TextureDimension::D2,
                        format: swapchain_format,
                        usage: wgpu::TextureUsages::RENDER_ATTACHMENT
                            | wgpu::TextureUsages::COPY_DST,
                        view_formats: &[],
                    },
                )
            };
            texture
        })
        .collect();

    Ok((
        XrSession::D3D12(session.clone()),
        resolution.into(),
        swapchain_format.into(),
        // TODO: this shouldn't be in here
        AtomicBool::new(false).into(),
        frame_wait.into(),
        Swapchain::D3D12(SwapchainInner {
            stream: Mutex::new(frame_stream),
            handle: Mutex::new(handle),
            buffers,
            image_index: Mutex::new(0),
        })
        .into(),
        XrInput::new(xr_instance, &session.into_any_graphics())?,
        Vec::default().into(),
        // TODO: Feels wrong to return a FrameState here, we probably should just wait for the next frame
        xr::FrameState {
            predicted_display_time: xr::Time::from_nanos(1),
            predicted_display_period: xr::Duration::from_nanos(1),
            should_render: true,
        }
        .into(),
    ))
}

// Extracted from https://github.com/gfx-rs/wgpu/blob/1161a22f4fbb4fc204eb06f2ac4243f83e0e980d/wgpu-hal/src/dx12/adapter.rs#L73-L94
// license: MIT OR Apache-2.0
fn get_device_feature_level(
    device: &d3d12::ComPtr<winapi_d3d12::ID3D12Device>,
) -> d3d12::FeatureLevel {
    // Detect the highest supported feature level.
    let d3d_feature_level = [
        d3d12::FeatureLevel::L12_1,
        d3d12::FeatureLevel::L12_0,
        d3d12::FeatureLevel::L11_1,
        d3d12::FeatureLevel::L11_0,
    ];
    type FeatureLevelsInfo = winapi_d3d12::D3D12_FEATURE_DATA_FEATURE_LEVELS;
    let mut device_levels: FeatureLevelsInfo = unsafe { std::mem::zeroed() };
    device_levels.NumFeatureLevels = d3d_feature_level.len() as u32;
    device_levels.pFeatureLevelsRequested = d3d_feature_level.as_ptr().cast();
    unsafe {
        device.CheckFeatureSupport(
            winapi_d3d12::D3D12_FEATURE_FEATURE_LEVELS,
            (&mut device_levels as *mut FeatureLevelsInfo).cast(),
            std::mem::size_of::<FeatureLevelsInfo>() as _,
        )
    };
    // This cast should never fail because we only requested feature levels that are already in the enum.
    let max_feature_level = d3d12::FeatureLevel::try_from(device_levels.MaxSupportedFeatureLevel)
        .expect("Unexpected feature level");
    max_feature_level
}

fn wgpu_to_d3d12(format: wgpu::TextureFormat) -> Option<DXGI_FORMAT> {
    // Copied wholesale from:
    // https://github.com/gfx-rs/wgpu/blob/v0.19/wgpu-hal/src/auxil/dxgi/conv.rs#L12-L94
    // license: MIT OR Apache-2.0
    use wgpu::TextureFormat as Tf;
    use winapi::shared::dxgiformat::*;

    Some(match format {
        Tf::R8Unorm => DXGI_FORMAT_R8_UNORM,
        Tf::R8Snorm => DXGI_FORMAT_R8_SNORM,
        Tf::R8Uint => DXGI_FORMAT_R8_UINT,
        Tf::R8Sint => DXGI_FORMAT_R8_SINT,
        Tf::R16Uint => DXGI_FORMAT_R16_UINT,
        Tf::R16Sint => DXGI_FORMAT_R16_SINT,
        Tf::R16Unorm => DXGI_FORMAT_R16_UNORM,
        Tf::R16Snorm => DXGI_FORMAT_R16_SNORM,
        Tf::R16Float => DXGI_FORMAT_R16_FLOAT,
        Tf::Rg8Unorm => DXGI_FORMAT_R8G8_UNORM,
        Tf::Rg8Snorm => DXGI_FORMAT_R8G8_SNORM,
        Tf::Rg8Uint => DXGI_FORMAT_R8G8_UINT,
        Tf::Rg8Sint => DXGI_FORMAT_R8G8_SINT,
        Tf::Rg16Unorm => DXGI_FORMAT_R16G16_UNORM,
        Tf::Rg16Snorm => DXGI_FORMAT_R16G16_SNORM,
        Tf::R32Uint => DXGI_FORMAT_R32_UINT,
        Tf::R32Sint => DXGI_FORMAT_R32_SINT,
        Tf::R32Float => DXGI_FORMAT_R32_FLOAT,
        Tf::Rg16Uint => DXGI_FORMAT_R16G16_UINT,
        Tf::Rg16Sint => DXGI_FORMAT_R16G16_SINT,
        Tf::Rg16Float => DXGI_FORMAT_R16G16_FLOAT,
        Tf::Rgba8Unorm => DXGI_FORMAT_R8G8B8A8_UNORM,
        Tf::Rgba8UnormSrgb => DXGI_FORMAT_R8G8B8A8_UNORM_SRGB,
        Tf::Bgra8UnormSrgb => DXGI_FORMAT_B8G8R8A8_UNORM_SRGB,
        Tf::Rgba8Snorm => DXGI_FORMAT_R8G8B8A8_SNORM,
        Tf::Bgra8Unorm => DXGI_FORMAT_B8G8R8A8_UNORM,
        Tf::Rgba8Uint => DXGI_FORMAT_R8G8B8A8_UINT,
        Tf::Rgba8Sint => DXGI_FORMAT_R8G8B8A8_SINT,
        Tf::Rgb9e5Ufloat => DXGI_FORMAT_R9G9B9E5_SHAREDEXP,
        Tf::Rgb10a2Uint => DXGI_FORMAT_R10G10B10A2_UINT,
        Tf::Rgb10a2Unorm => DXGI_FORMAT_R10G10B10A2_UNORM,
        Tf::Rg11b10Float => DXGI_FORMAT_R11G11B10_FLOAT,
        Tf::Rg32Uint => DXGI_FORMAT_R32G32_UINT,
        Tf::Rg32Sint => DXGI_FORMAT_R32G32_SINT,
        Tf::Rg32Float => DXGI_FORMAT_R32G32_FLOAT,
        Tf::Rgba16Uint => DXGI_FORMAT_R16G16B16A16_UINT,
        Tf::Rgba16Sint => DXGI_FORMAT_R16G16B16A16_SINT,
        Tf::Rgba16Unorm => DXGI_FORMAT_R16G16B16A16_UNORM,
        Tf::Rgba16Snorm => DXGI_FORMAT_R16G16B16A16_SNORM,
        Tf::Rgba16Float => DXGI_FORMAT_R16G16B16A16_FLOAT,
        Tf::Rgba32Uint => DXGI_FORMAT_R32G32B32A32_UINT,
        Tf::Rgba32Sint => DXGI_FORMAT_R32G32B32A32_SINT,
        Tf::Rgba32Float => DXGI_FORMAT_R32G32B32A32_FLOAT,
        Tf::Stencil8 => DXGI_FORMAT_D24_UNORM_S8_UINT,
        Tf::Depth16Unorm => DXGI_FORMAT_D16_UNORM,
        Tf::Depth24Plus => DXGI_FORMAT_D24_UNORM_S8_UINT,
        Tf::Depth24PlusStencil8 => DXGI_FORMAT_D24_UNORM_S8_UINT,
        Tf::Depth32Float => DXGI_FORMAT_D32_FLOAT,
        Tf::Depth32FloatStencil8 => DXGI_FORMAT_D32_FLOAT_S8X24_UINT,
        Tf::NV12 => DXGI_FORMAT_NV12,
        Tf::Bc1RgbaUnorm => DXGI_FORMAT_BC1_UNORM,
        Tf::Bc1RgbaUnormSrgb => DXGI_FORMAT_BC1_UNORM_SRGB,
        Tf::Bc2RgbaUnorm => DXGI_FORMAT_BC2_UNORM,
        Tf::Bc2RgbaUnormSrgb => DXGI_FORMAT_BC2_UNORM_SRGB,
        Tf::Bc3RgbaUnorm => DXGI_FORMAT_BC3_UNORM,
        Tf::Bc3RgbaUnormSrgb => DXGI_FORMAT_BC3_UNORM_SRGB,
        Tf::Bc4RUnorm => DXGI_FORMAT_BC4_UNORM,
        Tf::Bc4RSnorm => DXGI_FORMAT_BC4_SNORM,
        Tf::Bc5RgUnorm => DXGI_FORMAT_BC5_UNORM,
        Tf::Bc5RgSnorm => DXGI_FORMAT_BC5_SNORM,
        Tf::Bc6hRgbUfloat => DXGI_FORMAT_BC6H_UF16,
        Tf::Bc6hRgbFloat => DXGI_FORMAT_BC6H_SF16,
        Tf::Bc7RgbaUnorm => DXGI_FORMAT_BC7_UNORM,
        Tf::Bc7RgbaUnormSrgb => DXGI_FORMAT_BC7_UNORM_SRGB,
        Tf::Etc2Rgb8Unorm
        | Tf::Etc2Rgb8UnormSrgb
        | Tf::Etc2Rgb8A1Unorm
        | Tf::Etc2Rgb8A1UnormSrgb
        | Tf::Etc2Rgba8Unorm
        | Tf::Etc2Rgba8UnormSrgb
        | Tf::EacR11Unorm
        | Tf::EacR11Snorm
        | Tf::EacRg11Unorm
        | Tf::EacRg11Snorm
        | Tf::Astc {
            block: _,
            channel: _,
        } => return None,
    })
}