Struct vulkano::swapchain::Swapchain

pub struct Swapchain<W> { /* fields omitted */ }

Contains the swapping system and the images that can be shown on a surface.

Implementations

impl<W> Swapchain<W>

pub fn start(
    device: Arc<Device>,
    surface: Arc<Surface<W>>
) -> SwapchainBuilder<W>

Starts the process of building a new swapchain, using default values for the parameters.

pub fn recreate(self: &Arc<Self>) -> SwapchainBuilder<W>

Starts building a new swapchain from an existing swapchain.

Use this when a swapchain has become invalidated, such as due to window resizes. The builder is pre-filled with the parameters of the old one, except for dimensions, which is set to None.

pub fn surface(&self) -> &Arc<Surface<W>>

Returns the saved Surface, from the Swapchain creation.

pub fn raw_image(&self, offset: usize) -> Option<ImageInner<'_>>

Returns of the images that belong to this swapchain.

pub fn num_images(&self) -> u32

Returns the number of images of the swapchain.

pub fn format(&self) -> Format

Returns the format of the images of the swapchain.

pub fn dimensions(&self) -> [u32; 2]

Returns the dimensions of the images of the swapchain.

pub fn layers(&self) -> u32

Returns the number of layers of the images of the swapchain.

pub fn transform(&self) -> SurfaceTransform

Returns the transform that was passed when creating the swapchain.

pub fn composite_alpha(&self) -> CompositeAlpha

Returns the alpha mode that was passed when creating the swapchain.

pub fn present_mode(&self) -> PresentMode

Returns the present mode that was passed when creating the swapchain.

pub fn clipped(&self) -> bool

Returns the value of clipped that was passed when creating the swapchain.

pub fn fullscreen_exclusive(&self) -> FullscreenExclusive

Returns the value of ’fullscreen_exclusive` that was passed when creating the swapchain.

pub fn acquire_fullscreen_exclusive(
    &self
) -> Result<(), FullscreenExclusiveError>

FullscreenExclusive::AppControlled must be the active fullscreen exclusivity mode. Acquire fullscreen exclusivity until either the release_fullscreen_exclusive is called, or if any of the the other Swapchain functions return FullscreenExclusiveLost. Requires: FullscreenExclusive::AppControlled

pub fn release_fullscreen_exclusive(
    &self
) -> Result<(), FullscreenExclusiveError>

FullscreenExclusive::AppControlled must be the active fullscreen exclusivity mode. Release fullscreen exclusivity.

pub fn is_fullscreen_exclusive(&self) -> bool

FullscreenExclusive::AppControlled is not the active fullscreen exclusivity mode, then this function will always return false. If true is returned the swapchain is in FullscreenExclusive::AppControlled fullscreen exclusivity mode and exclusivity is currently acquired.

Trait Implementations

impl<W> Debug for Swapchain<W>

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

Formats the value using the given formatter.

impl<W> DeviceOwned for Swapchain<W>

fn device(&self) -> &Arc<Device>

Returns the device that owns Self.

impl<W> Drop for Swapchain<W>

fn drop(&mut self)

Executes the destructor for this type.

impl<W> VulkanObject for Swapchain<W>

type Object = SwapchainKHR

The type of the object.

fn internal_object(&self) -> SwapchainKHR

Returns a reference to the object.