use std::error;
use std::fmt;
use std::mem::MaybeUninit;
use std::os::raw::c_ulong;
use std::ptr;
use std::sync::Arc;
use std::sync::atomic::AtomicBool;
use format::Format;
use image::ImageUsage;
use instance::Instance;
use instance::PhysicalDevice;
use instance::QueueFamily;
use swapchain::Capabilities;
use swapchain::SurfaceSwapchainLock;
use swapchain::capabilities;
use swapchain::display::DisplayMode;
use swapchain::display::DisplayPlane;
use Error;
use OomError;
use VulkanObject;
use check_errors;
use vk;
pub struct Surface<W> {
window: W,
instance: Arc<Instance>,
surface: vk::SurfaceKHR,
has_swapchain: AtomicBool,
}
impl<W> Surface<W> {
pub unsafe fn from_raw_surface(instance: Arc<Instance>, surface: vk::SurfaceKHR,
win: W)
-> Surface<W> {
Surface {
window: win,
instance: instance,
surface: surface,
has_swapchain: AtomicBool::new(false),
}
}
pub fn from_display_mode(display_mode: &DisplayMode, plane: &DisplayPlane)
-> Result<Arc<Surface<()>>, SurfaceCreationError> {
if !display_mode
.display()
.physical_device()
.instance()
.loaded_extensions()
.khr_display
{
return Err(SurfaceCreationError::MissingExtension { name: "VK_KHR_display" });
}
assert_eq!(display_mode.display().physical_device().internal_object(),
plane.physical_device().internal_object());
assert!(plane.supports(display_mode.display()));
let instance = display_mode.display().physical_device().instance();
let vk = instance.pointers();
let surface = unsafe {
let infos = vk::DisplaySurfaceCreateInfoKHR {
sType: vk::STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR,
pNext: ptr::null(),
flags: 0,
displayMode: display_mode.internal_object(),
planeIndex: plane.index(),
planeStackIndex: 0,
transform: vk::SURFACE_TRANSFORM_IDENTITY_BIT_KHR,
globalAlpha: 0.0,
alphaMode: vk::DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR,
imageExtent: vk::Extent2D {
width: display_mode.visible_region()[0],
height: display_mode.visible_region()[1],
},
};
let mut output = MaybeUninit::uninit();
check_errors(vk.CreateDisplayPlaneSurfaceKHR(instance.internal_object(),
&infos,
ptr::null(),
output.as_mut_ptr()))?;
output.assume_init()
};
Ok(Arc::new(Surface {
window: (),
instance: instance.clone(),
surface: surface,
has_swapchain: AtomicBool::new(false),
}))
}
pub unsafe fn from_hwnd<T, U>(instance: Arc<Instance>, hinstance: *const T, hwnd: *const U,
win: W)
-> Result<Arc<Surface<W>>, SurfaceCreationError> {
let vk = instance.pointers();
if !instance.loaded_extensions().khr_win32_surface {
return Err(SurfaceCreationError::MissingExtension { name: "VK_KHR_win32_surface" });
}
let surface = {
let infos = vk::Win32SurfaceCreateInfoKHR {
sType: vk::STRUCTURE_TYPE_WIN32_SURFACE_CREATE_INFO_KHR,
pNext: ptr::null(),
flags: 0,
hinstance: hinstance as *mut _,
hwnd: hwnd as *mut _,
};
let mut output = MaybeUninit::uninit();
check_errors(vk.CreateWin32SurfaceKHR(instance.internal_object(),
&infos,
ptr::null(),
output.as_mut_ptr()))?;
output.assume_init()
};
Ok(Arc::new(Surface {
window: win,
instance: instance.clone(),
surface: surface,
has_swapchain: AtomicBool::new(false),
}))
}
pub unsafe fn from_xcb<C>(instance: Arc<Instance>, connection: *const C, window: u32,
win: W)
-> Result<Arc<Surface<W>>, SurfaceCreationError> {
let vk = instance.pointers();
if !instance.loaded_extensions().khr_xcb_surface {
return Err(SurfaceCreationError::MissingExtension { name: "VK_KHR_xcb_surface" });
}
let surface = {
let infos = vk::XcbSurfaceCreateInfoKHR {
sType: vk::STRUCTURE_TYPE_XCB_SURFACE_CREATE_INFO_KHR,
pNext: ptr::null(),
flags: 0,
connection: connection as *mut _,
window: window,
};
let mut output = MaybeUninit::uninit();
check_errors(vk.CreateXcbSurfaceKHR(instance.internal_object(),
&infos,
ptr::null(),
output.as_mut_ptr()))?;
output.assume_init()
};
Ok(Arc::new(Surface {
window: win,
instance: instance.clone(),
surface: surface,
has_swapchain: AtomicBool::new(false),
}))
}
pub unsafe fn from_xlib<D>(instance: Arc<Instance>, display: *const D, window: c_ulong,
win: W)
-> Result<Arc<Surface<W>>, SurfaceCreationError> {
let vk = instance.pointers();
if !instance.loaded_extensions().khr_xlib_surface {
return Err(SurfaceCreationError::MissingExtension { name: "VK_KHR_xlib_surface" });
}
let surface = {
let infos = vk::XlibSurfaceCreateInfoKHR {
sType: vk::STRUCTURE_TYPE_XLIB_SURFACE_CREATE_INFO_KHR,
pNext: ptr::null(),
flags: 0,
dpy: display as *mut _,
window: window,
};
let mut output = MaybeUninit::uninit();
check_errors(vk.CreateXlibSurfaceKHR(instance.internal_object(),
&infos,
ptr::null(),
output.as_mut_ptr()))?;
output.assume_init()
};
Ok(Arc::new(Surface {
window: win,
instance: instance.clone(),
surface: surface,
has_swapchain: AtomicBool::new(false),
}))
}
pub unsafe fn from_wayland<D, S>(instance: Arc<Instance>, display: *const D,
surface: *const S,
win: W)
-> Result<Arc<Surface<W>>, SurfaceCreationError> {
let vk = instance.pointers();
if !instance.loaded_extensions().khr_wayland_surface {
return Err(SurfaceCreationError::MissingExtension { name: "VK_KHR_wayland_surface" });
}
let surface = {
let infos = vk::WaylandSurfaceCreateInfoKHR {
sType: vk::STRUCTURE_TYPE_WAYLAND_SURFACE_CREATE_INFO_KHR,
pNext: ptr::null(),
flags: 0,
display: display as *mut _,
surface: surface as *mut _,
};
let mut output = MaybeUninit::uninit();
check_errors(vk.CreateWaylandSurfaceKHR(instance.internal_object(),
&infos,
ptr::null(),
output.as_mut_ptr()))?;
output.assume_init()
};
Ok(Arc::new(Surface {
window: win,
instance: instance.clone(),
surface: surface,
has_swapchain: AtomicBool::new(false),
}))
}
pub unsafe fn from_anativewindow<T>(instance: Arc<Instance>, window: *const T,
win: W)
-> Result<Arc<Surface<W>>, SurfaceCreationError> {
let vk = instance.pointers();
if !instance.loaded_extensions().khr_android_surface {
return Err(SurfaceCreationError::MissingExtension { name: "VK_KHR_android_surface" });
}
let surface = {
let infos = vk::AndroidSurfaceCreateInfoKHR {
sType: vk::STRUCTURE_TYPE_ANDROID_SURFACE_CREATE_INFO_KHR,
pNext: ptr::null(),
flags: 0,
window: window as *mut _,
};
let mut output = MaybeUninit::uninit();
check_errors(vk.CreateAndroidSurfaceKHR(instance.internal_object(),
&infos,
ptr::null(),
output.as_mut_ptr()))?;
output.assume_init()
};
Ok(Arc::new(Surface {
window: win,
instance: instance.clone(),
surface: surface,
has_swapchain: AtomicBool::new(false),
}))
}
pub unsafe fn from_ios_moltenvk<T>(instance: Arc<Instance>, view: *const T,
win: W)
-> Result<Arc<Surface<W>>, SurfaceCreationError> {
let vk = instance.pointers();
if !instance.loaded_extensions().mvk_ios_surface {
return Err(SurfaceCreationError::MissingExtension { name: "VK_MVK_ios_surface" });
}
let surface = {
let infos = vk::IOSSurfaceCreateInfoMVK {
sType: vk::STRUCTURE_TYPE_IOS_SURFACE_CREATE_INFO_MVK,
pNext: ptr::null(),
flags: 0,
pView: view as *const _,
};
let mut output = MaybeUninit::uninit();
check_errors(vk.CreateIOSSurfaceMVK(instance.internal_object(),
&infos,
ptr::null(),
output.as_mut_ptr()))?;
output.assume_init()
};
Ok(Arc::new(Surface {
window: win,
instance: instance.clone(),
surface: surface,
has_swapchain: AtomicBool::new(false),
}))
}
pub unsafe fn from_macos_moltenvk<T>(instance: Arc<Instance>, view: *const T,
win: W)
-> Result<Arc<Surface<W>>, SurfaceCreationError> {
let vk = instance.pointers();
if !instance.loaded_extensions().mvk_macos_surface {
return Err(SurfaceCreationError::MissingExtension { name: "VK_MVK_macos_surface" });
}
let surface = {
let infos = vk::MacOSSurfaceCreateInfoMVK {
sType: vk::STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK,
pNext: ptr::null(),
flags: 0,
pView: view as *const _,
};
let mut output = MaybeUninit::uninit();
check_errors(vk.CreateMacOSSurfaceMVK(instance.internal_object(),
&infos,
ptr::null(),
output.as_mut_ptr()))?;
output.assume_init()
};
Ok(Arc::new(Surface {
window: win,
instance: instance.clone(),
surface: surface,
has_swapchain: AtomicBool::new(false),
}))
}
pub unsafe fn from_vi_surface<T>(instance: Arc<Instance>, window: *const T,
win: W)
-> Result<Arc<Surface<W>>, SurfaceCreationError> {
let vk = instance.pointers();
if !instance.loaded_extensions().nn_vi_surface {
return Err(SurfaceCreationError::MissingExtension { name: "VK_NN_vi_surface" });
}
let surface = {
let infos = vk::ViSurfaceCreateInfoNN {
sType: vk::STRUCTURE_TYPE_VI_SURFACE_CREATE_INFO_NN,
pNext: ptr::null(),
flags: 0,
window: window as *mut _,
};
let mut output = MaybeUninit::uninit();
check_errors(vk.CreateViSurfaceNN(instance.internal_object(),
&infos,
ptr::null(),
output.as_mut_ptr()))?;
output.assume_init()
};
Ok(Arc::new(Surface {
window: win,
instance: instance.clone(),
surface: surface,
has_swapchain: AtomicBool::new(false),
}))
}
pub fn is_supported(&self, queue: QueueFamily) -> Result<bool, CapabilitiesError> {
unsafe {
let vk = self.instance.pointers();
let mut output = MaybeUninit::uninit();
check_errors(vk.GetPhysicalDeviceSurfaceSupportKHR(queue
.physical_device()
.internal_object(),
queue.id(),
self.surface,
output.as_mut_ptr()))?;
Ok(output.assume_init() != 0)
}
}
pub fn capabilities(&self, device: PhysicalDevice) -> Result<Capabilities, CapabilitiesError> {
unsafe {
assert_eq!(&*self.instance as *const _,
&**device.instance() as *const _,
"Instance mismatch in Surface::capabilities");
let vk = self.instance.pointers();
let caps = {
let mut out: MaybeUninit<vk::SurfaceCapabilitiesKHR> = MaybeUninit::uninit();
check_errors(vk.GetPhysicalDeviceSurfaceCapabilitiesKHR(device.internal_object(),
self.surface,
out.as_mut_ptr()))?;
out.assume_init()
};
let formats = {
let mut num = 0;
check_errors(vk.GetPhysicalDeviceSurfaceFormatsKHR(device.internal_object(),
self.surface,
&mut num,
ptr::null_mut()))?;
let mut formats = Vec::with_capacity(num as usize);
check_errors(vk.GetPhysicalDeviceSurfaceFormatsKHR(device.internal_object(),
self.surface,
&mut num,
formats.as_mut_ptr()))?;
formats.set_len(num as usize);
formats
};
let modes = {
let mut num = 0;
check_errors(vk.GetPhysicalDeviceSurfacePresentModesKHR(device.internal_object(),
self.surface,
&mut num,
ptr::null_mut()))?;
let mut modes = Vec::with_capacity(num as usize);
check_errors(vk.GetPhysicalDeviceSurfacePresentModesKHR(device.internal_object(),
self.surface,
&mut num,
modes.as_mut_ptr()))?;
modes.set_len(num as usize);
debug_assert!(modes
.iter()
.find(|&&m| m == vk::PRESENT_MODE_FIFO_KHR)
.is_some());
debug_assert!(modes.iter().count() > 0);
capabilities::supported_present_modes_from_list(modes.into_iter())
};
Ok(Capabilities {
min_image_count: caps.minImageCount,
max_image_count: if caps.maxImageCount == 0 { None }
else { Some(caps.maxImageCount) },
current_extent: if caps.currentExtent.width == 0xffffffff &&
caps.currentExtent.height == 0xffffffff
{
None
} else {
Some([caps.currentExtent.width, caps.currentExtent.height])
},
min_image_extent: [caps.minImageExtent.width, caps.minImageExtent.height],
max_image_extent: [caps.maxImageExtent.width, caps.maxImageExtent.height],
max_image_array_layers: caps.maxImageArrayLayers,
supported_transforms: capabilities::surface_transforms_from_bits(caps.supportedTransforms),
current_transform: capabilities::surface_transforms_from_bits(caps.currentTransform).iter().next().unwrap(),
supported_composite_alpha: capabilities::supported_composite_alpha_from_bits(caps.supportedCompositeAlpha),
supported_usage_flags: {
let usage = ImageUsage::from_bits(caps.supportedUsageFlags);
debug_assert!(usage.color_attachment);
usage
},
supported_formats: formats.into_iter().map(|f| {
(Format::from_vulkan_num(f.format).unwrap(), capabilities::color_space_from_num(f.colorSpace))
}).collect(),
present_modes: modes,
})
}
}
#[inline]
pub fn window(&self) -> &W {
&self.window
}
#[inline]
pub fn instance(&self) -> &Arc<Instance> {
&self.instance
}
}
unsafe impl <W> SurfaceSwapchainLock for Surface<W> {
#[inline]
fn flag(&self) -> &AtomicBool {
&self.has_swapchain
}
}
unsafe impl <W> VulkanObject for Surface<W> {
type Object = vk::SurfaceKHR;
const TYPE: vk::ObjectType = vk::OBJECT_TYPE_SURFACE_KHR;
#[inline]
fn internal_object(&self) -> vk::SurfaceKHR {
self.surface
}
}
impl <W> fmt::Debug for Surface<W> {
#[inline]
fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
write!(fmt, "<Vulkan surface {:?}>", self.surface)
}
}
impl <W> Drop for Surface<W> {
#[inline]
fn drop(&mut self) {
unsafe {
let vk = self.instance.pointers();
vk.DestroySurfaceKHR(self.instance.internal_object(), self.surface, ptr::null());
}
}
}
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum SurfaceCreationError {
OomError(OomError),
MissingExtension {
name: &'static str,
},
}
impl error::Error for SurfaceCreationError {
#[inline]
fn description(&self) -> &str {
match *self {
SurfaceCreationError::OomError(_) => "not enough memory available",
SurfaceCreationError::MissingExtension { .. } =>
"the extension required for this function was not enabled",
}
}
#[inline]
fn cause(&self) -> Option<&dyn error::Error> {
match *self {
SurfaceCreationError::OomError(ref err) => Some(err),
_ => None,
}
}
}
impl fmt::Display for SurfaceCreationError {
#[inline]
fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
write!(fmt, "{}", error::Error::description(self))
}
}
impl From<OomError> for SurfaceCreationError {
#[inline]
fn from(err: OomError) -> SurfaceCreationError {
SurfaceCreationError::OomError(err)
}
}
impl From<Error> for SurfaceCreationError {
#[inline]
fn from(err: Error) -> SurfaceCreationError {
match err {
err @ Error::OutOfHostMemory => SurfaceCreationError::OomError(OomError::from(err)),
err @ Error::OutOfDeviceMemory => SurfaceCreationError::OomError(OomError::from(err)),
_ => panic!("unexpected error: {:?}", err),
}
}
}
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[repr(u32)]
pub enum CapabilitiesError {
OomError(OomError),
SurfaceLost,
}
impl error::Error for CapabilitiesError {
#[inline]
fn description(&self) -> &str {
match *self {
CapabilitiesError::OomError(_) => "not enough memory",
CapabilitiesError::SurfaceLost => "the surface is no longer valid",
}
}
#[inline]
fn cause(&self) -> Option<&dyn error::Error> {
match *self {
CapabilitiesError::OomError(ref err) => Some(err),
_ => None,
}
}
}
impl fmt::Display for CapabilitiesError {
#[inline]
fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
write!(fmt, "{}", error::Error::description(self))
}
}
impl From<OomError> for CapabilitiesError {
#[inline]
fn from(err: OomError) -> CapabilitiesError {
CapabilitiesError::OomError(err)
}
}
impl From<Error> for CapabilitiesError {
#[inline]
fn from(err: Error) -> CapabilitiesError {
match err {
err @ Error::OutOfHostMemory => CapabilitiesError::OomError(OomError::from(err)),
err @ Error::OutOfDeviceMemory => CapabilitiesError::OomError(OomError::from(err)),
Error::SurfaceLost => CapabilitiesError::SurfaceLost,
_ => panic!("unexpected error: {:?}", err),
}
}
}
#[cfg(test)]
mod tests {
use std::ptr;
use swapchain::Surface;
use swapchain::SurfaceCreationError;
#[test]
fn khr_win32_surface_ext_missing() {
let instance = instance!();
match unsafe { Surface::from_hwnd(instance, ptr::null::<u8>(), ptr::null::<u8>(), ()) } {
Err(SurfaceCreationError::MissingExtension { .. }) => (),
_ => panic!(),
}
}
#[test]
fn khr_xcb_surface_ext_missing() {
let instance = instance!();
match unsafe { Surface::from_xcb(instance, ptr::null::<u8>(), 0, ()) } {
Err(SurfaceCreationError::MissingExtension { .. }) => (),
_ => panic!(),
}
}
#[test]
fn khr_xlib_surface_ext_missing() {
let instance = instance!();
match unsafe { Surface::from_xlib(instance, ptr::null::<u8>(), 0, ()) } {
Err(SurfaceCreationError::MissingExtension { .. }) => (),
_ => panic!(),
}
}
#[test]
fn khr_wayland_surface_ext_missing() {
let instance = instance!();
match unsafe {
Surface::from_wayland(instance, ptr::null::<u8>(), ptr::null::<u8>(), ())
} {
Err(SurfaceCreationError::MissingExtension { .. }) => (),
_ => panic!(),
}
}
#[test]
fn khr_android_surface_ext_missing() {
let instance = instance!();
match unsafe { Surface::from_anativewindow(instance, ptr::null::<u8>(), ()) } {
Err(SurfaceCreationError::MissingExtension { .. }) => (),
_ => panic!(),
}
}
}