mev 0.1.0

Metal Et Vulkan abstraction
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

use crate::generic::{ArgumentGroupLayout, ArgumentKind, ArgumentsSealed};

use super::{
    command::{ComputeCommandEncoder, RenderCommandEncoder},
    refs::Refs,
};

#[doc(hidden)]
pub trait Arguments: 'static {
    const LAYOUT: ArgumentGroupLayout<'static>;

    /// Descriptor updates matching template created from this type.
    type Update: Copy;

    /// Create a descriptor update template for this type.
    /// The result must not depend on the value.
    fn template_entries() -> &'static [ash::vk::DescriptorUpdateTemplateEntry];

    /// Fill descriptor update template with the value.
    fn update(&self) -> Self::Update;

    /// Add references to descriptors into the `Refs` object.
    fn add_refs(&self, refs: &mut Refs);
}

impl<T> ArgumentsSealed for T where T: Arguments {}
impl<T> crate::generic::Arguments for T
where
    T: Arguments,
{
    const LAYOUT: ArgumentGroupLayout<'static> = T::LAYOUT;

    #[inline]
    fn bind_render(&self, group: u32, encoder: &mut RenderCommandEncoder) {
        let Some(layout) = encoder.current_layout() else {
            panic!("Argument binding requires a pipeline to be bound to the encoder");
        };

        let device = encoder.device();

        if device.get_error().is_err() {
            return;
        }

        let Ok(template) = device.get_descriptor_update_template::<Self>(
            Self::template_entries(),
            ash::vk::PipelineBindPoint::GRAPHICS,
            layout,
            group,
        ) else {
            device.set_oom();
            return;
        };

        let update = self.update();

        unsafe {
            device
                .push_descriptor()
                .cmd_push_descriptor_set_with_template(
                    encoder.handle(),
                    template,
                    layout.handle(),
                    group,
                    &update as *const _ as *const _,
                )
        }

        self.add_refs(encoder.refs_mut());
    }

    #[inline]
    fn bind_compute(&self, group: u32, encoder: &mut ComputeCommandEncoder) {
        let Some(layout) = encoder.current_layout() else {
            panic!("Argument binding requires a pipeline to be bound to the encoder");
        };

        let device = encoder.device();

        if device.get_error().is_err() {
            return;
        }

        let Ok(template) = device.get_descriptor_update_template::<Self>(
            Self::template_entries(),
            ash::vk::PipelineBindPoint::COMPUTE,
            layout,
            group,
        ) else {
            device.set_oom();
            return;
        };

        let update = self.update();

        unsafe {
            device
                .push_descriptor()
                .cmd_push_descriptor_set_with_template(
                    encoder.handle(),
                    template,
                    layout.handle(),
                    group,
                    &update as *const _ as *const _,
                )
        }

        self.add_refs(encoder.refs_mut());
    }
}

#[doc(hidden)]
pub trait ArgumentsField<T>: 'static {
    const KIND: ArgumentKind;
    const SIZE: usize;
    const OFFSET: usize;
    const STRIDE: usize;

    type Update: Copy;

    fn update(&self) -> Self::Update;

    /// Add references to descriptors into the `Refs` object.
    fn add_refs(&self, refs: &mut Refs);
}

impl<T, F> crate::generic::ArgumentsField<T> for F
where
    T: ArgumentsSealed,
    F: ArgumentsField<T> + ArgumentsSealed,
{
    const KIND: ArgumentKind = F::KIND;
    const SIZE: usize = F::SIZE;
}

#[doc(hidden)]
pub const fn descriptor_type(kind: ArgumentKind) -> ash::vk::DescriptorType {
    match kind {
        // ArgumentKind::Constant => ash::vk::DescriptorType::INLINE_UNIFORM_BLOCK,
        ArgumentKind::Sampler => ash::vk::DescriptorType::SAMPLER,
        ArgumentKind::UniformBuffer => ash::vk::DescriptorType::UNIFORM_BUFFER,
        ArgumentKind::StorageBuffer => ash::vk::DescriptorType::STORAGE_BUFFER,
        ArgumentKind::SampledImage => ash::vk::DescriptorType::SAMPLED_IMAGE,
        ArgumentKind::StorageImage => ash::vk::DescriptorType::STORAGE_IMAGE,
    }
}