Struct voodoo::Instance

pub struct Instance { /* fields omitted */ }

A Vulkan instance.

Destruction

Dropping this Instance will cause Loader::destroy_instance to be called, automatically releasing any resources associated with it.

Methods

impl Instance

pub fn builder<'ib>() -> InstanceBuilder<'ib>

Returns an InstanceBuilder use to create an instance.

pub fn handle(&self) -> InstanceHandle

Returns the handle to this instance.

pub fn proc_addr_loader(&self) -> &InstanceProcAddrLoader

Returns the InstanceProcAddrLoader associated with this instance.

pub fn loader(&self) -> &Loader

Returns the Loader associated with this instance.

pub fn physical_devices(&self) -> VdResult<SmallVec<[PhysicalDevice; 16]>>

Returns a list of all physical devices available.

pub fn get_physical_device_features<Pd>(
    &self,
    physical_device: Pd
) -> PhysicalDeviceFeatures where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Reports the capabilities of a physical device.

https://www.khronos.org/registry/vulkan/specs/1.0/man/html/vkGetPhysicalDeviceFeatures.html

pub fn get_physical_device_format_properties<Pd>(
    &self,
    physical_device: Pd,
    format: Format
) -> FormatProperties where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Lists a physical device's format capabilities.

https://www.khronos.org/registry/vulkan/specs/1.0/man/html/vkGetPhysicalDeviceFormatProperties.html

pub fn get_physical_device_image_format_properties<Pd>(
    &self,
    physical_device: Pd,
    format: Format,
    type_: ImageType,
    tiling: ImageTiling,
    usage: ImageUsageFlags,
    flags: ImageCreateFlags
) -> VdResult<ImageFormatProperties> where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Lists a physical device's image format capabilities.

https://www.khronos.org/registry/vulkan/specs/1.0/man/html/vkGetPhysicalDeviceImageFormatProperties.html

pub fn get_physical_device_properties<Pd>(
    &self,
    physical_device: Pd
) -> PhysicalDeviceProperties where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Returns the properties of a physical device.

https://www.khronos.org/registry/vulkan/specs/1.0/man/html/vkGetPhysicalDeviceProperties.html

pub fn get_physical_device_queue_family_properties<Pd>(
    &self,
    physical_device: Pd
) -> VdResult<SmallVec<[QueueFamilyProperties; 16]>> where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Reports properties of the queues of the specified physical device.

https://www.khronos.org/registry/vulkan/specs/1.0/man/html/vkGetPhysicalDeviceQueueFamilyProperties.html

pub fn get_physical_device_memory_properties<Pd>(
    &self,
    physical_device: Pd
) -> PhysicalDeviceMemoryProperties where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Reports memory information for the specified physical device.

https://www.khronos.org/registry/vulkan/specs/1.0/man/html/vkGetPhysicalDeviceMemoryProperties.html

pub unsafe fn create_device(
    &self,
    physical_device: PhysicalDeviceHandle,
    create_info: &DeviceCreateInfo,
    allocator: Option<*const VkAllocationCallbacks>
) -> VdResult<DeviceHandle>

Creates a new device instance.

https://www.khronos.org/registry/vulkan/specs/1.0/man/html/vkCreateDevice.html

pub unsafe fn destroy_device(
    &self,
    device: DeviceHandle,
    allocator: Option<*const VkAllocationCallbacks>
)

Destroys a logical device.

https://www.khronos.org/registry/vulkan/specs/1.0/man/html/vkDestroyDevice.html

pub fn enumerate_device_extension_properties<Pd>(
    &self,
    physical_device: Pd,
    layer_name: Option<&CStr>
) -> VdResult<SmallVec<[ExtensionProperties; 64]>> where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Returns the properties of available physical device extensions.

https://www.khronos.org/registry/vulkan/specs/1.0/man/html/vkEnumerateDeviceExtensionProperties.html

pub fn enumerate_device_layer_properties<Pd>(
    &self,
    physical_device: Pd
) -> VdResult<SmallVec<[LayerProperties; 64]>> where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Returns the properties of available physical device layers.

