memkit-gpu 0.2.0-beta.1

Backend-agnostic GPU memory management for memkit
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

//! GPU buffer types.

use crate::backend::MkGpuBackend;

/// Buffer usage flags.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct MkBufferUsage(u32);

impl MkBufferUsage {
    pub const TRANSFER_SRC: Self = Self(0x0001);
    pub const TRANSFER_DST: Self = Self(0x0002);
    pub const UNIFORM: Self = Self(0x0010);
    pub const STORAGE: Self = Self(0x0020);
    pub const VERTEX: Self = Self(0x0080);
    pub const INDEX: Self = Self(0x0040);
    
    /// Combine usage flags.
    pub const fn or(self, other: Self) -> Self {
        Self(self.0 | other.0)
    }
    
    /// Check if a flag is set.
    pub const fn contains(self, other: Self) -> bool {
        (self.0 & other.0) == other.0
    }
}

impl std::ops::BitOr for MkBufferUsage {
    type Output = Self;
    
    fn bitor(self, rhs: Self) -> Self::Output {
        Self(self.0 | rhs.0)
    }
}

/// A device-local GPU buffer.
pub struct MkDeviceBuffer<B: MkGpuBackend> {
    handle: B::BufferHandle,
    size: usize,
    usage: MkBufferUsage,
}

impl<B: MkGpuBackend> MkDeviceBuffer<B> {
    /// Create a new device buffer.
    pub(crate) fn new(handle: B::BufferHandle, size: usize, usage: MkBufferUsage) -> Self {
        Self { handle, size, usage }
    }

    /// Get the buffer size in bytes.
    pub fn size(&self) -> usize {
        self.size
    }
    
    /// Get the buffer usage flags.
    pub fn usage(&self) -> MkBufferUsage {
        self.usage
    }
    
    /// Get the native buffer handle.
    pub fn handle(&self) -> &B::BufferHandle {
        &self.handle
    }
}