vertex-buffer.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2023  Christopher J. Howard
 *
 * This file is part of Antkeeper source code.
 *
 * Antkeeper source code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Antkeeper source code is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Antkeeper source code.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef ANTKEEPER_GL_VERTEX_BUFFER_HPP
#define ANTKEEPER_GL_VERTEX_BUFFER_HPP
 
#include <engine/gl/buffer-usage.hpp>
#include <cstddef>
#include <span>
 
namespace gl {
 
class vertex_buffer
{
public:
    vertex_buffer(buffer_usage usage, std::size_t size, std::span<const std::byte> data = {});
    
    inline explicit vertex_buffer(buffer_usage usage, std::span<const std::byte> data = {}):
        vertex_buffer(usage, data.size(), data)
    {}
    
    inline vertex_buffer():
        vertex_buffer(buffer_usage::static_draw, 0)
    {}
    
    vertex_buffer(const vertex_buffer& buffer);
    
    vertex_buffer(vertex_buffer&& buffer);
    
    ~vertex_buffer();
    
    vertex_buffer& operator=(const vertex_buffer& buffer);
    
    vertex_buffer& operator=(vertex_buffer&& buffer);
    
    void repurpose(buffer_usage usage, std::size_t size, std::span<const std::byte> data = {});
    
    inline void repurpose(buffer_usage usage, std::span<const std::byte> data)
    {
        repurpose(usage, data.size(), data);
    }
    
    inline void repurpose(buffer_usage usage)
    {
        repurpose(usage, m_size, {});
    }
    
    inline void resize(std::size_t size, std::span<const std::byte> data = {})
    {
        repurpose(m_usage, size, data);
    }
    
    inline void resize(std::span<const std::byte> data)
    {
        repurpose(m_usage, data.size(), data);
    }
    
    void write(std::size_t offset, std::span<const std::byte> data);
    
    inline void write(std::span<const std::byte> data)
    {
        write(0, data);
    }
    
    void read(std::size_t offset, std::span<std::byte> data) const;
    
    inline void read(std::span<std::byte> data) const
    {
        read(0, data);
    }
    
    void copy(const vertex_buffer& read_buffer, std::size_t copy_size, std::size_t read_offset = 0, std::size_t write_offset = 0);
    
    [[nodiscard]] inline constexpr std::size_t size() const noexcept
    {
        return m_size;
    }
    
    [[nodiscard]] inline constexpr buffer_usage usage() const noexcept
    {
        return m_usage;
    }
 
private:
    friend class pipeline;
    
    unsigned int m_gl_named_buffer{0};
    buffer_usage m_usage{buffer_usage::static_draw};
    std::size_t m_size{0};
};
 
} // namespace gl
 
#endif // ANTKEEPER_GL_VERTEX_BUFFER_HPP