Struct vulkano::image::swapchain::SwapchainImage

pub struct SwapchainImage { /* private fields */ }

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

impl SwapchainImage

pub fn swapchain(&self) -> &Arc<Swapchain>

Returns the swapchain this image belongs to.

Trait Implementations

impl Debug for SwapchainImage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DeviceOwned for SwapchainImage

fn device(&self) -> &Arc<Device>

Returns the device that owns Self.

impl Hash for SwapchainImage

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl ImageAccess for SwapchainImage

fn inner(&self) -> ImageInner<'_>

Returns the inner unsafe image object used by this image.

fn initial_layout_requirement(&self) -> ImageLayout

Returns the layout that the image has when it is first used in a primary command buffer.

fn final_layout_requirement(&self) -> ImageLayout

Returns the layout that the image must be returned to before the end of the command buffer.

fn descriptor_layouts(&self) -> Option<ImageDescriptorLayouts>

Returns an ImageDescriptorLayouts structure specifying the image layout to use in descriptors of various kinds.

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.

fn is_layout_initialized(&self) -> bool

fn dimensions(&self) -> ImageDimensions

Returns the dimensions of the image.

fn format(&self) -> Format

Returns the format of this image.

fn format_features(&self) -> &FormatFeatures

Returns the features supported by the image’s format.

fn mip_levels(&self) -> u32

Returns the number of mipmap levels of this image.

fn samples(&self) -> SampleCount

Returns the number of samples of this image.

fn usage(&self) -> &ImageUsage

Returns the usage the image was created with.

fn stencil_usage(&self) -> &ImageUsage

Returns the stencil usage the image was created with.

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.

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

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.

impl<P> ImageContent<P> for SwapchainImage

fn matches_format(&self) -> bool

Checks whether pixels of type P match the format of the image.

impl PartialEq<SwapchainImage> for SwapchainImage

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SwapchainImage