Struct vulkano::image::sys::UnsafeImage

pub struct UnsafeImage { /* private fields */ }

A storage for pixels or arbitrary data.

Safety

UnsafeImage is not unsafe to create, but it is unsafe to use:

• You must manually bind memory to the image with bind_memory. The memory must respect the requirements returned by memory_requirements.
• The memory that you bind to the image must be manually kept alive.
• The queue family ownership must be manually enforced.
• The usage must be manually enforced.
• The image layout must be manually enforced and transitioned.

Implementations

impl UnsafeImage

pub fn new(
    device: Arc<Device>,
    create_info: UnsafeImageCreateInfo
) -> Result<UnsafeImage, ImageCreationError>

Creates a new UnsafeImage.

Panics

• Panics if one of the values in create_info.dimensions is zero.
• Panics if create_info.format is None.
• Panics if create_info.block_texel_view_compatible is set but not create_info.mutable_format.
• Panics if create_info.mip_levels is 0.
• Panics if create_info.sharing is Sharing::Concurrent with less than 2 items.
• Panics if create_info.initial)layout is something other than ImageLayout::Undefined or ImageLayout::Preinitialized.
• Panics if create_info.usage is empty.
• Panics if create_info.usage contains transient_attachment, but does not also contain at least one of color_attachment, depth_stencil_attachment, input_attachment, or if it contains values other than these.

pub fn memory_requirements(&self) -> MemoryRequirements

Returns the memory requirements for this image.

pub unsafe fn bind_memory(
    &self,
    memory: &DeviceMemory,
    offset: DeviceSize
) -> Result<(), OomError>

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 mutable_format(&self) -> bool

Returns whether mutable_format is enabled on the image.

pub fn cube_compatible(&self) -> bool

Returns whether cube_compatible is enabled on the image.

pub fn array_2d_compatible(&self) -> bool

Returns whether array_2d_compatible is enabled on the image.

pub fn block_texel_view_compatible(&self) -> bool

Returns whether block_texel_view_compatible is enabled on the image.

pub fn key(&self) -> u64

Returns a key unique to each UnsafeImage. Can be used for the conflicts_key method.

pub unsafe fn color_linear_layout(&self, mip_level: u32) -> LinearLayout

Queries the layout of an image in memory. Only valid for images with linear tiling.

This function is only valid for images with a color format. See the other similar functions for the other aspects.

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.

Note that while Vulkan allows querying the array layers other than 0, it is redundant as you can easily calculate the position of any layer.

Panic

• Panics if the mipmap level is out of range.

Safety

• The image must not have a depth, stencil or depth-stencil format.
• The image must have been created with linear tiling.

pub unsafe fn depth_linear_layout(&self, mip_level: u32) -> LinearLayout

Same as color_linear_layout, except that it retrieves the depth component of the image.

Panic

• Panics if the mipmap level is out of range.

Safety

• The image must have a depth or depth-stencil format.
• The image must have been created with linear tiling.

pub unsafe fn stencil_linear_layout(&self, mip_level: u32) -> LinearLayout

Same as color_linear_layout, except that it retrieves the stencil component of the image.

Panic

• Panics if the mipmap level is out of range.

Safety

• The image must have a stencil or depth-stencil format.
• The image must have been created with linear tiling.

pub unsafe fn multiplane_color_layout(
    &self,
    aspect: ImageAspect
) -> LinearLayout

Same as color_linear_layout, except that it retrieves layout for the requested YCbCr component too if the format is a YCbCr format.

Panic

• Panics if plane aspect is out of range.
• Panics if the aspect is not a color or planar aspect.
• Panics if the number of mipmaps is not 1.

Trait Implementations

impl Debug for UnsafeImage

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

Formats the value using the given formatter.

impl DeviceOwned for UnsafeImage

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

Returns the device that owns Self.

impl Drop for UnsafeImage

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for UnsafeImage

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 PartialEq<UnsafeImage> for UnsafeImage

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

type Object = Image

The type of the object.

fn internal_object(&self) -> Image

Returns a reference to the object.

impl Eq for UnsafeImage