https://www.khronos.org/registry/vulkan/specs/1.0/man/html/vkEnumerateDeviceLayerProperties.html

Important traits for SmallVec<A>

impl<A> Write for SmallVec<A> where
    A: Array<Item = u8>, 

pub fn get_physical_device_sparse_image_format_properties<Pd>(
    &self,
    physical_device: Pd,
    format: Format,
    type_: ImageType,
    samples: SampleCountFlags,
    usage: ImageCreateFlags,
    tiling: ImageTiling
) -> SmallVec<[SparseImageFormatProperties; 8]> where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Retrieves the properties of an image format applied to sparse images.

https://www.khronos.org/registry/vulkan/specs/1.0/man/html/vkGetPhysicalDeviceSparseImageFormatProperties.html

pub unsafe fn destroy_surface_khr(
    &self,
    surface: SurfaceKhrHandle,
    allocator: Option<*const VkAllocationCallbacks>
)

Destroys a VkSurfaceKHR object.

https://manned.org/vkDestroySurfaceKHR/adcec40c

pub unsafe fn get_physical_device_surface_support_khr<Pd, Sk>(
    &self,
    physical_device: Pd,
    queue_family_index: u32,
    surface: Sk
) -> VdResult<bool> where
    Pd: Handle<Target = PhysicalDeviceHandle>,
    Sk: Handle<Target = SurfaceKhrHandle>, 

Queries if presentation is supported.

https://manned.org/vkGetPhysicalDeviceSurfaceSupportKHR.3

pub unsafe fn get_physical_device_surface_capabilities_khr<Pd, Sk>(
    &self,
    physical_device: Pd,
    surface: Sk
) -> VdResult<SurfaceCapabilitiesKhr> where
    Pd: Handle<Target = PhysicalDeviceHandle>,
    Sk: Handle<Target = SurfaceKhrHandle>, 

Queries surface capabilities.

https://manned.org/vkGetPhysicalDeviceSurfaceCapabilitiesKHR.3

pub unsafe fn get_physical_device_surface_formats_khr<Pd, Sk>(
    &self,
    physical_device: Pd,
    surface: Sk
) -> VdResult<SmallVec<[SurfaceFormatKhr; 64]>> where
    Pd: Handle<Target = PhysicalDeviceHandle>,
    Sk: Handle<Target = SurfaceKhrHandle>, 

Queries color formats supported by surface.

https://manned.org/vkGetPhysicalDeviceSurfaceFormatsKHR.3

pub unsafe fn get_physical_device_surface_present_modes_khr<Pd, Sk>(
    &self,
    physical_device: Pd,
    surface: Sk
) -> VdResult<SmallVec<[PresentModeKhr; 16]>> where
    Pd: Handle<Target = PhysicalDeviceHandle>,
    Sk: Handle<Target = SurfaceKhrHandle>, 

Queries supported presentation modes.

https://manned.org/vkGetPhysicalDeviceSurfacePresentModesKHR.3

pub unsafe fn get_physical_device_display_properties_khr<Pd>(
    &self,
    physical_device: Pd
) -> VdResult<SmallVec<[DisplayPropertiesKhr; 16]>> where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Queries information about the available displays.

https://manned.org/vkGetPhysicalDeviceDisplayPropertiesKHR.3

pub unsafe fn get_physical_device_display_plane_properties_khr<Pd>(
    &self,
    physical_device: Pd
) -> VdResult<SmallVec<[DisplayPlanePropertiesKhr; 16]>> where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Queries the plane properties.

https://manned.org/vkGetPhysicalDeviceDisplayPlanePropertiesKHR.3

pub unsafe fn get_display_plane_supported_displays_khr<Pd>(
    &self,
    physical_device: Pd,
    plane_index: u32
) -> VdResult<SmallVec<[DisplayKhr; 16]>> where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Queries the list of displays a plane supports.

https://manned.org/vkGetDisplayPlaneSupportedDisplaysKHR.3

