Enum vulkano::format::Format[][src]

#[repr(u32)]
pub enum Format {
Show variants R4G4UnormPack8, R4G4B4A4UnormPack16, B4G4R4A4UnormPack16, R5G6B5UnormPack16, B5G6R5UnormPack16, R5G5B5A1UnormPack16, B5G5R5A1UnormPack16, A1R5G5B5UnormPack16, R8Unorm, R8Snorm, R8Uscaled, R8Sscaled, R8Uint, R8Sint, R8Srgb, R8G8Unorm, R8G8Snorm, R8G8Uscaled, R8G8Sscaled, R8G8Uint, R8G8Sint, R8G8Srgb, R8G8B8Unorm, R8G8B8Snorm, R8G8B8Uscaled, R8G8B8Sscaled, R8G8B8Uint, R8G8B8Sint, R8G8B8Srgb, B8G8R8Unorm, B8G8R8Snorm, B8G8R8Uscaled, B8G8R8Sscaled, B8G8R8Uint, B8G8R8Sint, B8G8R8Srgb, R8G8B8A8Unorm, R8G8B8A8Snorm, R8G8B8A8Uscaled, R8G8B8A8Sscaled, R8G8B8A8Uint, R8G8B8A8Sint, R8G8B8A8Srgb, B8G8R8A8Unorm, B8G8R8A8Snorm, B8G8R8A8Uscaled, B8G8R8A8Sscaled, B8G8R8A8Uint, B8G8R8A8Sint, B8G8R8A8Srgb, A8B8G8R8UnormPack32, A8B8G8R8SnormPack32, A8B8G8R8UscaledPack32, A8B8G8R8SscaledPack32, A8B8G8R8UintPack32, A8B8G8R8SintPack32, A8B8G8R8SrgbPack32, A2R10G10B10UnormPack32, A2R10G10B10SnormPack32, A2R10G10B10UscaledPack32, A2R10G10B10SscaledPack32, A2R10G10B10UintPack32, A2R10G10B10SintPack32, A2B10G10R10UnormPack32, A2B10G10R10SnormPack32, A2B10G10R10UscaledPack32, A2B10G10R10SscaledPack32, A2B10G10R10UintPack32, A2B10G10R10SintPack32, R16Unorm, R16Snorm, R16Uscaled, R16Sscaled, R16Uint, R16Sint, R16Sfloat, R16G16Unorm, R16G16Snorm, R16G16Uscaled, R16G16Sscaled, R16G16Uint, R16G16Sint, R16G16Sfloat, R16G16B16Unorm, R16G16B16Snorm, R16G16B16Uscaled, R16G16B16Sscaled, R16G16B16Uint, R16G16B16Sint, R16G16B16Sfloat, R16G16B16A16Unorm, R16G16B16A16Snorm, R16G16B16A16Uscaled, R16G16B16A16Sscaled, R16G16B16A16Uint, R16G16B16A16Sint, R16G16B16A16Sfloat, R32Uint, R32Sint, R32Sfloat, R32G32Uint, R32G32Sint, R32G32Sfloat, R32G32B32Uint, R32G32B32Sint, R32G32B32Sfloat, R32G32B32A32Uint, R32G32B32A32Sint, R32G32B32A32Sfloat, R64Uint, R64Sint, R64Sfloat, R64G64Uint, R64G64Sint, R64G64Sfloat, R64G64B64Uint, R64G64B64Sint, R64G64B64Sfloat, R64G64B64A64Uint, R64G64B64A64Sint, R64G64B64A64Sfloat, B10G11R11UfloatPack32, E5B9G9R9UfloatPack32, D16Unorm, X8_D24UnormPack32, D32Sfloat, S8Uint, D16Unorm_S8Uint, D24Unorm_S8Uint, D32Sfloat_S8Uint, BC1_RGBUnormBlock, BC1_RGBSrgbBlock, BC1_RGBAUnormBlock, BC1_RGBASrgbBlock, BC2UnormBlock, BC2SrgbBlock, BC3UnormBlock, BC3SrgbBlock, BC4UnormBlock, BC4SnormBlock, BC5UnormBlock, BC5SnormBlock, BC6HUfloatBlock, BC6HSfloatBlock, BC7UnormBlock, BC7SrgbBlock, ETC2_R8G8B8UnormBlock, ETC2_R8G8B8SrgbBlock, ETC2_R8G8B8A1UnormBlock, ETC2_R8G8B8A1SrgbBlock, ETC2_R8G8B8A8UnormBlock, ETC2_R8G8B8A8SrgbBlock, EAC_R11UnormBlock, EAC_R11SnormBlock, EAC_R11G11UnormBlock, EAC_R11G11SnormBlock, ASTC_4x4UnormBlock, ASTC_4x4SrgbBlock, ASTC_5x4UnormBlock, ASTC_5x4SrgbBlock, ASTC_5x5UnormBlock, ASTC_5x5SrgbBlock, ASTC_6x5UnormBlock, ASTC_6x5SrgbBlock, ASTC_6x6UnormBlock, ASTC_6x6SrgbBlock, ASTC_8x5UnormBlock, ASTC_8x5SrgbBlock, ASTC_8x6UnormBlock, ASTC_8x6SrgbBlock, ASTC_8x8UnormBlock, ASTC_8x8SrgbBlock, ASTC_10x5UnormBlock, ASTC_10x5SrgbBlock, ASTC_10x6UnormBlock, ASTC_10x6SrgbBlock, ASTC_10x8UnormBlock, ASTC_10x8SrgbBlock, ASTC_10x10UnormBlock, ASTC_10x10SrgbBlock, ASTC_12x10UnormBlock, ASTC_12x10SrgbBlock, ASTC_12x12UnormBlock, ASTC_12x12SrgbBlock, G8B8R8_3PLANE420Unorm, G8B8R8_2PLANE420Unorm,
}

