Struct gfx_hal::window::SwapchainConfig
source · pub struct SwapchainConfig {
pub present_mode: PresentMode,
pub composite_alpha: CompositeAlpha,
pub format: Format,
pub extent: Extent2D,
pub image_count: SwapImageIndex,
pub image_layers: Layer,
pub image_usage: Usage,
}
Expand description
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: 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
sourceimpl SwapchainConfig
impl SwapchainConfig
sourcepub fn from_caps(
caps: &SurfaceCapabilities,
format: Format,
default_extent: Extent2D
) -> Self
pub fn from_caps(
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.
sourcepub fn with_mode(self, mode: PresentMode) -> Self
pub fn with_mode(self, mode: PresentMode) -> Self
sourcepub fn with_image_usage(self, usage: Usage) -> Self
pub fn with_image_usage(self, usage: Usage) -> Self
Trait Implementations
sourceimpl Clone for SwapchainConfig
impl Clone for SwapchainConfig
sourcefn clone(&self) -> SwapchainConfig
fn clone(&self) -> SwapchainConfig
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreAuto Trait Implementations
impl RefUnwindSafe for SwapchainConfig
impl Send for SwapchainConfig
impl Sync for SwapchainConfig
impl Unpin for SwapchainConfig
impl UnwindSafe for SwapchainConfig
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more