1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104

// Generated by `scripts/generate.js`

use utils::vk_traits::*;

/// Wrapper for [VkSparseImageFormatFlags](https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VkSparseImageFormatFlags.html).
///
/// Use the macro `VkSparseImageFormatFlags!` as an alternative method to create a structure. For example, these two snippets return the same value:
/// ```
/// VkSparseImageFormatFlags!(single_miptail, aligned_mip_size)
/// ```
/// ```
/// VkSparseImageFormatFlags {
///     single_miptail: true,
///     aligned_mip_size: true,
///     ..VkSparseImageFormatFlags::none()
/// }
/// ```
#[derive(Debug, Clone)]
pub struct VkSparseImageFormatFlags {
    pub single_miptail: bool,
    pub aligned_mip_size: bool,
    pub nonstandard_block_size: bool,
}

#[doc(hidden)]
pub type RawVkSparseImageFormatFlags = u32;

impl VkWrappedType<RawVkSparseImageFormatFlags> for VkSparseImageFormatFlags {
    fn vk_to_raw(src: &VkSparseImageFormatFlags, dst: &mut RawVkSparseImageFormatFlags) {
        *dst = 0;
        if src.single_miptail { *dst |= 0x00000001; }
        if src.aligned_mip_size { *dst |= 0x00000002; }
        if src.nonstandard_block_size { *dst |= 0x00000004; }
    }
}

impl VkRawType<VkSparseImageFormatFlags> for RawVkSparseImageFormatFlags {
    fn vk_to_wrapped(src: &RawVkSparseImageFormatFlags) -> VkSparseImageFormatFlags {
        VkSparseImageFormatFlags {
            single_miptail: (src & 0x00000001) != 0,
            aligned_mip_size: (src & 0x00000002) != 0,
            nonstandard_block_size: (src & 0x00000004) != 0,
        }
    }
}

impl Default for VkSparseImageFormatFlags {
    fn default() -> VkSparseImageFormatFlags {
        VkSparseImageFormatFlags {
            single_miptail: false,
            aligned_mip_size: false,
            nonstandard_block_size: false,
        }
    }
}

impl VkSparseImageFormatFlags {
    
    /// Return a structure with all flags to `false`.
    pub fn none() -> Self {
        VkSparseImageFormatFlags {
            single_miptail: false,
            aligned_mip_size: false,
            nonstandard_block_size: false,
        }
    }
    
    /// Return a structure with all flags to `true`.
    pub fn all() -> Self {
        VkSparseImageFormatFlags {
            single_miptail: true,
            aligned_mip_size: true,
            nonstandard_block_size: true,
        }
    }
    
    /// Return the numerical bit flags corresponding to the structure (as described in the Vulkan specs).
    pub fn to_u32(&self) -> u32 {
        0
        + if self.single_miptail { 0x00000001 } else { 0 }
        + if self.aligned_mip_size { 0x00000002 } else { 0 }
        + if self.nonstandard_block_size { 0x00000004 } else { 0 }
    }
    
    /// Create a structure corresponding to the specified numerical bit flags.
    pub fn from_u32(value: u32) -> Self {
        VkSparseImageFormatFlags {
            single_miptail: value & 0x00000001 > 0,
            aligned_mip_size: value & 0x00000002 > 0,
            nonstandard_block_size: value & 0x00000004 > 0,
        }
    }
}

#[doc(hidden)]
#[macro_export]
macro_rules! VkSparseImageFormatFlags {
    ( $( $x:ident ),* ) => {
        VkSparseImageFormatFlags {
            $($x: true,)*
            ..VkSparseImageFormatFlags::none()
        }
    }
}