Struct vulkano::image::immutable::ImmutableImage

pub struct ImmutableImage<F, A = PotentialDedicatedAllocation<StdMemoryPoolAlloc>> { /* fields omitted */ }

Image whose purpose is to be used for read-only purposes. You can write to the image once, but then you must only ever read from it.

Implementations

impl<F> ImmutableImage<F>

pub fn new<'a, I>(
    device: Arc<Device>,
    dimensions: Dimensions,
    format: F,
    queue_families: I
) -> Result<Arc<ImmutableImage<F>>, ImageCreationError> where
    F: FormatDesc,
    I: IntoIterator<Item = QueueFamily<'a>>, 

👎 Deprecated:

use ImmutableImage::uninitialized instead

pub fn with_mipmaps<'a, I, M>(
    device: Arc<Device>,
    dimensions: Dimensions,
    format: F,
    mipmaps: M,
    queue_families: I
) -> Result<Arc<ImmutableImage<F>>, ImageCreationError> where
    F: FormatDesc,
    I: IntoIterator<Item = QueueFamily<'a>>,
    M: Into<MipmapsCount>, 

👎 Deprecated:

use ImmutableImage::uninitialized instead

pub fn uninitialized<'a, I, M>(
    device: Arc<Device>,
    dimensions: Dimensions,
    format: F,
    mipmaps: M,
    usage: ImageUsage,
    layout: ImageLayout,
    queue_families: I
) -> Result<(Arc<ImmutableImage<F>>, ImmutableImageInitialization<F>), ImageCreationError> where
    F: FormatDesc,
    I: IntoIterator<Item = QueueFamily<'a>>,
    M: Into<MipmapsCount>, 

Builds an uninitialized immutable image.

Returns two things: the image, and a special access that should be used for the initial upload to the image.

pub fn from_iter<P, I>(
    iter: I,
    dimensions: Dimensions,
    mipmaps: MipmapsCount,
    format: F,
    queue: Arc<Queue>
) -> Result<(Arc<Self>, CommandBufferExecFuture<NowFuture, AutoCommandBuffer>), ImageCreationError> where
    P: Send + Sync + Clone + 'static,
    F: FormatDesc + AcceptsPixels<P> + 'static + Send + Sync,
    I: ExactSizeIterator<Item = P>,
    Format: AcceptsPixels<P>, 

Construct an ImmutableImage from the contents of iter.

pub fn from_buffer<B, P>(
    source: B,
    dimensions: Dimensions,
    mipmaps: MipmapsCount,
    format: F,
    queue: Arc<Queue>
) -> Result<(Arc<Self>, CommandBufferExecFuture<NowFuture, AutoCommandBuffer>), ImageCreationError> where
    B: BufferAccess + TypedBufferAccess<Content = [P]> + 'static + Clone + Send + Sync,
    P: Send + Sync + Clone + 'static,
    F: FormatDesc + AcceptsPixels<P> + 'static + Send + Sync,
    Format: AcceptsPixels<P>, 

Construct an ImmutableImage containing a copy of the data in source.

impl<F, A> ImmutableImage<F, A>

pub fn dimensions(&self) -> Dimensions

Returns the dimensions of the image.

pub fn mipmap_levels(&self) -> u32

Returns the number of mipmap levels of the image.

Trait Implementations

impl<F: Debug, A: Debug> Debug for ImmutableImage<F, A>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<F, A> Eq for ImmutableImage<F, A> where
    F: 'static + Send + Sync, 

impl<F, A> Hash for ImmutableImage<F, A> where
    F: 'static + Send + Sync, 

pub fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<F, A> ImageAccess for ImmutableImage<F, A> where
    F: 'static + Send + Sync, 

pub fn inner(&self) -> ImageInner<'_>

Returns the inner unsafe image object used by this image.

pub fn initial_layout_requirement(&self) -> ImageLayout

Returns the layout that the image has when it is first used in a primary command buffer.

pub fn final_layout_requirement(&self) -> ImageLayout

Returns the layout that the image must be returned to before the end of the command buffer.

pub 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.

pub 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.

pub 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.

pub 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.

pub 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.

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

Unlocks the resource previously acquired with try_gpu_lock or increase_gpu_lock.

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

Returns the current mip level that is accessed by the gpu

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

Returns the current layer level that is accessed by the gpu

pub fn format(&self) -> Format

Returns the format of this image.

pub fn has_color(&self) -> bool

Returns true if the image is a color image.

pub 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.

pub 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.

pub fn mipmap_levels(&self) -> u32

Returns the number of mipmap levels of this image.

pub fn samples(&self) -> u32

Returns the number of samples of this image.

pub fn dimensions(&self) -> ImageDimensions

Returns the dimensions of the image.

pub fn supports_blit_source(&self) -> bool

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

pub fn supports_blit_destination(&self) -> bool

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

pub 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.

pub fn is_layout_initialized(&self) -> bool

pub unsafe fn preinitialized_layout(&self) -> bool

pub 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.

impl<P, F, A> ImageContent<P> for ImmutableImage<F, A> where
    F: 'static + Send + Sync, 

pub fn matches_format(&self) -> bool

Checks whether pixels of type P match the format of the image.

impl<F: 'static, A> ImageViewAccess for ImmutableImage<F, A> where
    F: 'static + Send + Sync, 

pub fn parent(&self) -> &dyn ImageAccess

pub fn dimensions(&self) -> Dimensions

Returns the dimensions of the image view.

pub fn inner(&self) -> &UnsafeImageView

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

pub fn descriptor_set_storage_image_layout(&self) -> ImageLayout

Returns the image layout to use in a descriptor with the given subresource.

pub fn descriptor_set_combined_image_sampler_layout(&self) -> ImageLayout

Returns the image layout to use in a descriptor with the given subresource.

pub fn descriptor_set_sampled_image_layout(&self) -> ImageLayout

Returns the image layout to use in a descriptor with the given subresource.

pub fn descriptor_set_input_attachment_layout(&self) -> ImageLayout

Returns the image layout to use in a descriptor with the given subresource.

pub fn identity_swizzle(&self) -> bool

Returns true if the view doesn't use components swizzling.

pub fn format(&self) -> Format

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

pub fn samples(&self) -> u32

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

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

impl<F, A> PartialEq<ImmutableImage<F, A>> for ImmutableImage<F, A> where
    F: 'static + Send + Sync, 

pub fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.