storage_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 StorageBufferProvider;
42 class StorageBuffer_Impl;
43 class ProgramObject;
44
47 {
48 public:
51
58
65 StorageBuffer(GraphicContext &gc, const void *data, int size, int stride, BufferUsage usage = BufferUsage::dynamic_draw);
66
68 bool is_null() const { return !impl; }
69 explicit operator bool() const { return bool(impl); }
70
72 void throw_if_null() const;
73
78
80 bool operator==(const StorageBuffer &other) const;
81
85 void upload_data(GraphicContext &gc, const void *data, int size);
86
88 void copy_from(GraphicContext &gc, TransferBuffer &buffer, int dest_pos = 0, int src_pos = 0, int size = -1);
89
91 void copy_to(GraphicContext &gc, TransferBuffer &buffer, int dest_pos = 0, int src_pos = 0, int size = -1);
92
93 private:
94 std::shared_ptr<StorageBuffer_Impl> impl;
95 };
96
98}
Interface to drawing graphics.
Definition: graphic_context.h:257
Storage Buffer provider.
Definition: storage_buffer_provider.h:40
Storage Buffer.
Definition: storage_buffer.h:47
void copy_from(GraphicContext &gc, TransferBuffer &buffer, int dest_pos=0, int src_pos=0, int size=-1)
Copies data from transfer buffer.
StorageBuffer()
Constructs a null instance.
bool operator==(const StorageBuffer &other) const
Handle comparison operator.
void copy_to(GraphicContext &gc, TransferBuffer &buffer, int dest_pos=0, int src_pos=0, int size=-1)
Copies data to transfer buffer.
StorageBuffer(GraphicContext &gc, const void *data, int size, int stride, BufferUsage usage=BufferUsage::dynamic_draw)
Constructs a buffer.
StorageBuffer(GraphicContext &gc, int size, int stride, BufferUsage usage=BufferUsage::dynamic_draw)
Constructs a buffer.
void upload_data(GraphicContext &gc, const void *data, int size)
Uploads data to storage buffer.
void throw_if_null() const
Throw an exception if this object is invalid.
StorageBufferProvider * get_provider() const
Get Provider.
bool is_null() const
Returns true if this object is invalid.
Definition: storage_buffer.h:68
Transfer Buffer.
Definition: transfer_buffer.h:45
BufferUsage
Array Buffer usage enum.
Definition: buffer_usage.h:39
Definition: clanapp.h:36