Struct gfx_hal::window::SwapchainConfig
source · [−]pub struct SwapchainConfig {
pub present_mode: PresentMode,
pub composite_alpha_mode: CompositeAlphaMode,
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_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
sourceimpl SwapchainConfig
impl SwapchainConfig
sourcepub fn new(
width: u32,
height: u32,
format: Format,
image_count: SwapImageIndex
) -> Self
pub fn new(
width: u32,
height: u32,
format: Format,
image_count: SwapImageIndex
) -> Self
Create a new default configuration (color images only).
sourcepub fn framebuffer_attachment(&self) -> FramebufferAttachment
pub fn framebuffer_attachment(&self) -> FramebufferAttachment
Return the framebuffer attachment corresponding to the swapchain image views.
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.
The default values are taken from DEFAULT_USAGE
and DEFAULT_IMAGE_COUNT
.
sourcepub fn with_present_mode(self, mode: PresentMode) -> Self
pub fn with_present_mode(self, mode: PresentMode) -> Self
Specify the presentation mode.
sourcepub fn with_composite_alpha_mode(self, mode: CompositeAlphaMode) -> Self
pub fn with_composite_alpha_mode(self, mode: CompositeAlphaMode) -> Self
Specify the presentation mode.
sourcepub fn with_image_usage(self, usage: Usage) -> Self
pub fn with_image_usage(self, usage: Usage) -> Self
Specify the usage of backbuffer images.
sourcepub fn with_image_count(self, count: SwapImageIndex) -> Self
pub fn with_image_count(self, count: SwapImageIndex) -> Self
Specify the count of backbuffer image.
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 more
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more