pub unsafe fn get_display_mode_properties_khr<Pd, D>(
    &self,
    physical_device: Pd,
    display: D
) -> VdResult<SmallVec<[DisplayModePropertiesKhr; 16]>> where
    Pd: Handle<Target = PhysicalDeviceHandle>,
    D: Handle<Target = DisplayKhrHandle>, 

Queries the set of mode properties supported by the display.

https://manned.org/vkGetDisplayModePropertiesKHR.3

pub unsafe fn create_display_mode_khr<Pd, D>(
    &self,
    physical_device: Pd,
    display: D,
    create_info: &DisplayModeCreateInfoKhr,
    allocator: Option<*const VkAllocationCallbacks>
) -> VdResult<DisplayModeKhrHandle> where
    Pd: Handle<Target = PhysicalDeviceHandle>,
    D: Handle<Target = DisplayKhrHandle>, 

Creates a display mode.

https://manned.org/vkCreateDisplayModeKHR.3

pub unsafe fn get_display_plane_capabilities_khr<Pd, M>(
    &self,
    physical_device: Pd,
    mode: M,
    plane_index: u32
) -> VdResult<DisplayPlaneCapabilitiesKhr> where
    Pd: Handle<Target = PhysicalDeviceHandle>,
    M: Handle<Target = DisplayModeKhrHandle>, 

Queries capabilities of a mode and plane combination.

https://manned.org/vkGetDisplayPlaneCapabilitiesKHR.3

pub unsafe fn create_display_plane_surface_khr(
    &self,
    create_info: DisplaySurfaceCreateInfoKhr,
    allocator: Option<*const VkAllocationCallbacks>
) -> VdResult<SurfaceKhrHandle>

Creates a SurfaceKhrHandle structure representing a display plane and mode.

https://manned.org/vkCreateDisplayPlaneSurfaceKHR.3

pub unsafe fn create_xlib_surface_khr(
    &self,
    create_info: &XlibSurfaceCreateInfoKhr,
    allocator: Option<*const VkAllocationCallbacks>
) -> VdResult<SurfaceKhrHandle>

Creates a SurfaceKhrHandle object for an X11 window, using the Xlib client-side library.

https://manned.org/vkCreateXlibSurfaceKHR.3

pub unsafe fn get_physical_device_xlib_presentation_support_khr<Pd>(
    &self,
    physical_device: Pd,
    queue_family_index: u32,
    dpy: *mut Display,
    visual_id: VisualID
) -> bool where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Queries physical device for presentation to X11 server using Xlib.

https://manned.org/vkGetPhysicalDeviceXlibPresentationSupportKHR.3

pub unsafe fn create_xcb_surface_khr(
    &self,
    create_info: &XcbSurfaceCreateInfoKhr,
    allocator: Option<*const VkAllocationCallbacks>
) -> VdResult<SurfaceKhrHandle>

Creates a SurfaceKhrHandle object for a X11 window, using the XCB client-side library.

https://manned.org/vkCreateXcbSurfaceKHR.3

pub unsafe fn get_physical_device_xcb_presentation_support_khr<Pd>(
    &self,
    physical_device: Pd,
    queue_family_index: u32,
    connection: *mut xcb_connection_t,
    visual_id: xcb_visualid_t
) -> bool where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Queries physical device for presentation to X11 server using XCB.

https://manned.org/vkGetPhysicalDeviceXcbPresentationSupportKHR.3

pub unsafe fn create_wayland_surface_khr(
    &self,
    create_info: &WaylandSurfaceCreateInfoKhr,
    allocator: Option<*const VkAllocationCallbacks>
) -> VdResult<SurfaceKhrHandle>

Creates a SurfaceKhrHandle object for a Wayland window.

https://manned.org/vkCreateWaylandSurfaceKHR.3

pub unsafe fn get_physical_device_wayland_presentation_support_khr<Pd>(
    &self,
    physical_device: Pd,
    queue_family_index: u32,
    display: *mut wl_display
) -> bool where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Queries physical device for presentation to Wayland.

https://manned.org/vkGetPhysicalDeviceWaylandPresentationSupportKHR.3

