Struct demo_vk::graphics::vulkan::Swapchain

source ·
pub struct Swapchain { /* private fields */ }
Expand description

The Vulkan swapchain and associated resources.

Implementations§

source§

impl Swapchain

source

pub fn new( cxt: Arc<VulkanContext>, framebuffer_size: (u32, u32), previous_swapchain: Option<SwapchainKHR>, ) -> Result<Self>

Creates a new Vulkan swapchain.

source

pub fn raw(&self) -> SwapchainKHR

Returns the non-owning Vulkan swapchain handle.

source

pub fn extent(&self) -> Extent2D

Returns the Swapchain’s current extent.

source

pub fn scissor(&self) -> Rect2D

Returns a scissor rect for the full swapchain extent.

source

pub fn viewport(&self) -> Viewport

source

pub fn format(&self) -> Format

Returns the Swapchain’s image format.

source

pub fn images(&self) -> &[Image]

Returns the Swapchain’s image handles.

source

pub fn image_views(&self) -> &[ImageView]

Returns the Swapchain’s image views.

Views are paired 1-1 with images of the same index.

source

pub fn acquire_image( &self, image_ready_semaphore: Semaphore, ) -> Result<AcquireImageStatus>

Acquires the index for the next swapchain image.

  • image_ready_semaphore - A Vulkan semaphore to signal when the swapchain image is ready. This can be vk::Semaphore::null() if not required.
source

pub fn present_image( &self, wait_semaphore: Semaphore, image_index: u32, ) -> Result<PresentImageStatus>

Presents the swapchain image.

  • wait_semaphore - Image presentation waits for the semaphore to be signalled.
  • image_index - The index of the swapchain image being presented. This must come from a prior call to Self::acquire_image.

Trait Implementations§

source§

impl Debug for Swapchain

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
source§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.