vertex_array_buffer.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Magnus Norddahl
00027 */
00028 
00031 
00032 #pragma once
00033 
00034 #include "../../Core/System/sharedptr.h"
00035 #include "graphic_context.h"
00036 #include "../api_display.h"
00037 
00038 #include "../Image/buffer_usage.h"
00039 
00040 class CL_VertexArrayBufferProvider;
00041 class CL_VertexArrayBuffer_Impl;
00042 
00046 class CL_API_DISPLAY CL_VertexArrayBuffer
00047 {
00050 
00051 public:
00053         CL_VertexArrayBuffer();
00054 
00060         CL_VertexArrayBuffer(CL_GraphicContext &gc, int size, CL_BufferUsage usage = cl_usage_static_draw);
00061 
00068         CL_VertexArrayBuffer(CL_GraphicContext &gc, void *data, int size, CL_BufferUsage usage = cl_usage_static_draw);
00069 
00070         virtual ~CL_VertexArrayBuffer();
00071 
00075 
00076 public:
00078         bool is_null() const { return !impl; }
00079 
00081         void throw_if_null() const;
00082 
00084         void *get_data();
00085 
00089         CL_VertexArrayBufferProvider *get_provider() const;
00090 
00094 
00095 public:
00097         bool operator==(const CL_VertexArrayBuffer &other) const;
00098 
00100         void lock(CL_BufferAccess access);
00101 
00103         void unlock();
00104 
00106         void upload_data(int offset, void *data, int size);
00107 
00111 
00112 private:
00113         CL_SharedPtr<CL_VertexArrayBuffer_Impl> impl;
00115 };
00116