element_array_buffer.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28
29
30 #pragma once
31
32 #include <memory>
33 #include "vertex_array_buffer.h"
34
35 namespace clan
36 {
39
40 class GraphicContext;
41 class TransferBuffer;
42 class ElementArrayBufferProvider;
43 class ElementArrayBuffer_Impl;
44
46 class ElementArrayBuffer
47 {
50 public:
52 ElementArrayBuffer();
53
59 ElementArrayBuffer(GraphicContext &gc, int size, BufferUsage usage = usage_static_draw);
60
67 ElementArrayBuffer(GraphicContext &gc, const void *data, int size, BufferUsage usage = usage_static_draw);
68
69 virtual ~ElementArrayBuffer();
71
74 public:
76 bool is_null() const { return !impl; }
77
79 void throw_if_null() const;
80
84 ElementArrayBufferProvider *get_provider() const;
86
89 public:
91 bool operator==(const ElementArrayBuffer &other) const;
92
96 void upload_data(GraphicContext &gc, const void *data, int size);
97
99 void copy_from(GraphicContext &gc, TransferBuffer &buffer, int dest_pos = 0, int src_pos = 0, int size = -1);
100
102 void copy_to(GraphicContext &gc, TransferBuffer &buffer, int dest_pos = 0, int src_pos = 0, int size = -1);
104
107 private:
108 std::shared_ptr<ElementArrayBuffer_Impl> impl;
110 };
111
112 }
113
clan
Definition: clanapp.h:35
clan::ElementArrayBuffer::copy_to
void copy_to(GraphicContext &gc, TransferBuffer &buffer, int dest_pos=0, int src_pos=0, int size=-1)
Copies data to transfer buffer.
clan::ElementArrayBuffer::copy_from
void copy_from(GraphicContext &gc, TransferBuffer &buffer, int dest_pos=0, int src_pos=0, int size=-1)
Copies data from transfer buffer.
clan::ElementArrayBuffer::~ElementArrayBuffer
virtual ~ElementArrayBuffer()
clan::ElementArrayBuffer::is_null
bool is_null() const
Returns true if this object is invalid.
Definition: element_array_buffer.h:76
clan::usage_static_draw
Definition: buffer_usage.h:45
clan::BufferUsage
BufferUsage
Array Buffer usage enum.
Definition: buffer_usage.h:40
clan::ElementArrayBuffer::operator==
bool operator==(const ElementArrayBuffer &other) const
Handle comparison operator.
clan::ElementArrayBuffer
Element Array Buffer.
Definition: element_array_buffer.h:46
clan::GraphicContext
Interface to drawing graphics.
Definition: graphic_context.h:257
clan::ElementArrayBuffer::ElementArrayBuffer
ElementArrayBuffer()
Constructs a null instance.
clan::ElementArrayBuffer::throw_if_null
void throw_if_null() const
Throw an exception if this object is invalid.
clan::ElementArrayBuffer::get_provider
ElementArrayBufferProvider * get_provider() const
Get Provider.
clan::ElementArrayBufferProvider
Element Array Buffer provider.
Definition: element_array_buffer_provider.h:40
clan::TransferBuffer
Transfer Buffer.
Definition: transfer_buffer.h:45
clan::ElementArrayBuffer::upload_data
void upload_data(GraphicContext &gc, const void *data, int size)
Uploads data to element array buffer.