Struct gfx_hal::window::SwapchainConfig [−][src]
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_mode: CompositeAlphaMode
Alpha composition mode.
format: Format
Format of the backbuffer images.
extent: Extent2D
Requested image extent. Must be in
SurfaceCapabilities::extents
range.
image_count: SwapImageIndex
Number of images in the swapchain. Must be in
SurfaceCapabilities::image_count
range.
image_layers: Layer
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
[src]
pub fn new(
width: u32,
height: u32,
format: Format,
image_count: SwapImageIndex
) -> Self
[src]
width: u32,
height: u32,
format: Format,
image_count: SwapImageIndex
) -> Self
Create a new default configuration (color images only).
pub fn framebuffer_attachment(&self) -> FramebufferAttachment
[src]
Return the framebuffer attachment corresponding to the swapchain image views.
pub fn from_caps(
caps: &SurfaceCapabilities,
format: Format,
default_extent: Extent2D
) -> Self
[src]
caps: &SurfaceCapabilities,
format: Format,
default_extent: Extent2D
) -> Self
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.
The default values are taken from DEFAULT_USAGE
and DEFAULT_IMAGE_COUNT
.
pub fn with_present_mode(mut self: Self, mode: PresentMode) -> Self
[src]
Specify the presentation mode.
pub fn with_composite_alpha_mode(
mut self: Self,
mode: CompositeAlphaMode
) -> Self
[src]
mut self: Self,
mode: CompositeAlphaMode
) -> Self
Specify the presentation mode.
pub fn with_image_usage(mut self: Self, usage: Usage) -> Self
[src]
Specify the usage of backbuffer images.
pub fn with_image_count(mut self: Self, count: SwapImageIndex) -> Self
[src]
Specify the count of backbuffer image.
Trait Implementations
impl Clone for SwapchainConfig
[src]
fn clone(&self) -> SwapchainConfig
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for SwapchainConfig
[src]
Auto Trait Implementations
impl RefUnwindSafe for SwapchainConfig
[src]
impl Send for SwapchainConfig
[src]
impl Sync for SwapchainConfig
[src]
impl Unpin for SwapchainConfig
[src]
impl UnwindSafe for SwapchainConfig
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,