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

vertex_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 "../Image/buffer_usage.h"
33
34namespace clan
35{
38
39 class GraphicContext;
40 class TransferBuffer;
41 class VertexArrayBufferProvider;
42 class VertexArrayBuffer_Impl;
43
45 class VertexArrayBuffer
46 {
47 public:
49 VertexArrayBuffer();
50
56 VertexArrayBuffer(GraphicContext &gc, int size, BufferUsage usage = BufferUsage::static_draw);
57
64 VertexArrayBuffer(GraphicContext &gc, const void *data, int size, BufferUsage usage = BufferUsage::static_draw);
65
66 virtual ~VertexArrayBuffer();
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 VertexArrayBufferProvider *get_provider() const;
79
81 bool operator==(const VertexArrayBuffer &other) const;
82
84 void upload_data(GraphicContext &gc, int offset, const void *data, int size);
85
87 void copy_from(GraphicContext &gc, TransferBuffer &buffer, int dest_pos = 0, int src_pos = 0, int size = -1);
88
90 void copy_to(GraphicContext &gc, TransferBuffer &buffer, int dest_pos = 0, int src_pos = 0, int size = -1);
91
92 private:
93 std::shared_ptr<VertexArrayBuffer_Impl> impl;
94 };
95
97}
clan::GraphicContext
Interface to drawing graphics.
Definition graphic_context.h:257
clan::TransferBuffer
Transfer Buffer.
Definition transfer_buffer.h:45
clan::VertexArrayBufferProvider
Vertex Array Buffer provider.
Definition vertex_array_buffer_provider.h:42
clan::VertexArrayBuffer::operator==
bool operator==(const VertexArrayBuffer &other) const
Handle comparison operator.
clan::VertexArrayBuffer::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::VertexArrayBuffer::VertexArrayBuffer
VertexArrayBuffer(GraphicContext &gc, int size, BufferUsage usage=BufferUsage::static_draw)
Constructs a VertexArrayBuffer.
clan::VertexArrayBuffer::~VertexArrayBuffer
virtual ~VertexArrayBuffer()
clan::VertexArrayBuffer::upload_data
void upload_data(GraphicContext &gc, int offset, const void *data, int size)
Uploads data to vertex array buffer.
clan::VertexArrayBuffer::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::VertexArrayBuffer::throw_if_null
void throw_if_null() const
Throw an exception if this object is invalid.
clan::VertexArrayBuffer::get_provider
VertexArrayBufferProvider * get_provider() const
Get Provider.
clan::VertexArrayBuffer::VertexArrayBuffer
VertexArrayBuffer(GraphicContext &gc, const void *data, int size, BufferUsage usage=BufferUsage::static_draw)
Constructs a VertexArrayBuffer.
clan::VertexArrayBuffer::is_null
bool is_null() const
Returns true if this object is invalid.
Definition vertex_array_buffer.h:69
clan::VertexArrayBuffer::VertexArrayBuffer
VertexArrayBuffer()
Constructs a null instance.
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