Struct vulkano::image::sys::UnsafeImageBuilder

pub struct UnsafeImageBuilder { /* private fields */ }

Used to construct a new UnsafeImage.

Implementations

impl UnsafeImageBuilder

pub fn build(self) -> Result<UnsafeImage, ImageCreationError>

Creates the UnsafeImage.

Panics

• Panics if no dimensions were specified.
• Panics if no format was specified.
• Panics if no usage was specified.

pub fn dimensions(self, dimensions: ImageDimensions) -> Self

The type, extent and number of array layers to create the image with.

There is no default value, this value must be provided.

Panics

• Panics if one of the dimensions is zero.
• Panics if the number of array layers is zero.

pub fn external_memory_handle_types(
    self,
    handle_types: ExternalMemoryHandleTypes
) -> Self

The external memory handle types that are going to be used with the image.

If any of the fields in this value are set, the device must either support API version 1.1 or the khr_external_memory extension must be enabled, and initial_layout must be set to Undefined.

The default value is ExternalMemoryHandleTypes::none().

pub fn flags(self, flags: ImageCreateFlags) -> Self

Miscellaneous properties of the image.

The default value is ImageCreateFlags::none().

Panics

• Panics if flags contains block_texel_view_compatible but not mutable_format.

pub fn format(self, format: Format) -> Self

The format used to store the image data.

There is no default value, this value must be provided.

pub fn initial_layout(self, layout: ImageLayout) -> Self

The image layout that the image will have when it is created.

The default value is Undefined.

Panics

• Panics if layout is something other than Undefined or Preinitialized.

pub fn mip_levels<M>(self, mip_levels: M) -> Self where
    M: Into<MipmapsCount>, 

The number of mip levels to create the image with.

The default value is 1.

Panics

• Panics if mip_levels is Specific(0).

pub fn samples(self, samples: SampleCount) -> Self

The number of samples per texel that the image should use.

The default value is Sample1.

pub fn sharing<I>(self, sharing: Sharing<I>) -> Self where
    I: IntoIterator<Item = u32>, 

Whether the image can be shared across multiple queues, or is limited to a single queue.

The default value is Exclusive.

Panics

• Panics if sharing is Concurrent with less than 2 items.

pub fn tiling(self, tiling: ImageTiling) -> Self

The memory arrangement of the texel blocks.

The default value is Optimal.

pub fn usage(self, usage: ImageUsage) -> Self

How the image is going to be used.

There is no default value, this value must be provided.

Panics

• Panics if usage has no bits set.
• Panics if usage.transient_attachment is set, and usage does contain at least one of color_attachment, depth_stencil_attachment, input_attachment, or contains set flags other than these.