uniform_buffer.h

/*
**  UICore
**  Copyright (c) 1997-2015 The UICore Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries UICore may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/

#pragma once

#include <memory>
#include "buffer_usage.h"

namespace uicore
{
    class GraphicContext;
    typedef std::shared_ptr<GraphicContext> GraphicContextPtr;
    class StagingBuffer;
    typedef std::shared_ptr<StagingBuffer> StagingBufferPtr;
    class ProgramObject;
    typedef std::shared_ptr<ProgramObject> ProgramObjectPtr;

    class UniformBuffer
    {
    public:
        static std::shared_ptr<UniformBuffer> create(const GraphicContextPtr &gc, int size, BufferUsage usage = usage_dynamic_draw);
        static std::shared_ptr<UniformBuffer> create(const GraphicContextPtr &gc, const void *data, int size, BufferUsage usage = usage_dynamic_draw);
        static std::shared_ptr<UniformBuffer> create(const GraphicContextPtr &gc, const ProgramObjectPtr &program, const std::string &name, int num_blocks = 1, BufferUsage usage = usage_dynamic_draw);

        virtual void upload_data(const GraphicContextPtr &gc, const void *data, int size) = 0;

        virtual void copy_from(const GraphicContextPtr &gc, const StagingBufferPtr &buffer, int dest_pos = 0, int src_pos = 0, int size = -1) = 0;

        virtual void copy_to(const GraphicContextPtr &gc, const StagingBufferPtr &buffer, int dest_pos = 0, int src_pos = 0, int size = -1) = 0;
    };

    typedef std::shared_ptr<UniformBuffer> UniformBufferPtr;
}