Struct CopyImageToBufferInfo

pub struct CopyImageToBufferInfo {
    pub src_image: Arc<Image>,
    pub src_image_layout: ImageLayout,
    pub dst_buffer: Subbuffer<[u8]>,
    pub regions: SmallVec<[BufferImageCopy; 1]>,
    pub _ne: NonExhaustive,
}

Parameters to copy data from an image to a buffer.

Fields

src_image: Arc<Image>

The image to copy from.

There is no default value.

src_image_layout: ImageLayout

The layout used for src_image during the copy operation.

The following layouts are allowed:

• ImageLayout::TransferSrcOptimal
• ImageLayout::General

The default value is ImageLayout::TransferSrcOptimal.

dst_buffer: Subbuffer<[u8]>

The buffer to copy to.

There is no default value.

regions: SmallVec<[BufferImageCopy; 1]>

The regions of the image and buffer to copy between.

The default value is a single region, covering all of the buffer and the first mip level of the image. All aspects of the image are selected, or plane0 if the image is multi-planar.

_ne: NonExhaustive

Implementations

impl CopyImageToBufferInfo

pub fn image_buffer( src_image: Arc<Image>, dst_buffer: Subbuffer<impl ?Sized>, ) -> Self

Returns a CopyImageToBufferInfo with the specified src_image and dst_buffer.

Trait Implementations

impl Clone for CopyImageToBufferInfo

fn clone(&self) -> CopyImageToBufferInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CopyImageToBufferInfo

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

Formats the value using the given formatter.