Struct SurfaceSwapchainObject

pub struct SurfaceSwapchainObject<Device: VkHandle<Handle = VkDevice>, Surface: VkHandle<Handle = VkSurfaceKHR>> { /* private fields */ }

Opaque handle to as swapchain object, backed with specific surface

Implementations

impl<Device, Surface> SurfaceSwapchainObject<Device, Surface>

where Device: VkHandle<Handle = VkDevice>, Surface: VkHandle<Handle = VkSurfaceKHR>,

pub fn deconstruct(self) -> (Device, Surface)

Available on crate feature Implements only.

Deconstructs the swapchain and retrieves its parents

Trait Implementations

impl<Device, Surface> DeviceChild for SurfaceSwapchainObject<Device, Surface>

where Device: Device, Surface: VkHandle<Handle = VkSurfaceKHR>,

type ConcreteDevice = Device

A concrete type of the parent device object.

fn device(&self) -> &Self::ConcreteDevice

Retrieve a reference to a device object that creates this object

impl<Device, Surface> DeviceChildHandle for SurfaceSwapchainObject<Device, Surface>

where Device: VkHandle<Handle = VkDevice>, Surface: VkHandle<Handle = VkSurfaceKHR>,

fn device_handle(&self) -> VkDevice

Retrieve a reference to a device handle that creates this objecs

impl<Device, Surface> Drop for SurfaceSwapchainObject<Device, Surface>

where Device: VkHandle<Handle = VkDevice>, Surface: VkHandle<Handle = VkSurfaceKHR>,

Available on crate feature Implements only.

fn drop(&mut self)

Executes the destructor for this type.

impl<Device, Surface> Swapchain for SurfaceSwapchainObject<Device, Surface>

where Device: Device, Surface: VkHandle<Handle = VkSurfaceKHR>,

fn format(&self) -> VkFormat

fn size(&self) -> &VkExtent2D

fn acquire_next( &mut self, timeout: Option<u64>, completion: CompletionHandlerMut<'_>, ) -> Result<u32>

Available on crate feature Implements only.

Retrieve the index of the next available presentation image

fn acquire_full_screen_exclusive_mode(&self) -> Result<()>

where Self::ConcreteDevice: DeviceFullScreenExclusiveExtension,

Available on crate features Implements and VK_EXT_full_screen_exclusive only.

Acquire full-screen exclusive mode for a swapchain.

fn release_full_screen_exclusive_mode(&self) -> Result<()>

where Self::ConcreteDevice: DeviceFullScreenExclusiveExtension,

Available on crate features Implements and VK_EXT_full_screen_exclusive only.

Release full-screen exclusive mode from a swapchain.

fn image_count(&self) -> Result<u32>

Available on crate feature Implements only.

Obtain a count of the array of presentable images associated with a swapchain

fn images(&self, sink: &mut [VkImage]) -> Result<u32>

Available on crate feature Implements only.

Obtain the array of presentable images associated with a swapchain

fn images_alloc(&self) -> Result<Vec<SwapchainImage<&Self>>>

where Self: Sized,

Available on crate features Implements and alloc only.

Obtain the array of presentable images associated with a swapchain

impl<Device: VkHandle<Handle = VkDevice>, Surface: VkHandle<Handle = VkSurfaceKHR>> VkHandle for SurfaceSwapchainObject<Device, Surface>

type Handle = VkSwapchainKHR

fn native_ptr(&self) -> Self::Handle

Retrieve an underlying handle

fn as_transparent_ref(&self) -> VkHandleRef<'_, Self::Handle>

impl<Device: VkHandle<Handle = VkDevice>, Surface: VkHandle<Handle = VkSurfaceKHR>> VkHandleMut for SurfaceSwapchainObject<Device, Surface>

fn native_ptr_mut(&mut self) -> Self::Handle

Retrieve an underlying mutable handle

fn as_transparent_ref_mut(&mut self) -> VkHandleRefMut<'_, Self::Handle>

impl<Device: VkHandle<Handle = VkDevice>, Surface: VkHandle<Handle = VkSurfaceKHR>> VkObject for SurfaceSwapchainObject<Device, Surface>

const TYPE: VkObjectType = 1_000_001_000i32

fn set_name(&self, name: Option<&CStr>) -> Result<()>

where Self: DeviceChild<ConcreteDevice: InstanceChild<ConcreteInstance: InstanceExtensions>>, Self::Handle: VkRawHandle,

Available on crate features Implements and VK_EXT_debug_utils only.

Give a user-friendly name to this object.

impl<Device, Surface> Send for SurfaceSwapchainObject<Device, Surface>

where Device: VkHandle<Handle = VkDevice> + Send, Surface: VkHandle<Handle = VkSurfaceKHR> + Send,

impl<Device, Surface> Sync for SurfaceSwapchainObject<Device, Surface>

where Device: VkHandle<Handle = VkDevice> + Sync, Surface: VkHandle<Handle = VkSurfaceKHR> + Sync,