Struct vulkano::command_buffer::ClearColorImageInfo

pub struct ClearColorImageInfo {
    pub image: Arc<dyn ImageAccess>,
    pub image_layout: ImageLayout,
    pub clear_value: ClearColorValue,
    pub regions: SmallVec<[ImageSubresourceRange; 1]>,
    pub _ne: NonExhaustive,
}

Parameters to clear a color image.

Fields

image: Arc<dyn ImageAccess>

The image to clear.

There is no default value.

image_layout: ImageLayout

The layout used for image during the clear operation.

The following layouts are allowed:

• ImageLayout::TransferDstOptimal
• ImageLayout::General

The default value is ImageLayout::TransferDstOptimal.

clear_value: ClearColorValue

The color value to clear the image to.

The default value is ClearColorValue::Float([0.0; 4]).

regions: SmallVec<[ImageSubresourceRange; 1]>

The subresource ranges of image to clear.

The default value is a single region, covering the whole image.

_ne: NonExhaustive

Implementations

impl ClearColorImageInfo

pub fn image(image: Arc<dyn ImageAccess>) -> Self

Returns a ClearColorImageInfo with the specified image.

Trait Implementations

impl Clone for ClearColorImageInfo

fn clone(&self) -> ClearColorImageInfo

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClearColorImageInfo

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

Formats the value using the given formatter.