Struct ash::extensions::khr::Swapchain

pub struct Swapchain { /* private fields */ }

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VK_KHR_swapchain.html

Implementations

impl Swapchain

pub fn new(instance: &Instance, device: &Device) -> Self

Warning

Instance functions cannot be loaded from a Device and will always panic when called:

• Self::get_physical_device_present_rectangles()

Load this struct using an Instance instead via Self::new_from_instance() if the above Instance function is called. This will be solved in the next breaking ash release: https://github.com/ash-rs/ash/issues/727.

pub fn new_from_instance( entry: &Entry, instance: &Instance, device: Device, ) -> Self

Loads all functions on the Instance instead of Device. This incurs an extra dispatch table for Device functions but also allows the Instance function to be loaded instead of always panicking. See also Self::new() for more details.

It is okay to pass vk::Device::null() when this struct is only used to call the Instance function.

pub unsafe fn create_swapchain( &self, create_info: &SwapchainCreateInfoKHR, allocation_callbacks: Option<&AllocationCallbacks>, ) -> VkResult<SwapchainKHR>

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkCreateSwapchainKHR.html

pub unsafe fn destroy_swapchain( &self, swapchain: SwapchainKHR, allocation_callbacks: Option<&AllocationCallbacks>, )

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkDestroySwapchainKHR.html

pub unsafe fn get_swapchain_images( &self, swapchain: SwapchainKHR, ) -> VkResult<Vec<Image>>

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetSwapchainImagesKHR.html

pub unsafe fn acquire_next_image( &self, swapchain: SwapchainKHR, timeout: u64, semaphore: Semaphore, fence: Fence, ) -> VkResult<(u32, bool)>

On success, returns the next image’s index and whether the swapchain is suboptimal for the surface.

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkAcquireNextImageKHR.html

pub unsafe fn queue_present( &self, queue: Queue, present_info: &PresentInfoKHR, ) -> VkResult<bool>

On success, returns whether the swapchain is suboptimal for the surface.

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkQueuePresentKHR.html

pub unsafe fn get_device_group_present_capabilities( &self, device_group_present_capabilities: &mut DeviceGroupPresentCapabilitiesKHR, ) -> VkResult<()>

Only available since Vulkan 1.1.

Also available as DeviceGroup::get_device_group_present_capabilities() when VK_KHR_surface is enabled.

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetDeviceGroupPresentCapabilitiesKHR.html

pub unsafe fn get_device_group_surface_present_modes( &self, surface: SurfaceKHR, ) -> VkResult<DeviceGroupPresentModeFlagsKHR>

Only available since Vulkan 1.1.

Also available as DeviceGroup::get_device_group_surface_present_modes() when VK_KHR_surface is enabled.

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetDeviceGroupSurfacePresentModesKHR.html

pub unsafe fn get_physical_device_present_rectangles( &self, physical_device: PhysicalDevice, surface: SurfaceKHR, ) -> VkResult<Vec<Rect2D>>

Only available since Vulkan 1.1.

Also available as DeviceGroup::get_physical_device_present_rectangles() when VK_KHR_surface is enabled.

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDevicePresentRectanglesKHR.html

Warning

Function will always panic unless this struct is loaded via Self::new_from_instance().

pub unsafe fn acquire_next_image2( &self, acquire_info: &AcquireNextImageInfoKHR, ) -> VkResult<(u32, bool)>

On success, returns the next image’s index and whether the swapchain is suboptimal for the surface.

Only available since Vulkan 1.1.

Also available as DeviceGroup::acquire_next_image2() when VK_KHR_swapchain is enabled.

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkAcquireNextImage2KHR.html

pub const fn name() -> &'static CStr

pub fn fp(&self) -> &KhrSwapchainFn

pub fn device(&self) -> Device

Trait Implementations

impl Clone for Swapchain

fn clone(&self) -> Swapchain

Returns a copy of the value.

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

Performs copy-assignment from source.