Struct vulkano::image::immutable::SubImage

pub struct SubImage { /* fields omitted */ }

Image whose purpose is to access only a part of one image, for any kind of access We define a part of one image here by a level of mipmap, or a layer of an array The image attribute must be an implementation of ImageAccess The mip_levels_access must be a range showing which mipmaps will be accessed The layer_levels_access must be a range showing which layers will be accessed The layout must be the layout of the image at the beginning and at the end of the command buffer

Implementations

impl SubImage

pub fn new(
    image: Arc<dyn ImageAccess + Sync + Send>,
    mip_level: u32,
    mip_level_count: u32,
    layer_level: u32,
    layer_level_count: u32,
    layout: ImageLayout
) -> Arc<SubImage>

Trait Implementations

impl ImageAccess for SubImage

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 descriptor_layouts(&self) -> Option<ImageDescriptorLayouts>

Returns an ImageDescriptorLayouts structure specifying the image layout to use in descriptors of various kinds.

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

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

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

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

fn current_miplevels_access(&self) -> Range<u32>

Returns the current mip level that is accessed by the gpu

fn current_layer_levels_access(&self) -> Range<u32>

Returns the current layer level that is accessed by the gpu

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 layout_initialized(&self)

When images are created their memory layout is initially Undefined or Preinitialized. This method allows the image memory barrier creation process to signal when an image has been transitioned out of its initial Undefined or Preinitialized state. This allows vulkano to avoid creating unnecessary image memory barriers between future uses of the image.

fn is_layout_initialized(&self) -> bool

unsafe fn preinitialized_layout(&self) -> bool

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.