Struct vulkano::image::traits::ImageAccessFromUndefinedLayout

pub struct ImageAccessFromUndefinedLayout<I> { /* fields omitted */ }

Wraps around an object that implements ImageAccess and modifies the initial layout requirement to be either Undefined or Preinitialized.

Trait Implementations

impl<I: Debug> Debug for ImageAccessFromUndefinedLayout<I>

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

Formats the value using the given formatter.

impl<I: Copy> Copy for ImageAccessFromUndefinedLayout<I>

impl<I: Clone> Clone for ImageAccessFromUndefinedLayout<I>

fn clone(&self) -> ImageAccessFromUndefinedLayout<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I> ImageAccess for ImageAccessFromUndefinedLayout<I> where     I: ImageAccess,

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 conflicts_buffer(&self, other: &BufferAccess) -> bool

Returns true if an access to self potentially overlaps the same memory as an access to other.

fn conflicts_image(&self, other: &ImageAccess) -> bool

Returns true if an access to self potentially overlaps the same memory as an access to other.

fn conflict_key(&self) -> u64

Returns a key that uniquely identifies the memory content of the image. Two ranges that potentially overlap in memory must return the same key.

fn try_gpu_lock(     &self,     exclusive_access: bool,     expected_layout: ImageLayout ) -> Result<(), AccessError>

Locks the resource for usage on the GPU. Returns an error if the lock can't be acquired.

unsafe fn increase_gpu_lock(&self)

Locks the resource for usage on the GPU. Supposes that the resource is already locked, and simply increases the lock by one.

unsafe fn unlock(&self, new_layout: Option<ImageLayout>)

Unlocks the resource previously acquired with try_gpu_lock or increase_gpu_lock.

fn format(&self) -> Format

Returns the format of this image.

fn has_color(&self) -> bool

Returns true if the image is a color image.

fn has_depth(&self) -> bool

Returns true if the image has a depth component. In other words, if it is a depth or a depth-stencil format.

fn has_stencil(&self) -> bool

Returns true if the image has a stencil component. In other words, if it is a stencil or a depth-stencil format.

fn mipmap_levels(&self) -> u32

Returns the number of mipmap levels of this image.

fn samples(&self) -> u32

Returns the number of samples of this image.

fn dimensions(&self) -> ImageDimensions

Returns the dimensions of the image.

fn supports_blit_source(&self) -> bool

Returns true if the image can be used as a source for blits.

fn supports_blit_destination(&self) -> bool

Returns true if the image can be used as a destination for blits.

unsafe fn forced_undefined_initial_layout(     self,     preinitialized: bool ) -> ImageAccessFromUndefinedLayout<Self> where     Self: Sized,

Wraps around this ImageAccess and returns an identical ImageAccess but whose initial layout requirement is either Undefined or Preinitialized.