Struct ilmenite::image_view::ImtImageView

pub struct ImtImageView { /* fields omitted */ }

Implementations

impl ImtImageView

pub fn from_storage(
    image: Arc<StorageImage>
) -> Result<Arc<Self>, ImageViewCreationError>

pub fn from_immutable(
    image: Arc<ImmutableImage>
) -> Result<Arc<Self>, ImageViewCreationError>

pub fn from_sub(
    image: Arc<SubImage>
) -> Result<Arc<Self>, ImageViewCreationError>

pub fn from_attachment(
    image: Arc<AttachmentImage>
) -> Result<Arc<Self>, ImageViewCreationError>

pub fn create_tmp(self: &Arc<Self>) -> (Arc<Self>, Arc<AtomicBool>)

Create a clone of this view that is intented to be temporary. This method will return a clone of this view along with an AtomicBool. The AtomicBool will be set to false when the cloned copy is dropped.

pub fn is_temporary(&self) -> bool

Check whether this view is temporary. In the case it is the method that provided this view intended for it be dropped after use.

pub fn dimensions(&self) -> ImageDimensions

Trait Implementations

impl Drop for ImtImageView

fn drop(&mut self)

Executes the destructor for this type.

impl ImageAccess for ImtImageView

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 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 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 try_gpu_lock(
    &self,
    exclusive_access: bool,
    uninitialized_safe: 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, transitioned_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) -> SampleCount

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>

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

impl ImageViewAbstract for ImtImageView

fn image(&self) -> &dyn ImageAccess

Returns the wrapped image that this image view was created from.

fn inner(&self) -> &UnsafeImageView

Returns the inner unsafe image view object used by this image view.

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

Returns the range of array layers of the wrapped image that this view exposes.

fn format(&self) -> Format

Returns the format of this view. This can be different from the parent’s format.

fn component_mapping(&self) -> ComponentMapping

Returns the component mapping of this view.

fn ty(&self) -> ImageViewType

Returns the ImageViewType of this image view.

fn can_be_sampled(&self, _sampler: &Sampler) -> bool

Returns true if the given sampler can be used with this image view.