renderdoc 0.10.1

RenderDoc application bindings for Rust
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

//! Portable wrapper types around platform specific window and device handles.

use std::os::raw::c_void;

#[cfg(feature = "glutin")]
use glutin::platform::ContextTraitExt;
#[cfg(windows)]
use wio::com::ComPtr;

/// Raw mutable pointer to the OS-provided window handle.
pub type WindowHandle = *const c_void;

/// Raw mutable pointer to the API's root handle.
///
/// For example, this could be a pointer to an `ID3D11Device`, `HGLRC`/`GLXContext`,
/// `ID3D12Device`, etc.
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct DevicePointer(pub(crate) *const c_void);

impl From<*const c_void> for DevicePointer {
    fn from(ptr: *const c_void) -> Self {
        DevicePointer(ptr)
    }
}

impl From<*mut c_void> for DevicePointer {
    fn from(ptr: *mut c_void) -> Self {
        DevicePointer(ptr)
    }
}

#[cfg(windows)]
impl From<winapi::shared::windef::HGLRC> for DevicePointer {
    fn from(ctx: winapi::shared::windef::HGLRC) -> Self {
        DevicePointer(ctx as *mut _ as *const c_void)
    }
}

#[cfg(windows)]
impl From<*mut winapi::um::d3d11::ID3D11Device> for DevicePointer {
    fn from(ctx: *mut winapi::um::d3d11::ID3D11Device) -> Self {
        DevicePointer(ctx as *mut _ as *const c_void)
    }
}

#[cfg(windows)]
impl From<ComPtr<winapi::um::d3d11::ID3D11Device>> for DevicePointer {
    fn from(ctx: ComPtr<winapi::um::d3d11::ID3D11Device>) -> Self {
        DevicePointer(ctx.as_raw() as *mut _ as *const c_void)
    }
}

#[cfg(windows)]
impl From<*mut winapi::um::d3d12::ID3D12Device> for DevicePointer {
    fn from(ctx: *mut winapi::um::d3d12::ID3D12Device) -> Self {
        DevicePointer(ctx as *mut _ as *const c_void)
    }
}

#[cfg(windows)]
impl From<ComPtr<winapi::um::d3d12::ID3D12Device>> for DevicePointer {
    fn from(ctx: ComPtr<winapi::um::d3d12::ID3D12Device>) -> Self {
        DevicePointer(ctx.as_raw() as *mut _ as *const c_void)
    }
}

#[cfg(feature = "glutin")]
impl<'a, T: glutin::ContextCurrentState> From<&'a glutin::Context<T>> for DevicePointer {
    fn from(ctx: &'a glutin::Context<T>) -> Self {
        #[cfg(unix)]
        unsafe {
            use glutin::platform::unix::RawHandle;
            match ctx.raw_handle() {
                RawHandle::Glx(glx) => DevicePointer::from(glx),
                _ => panic!("RenderDoc only supports GLX contexts on Unix!"),
            }
        }

        #[cfg(windows)]
        unsafe {
            use glutin::platform::windows::RawHandle;
            match ctx.raw_handle() {
                RawHandle::Wgl(wgl) => DevicePointer::from(wgl),
                _ => panic!("RenderDoc only supports WGL contexts on Windows!"),
            }
        }
    }
}