use crate::{
binding_model::MAX_BIND_GROUPS,
hub::{HUB, Root, Token},
AdapterHandle,
AdapterId,
DeviceHandle,
InstanceId,
SurfaceHandle,
};
#[cfg(feature = "local")]
use crate::{device::BIND_BUFFER_ALIGNMENT, DeviceId, SurfaceId};
#[cfg(feature = "local")]
use log::info;
#[cfg(feature = "remote")]
use serde::{Deserialize, Serialize};
use hal::{self, Instance as _, PhysicalDevice as _};
#[repr(C)]
#[derive(Copy, Clone, Debug, Hash, Eq, PartialEq)]
#[cfg_attr(feature = "remote", derive(Serialize, Deserialize))]
pub enum PowerPreference {
Default = 0,
LowPower = 1,
HighPerformance = 2,
}
impl Default for PowerPreference {
fn default() -> Self {
PowerPreference::Default
}
}
#[repr(C)]
#[derive(Clone, Debug, Default)]
#[cfg_attr(feature = "remote", derive(Serialize, Deserialize))]
pub struct RequestAdapterOptions {
pub power_preference: PowerPreference,
}
#[repr(C)]
#[derive(Clone, Debug, Default)]
#[cfg_attr(feature = "remote", derive(Serialize, Deserialize))]
pub struct Extensions {
pub anisotropic_filtering: bool,
}
#[repr(C)]
#[derive(Clone, Debug)]
#[cfg_attr(feature = "remote", derive(Serialize, Deserialize))]
pub struct Limits {
pub max_bind_groups: u32,
}
impl Default for Limits {
fn default() -> Self {
Limits {
max_bind_groups: MAX_BIND_GROUPS as u32,
}
}
}
#[repr(C)]
#[derive(Clone, Debug, Default)]
#[cfg_attr(feature = "remote", derive(Serialize, Deserialize))]
pub struct DeviceDescriptor {
pub extensions: Extensions,
pub limits: Limits,
}
#[cfg(not(feature = "gfx-backend-gl"))]
pub fn create_instance() -> ::back::Instance {
::back::Instance::create("wgpu", 1)
}
#[cfg(all(feature = "local", not(feature = "gfx-backend-gl")))]
#[no_mangle]
pub extern "C" fn wgpu_create_instance() -> InstanceId {
let inst = create_instance();
HUB.instances.register_local(inst, &mut Token::root())
}
#[cfg(all(feature = "local", feature = "glutin"))]
pub fn wgpu_create_gl_instance(windowed_context: back::glutin::RawContext<back::glutin::PossiblyCurrent>) -> InstanceId {
let raw = back::Surface::from_context(windowed_context);
let surface = SurfaceHandle::new(raw);
HUB.surfaces.register_local(surface, &mut Token::root())
}
#[cfg(all(feature = "local", not(feature = "gfx-backend-gl")))]
pub fn wgpu_instance_create_surface(
instance_id: InstanceId,
raw_handle: raw_window_handle::RawWindowHandle,
) -> SurfaceId {
let mut token = Token::root();
let (instance_guard, mut token) = HUB.instances.read(&mut token);
let instance = &instance_guard[instance_id];
let raw = match raw_handle {
#[cfg(all(target_os = "ios", feature = "gfx-backend-metal"))]
raw_window_handle::RawWindowHandle::IOS(h) =>
instance.create_surface_from_uiview(h.ui_view, cfg!(debug_assertions)),
#[cfg(all(target_os = "macos", feature = "gfx-backend-metal"))]
raw_window_handle::RawWindowHandle::MacOS(h) =>
instance.create_surface_from_nsview(h.ns_view, cfg!(debug_assertions)),
#[cfg(all(target_os = "macos", feature = "gfx-backend-vulkan"))]
raw_window_handle::RawWindowHandle::MacOS(h) =>
instance.create_surface_from_nsview(h.ns_view),
#[cfg(all(unix, feature = "gfx-backend-vulkan"))]
raw_window_handle::RawWindowHandle::X11(h) =>
instance.create_surface_from_xlib(h.display as _, h.window as _),
#[cfg(all(unix, feature = "gfx-backend-vulkan"))]
raw_window_handle::RawWindowHandle::Wayland(h) =>
instance.create_surface_from_wayland(h.display, h.surface),
#[cfg(all(windows, feature = "gfx-backend-vulkan"))]
raw_window_handle::RawWindowHandle::Windows(h) =>
instance.create_surface_from_hwnd(ptr::null_mut(), h.hwnd),
#[cfg(all(windows, feature = "gfx-backend-dx12"))]
raw_window_handle::RawWindowHandle::Windows(h) =>
instance.create_surface_from_hwnd(h.hwnd),
#[cfg(all(windows, feature = "gfx-backend-dx12"))]
raw_window_handle::RawWindowHandle::Windows(h) =>
instance.create_surface_from_hwnd(h.hwnd),
#[cfg(any(
feature = "gfx-backend-vulkan",
feature = "gfx-backend-dx11",
feature = "gfx-backend-dx12",
feature = "gfx-backend-metal",
feature = "gfx-backend-gl",
))]
_ => panic!("Unsupported window handle"),
#[cfg(not(any(
feature = "gfx-backend-vulkan",
feature = "gfx-backend-dx11",
feature = "gfx-backend-dx12",
feature = "gfx-backend-metal",
feature = "gfx-backend-gl",
)))]
_ => { let _ = instance; back::Surface },
};
let surface = SurfaceHandle::new(raw);
HUB.surfaces.register_local(surface, &mut token)
}
#[cfg(not(feature = "gfx-backend-gl"))]
#[allow(unused_variables)]
pub fn instance_create_surface_from_xlib(
instance_id: InstanceId,
display: *mut *const std::ffi::c_void,
window: u64,
token: &mut Token<Root>,
) -> SurfaceHandle {
#[cfg(not(all(unix, feature = "gfx-backend-vulkan")))]
unimplemented!();
#[cfg(all(unix, feature = "gfx-backend-vulkan"))]
{
let (instance_guard, _) = HUB.instances.read(token);
SurfaceHandle::new(instance_guard[instance_id].create_surface_from_xlib(display, window))
}
}
#[cfg(all(feature = "local", not(feature = "gfx-backend-gl")))]
#[no_mangle]
pub extern "C" fn wgpu_instance_create_surface_from_xlib(
instance_id: InstanceId,
display: *mut *const std::ffi::c_void,
window: u64,
) -> SurfaceId {
let mut token = Token::root();
let surface = instance_create_surface_from_xlib(instance_id, display, window, &mut token);
HUB.surfaces.register_local(surface, &mut token)
}
#[cfg(not(feature = "gfx-backend-gl"))]
#[allow(unused_variables)]
pub fn instance_create_surface_from_macos_layer(
instance_id: InstanceId,
layer: *mut std::ffi::c_void,
token: &mut Token<Root>,
) -> SurfaceHandle {
#[cfg(not(feature = "gfx-backend-metal"))]
unimplemented!();
#[cfg(feature = "gfx-backend-metal")]
{
let (instance_guard, _) = HUB.instances.read(token);
SurfaceHandle::new(
instance_guard[instance_id]
.create_surface_from_layer(layer as *mut _, cfg!(debug_assertions)),
)
}
}
#[cfg(all(feature = "local", not(feature = "gfx-backend-gl")))]
#[no_mangle]
pub extern "C" fn wgpu_instance_create_surface_from_macos_layer(
instance_id: InstanceId,
layer: *mut std::ffi::c_void,
) -> SurfaceId {
let mut token = Token::root();
let surface = instance_create_surface_from_macos_layer(instance_id, layer, &mut token);
HUB.surfaces.register_local(surface, &mut token)
}
#[cfg(not(feature = "gfx-backend-gl"))]
#[allow(unused_variables)]
pub fn instance_create_surface_from_windows_hwnd(
instance_id: InstanceId,
hinstance: *mut std::ffi::c_void,
hwnd: *mut std::ffi::c_void,
token: &mut Token<Root>,
) -> SurfaceHandle {
let (instance_guard, _) = HUB.instances.read(token);
#[cfg(not(any(
feature = "gfx-backend-dx11",
feature = "gfx-backend-dx12",
all(target_os = "windows", feature = "gfx-backend-vulkan"),
)))]
let raw = unimplemented!();
#[cfg(any(feature = "gfx-backend-dx11", feature = "gfx-backend-dx12"))]
let raw = instance_guard[instance_id].create_surface_from_hwnd(hwnd);
#[cfg(all(target_os = "windows", feature = "gfx-backend-vulkan"))]
let raw = instance_guard[instance_id].create_surface_from_hwnd(hinstance, hwnd);
#[allow(unreachable_code)]
SurfaceHandle::new(raw)
}
#[cfg(all(feature = "local", not(feature = "gfx-backend-gl")))]
#[no_mangle]
pub extern "C" fn wgpu_instance_create_surface_from_windows_hwnd(
instance_id: InstanceId,
hinstance: *mut std::ffi::c_void,
hwnd: *mut std::ffi::c_void,
) -> SurfaceId {
let mut token = Token::root();
let surface = instance_create_surface_from_windows_hwnd(instance_id, hinstance, hwnd, &mut token);
HUB.surfaces.register_local(surface, &mut token)
}
#[cfg(all(feature = "local", feature = "gfx-backend-gl"))]
pub fn wgpu_instance_get_gl_surface(instance_id: InstanceId) -> SurfaceId {
instance_id
}
pub fn instance_get_adapter(
instance_id: InstanceId,
desc: &RequestAdapterOptions,
token: &mut Token<Root>,
) -> AdapterHandle {
#[cfg(not(feature = "gfx-backend-gl"))]
let adapters = {
let (instance_guard, _) = HUB.instances.read(token);
instance_guard[instance_id].enumerate_adapters()
};
#[cfg(feature = "glutin")]
let adapters = {
let (surface_guard, _) = HUB.surfaces.read(token);
surface_guard[instance_id].raw.enumerate_adapters()
};
#[cfg(all(not(feature = "glutin"), feature = "gfx-backend-gl"))]
let adapters = Vec::<AdapterHandle>::new();
let (mut integrated_first, mut discrete_first, mut discrete_last, mut alternative) =
(None, None, None, None);
for (i, adapter) in adapters.iter().enumerate() {
match adapter.info.device_type {
hal::adapter::DeviceType::IntegratedGpu => {
integrated_first = integrated_first.or(Some(i));
}
hal::adapter::DeviceType::DiscreteGpu => {
discrete_first = discrete_first.or(Some(i));
discrete_last = Some(i);
}
_ => alternative = Some(i),
}
}
let preferred_gpu = match desc.power_preference {
PowerPreference::LowPower => integrated_first.or(discrete_last),
PowerPreference::HighPerformance | PowerPreference::Default => {
discrete_first.or(integrated_first)
}
};
let selected = preferred_gpu
.or(alternative)
.expect("No adapters found. Please enable the feature for one of the graphics backends: vulkan, metal, dx12, dx11, gl");
adapters.into_iter().nth(selected).unwrap()
}
#[cfg(feature = "local")]
#[no_mangle]
pub extern "C" fn wgpu_instance_request_adapter(
instance_id: InstanceId,
desc: Option<&RequestAdapterOptions>,
) -> AdapterId {
let mut token = Token::root();
let adapter = instance_get_adapter(instance_id, &desc.cloned().unwrap_or_default(), &mut token);
let limits = adapter.physical_device.limits();
info!("Adapter {:?}", adapter.info);
assert!(
BIND_BUFFER_ALIGNMENT % limits.min_storage_buffer_offset_alignment == 0,
"Adapter storage buffer offset alignment not compatible with WGPU"
);
assert!(
BIND_BUFFER_ALIGNMENT % limits.min_uniform_buffer_offset_alignment == 0,
"Adapter uniform buffer offset alignment not compatible with WGPU"
);
HUB.adapters.register_local(adapter, &mut token)
}
pub fn adapter_create_device(
adapter_id: AdapterId,
_desc: &DeviceDescriptor,
token: &mut Token<Root>,
) -> DeviceHandle {
let (adapter_guard, _) = HUB.adapters.read(token);
let adapter = &adapter_guard[adapter_id];
let (raw, queue_group) = adapter.open_with::<_, hal::General>(1, |_qf| true).unwrap();
let mem_props = adapter.physical_device.memory_properties();
DeviceHandle::new(raw, adapter_id, queue_group, mem_props)
}
#[cfg(feature = "local")]
#[no_mangle]
pub extern "C" fn wgpu_adapter_request_device(
adapter_id: AdapterId,
desc: Option<&DeviceDescriptor>,
) -> DeviceId {
let mut token = Token::root();
let device = adapter_create_device(
adapter_id,
&desc.cloned().unwrap_or_default(),
&mut token,
);
HUB.devices.register_local(device, &mut token)
}