vertex_array_buffer.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib 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 ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/


#pragma once

#include "../../Core/System/sharedptr.h"
#include "graphic_context.h"
#include "../api_display.h"

enum CL_BufferUsage
{
        cl_usage_stream_draw,
        cl_usage_stream_read,
        cl_usage_stream_copy,
        cl_usage_static_draw,
        cl_usage_static_read,
        cl_usage_static_copy,
        cl_usage_dynamic_draw,
        cl_usage_dynamic_read,
        cl_usage_dynamic_copy
};

enum CL_BufferAccess
{
        cl_access_read_only,
        cl_access_write_only,
        cl_access_read_write
};

class CL_VertexArrayBufferProvider;
class CL_VertexArrayBuffer_Impl;

class CL_API_DISPLAY CL_VertexArrayBuffer
{

public:
        CL_VertexArrayBuffer();

        CL_VertexArrayBuffer(CL_GraphicContext &gc, int size, CL_BufferUsage usage = cl_usage_static_draw);

        CL_VertexArrayBuffer(CL_GraphicContext &gc, void *data, int size, CL_BufferUsage usage = cl_usage_static_draw);

        virtual ~CL_VertexArrayBuffer();


public:
        void *get_data();

        CL_VertexArrayBufferProvider *get_provider() const;


public:
        bool operator==(const CL_VertexArrayBuffer &other) const;

        void lock(CL_BufferAccess access);

        void unlock();

        void upload_data(int offset, void *data, int size);


private:
        CL_SharedPtr<CL_VertexArrayBuffer_Impl> impl;
};

---