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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
use super::*;
use super::errors::*;

use std;
use std::os::raw::c_void;

#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct BufferId(u32);

impl BufferId {
    pub fn empty() -> BufferId {
        BufferId(0)
    }
}

impl From<BufferId> for u32 {
    fn from(buffer_id: BufferId) -> Self {
        buffer_id.0
    }
}

#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct BlockIndex(pub u32);

impl From<BlockIndex> for u32 {
    fn from(block_index: BlockIndex) -> Self {
        block_index.0
    }
}

#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum BufferMutability {
    Mutable,
    Immutable,
}

#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum BufferMap {
    Read,
    Write,
    ReadWrite,
}

#[derive(Debug, Copy, Clone)]
pub enum BufferData<'a, T: 'a> {
    Empty(usize),
    Data(&'a [T]),
}

#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum BindBufferTarget {
    DispatchIndirectBuffer,
    DrawIndirectBuffer,
    PixelPackBuffer,
    PixelUnpackBuffer,
    ElementArrayBuffer,
}

impl From<BindBufferTarget> for u32 {
    fn from(target: BindBufferTarget) -> Self {
        match target {
            BindBufferTarget::DispatchIndirectBuffer => gl::DISPATCH_INDIRECT_BUFFER,
            BindBufferTarget::DrawIndirectBuffer => gl::DRAW_INDIRECT_BUFFER,
            BindBufferTarget::PixelPackBuffer => gl::PIXEL_PACK_BUFFER,
            BindBufferTarget::PixelUnpackBuffer => gl::PIXEL_UNPACK_BUFFER,
            BindBufferTarget::ElementArrayBuffer => gl::ELEMENT_ARRAY_BUFFER,
        }
    }
}

#[derive(Debug, Copy, Clone, PartialEq)]
pub enum BufferBaseTarget {
    AtomicCounter,
    TransformFeedback,
    Uniform,
    ShaderStorage,
}

impl From<BufferBaseTarget> for u32 {
    fn from(target: BufferBaseTarget) -> Self {
        match target {
            BufferBaseTarget::AtomicCounter => gl::ATOMIC_COUNTER_BUFFER,
            BufferBaseTarget::TransformFeedback => gl::TRANSFORM_FEEDBACK_BUFFER,
            BufferBaseTarget::Uniform => gl::UNIFORM_BUFFER,
            BufferBaseTarget::ShaderStorage => gl::SHADER_STORAGE_BUFFER,
        }
    }
}

impl<'a> From<&'a BufferBaseTarget> for u32 {
    fn from(target: &'a BufferBaseTarget) -> Self {
        match *target {
            BufferBaseTarget::AtomicCounter => gl::ATOMIC_COUNTER_BUFFER,
            BufferBaseTarget::TransformFeedback => gl::TRANSFORM_FEEDBACK_BUFFER,
            BufferBaseTarget::Uniform => gl::UNIFORM_BUFFER,
            BufferBaseTarget::ShaderStorage => gl::SHADER_STORAGE_BUFFER,
        }
    }
}

/// Returns a new buffer
///
/// # Example
///
/// ```
/// let vertices_buffer = create_buffer();
/// ```
///
pub fn create_buffer() -> BufferId {
    let mut buffer_id: u32 = 0;
    let buffer_id_ptr: *mut u32 = &mut buffer_id;

    // Safe without errors because:
    // - GL_INVALID_VALUE happens when *n* is negative, 1 is not negative
    // - pointer to memory is valid
    unsafe {
        gl::CreateBuffers(1, buffer_id_ptr);
    }

    BufferId(buffer_id)
}

/// Initializes buffer
///
/// # Arguments
/// - `id` - id of the buffer
/// - `data` - enumeration, Empty(size) will allocate the size for the buffer,
/// Data(&[T]) will initialize size of &[T] and copy data from slice to GPU memory
/// - `mutability` - sets the mutability for the buffer. Beware, in OpenGL terminology
/// immutable buffer means not resizable but all buffers created with `glNamedBufferStorage`
/// are non-resizable. This simply says whether you can **modify** data in the buffer
/// - `map` - whether to map the buffer for reading, writing, both or none
///
/// # Example
///
/// ```
/// let vertices: Vec<f32> = vec![-1.0, -1.0, 0.0, 1.0, -1.0, 0.0, 0.0, 1.0, 0.0];
/// let vertices_buffer = create_buffer();
/// named_buffer_storage(
///     buffer,
///     BufferData::Data(&vertices),
///     BufferMutability:Immutable,
///     None
/// );
/// ```
///
pub unsafe fn named_buffer_storage<T, M>(
    id: BufferId,
    data: BufferData<T>,
    mutability: BufferMutability,
    map: M,
) -> Result<()>
where
    M: Into<Option<BufferMap>>,
{
    let mut flags: u32 = match mutability {
        BufferMutability::Mutable => gl::DYNAMIC_STORAGE_BIT,
        _ => 0,
    };

    flags |= match map.into() {
        None => 0,
        Some(BufferMap::Read) => gl::MAP_READ_BIT | gl::MAP_COHERENT_BIT | gl::MAP_PERSISTENT_BIT,
        Some(BufferMap::Write) => gl::MAP_WRITE_BIT | gl::MAP_COHERENT_BIT | gl::MAP_PERSISTENT_BIT,
        Some(BufferMap::ReadWrite) => {
            gl::MAP_READ_BIT | gl::MAP_WRITE_BIT | gl::MAP_COHERENT_BIT | gl::MAP_PERSISTENT_BIT
        }
    };

    match data {
        BufferData::Data(data) => {
            let size = (std::mem::size_of::<T>() * data.len()) as isize;
            let buffer_ptr = data.as_ptr() as *const c_void;

            gl::NamedBufferStorage(id.into(), size, buffer_ptr, flags);
        }
        BufferData::Empty(size) => {
            gl::NamedBufferStorage(id.into(), size as isize, std::ptr::null(), flags);
        }
    }

    get_error(())
}

