vka 0.0.4

A minimal vulkan wrapper
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

use std::ops::Deref;
use std::sync::Arc;

use ash::vk;

use crate::RenderingDevice;
use crate::SharedDevice;
use crate::next_resource_id;

#[derive(Clone)]
#[repr(transparent)]
pub struct Sampler(Arc<SamplerImpl>);

pub struct SamplerImpl {
    pub raw: vk::Sampler,
    pub id: u64,
    device: Arc<SharedDevice>,
}

impl Deref for Sampler {
    type Target = Arc<SamplerImpl>;
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl Drop for SamplerImpl {
    fn drop(&mut self) {
        unsafe {
            self.device.raw.destroy_sampler(self.raw, None);
        }
    }
}

impl RenderingDevice {
    pub fn new_sampler(&self, desc: &vk::SamplerCreateInfo) -> Sampler {
        let raw = unsafe { self.raw.create_sampler(desc, None).expect("Failed to create sampler") };
        let id = next_resource_id();
        Sampler(Arc::new(SamplerImpl { raw, id, device: self.shared.clone() }))
    }

    /// Creates a Sampler with nearest filtering for both min and mag.
    pub fn new_sampler_nearest(&self, wrap_mode: vk::SamplerAddressMode) -> Sampler {
        self.new_sampler(
            &vk::SamplerCreateInfo::default()
                .mag_filter(vk::Filter::NEAREST)
                .min_filter(vk::Filter::NEAREST)
                .mipmap_mode(vk::SamplerMipmapMode::LINEAR)
                .address_mode_u(wrap_mode)
                .address_mode_v(wrap_mode)
                .address_mode_w(wrap_mode),
        )
    }

    /// Creates a Sampler with nearest mag and linear min filtering.
    pub fn new_sampler_nearest_linear(&self, wrap_mode: vk::SamplerAddressMode) -> Sampler {
        self.new_sampler(
            &vk::SamplerCreateInfo::default()
                .mag_filter(vk::Filter::NEAREST)
                .min_filter(vk::Filter::LINEAR)
                .mipmap_mode(vk::SamplerMipmapMode::LINEAR)
                .address_mode_u(wrap_mode)
                .address_mode_v(wrap_mode)
                .address_mode_w(wrap_mode),
        )
    }

    /// Creates a Sampler with bilinear filtering (linear min/mag, nearest mipmap).
    pub fn new_sampler_bilinear(&self, wrap_mode: vk::SamplerAddressMode) -> Sampler {
        self.new_sampler(
            &vk::SamplerCreateInfo::default()
                .mag_filter(vk::Filter::LINEAR)
                .min_filter(vk::Filter::LINEAR)
                .mipmap_mode(vk::SamplerMipmapMode::NEAREST)
                .address_mode_u(wrap_mode)
                .address_mode_v(wrap_mode)
                .address_mode_w(wrap_mode),
        )
    }

    /// Creates a Sampler with trilinear filtering (linear min/mag/mipmap).
    pub fn new_sampler_trilinear(&self, wrap_mode: vk::SamplerAddressMode) -> Sampler {
        self.new_sampler(
            &vk::SamplerCreateInfo::default()
                .mag_filter(vk::Filter::LINEAR)
                .min_filter(vk::Filter::LINEAR)
                .mipmap_mode(vk::SamplerMipmapMode::LINEAR)
                .address_mode_u(wrap_mode)
                .address_mode_v(wrap_mode)
                .address_mode_w(wrap_mode),
        )
    }

    /// Creates a Sampler with anisotropic filtering enabled.
    pub fn new_sampler_anisotropic(&self, wrap_mode: vk::SamplerAddressMode, max_anisotropy: f32) -> Sampler {
        self.new_sampler(
            &vk::SamplerCreateInfo::default()
                .mag_filter(vk::Filter::LINEAR)
                .min_filter(vk::Filter::LINEAR)
                .mipmap_mode(vk::SamplerMipmapMode::LINEAR)
                .address_mode_u(wrap_mode)
                .address_mode_v(wrap_mode)
                .address_mode_w(wrap_mode)
                .anisotropy_enable(true)
                .max_anisotropy(max_anisotropy),
        )
    }

    /// Creates a Sampler configured for shadow mapping (linear filtering, compare enable).
    pub fn new_sampler_shadow(&self, wrap_mode: vk::SamplerAddressMode) -> Sampler {
        self.new_sampler(
            &vk::SamplerCreateInfo::default()
                .mag_filter(vk::Filter::LINEAR)
                .min_filter(vk::Filter::LINEAR)
                .mipmap_mode(vk::SamplerMipmapMode::LINEAR)
                .address_mode_u(wrap_mode)
                .address_mode_v(wrap_mode)
                .address_mode_w(wrap_mode)
                .compare_enable(true)
                .compare_op(vk::CompareOp::LESS_OR_EQUAL),
        )
    }
}