pub unsafe fn create_mir_surface_khr(
    &self,
    create_info: &MirSurfaceCreateInfoKhr,
    allocator: Option<*const VkAllocationCallbacks>
) -> VdResult<SurfaceKhrHandle>

Creates a SurfaceKhrHandle object for a Mir window.

https://manned.org/vkCreateMirSurfaceKHR.3

pub unsafe fn get_physical_device_mir_presentation_support_khr<Pd>(
    &self,
    physical_device: Pd,
    queue_family_index: u32,
    connection: *mut MirConnection
) -> bool where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Queries physical device for presentation to Mir.

https://manned.org/vkGetPhysicalDeviceMirPresentationSupportKHR.3

pub unsafe fn create_android_surface_khr(
    &self,
    create_info: &AndroidSurfaceCreateInfoKhr,
    allocator: Option<*const VkAllocationCallbacks>
) -> VdResult<SurfaceKhrHandle>

Create a SurfaceKhrHandle object for an Android native window.

https://manned.org/vkCreateAndroidSurfaceKHR.3

pub unsafe fn create_win32_surface_khr(
    &self,
    create_info: &Win32SurfaceCreateInfoKhr,
    allocator: Option<*const VkAllocationCallbacks>
) -> VdResult<SurfaceKhrHandle>

Creates a SurfaceKhrHandle object for an Win32 native window.

https://manned.org/vkCreateWin32SurfaceKHR.3

pub unsafe fn get_physical_device_win32_presentation_support_khr<Pd>(
    &self,
    physical_device: Pd,
    queue_family_index: u32
) -> bool where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Queries queue family support for presentation on a Win32 display.

https://manned.org/vkGetPhysicalDeviceWin32PresentationSupportKHR.3

pub unsafe fn get_physical_device_features_2_khr<Pd>(
    &self,
    physical_device: Pd
) -> PhysicalDeviceFeatures2Khr where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

pub unsafe fn get_physical_device_properties_2_khr<Pd>(
    &self,
    physical_device: Pd
) -> PhysicalDeviceProperties2Khr where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

pub unsafe fn get_physical_device_format_properties_2_khr<Pd>(
    &self,
    physical_device: Pd,
    format: Format
) -> FormatProperties2Khr where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

pub unsafe fn get_physical_device_image_format_properties_2_khr<Pd>(
    &self,
    physical_device: Pd,
    image_format_info: &PhysicalDeviceImageFormatInfo2Khr
) -> VdResult<ImageFormatProperties2Khr> where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

pub unsafe fn get_physical_device_queue_family_properties_2_khr<Pd>(
    &self,
    physical_device: Pd
) -> VdResult<SmallVec<[QueueFamilyProperties2Khr; 16]>> where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

pub unsafe fn get_physical_device_memory_properties_2_khr<Pd>(
    &self,
    physical_device: Pd
) -> PhysicalDeviceMemoryProperties2Khr where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

Important traits for SmallVec<A>

impl<A> Write for SmallVec<A> where
    A: Array<Item = u8>, 

pub unsafe fn get_physical_device_sparse_image_format_properties_2_khr<Pd>(
    &self,
    physical_device: Pd,
    format_info: &PhysicalDeviceSparseImageFormatInfo2Khr
) -> SmallVec<[SparseImageFormatProperties2Khr; 8]> where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

pub unsafe fn get_physical_device_external_buffer_properties_khr<Pd>(
    &self,
    physical_device: Pd,
    external_buffer_info: &PhysicalDeviceExternalBufferInfoKhr
) -> ExternalBufferPropertiesKhr where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

pub unsafe fn get_physical_device_external_semaphore_properties_khr<Pd>(
    &self,
    physical_device: Pd,
    external_semaphore_info: &PhysicalDeviceExternalSemaphoreInfoKhr
) -> ExternalSemaphorePropertiesKhr where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

pub unsafe fn get_physical_device_external_fence_properties_khr<Pd>(
    &self,
    physical_device: Pd,
    external_fence_info: &PhysicalDeviceExternalFenceInfoKhr
) -> ExternalFencePropertiesKhr where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

