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, __arg_0: &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 conflict_key(
    &self,
    first_layer: u32,
    num_layers: u32,
    first_mipmap: u32,
    num_mipmaps: u32
) -> u64

Returns a key that uniquely identifies the range given by first_layer/num_layers/first_mipmap/num_mipmaps.

fn try_gpu_lock(
    &self,
    exclusive_access: bool,
    queue: &Queue
) -> 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)

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.

fn conflicts_buffer(
    &self,
    self_first_layer: u32,
    self_num_layers: u32,
    self_first_mipmap: u32,
    self_num_mipmaps: u32,
    other: &BufferAccess,
    other_offset: usize,
    other_size: usize
) -> bool

Returns true if an access to self (as defined by self_first_layer, self_num_layers, self_first_mipmap and self_num_mipmaps) potentially overlaps the same memory as an access to other (as defined by other_offset and other_size).

fn conflicts_image(
    &self,
    self_first_layer: u32,
    self_num_layers: u32,
    self_first_mipmap: u32,
    self_num_mipmaps: u32,
    other: &ImageAccess,
    other_first_layer: u32,
    other_num_layers: u32,
    other_first_mipmap: u32,
    other_num_mipmaps: u32
) -> bool

Returns true if an access to self (as defined by self_first_layer, self_num_layers, self_first_mipmap and self_num_mipmaps) potentially overlaps the same memory as an access to other (as defined by other_first_layer, other_num_layers, other_first_mipmap and other_num_mipmaps).

fn conflicts_buffer_all(&self, other: &BufferAccess) -> bool

Shortcut for conflicts_buffer that compares the whole buffer to another.

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

Shortcut for conflicts_image that compares the whole buffer to a whole image.

fn conflict_key_all(&self) -> u64

Shortcut for conflict_key that grabs the key of the whole buffer.