voodoo 0.3.1

An intuitive, idiomatic, unopinionated, zero-overhead Vulkan API
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

use std::sync::Arc;
use std::marker::PhantomData;
use vks;
use ::{VdResult, Device, Handle};


#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[repr(C)]
pub struct DescriptorSetLayoutHandle(pub(crate) vks::VkDescriptorSetLayout);

impl DescriptorSetLayoutHandle {
    #[inline(always)]
    pub fn to_raw(&self) -> vks::VkDescriptorSetLayout {
        self.0
    }
}

unsafe impl Handle for DescriptorSetLayoutHandle {
    type Target = DescriptorSetLayoutHandle;

    #[inline(always)]
    fn handle(&self) -> Self::Target {
        *self
    }
}


#[derive(Debug)]
struct Inner {
    handle: DescriptorSetLayoutHandle,
    device: Device,
}

impl Drop for Inner {
    fn drop(&mut self) {
        unsafe {
            self.device.destroy_descriptor_set_layout(self.handle, None);
        }
    }
}


/// A descriptor set layout.
///
///
/// ### Destruction
/// 
/// Dropping this `DescriptorSetLayout` will cause `Device::destroy_descriptor_set_layout` to be called, 
/// automatically releasing any resources associated with it.
///
#[derive(Debug, Clone)]
pub struct DescriptorSetLayout {
    inner: Arc<Inner>,
}

impl DescriptorSetLayout {
    /// Returns a new `DescriptorSetLayoutBuilder`.
    pub fn builder<'b>() -> DescriptorSetLayoutBuilder<'b> {
        DescriptorSetLayoutBuilder::new()
    }

    /// Returns this object's handle.
    pub fn handle(&self) -> DescriptorSetLayoutHandle {
        self.inner.handle
    }

    /// Returns a reference to the associated device.
    pub fn device(&self) -> &Device {
        &self.inner.device
    }
}

unsafe impl<'h> Handle for &'h DescriptorSetLayout {
    type Target = DescriptorSetLayoutHandle;

    #[inline(always)]
    fn handle(&self) -> Self::Target {
        self.inner.handle
    }
}


/// A builder for `DescriptorSetLayout`.
#[derive(Debug, Clone)]
pub struct DescriptorSetLayoutBuilder<'b> {
    create_info: ::DescriptorSetLayoutCreateInfo<'b>,
    _p: PhantomData<&'b ()>,
}

impl<'b> DescriptorSetLayoutBuilder<'b> {
    /// Returns a new render pass builder.
    pub fn new() -> DescriptorSetLayoutBuilder<'b> {
        DescriptorSetLayoutBuilder {
            create_info: ::DescriptorSetLayoutCreateInfo::default(),
            _p: PhantomData,
        }
    }

    /// Specifies options for descriptor set layout creation.
    pub fn flags<'s>(&'s mut self, flags: ::DescriptorSetLayoutCreateFlags)
            -> &'s mut DescriptorSetLayoutBuilder<'b> {
        self.create_info.set_flags(flags);
        self
    }

    /// Specifies a list of binding configuration structures.
    pub fn bindings<'s, 'p>(&'s mut self,
            bindings: &'p [::DescriptorSetLayoutBinding])
            -> &'s mut DescriptorSetLayoutBuilder<'b>
            where 'p: 'b {
        self.create_info.set_bindings(bindings);
        self
    }

    /// Creates and returns a new `DescriptorSetLayout`
    pub fn build(&self, device: Device) -> VdResult<DescriptorSetLayout> {
        let handle = unsafe { device.create_descriptor_set_layout(&self.create_info, None)? };

        Ok(DescriptorSetLayout {
            inner: Arc::new(Inner {
                handle,
                device,
            })
        })
    }

}