Enum vulkano::image::ImageLayout[−][src]

#[repr(u32)]
pub enum ImageLayout {
    Undefined,
    General,
    ColorAttachmentOptimal,
    DepthStencilAttachmentOptimal,
    DepthStencilReadOnlyOptimal,
    ShaderReadOnlyOptimal,
    TransferSrcOptimal,
    TransferDstOptimal,
    Preinitialized,
    PresentSrc,
}

Layout of an image.

Note: In vulkano, image layouts are mostly a low-level detail. You can ignore them, unless you use an unsafe function that states in its documentation that you must take care of an image’s layout.

In the Vulkan API, each mipmap level of each array layer is in one of the layouts of this enum.

Unless you use some sort of high-level shortcut function, an image always starts in either the Undefined or the Preinitialized layout. Before you can use an image for a given purpose, you must ensure that the image in question is in the layout required for that purpose. For example if you want to write data to an image, you must first transition the image to the TransferDstOptimal layout. The General layout can also be used as a general-purpose fit-all layout, but using it will result in slower operations.

Transitioning between layouts can only be done through a GPU-side operation that is part of a command buffer.

Variants

Undefined
General
ColorAttachmentOptimal
DepthStencilAttachmentOptimal
DepthStencilReadOnlyOptimal
ShaderReadOnlyOptimal
TransferSrcOptimal
TransferDstOptimal
Preinitialized
PresentSrc

Trait Implementations

impl Clone for ImageLayout[src]

fn clone(&self) -> ImageLayout[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for ImageLayout[src]

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

Formats the value using the given formatter. Read more

impl PartialEq<ImageLayout> for ImageLayout[src]

fn eq(&self, other: &ImageLayout) -> bool[src]

This method tests for self and other values to be equal, and is used by ==. Read more

#[must_use]
fn ne(&self, other: &Rhs) -> bool1.0.0[src]

This method tests for !=.

impl Copy for ImageLayout[src]

impl Eq for ImageLayout[src]

impl StructuralEq for ImageLayout[src]

impl StructuralPartialEq for ImageLayout[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> Content for T[src]

pub fn ref_from_ptr(*mut c_void, usize) -> Option<*mut T>[src]

Builds a pointer to this type from a raw pointer.

pub fn is_size_suitable(usize) -> bool[src]

Returns true if the size is suitable to store a type like this.

pub fn indiv_size() -> usize[src]

Returns the size of an individual element.

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.