/// Copies data from slice to GPU memory pointer by buffer
///
/// # Arguments
/// - `id` - id of the buffer
/// - `offset` - offset into buffer where to copy
/// - `data` - slice of data to copy
///
pub unsafe fn named_buffer_sub_data<T>(buffer_id: BufferId, offset: usize, data: &[T]) -> Result<()> {
    let size = (std::mem::size_of::<T>() * data.len()) as isize;
    let buffer_ptr = data.as_ptr() as *const c_void;

    gl::NamedBufferSubData(buffer_id.into(), offset as isize, size, buffer_ptr);

    get_error(())
}

/// Returns pointer to buffer memory
///
/// Every mapping is always COHERENT and PERSISTENT, this follows AZDO advices
/// and examples
pub unsafe fn map_named_buffer_range(
    id: BufferId,
    offset: usize,
    length: usize,
    access: BufferMap,
) -> Result<*mut c_void> {
    let flags = match access {
        BufferMap::Read => gl::MAP_READ_BIT | gl::MAP_COHERENT_BIT | gl::MAP_PERSISTENT_BIT,
        BufferMap::Write => gl::MAP_WRITE_BIT | gl::MAP_COHERENT_BIT | gl::MAP_PERSISTENT_BIT,
        BufferMap::ReadWrite => gl::MAP_WRITE_BIT | gl::MAP_READ_BIT | gl::MAP_COHERENT_BIT | gl::MAP_PERSISTENT_BIT,
    };

    let pointer: *mut c_void = gl::MapNamedBufferRange(id.into(), offset as isize, length as isize, flags);

    get_error(pointer)
}

pub unsafe fn get_named_buffer_sub_data<T>(id: BufferId, offset: usize, size: usize, data: &mut [T]) -> Result<()> {
    gl::GetNamedBufferSubData(
        id.into(),
        offset as isize,
        size as isize,
        data.as_mut_ptr() as *mut c_void,
    );

    get_error(())
}

pub unsafe fn bind_buffer(target: BindBufferTarget, id: BufferId) -> Result<()> {
    gl::BindBuffer(target.into(), id.into());

    get_error(())
}

pub unsafe fn bind_buffer_base(target: BufferBaseTarget, block_index: BlockIndex, buffer_id: BufferId) -> Result<()> {
    gl::BindBufferBase(target.into(), block_index.into(), buffer_id.into());

    get_error(())
}

pub unsafe fn bind_buffer_range(
    target: BufferBaseTarget,
    block_index: BlockIndex,
    buffer_id: BufferId,
    offset: usize,
    size: usize,
) -> Result<()> {
    gl::BindBufferRange(
        target.into(),
        block_index.into(),
        buffer_id.into(),
        offset as isize,
        size as isize,
    );

    get_error(())
}

pub unsafe fn bind_buffers_base(
    target: BufferBaseTarget,
    first_ubo_index: BlockIndex,
    buffers_id: &[BufferId],
) -> Result<()> {
    gl::BindBuffersBase(
        target.into(),
        first_ubo_index.into(),
        buffers_id.len() as i32,
        buffers_id.iter().map(|id| id.0).collect::<Vec<u32>>().as_ptr(),
    );

    get_error(())
}

/// Deletes buffer
pub unsafe fn delete_buffer(id: BufferId) {
    let buffer_id_ptr: *const u32 = &id.into();

    gl::DeleteBuffers(1, buffer_id_ptr);
}

pub unsafe fn clear_buffer_data(id: BufferId) -> Result<()> {
    let zero: u8 = 0;
    let zero_ptr: *const u8 = &zero;

    gl::ClearNamedBufferData(
        id.into(),
        gl::R8UI,
        gl::RED,
        gl::UNSIGNED_BYTE,
        zero_ptr as *const c_void,
    );

    get_error(())
}

pub unsafe fn clear_buffer_sub_data(id: BufferId, size: usize, offset: usize) -> Result<()> {
    let zero: u8 = 0;
    let zero_ptr: *const u8 = &zero;

    gl::ClearNamedBufferSubData(
        id.into(),
        gl::R8UI,
        offset as isize,
        size as isize,
        gl::RED,
        gl::UNSIGNED_BYTE,
        zero_ptr as *const c_void,
    );

    get_error(())
}

pub unsafe fn copy_named_buffer_sub_data(
    read_buffer_id: BufferId,
    write_buffer_id: BufferId,
    read_offset: usize,
    write_offset: usize,
    size: usize,
) -> Result<()> {
    gl::CopyNamedBufferSubData(
        read_buffer_id.into(),
        write_buffer_id.into(),
        read_offset as isize,
        write_offset as isize,
        size as isize,
    );

    get_error(())
}