pub unsafe fn get_physical_device_surface_capabilities_2_khr<Pd>(
    &self,
    physical_device: Pd,
    surface_info: &PhysicalDeviceSurfaceInfo2Khr
) -> VdResult<SurfaceCapabilities2Khr> where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

pub unsafe fn get_physical_device_surface_formats_2_khr<Pd>(
    &self,
    physical_device: Pd,
    surface_info: &PhysicalDeviceSurfaceInfo2Khr
) -> VdResult<SmallVec<[SurfaceFormat2Khr; 64]>> where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

pub unsafe fn create_debug_report_callback_ext(
    &self,
    create_info: &DebugReportCallbackCreateInfoExt,
    allocator: Option<*const VkAllocationCallbacks>
) -> VdResult<DebugReportCallbackExtHandle>

pub unsafe fn destroy_debug_report_callback_ext(
    &self,
    callback: DebugReportCallbackExtHandle,
    allocator: Option<*const VkAllocationCallbacks>
)

pub unsafe fn debug_report_message_ext(
    &self,
    flags: DebugReportFlagsExt,
    object_type: DebugReportObjectTypeExt,
    object: u64,
    location: usize,
    message_code: i32,
    layer_prefix: &CStr,
    message: &CStr
)

pub unsafe fn get_physical_device_external_image_format_properties_nv<Pd>(
    &self,
    physical_device: Pd,
    format: Format,
    type_: ImageType,
    tiling: ImageTiling,
    usage: ImageUsageFlags,
    flags: ImageCreateFlags,
    external_handle_type: ExternalMemoryHandleTypeFlagsNv
) -> VdResult<ExternalImageFormatPropertiesNv> where
    Pd: Handle<Target = PhysicalDeviceHandle>, 

pub unsafe fn create_vi_surface_nn(
    &self,
    create_info: &ViSurfaceCreateInfoNn,
    allocator: Option<*const VkAllocationCallbacks>
) -> VdResult<SurfaceKhrHandle>

pub unsafe fn release_display_ext<Pd, D>(
    &self,
    physical_device: Pd,
    display: D
) -> VdResult<()> where
    Pd: Handle<Target = PhysicalDeviceHandle>,
    D: Handle<Target = DisplayKhrHandle>, 

pub unsafe fn acquire_xlib_display_ext<Pd, D>(
    &self,
    physical_device: Pd,
    dpy: *mut Display,
    display: D
) -> VdResult<()> where
    Pd: Handle<Target = PhysicalDeviceHandle>,
    D: Handle<Target = DisplayKhrHandle>, 

pub unsafe fn get_rand_r_output_display_ext<Pd, D>(
    &self,
    physical_device: Pd,
    dpy: *mut Display,
    rr_output: RROutput
) -> VdResult<DisplayKhrHandle> where
    Pd: Handle<Target = PhysicalDeviceHandle>,
    D: Handle<Target = DisplayKhrHandle>, 

pub unsafe fn get_physical_device_surface_capabilities_2_ext<Pd, S>(
    &self,
    physical_device: Pd,
    surface: S
) -> VdResult<SurfaceCapabilities2Ext> where
    Pd: Handle<Target = PhysicalDeviceHandle>,
    S: Handle<Target = SurfaceKhrHandle>, 

pub unsafe fn create_ios_surface_mvk(
    &self,
    create_info: &IosSurfaceCreateInfoMvk,
    allocator: Option<*const VkAllocationCallbacks>
) -> VdResult<SurfaceKhrHandle>

pub unsafe fn create_mac_os_surface_mvk(
    &self,
    create_info: &MacOsSurfaceCreateInfoMvk,
    allocator: Option<*const VkAllocationCallbacks>
) -> VdResult<SurfaceKhrHandle>

Trait Implementations

impl Debug for Instance

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for Instance

fn clone(&self) -> Instance

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'h> Handle for &'h Instance

type Target = InstanceHandle

fn handle(&self) -> Self::Target

impl Send for Instance

impl Sync for Instance