An enumeration of all the possible formats.

Variants

R4G4UnormPack8
R4G4B4A4UnormPack16
B4G4R4A4UnormPack16
R5G6B5UnormPack16
B5G6R5UnormPack16
R5G5B5A1UnormPack16
B5G5R5A1UnormPack16
A1R5G5B5UnormPack16
R8Unorm
R8Snorm
R8Uscaled
R8Sscaled
R8Uint
R8Sint
R8Srgb
R8G8Unorm
R8G8Snorm
R8G8Uscaled
R8G8Sscaled
R8G8Uint
R8G8Sint
R8G8Srgb
R8G8B8Unorm
R8G8B8Snorm
R8G8B8Uscaled
R8G8B8Sscaled
R8G8B8Uint
R8G8B8Sint
R8G8B8Srgb
B8G8R8Unorm
B8G8R8Snorm
B8G8R8Uscaled
B8G8R8Sscaled
B8G8R8Uint
B8G8R8Sint
B8G8R8Srgb
R8G8B8A8Unorm
R8G8B8A8Snorm
R8G8B8A8Uscaled
R8G8B8A8Sscaled
R8G8B8A8Uint
R8G8B8A8Sint
R8G8B8A8Srgb
B8G8R8A8Unorm
B8G8R8A8Snorm
B8G8R8A8Uscaled
B8G8R8A8Sscaled
B8G8R8A8Uint
B8G8R8A8Sint
B8G8R8A8Srgb
A8B8G8R8UnormPack32
A8B8G8R8SnormPack32
A8B8G8R8UscaledPack32
A8B8G8R8SscaledPack32
A8B8G8R8UintPack32
A8B8G8R8SintPack32
A8B8G8R8SrgbPack32
A2R10G10B10UnormPack32
A2R10G10B10SnormPack32
A2R10G10B10UscaledPack32
A2R10G10B10SscaledPack32
A2R10G10B10UintPack32
A2R10G10B10SintPack32
A2B10G10R10UnormPack32
A2B10G10R10SnormPack32
A2B10G10R10UscaledPack32
A2B10G10R10SscaledPack32
A2B10G10R10UintPack32
A2B10G10R10SintPack32
R16Unorm
R16Snorm
R16Uscaled
R16Sscaled
R16Uint
R16Sint
R16Sfloat
R16G16Unorm
R16G16Snorm
R16G16Uscaled
R16G16Sscaled
R16G16Uint
R16G16Sint
R16G16Sfloat
R16G16B16Unorm
R16G16B16Snorm
R16G16B16Uscaled
R16G16B16Sscaled
R16G16B16Uint
R16G16B16Sint
R16G16B16Sfloat
R16G16B16A16Unorm
R16G16B16A16Snorm
R16G16B16A16Uscaled
R16G16B16A16Sscaled
R16G16B16A16Uint
R16G16B16A16Sint
R16G16B16A16Sfloat
R32Uint
R32Sint
R32Sfloat
R32G32Uint
R32G32Sint
R32G32Sfloat
R32G32B32Uint
R32G32B32Sint
R32G32B32Sfloat
R32G32B32A32Uint
R32G32B32A32Sint
R32G32B32A32Sfloat
R64Uint
R64Sint
R64Sfloat
R64G64Uint
R64G64Sint
R64G64Sfloat
R64G64B64Uint
R64G64B64Sint
R64G64B64Sfloat
R64G64B64A64Uint
R64G64B64A64Sint
R64G64B64A64Sfloat
B10G11R11UfloatPack32
E5B9G9R9UfloatPack32
D16Unorm
X8_D24UnormPack32
D32Sfloat
S8Uint
D16Unorm_S8Uint
D24Unorm_S8Uint
D32Sfloat_S8Uint
BC1_RGBUnormBlock
BC1_RGBSrgbBlock
BC1_RGBAUnormBlock
BC1_RGBASrgbBlock
BC2UnormBlock
BC2SrgbBlock
BC3UnormBlock
BC3SrgbBlock
BC4UnormBlock
BC4SnormBlock
BC5UnormBlock
BC5SnormBlock
BC6HUfloatBlock
BC6HSfloatBlock
BC7UnormBlock
BC7SrgbBlock
ETC2_R8G8B8UnormBlock
ETC2_R8G8B8SrgbBlock
ETC2_R8G8B8A1UnormBlock
ETC2_R8G8B8A1SrgbBlock
ETC2_R8G8B8A8UnormBlock
ETC2_R8G8B8A8SrgbBlock
EAC_R11UnormBlock
EAC_R11SnormBlock
EAC_R11G11UnormBlock
EAC_R11G11SnormBlock
ASTC_4x4UnormBlock
ASTC_4x4SrgbBlock
ASTC_5x4UnormBlock
ASTC_5x4SrgbBlock
ASTC_5x5UnormBlock
ASTC_5x5SrgbBlock
ASTC_6x5UnormBlock
ASTC_6x5SrgbBlock
ASTC_6x6UnormBlock
ASTC_6x6SrgbBlock
ASTC_8x5UnormBlock
ASTC_8x5SrgbBlock
ASTC_8x6UnormBlock
ASTC_8x6SrgbBlock
ASTC_8x8UnormBlock
ASTC_8x8SrgbBlock
ASTC_10x5UnormBlock
ASTC_10x5SrgbBlock
ASTC_10x6UnormBlock
ASTC_10x6SrgbBlock
ASTC_10x8UnormBlock
ASTC_10x8SrgbBlock
ASTC_10x10UnormBlock
ASTC_10x10SrgbBlock
ASTC_12x10UnormBlock
ASTC_12x10SrgbBlock
ASTC_12x12UnormBlock
ASTC_12x12SrgbBlock
G8B8R8_3PLANE420Unorm
G8B8R8_2PLANE420Unorm

