Struct vulkano::image::sys::Image

pub struct Image { /* private fields */ }

A multi-dimensioned storage for texel data.

Unlike RawImage, an Image has memory backing it, and can be used normally.

Implementations

impl Image

pub fn memory(&self) -> &ImageMemory

Returns the type of memory that is backing this image.

pub fn memory_requirements(&self) -> &[MemoryRequirements]

Returns the memory requirements for this image.

• If self.flags().disjoint is not set, this returns a slice with a length of 1.
• If self.flags().disjoint is set, this returns a slice with a length equal to self.format().unwrap().planes().len().

pub fn flags(&self) -> ImageCreateFlags

Returns the flags the image was created with.

pub fn dimensions(&self) -> ImageDimensions

Returns the dimensions of the image.

pub fn format(&self) -> Option<Format>

Returns the image’s format.

pub fn format_features(&self) -> &FormatFeatures

Returns the features supported by the image’s format.

pub fn mip_levels(&self) -> u32

Returns the number of mipmap levels in the image.

pub fn initial_layout(&self) -> ImageLayout

Returns the initial layout of the image.

pub fn samples(&self) -> SampleCount

Returns the number of samples for the image.

pub fn tiling(&self) -> ImageTiling

Returns the tiling of the image.

pub fn usage(&self) -> &ImageUsage

Returns the usage the image was created with.

pub fn stencil_usage(&self) -> &ImageUsage

Returns the stencil usage the image was created with.

pub fn sharing(&self) -> &Sharing<SmallVec<[u32; 4]>>

Returns the sharing the image was created with.

pub fn external_memory_handle_types(&self) -> ExternalMemoryHandleTypes

Returns the external memory handle types that are supported with this image.

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

pub fn subresource_range(&self) -> ImageSubresourceRange

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

pub fn subresource_layout(
    &self,
    aspect: ImageAspect,
    mip_level: u32,
    array_layer: u32
) -> Result<SubresourceLayout, ImageError>

Queries the memory layout of a single subresource of the image.

Only images with linear tiling are supported, if they do not have a format with both a depth and a stencil format. Images with optimal tiling have an opaque image layout that is not suitable for direct memory accesses, and likewise for combined depth/stencil formats. Multi-planar formats are supported, but you must specify one of the planes as the aspect, not ImageAspect::Color.

The layout is invariant for each image. However it is not cached, as this would waste memory in the case of non-linear-tiling images. You are encouraged to store the layout somewhere in order to avoid calling this semi-expensive function at every single memory access.

Trait Implementations

impl Debug for Image

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

Formats the value using the given formatter.

impl DeviceOwned for Image

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

Returns the device that owns Self.

impl Hash for Image

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Image> for Image

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 VulkanObject for Image

type Handle = Image

The type of the object.

fn handle(&self) -> Self::Handle

Returns the raw Vulkan handle of the object.

impl Eq for Image