element_array_buffer.h Source File - ClanLib SDK
Description: element_array_buffer.h Source File

element_array_buffer.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 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#pragma once
30
31#include <memory>
32#include "vertex_array_buffer.h"
33
34namespace clan
35{
38
39 class GraphicContext;
40 class TransferBuffer;
41 class ElementArrayBufferProvider;
42 class ElementArrayBuffer_Impl;
43
45 class ElementArrayBuffer
46 {
47 public:
49 ElementArrayBuffer();
50
56 ElementArrayBuffer(GraphicContext &gc, int size, BufferUsage usage = BufferUsage::static_draw);
57
64 ElementArrayBuffer(GraphicContext &gc, const void *data, int size, BufferUsage usage = BufferUsage::static_draw);
65
66 virtual ~ElementArrayBuffer();
67
69 bool is_null() const { return !impl; }
70 explicit operator bool() const { return bool(impl); }
71
73 void throw_if_null() const;
74
78 ElementArrayBufferProvider *get_provider() const;
79
81 bool operator==(const ElementArrayBuffer &other) const;
82
86 void upload_data(GraphicContext &gc, const void *data, int size);
87
89 void copy_from(GraphicContext &gc, TransferBuffer &buffer, int dest_pos = 0, int src_pos = 0, int size = -1);
90
92 void copy_to(GraphicContext &gc, TransferBuffer &buffer, int dest_pos = 0, int src_pos = 0, int size = -1);
93
94 private:
95 std::shared_ptr<ElementArrayBuffer_Impl> impl;
96 };
97
99}
clan::ElementArrayBufferProvider
Element Array Buffer provider.
Definition element_array_buffer_provider.h:40
clan::ElementArrayBuffer::operator==
bool operator==(const ElementArrayBuffer &other) const
Handle comparison operator.
clan::ElementArrayBuffer::ElementArrayBuffer
ElementArrayBuffer(GraphicContext &gc, int size, BufferUsage usage=BufferUsage::static_draw)
Constructs a ElementArrayBuffer.
clan::ElementArrayBuffer::get_provider
ElementArrayBufferProvider * get_provider() const
Get Provider.
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
ElementArrayBuffer()
Constructs a null instance.
clan::ElementArrayBuffer::~ElementArrayBuffer
virtual ~ElementArrayBuffer()
clan::ElementArrayBuffer::throw_if_null
void throw_if_null() const
Throw an exception if this object is invalid.
clan::ElementArrayBuffer::is_null
bool is_null() const
Returns true if this object is invalid.
Definition element_array_buffer.h:69
clan::ElementArrayBuffer::ElementArrayBuffer
ElementArrayBuffer(GraphicContext &gc, const void *data, int size, BufferUsage usage=BufferUsage::static_draw)
Constructs a ElementArrayBuffer.
clan::ElementArrayBuffer::upload_data
void upload_data(GraphicContext &gc, const void *data, int size)
Uploads data to element array buffer.
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::GraphicContext
Interface to drawing graphics.
Definition graphic_context.h:257
clan::TransferBuffer
Transfer Buffer.
Definition transfer_buffer.h:45
clan::BufferUsage
BufferUsage
Array Buffer usage enum.
Definition buffer_usage.h:39
clan::BufferUsage::static_draw
@ static_draw
Definition buffer_usage.h:43
clan
Definition clanapp.h:36