Implementations

impl Format[src]

pub const fn size(&self) -> Option<usize>[src]

Returns the size in bytes of an element of this format. For block based formats this will be the size of a single block. Returns None if the size is irrelevant.

pub const fn block_dimensions(&self) -> (u32, u32)[src]

Returns (width, height) of the dimensions for block based formats. For non block formats will return (1,1)

pub const fn ty(&self) -> FormatTy[src]

Returns the data type of the format.

pub const fn planes(&self) -> u8[src]

Returns the number of planes that images of this format have.

Returns 0 if the format is not multi-planar.

impl Format[src]

pub const fn aspects(&self) -> ImageAspects[src]

Returns the aspects that images of this format have.

pub fn properties(
    &self,
    physical_device: PhysicalDevice<'_>
) -> FormatProperties
[src]

Retrieves the properties of a format when used by a certain device.

pub fn decode_clear_value(&self, value: ClearValue) -> ClearValue[src]

Trait Implementations

impl Clone for Format[src]

fn clone(&self) -> Format[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 Format[src]

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

Formats the value using the given formatter. Read more

impl Hash for Format[src]

fn hash<__H: Hasher>(&self, state: &mut __H)[src]

Feeds this value into the given Hasher. Read more

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher
1.3.0[src]

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq<Format> for Format[src]

fn eq(&self, other: &Format) -> 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) -> bool
1.0.0[src]

This method tests for !=.

impl TryFrom<u32> for Format[src]

type Error = ()

The type returned in the event of a conversion error.

fn try_from(val: Format) -> Result<Format, ()>[src]

Performs the conversion.

impl Copy for Format[src]

impl Eq for Format[src]

impl StructuralEq for Format[src]

impl StructuralPartialEq for Format[src]

Auto Trait Implementations

impl RefUnwindSafe for Format

impl Send for Format

impl Sync for Format

impl Unpin for Format

impl UnwindSafe for Format

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.