lava 0.4.9

Rust wrapper to manipulate Vulkan more conveniently than with bindings.
Documentation 
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

// Generated by `scripts/generate.js`

use utils::vk_traits::*;

/// Wrapper for [VkImageAspectFlags](https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VkImageAspectFlags.html).
///
/// Use the macro `VkImageAspectFlags!` as an alternative method to create a structure. For example, these two snippets return the same value:
/// ```
/// VkImageAspectFlags!(color, depth)
/// ```
/// ```
/// VkImageAspectFlags {
///     color: true,
///     depth: true,
///     ..VkImageAspectFlags::none()
/// }
/// ```
#[derive(Debug, Clone)]
pub struct VkImageAspectFlags {
    pub color: bool,
    pub depth: bool,
    pub stencil: bool,
    pub metadata: bool,
    pub plane_0: bool,
    pub plane_1: bool,
    pub plane_2: bool,
    pub memory_plane_0_ext: bool,
    pub memory_plane_1_ext: bool,
    pub memory_plane_2_ext: bool,
    pub memory_plane_3_ext: bool,
}

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

impl VkWrappedType<RawVkImageAspectFlags> for VkImageAspectFlags {
    fn vk_to_raw(src: &VkImageAspectFlags, dst: &mut RawVkImageAspectFlags) {
        *dst = 0;
        if src.color { *dst |= 0x00000001; }
        if src.depth { *dst |= 0x00000002; }
        if src.stencil { *dst |= 0x00000004; }
        if src.metadata { *dst |= 0x00000008; }
        if src.plane_0 { *dst |= 0x00000010; }
        if src.plane_1 { *dst |= 0x00000020; }
        if src.plane_2 { *dst |= 0x00000040; }
        if src.memory_plane_0_ext { *dst |= 0x00000080; }
        if src.memory_plane_1_ext { *dst |= 0x00000100; }
        if src.memory_plane_2_ext { *dst |= 0x00000200; }
        if src.memory_plane_3_ext { *dst |= 0x00000400; }
    }
}

impl VkRawType<VkImageAspectFlags> for RawVkImageAspectFlags {
    fn vk_to_wrapped(src: &RawVkImageAspectFlags) -> VkImageAspectFlags {
        VkImageAspectFlags {
            color: (src & 0x00000001) != 0,
            depth: (src & 0x00000002) != 0,
            stencil: (src & 0x00000004) != 0,
            metadata: (src & 0x00000008) != 0,
            plane_0: (src & 0x00000010) != 0,
            plane_1: (src & 0x00000020) != 0,
            plane_2: (src & 0x00000040) != 0,
            memory_plane_0_ext: (src & 0x00000080) != 0,
            memory_plane_1_ext: (src & 0x00000100) != 0,
            memory_plane_2_ext: (src & 0x00000200) != 0,
            memory_plane_3_ext: (src & 0x00000400) != 0,
        }
    }
}

impl Default for VkImageAspectFlags {
    fn default() -> VkImageAspectFlags {
        VkImageAspectFlags {
            color: false,
            depth: false,
            stencil: false,
            metadata: false,
            plane_0: false,
            plane_1: false,
            plane_2: false,
            memory_plane_0_ext: false,
            memory_plane_1_ext: false,
            memory_plane_2_ext: false,
            memory_plane_3_ext: false,
        }
    }
}

impl VkImageAspectFlags {
    
    /// Return a structure with all flags to `false`.
    pub fn none() -> Self {
        VkImageAspectFlags {
            color: false,
            depth: false,
            stencil: false,
            metadata: false,
            plane_0: false,
            plane_1: false,
            plane_2: false,
            memory_plane_0_ext: false,
            memory_plane_1_ext: false,
            memory_plane_2_ext: false,
            memory_plane_3_ext: false,
        }
    }
    
    /// Return a structure with all flags to `true`.
    pub fn all() -> Self {
        VkImageAspectFlags {
            color: true,
            depth: true,
            stencil: true,
            metadata: true,
            plane_0: true,
            plane_1: true,
            plane_2: true,
            memory_plane_0_ext: true,
            memory_plane_1_ext: true,
            memory_plane_2_ext: true,
            memory_plane_3_ext: 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.color { 0x00000001 } else { 0 }
        + if self.depth { 0x00000002 } else { 0 }
        + if self.stencil { 0x00000004 } else { 0 }
        + if self.metadata { 0x00000008 } else { 0 }
        + if self.plane_0 { 0x00000010 } else { 0 }
        + if self.plane_1 { 0x00000020 } else { 0 }
        + if self.plane_2 { 0x00000040 } else { 0 }
        + if self.memory_plane_0_ext { 0x00000080 } else { 0 }
        + if self.memory_plane_1_ext { 0x00000100 } else { 0 }
        + if self.memory_plane_2_ext { 0x00000200 } else { 0 }
        + if self.memory_plane_3_ext { 0x00000400 } else { 0 }
    }
    
    /// Create a structure corresponding to the specified numerical bit flags.
    pub fn from_u32(value: u32) -> Self {
        VkImageAspectFlags {
            color: value & 0x00000001 > 0,
            depth: value & 0x00000002 > 0,
            stencil: value & 0x00000004 > 0,
            metadata: value & 0x00000008 > 0,
            plane_0: value & 0x00000010 > 0,
            plane_1: value & 0x00000020 > 0,
            plane_2: value & 0x00000040 > 0,
            memory_plane_0_ext: value & 0x00000080 > 0,
            memory_plane_1_ext: value & 0x00000100 > 0,
            memory_plane_2_ext: value & 0x00000200 > 0,
            memory_plane_3_ext: value & 0x00000400 > 0,
        }
    }
}

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