Struct vk_sync_fork::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
sourceimpl<'a> Clone for ImageBarrier<'a>
impl<'a> Clone for ImageBarrier<'a>
sourcefn clone(&self) -> ImageBarrier<'a>
fn clone(&self) -> ImageBarrier<'a>
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
sourceimpl<'a> Debug for ImageBarrier<'a>
impl<'a> Debug for ImageBarrier<'a>
sourceimpl<'a> Default for ImageBarrier<'a>
impl<'a> Default for ImageBarrier<'a>
sourcefn default() -> ImageBarrier<'a>
fn default() -> ImageBarrier<'a>
Returns the “default value” for a type. Read more
Auto Trait Implementations
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
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.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more