Struct ilmenite::image_view::ImtImageView

pub struct ImtImageView { /* private fields */ }

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

Trait Implementations

impl DeviceOwned for ImtImageView

fn device(&self) -> &Arc<Device>

Returns the device that owns Self.

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 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_mip_levels_access(&self) -> Range<u32>

Returns the current mip level that is accessed by the gpu

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

Returns the current array layer 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 mip_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 format_features(&self) -> &FormatFeatures

Returns the features supported by the image’s format.

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

unsafe fn forced_undefined_initial_layout(
    self,
    preinitialized: bool
) -> Arc<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) -> Arc<dyn ImageAccess>

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

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

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

fn aspects(&self) -> &ImageAspects

Returns the aspects of the wrapped image that this view exposes.

fn component_mapping(&self) -> ComponentMapping

Returns the component mapping of this view.

fn filter_cubic(&self) -> bool

Returns whether the image view supports sampling with a Cubic mag_filter or min_filter.

fn filter_cubic_minmax(&self) -> bool

Returns whether the image view supports sampling with a Cubic mag_filter or min_filter, and with a Min or Max reduction_mode.

fn format(&self) -> Format

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

fn format_features(&self) -> &FormatFeatures

Returns the features supported by the image view’s format.

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

Returns the range of mip levels of the wrapped image that this view exposes.

fn sampler_ycbcr_conversion(&self) -> Option<&Arc<SamplerYcbcrConversion>>

Returns the sampler YCbCr conversion that this image view was created with, if any.

fn ty(&self) -> ImageViewType

Returns the ImageViewType of this image view.

fn usage(&self) -> &ImageUsage

Returns the usage of the image view.

impl VulkanObject for ImtImageView

type Object = ImageView

The type of the object.

fn internal_object(&self) -> ImageView

Returns a reference to the object.