Struct vulkano::image::sys::UnsafeImage

source · [−]

pub struct UnsafeImage { /* private fields */ }

Expand description

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

source

impl UnsafeImage

source

pub fn new(
device: Arc<Device>,
create_info: UnsafeImageCreateInfo
) -> Result<Arc<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.

source

pub unsafe fn from_handle(
 device: Arc<Device>,
 handle: Image,
 create_info: UnsafeImageCreateInfo
) -> Arc<Self>

Creates a new UnsafeImage from a raw object handle.

Safety

handle must be a valid Vulkan object handle created from device.
create_info must match the info used to create the object.

source

pub fn memory_requirements(&self) -> MemoryRequirements

Returns the memory requirements for this image.

source

pub fn sparse_memory_requirements(&self) -> Vec<SparseImageMemoryRequirements>

Returns the sparse memory requirements for this image.

source

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

source

pub fn dimensions(&self) -> ImageDimensions

Returns the dimensions of the image.

source

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

Returns the image’s format.

source

pub fn format_features(&self) -> &FormatFeatures

Returns the features supported by the image’s format.

source

pub fn mip_levels(&self) -> u32

Returns the number of mipmap levels in the image.

source

pub fn initial_layout(&self) -> ImageLayout

Returns the initial layout of the image.

source

pub fn samples(&self) -> SampleCount

Returns the number of samples for the image.

source

pub fn tiling(&self) -> ImageTiling

Returns the tiling of the image.

source

pub fn usage(&self) -> &ImageUsage

Returns the usage the image was created with.

source

pub fn stencil_usage(&self) -> &ImageUsage

Returns the stencil usage the image was created with.

source

pub fn external_memory_handle_types(&self) -> ExternalMemoryHandleTypes

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

source

pub fn mutable_format(&self) -> bool

Returns whether mutable_format is enabled on the image.

source

pub fn cube_compatible(&self) -> bool

Returns whether cube_compatible is enabled on the image.

source

pub fn array_2d_compatible(&self) -> bool

Returns whether array_2d_compatible is enabled on the image.

source

pub fn block_texel_view_compatible(&self) -> bool

Returns whether block_texel_view_compatible is enabled on the image.

source

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.

source

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.

source

pub fn key(&self) -> u64

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

source

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.