Struct vulkano::image::StorageImage

pub struct StorageImage<F, A = Arc<StdMemoryPool>> where
    A: MemoryPool,  { /* fields omitted */ }

General-purpose image in device memory. Can be used for any usage, but will be slower than a specialized image.

Methods

impl<F> StorageImage<F>

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

Creates a new image with the given dimensions and format.

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

Same as new, but allows specifying the usage.

impl<F, A> StorageImage<F, A> where
    A: MemoryPool, 

pub fn dimensions(&self) -> Dimensions

Returns the dimensions of the image.

Trait Implementations

impl<F: Debug, A: Debug> Debug for StorageImage<F, A> where
    A: MemoryPool,
    A::Alloc: Debug, 

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

Formats the value using the given formatter.

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

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

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

Feeds this value into the given [Hasher].

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 StorageImage<F, A> where
    F: 'static + Send + Sync,
    A: MemoryPool, 

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 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 try_gpu_lock(
    &self,
    _: 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.

impl<F, A> ImageClearValue<<F as FormatDesc>::ClearValue> for StorageImage<F, A> where
    F: FormatDesc + 'static + Send + Sync,
    A: MemoryPool, 

fn decode(&self, value: F::ClearValue) -> Option<ClearValue>

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

fn matches_format(&self) -> bool

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

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

fn parent(&self) -> &dyn 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.

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

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

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

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

This method tests for !=.