Struct vulkano::image::sys::UnsafeImage

pub struct UnsafeImage { /* fields omitted */ }

A storage for pixels or arbitrary data.

Safety

This type is not just unsafe but very unsafe. Don’t use it directly.

• You must manually bind memory to the image with bind_memory. The memory must respect the requirements returned by new.
• 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 unsafe fn new<'a, Mi, I>(
    device: Arc<Device>,
    usage: ImageUsage,
    format: Format,
    flags: ImageCreateFlags,
    dimensions: ImageDimensions,
    num_samples: SampleCount,
    mipmaps: Mi,
    sharing: Sharing<I>,
    linear_tiling: bool,
    preinitialized_layout: bool
) -> Result<(UnsafeImage, MemoryRequirements), ImageCreationError> where
    Mi: Into<MipmapsCount>,
    I: Iterator<Item = u32>, 

Creates a new image and allocates memory for it.

Panic

• Panics if one of the dimensions is 0.
• Panics if the number of mipmaps is 0.
• Panics if the number of samples is 0.

pub unsafe fn from_raw(
    device: Arc<Device>,
    handle: Image,
    usage: ImageUsage,
    format: Format,
    flags: ImageCreateFlags,
    dimensions: ImageDimensions,
    samples: SampleCount,
    mipmaps: u32
) -> UnsafeImage

Creates an image from a raw handle. The image won’t be destroyed.

This function is for example used at the swapchain’s initialization.

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

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

pub fn format(&self) -> Format

pub fn create_flags(&self) -> ImageCreateFlags

pub fn mipmap_levels(&self) -> u32

pub fn dimensions(&self) -> ImageDimensions

pub fn samples(&self) -> SampleCount

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.

pub fn flags(&self) -> ImageCreateFlags

Returns the flags the image was created with.

pub fn format_features(&self) -> FormatFeatures

Returns the features supported by the image’s format.

pub fn usage(&self) -> ImageUsage

Returns the usage the image was created with.

pub fn preinitialized_layout(&self) -> bool

Trait Implementations

impl Debug for UnsafeImage

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

Formats the value using the given formatter.

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