Struct vulkano::image::StorageImage

pub struct StorageImage<A = Arc<StandardMemoryPool>>where
    A: MemoryPool,{ /* private fields */ }

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(
    device: Arc<Device>,
    dimensions: ImageDimensions,
    format: Format,
    queue_family_indices: impl IntoIterator<Item = u32>
) -> Result<Arc<StorageImage>, ImageCreationError>

Creates a new image with the given dimensions and format.

pub fn with_usage(
    device: Arc<Device>,
    dimensions: ImageDimensions,
    format: Format,
    usage: ImageUsage,
    flags: ImageCreateFlags,
    queue_family_indices: impl IntoIterator<Item = u32>
) -> Result<Arc<StorageImage>, ImageCreationError>

Same as new, but allows specifying the usage.

pub fn new_with_exportable_fd(
    device: Arc<Device>,
    dimensions: ImageDimensions,
    format: Format,
    usage: ImageUsage,
    flags: ImageCreateFlags,
    queue_family_indices: impl IntoIterator<Item = u32>
) -> Result<Arc<StorageImage>, ImageCreationError>

pub fn general_purpose_image_view(
    queue: Arc<Queue>,
    size: [u32; 2],
    format: Format,
    usage: ImageUsage
) -> Result<Arc<ImageView<StorageImage>>, ImageCreationError>

Allows the creation of a simple 2D general purpose image view from StorageImage.

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

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

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> DeviceOwned for StorageImage<A>where
    A: MemoryPool,

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

Returns the device that owns Self.

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

Returns the dimensions of the image.

fn format(&self) -> Format

Returns the format of this image.

fn format_features(&self) -> &FormatFeatures

Returns the features supported by the image’s format.

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 usage(&self) -> &ImageUsage

Returns the usage the image was created with.

fn stencil_usage(&self) -> &ImageUsage

Returns the stencil usage the image was created with.

fn subresource_layers(&self) -> ImageSubresourceLayers

Returns an ImageSubresourceLayers covering the first mip level of the image. All aspects of the image are selected, or plane0 if the image is multi-planar.

fn subresource_range(&self) -> ImageSubresourceRange

Returns an ImageSubresourceRange covering the whole image. If the image is multi-planar, only the color aspect is selected.

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

fn initial_layout(&self) -> ImageLayout

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<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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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