uniform_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 "../Image/buffer_usage.h"
34 
35 namespace clan
36 {
39 
40 class GraphicContext;
41 class TransferBuffer;
42 class UniformBufferProvider;
43 class UniformBuffer_Impl;
44 class ProgramObject;
45 
48 {
51 public:
54 
61 
68  UniformBuffer(GraphicContext &gc, const void *data, int size, BufferUsage usage = usage_dynamic_draw);
69 
75  UniformBuffer(GraphicContext &gc, ProgramObject &program, const std::string &name, int num_blocks = 1, BufferUsage usage = usage_dynamic_draw);
77 
80 public:
82  bool is_null() const { return !impl; }
83 
85  void throw_if_null() const;
86 
92 
95 public:
97  bool operator==(const UniformBuffer &other) const;
98 
102  void upload_data(GraphicContext &gc, const void *data, int size);
103 
105  void copy_from(GraphicContext &gc, TransferBuffer &buffer, int dest_pos = 0, int src_pos = 0, int size = -1);
106 
108  void copy_to(GraphicContext &gc, TransferBuffer &buffer, int dest_pos = 0, int src_pos = 0, int size = -1);
110 
113 private:
114  std::shared_ptr<UniformBuffer_Impl> impl;
116 };
117 
118 }
119 
void copy_to(GraphicContext &gc, TransferBuffer &buffer, int dest_pos=0, int src_pos=0, int size=-1)
Copies data to transfer buffer.
UniformBuffer(GraphicContext &gc, ProgramObject &program, const std::string &name, int num_blocks=1, BufferUsage usage=usage_dynamic_draw)
Constructs a ProgramUniformBlock - convenience function.
UniformBuffer(GraphicContext &gc, const void *data, int size, BufferUsage usage=usage_dynamic_draw)
Constructs a VertexArrayBuffer.
Transfer Buffer.
Definition: transfer_buffer.h:46
UniformBuffer(GraphicContext &gc, int block_size, BufferUsage usage=usage_dynamic_draw)
Constructs a ProgramUniformBlock.
Uniform Buffer provider.
Definition: uniform_buffer_provider.h:41
UniformBufferProvider * get_provider() const
Get Provider.
UniformBuffer()
Constructs a null instance.
bool operator==(const UniformBuffer &other) const
Handle comparison operator.
BufferUsage
Array Buffer usage enum.
Definition: buffer_usage.h:41
Interface to drawing graphics.
Definition: graphic_context.h:258
void throw_if_null() const
Throw an exception if this object is invalid.
void upload_data(GraphicContext &gc, const void *data, int size)
Uploads data to uniforms buffer.
Uniform Buffer.
Definition: uniform_buffer.h:48
@ usage_dynamic_draw
Definition: buffer_usage.h:48
Definition: clanapp.h:36
bool is_null() const
Returns true if this object is invalid.
Definition: uniform_buffer.h:82
void copy_from(GraphicContext &gc, TransferBuffer &buffer, int dest_pos=0, int src_pos=0, int size=-1)
Copies data from transfer buffer.
Program Object.
Definition: program_object.h:70