Struct vulkayes_core::swapchain::Swapchain

pub struct Swapchain { /* fields omitted */ }

Implementations

impl Swapchain

pub fn new(
    device: Vrc<Device>,
    surface: Surface,
    create_info: SwapchainCreateInfo<impl AsRef<[u32]>>,
    host_memory_allocator: HostMemoryAllocator
) -> Result<SwapchainData, SwapchainError>

pub fn recreate(
    &self,
    create_info: SwapchainCreateInfo<impl AsRef<[u32]>>,
    host_memory_allocator: HostMemoryAllocator
) -> Result<SwapchainData, SwapchainError>

pub unsafe fn from_create_info(
    device: Vrc<Device>,
    surface: Vrc<Surface>,
    create_info: impl Deref<Target = SwapchainCreateInfoKHR>,
    host_memory_allocator: HostMemoryAllocator
) -> Result<SwapchainData, SwapchainError>

Creates a new Swapchain from an existing SwapchainCreateInfoKHR.

Safety

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

pub unsafe fn present(
    &self,
    queue: &Queue,
    info: impl Deref<Target = PresentInfoKHR>
) -> QueuePresentResult

Presents on given queue.

Safety

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

pub fn acquire_next(
    &self,
    timeout: WaitTimeout,
    synchronization: AcquireSynchronization<'_>
) -> AcquireResult

pub const fn device(&self) -> &Vrc<Device>

pub const fn surface(&self) -> &Vrc<Surface>

pub const fn loader(&self) -> &Swapchain

pub fn retired(&self) -> bool

Methods from Deref<Target = Vutex<SwapchainKHR>>

pub fn lock(&self) -> Result<VutexGuard<'_, T>, BorrowMutError>

Trait Implementations

impl Borrow<Vutex<SwapchainKHR>> for Swapchain

fn borrow(&self) -> &Vutex<SwapchainKHR>

Immutably borrows from an owned value.

impl Debug for Swapchain

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for Swapchain

type Target = Vutex<SwapchainKHR>

The resulting type after dereferencing.

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

Dereferences the value.

impl Drop for Swapchain

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for Swapchain

impl HasSynchronizedHandle<SwapchainKHR> for Swapchain

fn lock_handle(&self) -> VutexGuard<'_, T>

fn lock_safe_handle(&self) -> VutexGuardSafeHandleBorrow<'_, T>

impl Hash for Swapchain

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Swapchain

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Swapchain> for Swapchain

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Swapchain> for Swapchain

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.