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.

Methods

impl<F> ImmutableImage<F>

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

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

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.

fn from_iter<P, I>(
    iter: I,
    dimensions: Dimensions,
    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.

TODO: Support mipmaps

fn from_buffer<B, P>(
    source: B,
    dimensions: Dimensions,
    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.

TODO: Support mipmaps

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

fn dimensions(&self) -> Dimensions

Returns the dimensions of the image.

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>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

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

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, _: u32, _: u32, _: u32, _: 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
) -> 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.

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

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, 

fn parent(&self) -> &ImageAccess

fn dimensions(&self) -> Dimensions

Returns the dimensions of the image view.

fn inner(&self) -> &UnsafeImageView

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

fn descriptor_set_storage_image_layout(&self) -> ImageLayout

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

fn descriptor_set_combined_image_sampler_layout(&self) -> ImageLayout

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

fn descriptor_set_sampled_image_layout(&self) -> ImageLayout

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

fn descriptor_set_input_attachment_layout(&self) -> ImageLayout

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

fn identity_swizzle(&self) -> bool

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

fn format(&self) -> Format

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

fn samples(&self) -> u32

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

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