vk_sync_fork

Struct ImageBarrier

Source
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: Image,
    pub range: ImageSubresourceRange,
}
Expand description

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: Image§range: ImageSubresourceRange

Trait Implementations§

Source§

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

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn default() -> ImageBarrier<'a>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for ImageBarrier<'a>

§

impl<'a> RefUnwindSafe for ImageBarrier<'a>

§

impl<'a> Send for ImageBarrier<'a>

§

impl<'a> Sync for ImageBarrier<'a>

§

impl<'a> Unpin for ImageBarrier<'a>

§

impl<'a> UnwindSafe for ImageBarrier<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.