Struct vulkano::image::StorageImage

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

Implementations

impl StorageImage

pub fn new<'a, I>(
    device: Arc<Device>,
    dimensions: ImageDimensions,
    format: Format,
    queue_families: I
) -> Result<Arc<StorageImage>, ImageCreationError> where
    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: ImageDimensions,
    format: Format,
    usage: ImageUsage,
    flags: ImageCreateFlags,
    queue_families: I
) -> Result<Arc<StorageImage>, ImageCreationError> where
    I: IntoIterator<Item = QueueFamily<'a>>, 

Same as new, but allows specifying the usage.

pub fn new_with_exportable_fd<'a, I>(
    device: Arc<Device>,
    dimensions: ImageDimensions,
    format: Format,
    usage: ImageUsage,
    flags: ImageCreateFlags,
    queue_families: I
) -> Result<Arc<StorageImage>, ImageCreationError> where
    I: IntoIterator<Item = QueueFamily<'a>>, 

pub fn export_posix_fd(&self) -> Result<File, DeviceMemoryAllocError>

Exports posix file descriptor for the allocated memory requires khr_external_memory_fd and khr_external_memory extensions to be loaded. Only works on Linux.

pub fn mem_size(&self) -> DeviceSize

Return the size of the allocated memory (used for e.g. with cuda)

Trait Implementations

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

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

Formats the value using the given formatter.

impl<A> Hash for StorageImage<A> where
    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<A> ImageAccess for StorageImage<A> where
    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 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 try_gpu_lock(
    &self,
    _: 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, new_layout: Option<ImageLayout>)

Unlocks the resource previously acquired with try_gpu_lock or increase_gpu_lock.

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 format(&self) -> Format

Returns the format of this image.

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
) -> Arc<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<A> ImageClearValue<ClearValue> for StorageImage<A> where
    A: MemoryPool, 

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

impl<P, A> ImageContent<P> for StorageImage<A> where
    A: MemoryPool, 

fn matches_format(&self) -> bool

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

impl<A> PartialEq<StorageImage<A>> for StorageImage<A> where
    A: MemoryPool, 

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<A> Eq for StorageImage<A> where
    A: MemoryPool,