Struct vulkano::swapchain::SwapchainBuilder

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

Builder for a Swapchain.

Implementations

impl<W> SwapchainBuilder<W>

pub fn build(
    self
) -> Result<(Arc<Swapchain<W>>, Vec<Arc<SwapchainImage<W>>>), SwapchainCreationError>

Builds a new swapchain. Allocates images who content can be made visible on a surface.

See also the Surface::get_capabilities function which returns the values that are supported by the implementation. All the parameters that you pass to the builder must be supported.

This function returns the swapchain plus a list of the images that belong to the swapchain. The order in which the images are returned is important for the acquire_next_image and present functions.

Panic

• Panics if the device and the surface don’t belong to the same instance.
• Panics if usage is empty.

pub fn num_images(self, num_images: u32) -> Self

Sets the number of images that will be created.

The default is 2.

pub fn format(self, format: Format) -> Self

Sets the pixel format that will be used for the images.

The default is either R8G8B8A8Unorm or B8G8R8A8Unorm, whichever is supported.

pub fn color_space(self, color_space: ColorSpace) -> Self

Sets the color space that will be used for the images.

The default is SrgbNonLinear.

pub fn dimensions(self, dimensions: [u32; 2]) -> Self

Sets the dimensions of the images.

The default is None, which means the value of Capabilities::current_extent will be used. Setting this will override it with a custom Some value.

pub fn layers(self, layers: u32) -> Self

Sets the number of layers for each image.

The default is 1.

pub fn usage(self, usage: ImageUsage) -> Self

Sets how the images will be used.

The default is ImageUsage::none().

pub fn sharing_mode<S>(self, sharing_mode: S) -> Self where
    S: Into<SharingMode>, 

Sets the sharing mode of the images.

The default is Exclusive.

pub fn transform(self, transform: SurfaceTransform) -> Self

Sets the transform that is to be applied to the surface.

The default is Identity.

pub fn composite_alpha(self, composite_alpha: CompositeAlpha) -> Self

Sets how alpha values of the pixels in the image are to be treated.

The default is Opaque.

pub fn present_mode(self, present_mode: PresentMode) -> Self

Sets the present mode for the swapchain.

The default is Fifo.

pub fn fullscreen_exclusive(
    self,
    fullscreen_exclusive: FullscreenExclusive
) -> Self

Sets how fullscreen exclusivity is to be handled.

The default is Default.

pub fn clipped(self, clipped: bool) -> Self

Sets whether the implementation is allowed to discard rendering operations that affect regions of the surface which aren’t visible. This is important to take into account if your fragment shader has side-effects or if you want to read back the content of the image afterwards.

The default is true.

Trait Implementations

impl<W: Debug> Debug for SwapchainBuilder<W>

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

Formats the value using the given formatter.