Struct vulkano::image::swapchain::SwapchainImage
source · pub struct SwapchainImage { /* private fields */ }
Expand description
An image that is part of a swapchain.
Creating a SwapchainImage
is automatically done when creating a swapchain.
A swapchain image is special in the sense that it can only be used after being acquired by
calling the acquire
method on the swapchain. You have no way to know in advance which
swapchain image is going to be acquired, so you should keep all of them alive.
After a swapchain image has been acquired, you are free to perform all the usual operations on it. When you are done you can then present the image (by calling the corresponding method on the swapchain), which will have the effect of showing the content of the image to the screen. Once an image has been presented, it can no longer be used unless it is acquired again.
Implementations§
Trait Implementations§
source§impl Debug for SwapchainImage
impl Debug for SwapchainImage
source§impl DeviceOwned for SwapchainImage
impl DeviceOwned for SwapchainImage
source§impl Hash for SwapchainImage
impl Hash for SwapchainImage
source§impl ImageAccess for SwapchainImage
impl ImageAccess for SwapchainImage
source§fn inner(&self) -> ImageInner<'_>
fn inner(&self) -> ImageInner<'_>
Returns the inner unsafe image object used by this image.
source§fn initial_layout_requirement(&self) -> ImageLayout
fn initial_layout_requirement(&self) -> ImageLayout
Returns the layout that the image has when it is first used in a primary command buffer. Read more
source§fn final_layout_requirement(&self) -> ImageLayout
fn final_layout_requirement(&self) -> ImageLayout
Returns the layout that the image must be returned to before the end of the command buffer. Read more
source§fn descriptor_layouts(&self) -> Option<ImageDescriptorLayouts>
fn descriptor_layouts(&self) -> Option<ImageDescriptorLayouts>
Returns an
ImageDescriptorLayouts
structure specifying the image layout to use
in descriptors of various kinds. Read moresource§unsafe fn layout_initialized(&self)
unsafe fn layout_initialized(&self)
When images are created their memory layout is initially
Undefined
or Preinitialized
.
This method allows the image memory barrier creation process to signal when an image
has been transitioned out of its initial Undefined
or Preinitialized
state. This
allows vulkano to avoid creating unnecessary image memory barriers between future
uses of the image. Read morefn is_layout_initialized(&self) -> bool
source§fn dimensions(&self) -> ImageDimensions
fn dimensions(&self) -> ImageDimensions
Returns the dimensions of the image.
source§fn format_features(&self) -> FormatFeatures
fn format_features(&self) -> FormatFeatures
Returns the features supported by the image’s format.
source§fn mip_levels(&self) -> u32
fn mip_levels(&self) -> u32
Returns the number of mipmap levels of this image.
source§fn samples(&self) -> SampleCount
fn samples(&self) -> SampleCount
Returns the number of samples of this image.
source§fn usage(&self) -> ImageUsage
fn usage(&self) -> ImageUsage
Returns the usage the image was created with.
source§fn stencil_usage(&self) -> ImageUsage
fn stencil_usage(&self) -> ImageUsage
Returns the stencil usage the image was created with.
source§fn subresource_layers(&self) -> ImageSubresourceLayers
fn subresource_layers(&self) -> ImageSubresourceLayers
Returns an
ImageSubresourceLayers
covering the first mip level of the image. All aspects
of the image are selected, or plane0
if the image is multi-planar.source§fn subresource_range(&self) -> ImageSubresourceRange
fn subresource_range(&self) -> ImageSubresourceRange
Returns an
ImageSubresourceRange
covering the whole image. If the image is multi-planar,
only the color
aspect is selected.fn initial_layout(&self) -> ImageLayout
source§unsafe fn forced_undefined_initial_layout(
self,
preinitialized: bool
) -> Arc<ImageAccessFromUndefinedLayout<Self>>where
Self: Sized,
unsafe fn forced_undefined_initial_layout( self, preinitialized: bool ) -> Arc<ImageAccessFromUndefinedLayout<Self>>where Self: Sized,
Wraps around this
ImageAccess
and returns an identical ImageAccess
but whose initial
layout requirement is either Undefined
or Preinitialized
.source§impl<P> ImageContent<P> for SwapchainImage
impl<P> ImageContent<P> for SwapchainImage
source§fn matches_format(&self) -> bool
fn matches_format(&self) -> bool
Checks whether pixels of type
P
match the format of the image.