uniform_buffer.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 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 "../api_display.h"
34 #include "../Image/buffer_usage.h"
35 
36 namespace clan
37 {
40 
41 class GraphicContext;
42 class TransferBuffer;
43 class UniformBufferProvider;
44 class UniformBuffer_Impl;
45 class ProgramObject;
46 
48 class CL_API_DISPLAY UniformBuffer
49 {
52 public:
54  UniformBuffer();
55 
61  UniformBuffer(GraphicContext &gc, int block_size, BufferUsage usage = usage_dynamic_draw);
62 
69  UniformBuffer(GraphicContext &gc, const void *data, int size, BufferUsage usage = usage_dynamic_draw);
70 
76  UniformBuffer(GraphicContext &gc, ProgramObject &program, const std::string &name, int num_blocks = 1, BufferUsage usage = usage_dynamic_draw);
78 
81 public:
83  bool is_null() const { return !impl; }
84 
86  void throw_if_null() const;
87 
91  UniformBufferProvider *get_provider() const;
93 
96 public:
98  bool operator==(const UniformBuffer &other) const;
99 
103  void upload_data(GraphicContext &gc, const void *data, int size);
104 
106  void copy_from(GraphicContext &gc, TransferBuffer &buffer, int dest_pos = 0, int src_pos = 0, int size = -1);
107 
109  void copy_to(GraphicContext &gc, TransferBuffer &buffer, int dest_pos = 0, int src_pos = 0, int size = -1);
111 
114 private:
115  std::shared_ptr<UniformBuffer_Impl> impl;
117 };
118 
119 }
120 
Definition: buffer_usage.h:49
BufferUsage
Array Buffer usage enum.
Definition: buffer_usage.h:41
bool is_null() const
Returns true if this object is invalid.
Definition: uniform_buffer.h:83
Uniform Buffer.
Definition: uniform_buffer.h:48
Interface to drawing graphics.
Definition: graphic_context.h:257
Program Object.
Definition: program_object.h:70
Uniform Buffer provider.
Definition: uniform_buffer_provider.h:40
Transfer Buffer.
Definition: transfer_buffer.h:46