Struct vk_sync::ImageBarrier

pub struct ImageBarrier<'a> {
    pub previous_accesses: &'a [AccessType],
    pub next_accesses: &'a [AccessType],
    pub previous_layout: ImageLayout,
    pub next_layout: ImageLayout,
    pub discard_contents: bool,
    pub src_queue_family_index: u32,
    pub dst_queue_family_index: u32,
    pub image: ImageType,
    pub range: ImageSubresourceRangeType,
}

Image barriers should only be used when a queue family ownership transfer or an image layout transition is required - prefer global barriers at all other times.

In general it is better to use image barriers with ImageLayout::Optimal than it is to use global barriers with images using either of the ImageLayout::General* layouts.

Access types are defined in the same way as for a global memory barrier, but they only affect the image subresource range identified by image and range, rather than all resources.

src_queue_family_index, dst_queue_family_index, image, and range will be passed unmodified into an image memory barrier.

An image barrier defining a queue ownership transfer needs to be executed twice - once by a queue in the source queue family, and then once again by a queue in the destination queue family, with a semaphore guaranteeing execution order between them.

If discard_contents is set to true, the contents of the image become undefined after the barrier is executed, which can result in a performance boost over attempting to preserve the contents. This is particularly useful for transient images where the contents are going to be immediately overwritten. A good example of when to use this is when an application re-uses a presented image after acquiring the next swap chain image.

Fields

previous_accesses: &'a [AccessType]

next_accesses: &'a [AccessType]

previous_layout: ImageLayout

next_layout: ImageLayout

discard_contents: bool

src_queue_family_index: u32

dst_queue_family_index: u32

image: ImageType

range: ImageSubresourceRangeType

Trait Implementations

impl<'a> Clone for ImageBarrier<'a>

fn clone(&self) -> ImageBarrier<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Default for ImageBarrier<'a>

fn default() -> ImageBarrier<'a>

Returns the "default value" for a type.

impl<'a> Debug for ImageBarrier<'a>

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

Formats the value using the given formatter.