[]Struct amethyst_rendy::rendy::hal::SwapchainConfig

pub struct SwapchainConfig {
    pub present_mode: PresentMode,
    pub composite_alpha: CompositeAlpha,
    pub format: Format,
    pub extent: Extent2D,
    pub image_count: u32,
    pub image_layers: u16,
    pub image_usage: Usage,
}

Contains all the data necessary to create a new Swapchain: color, depth, and number of images.

Examples

This type implements the builder pattern, method calls can be easily chained.

let config = SwapchainConfig::new(100, 100, Format::Bgra8Unorm, 2);

Fields

present_mode: PresentMode

Presentation mode.

composite_alpha: CompositeAlpha

Alpha composition mode.

format: Format

Format of the backbuffer images.

extent: Extent2D

Requested image extent. Must be in SurfaceCapabilities::extents range.

image_count: u32

Number of images in the swapchain. Must be in SurfaceCapabilities::image_count range.

image_layers: u16

Number of image layers. Must be lower or equal to SurfaceCapabilities::max_image_layers.

image_usage: Usage

Image usage of the backbuffer images.

Implementations

impl SwapchainConfig

pub fn new(
    width: u32,
    height: u32,
    format: Format,
    image_count: u32
) -> SwapchainConfig

Create a new default configuration (color images only).

Examples

pub fn from_caps(
    caps: &SurfaceCapabilities,
    format: Format,
    default_extent: Extent2D
) -> SwapchainConfig

Create a swapchain configuration based on the capabilities returned from a physical device query. If the surface does not specify a current size, default_extent is clamped and used instead.

pub fn with_mode(self, mode: PresentMode) -> SwapchainConfig

Specify the presentation mode.

Examples

pub fn with_image_usage(self, usage: Usage) -> SwapchainConfig

Specify the usage of backbuffer images.

Examples

Trait Implementations

impl Clone for SwapchainConfig

impl Debug for SwapchainConfig

Auto Trait Implementations

impl RefUnwindSafe for SwapchainConfig

impl Send for SwapchainConfig

impl Sync for SwapchainConfig

impl Unpin for SwapchainConfig

impl UnwindSafe for SwapchainConfig

Blanket Implementations

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
    D: AdaptFrom<S, Swp, Dwp, T>,
    Dwp: WhitePoint,
    Swp: WhitePoint,
    T: Component + Float
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Any for T where
    T: Any

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Clone for T where
    T: Clone
[src]

impl<T> Event for T where
    T: Send + Sync + 'static, 

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Resource for T where
    T: Any + Send + Sync

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> SetParameter for T

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

impl<T> Supports<T> for T

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,