Overview
Download
Documentation
Contact
Sources
API
Display
Render
uniform_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
34
namespace
clan
35
{
38
39
class
GraphicContext;
40
class
TransferBuffer;
41
class
UniformBufferProvider;
42
class
UniformBuffer_Impl;
43
class
ProgramObject;
44
46
class
UniformBuffer
47
{
48
public
:
50
UniformBuffer
();
51
57
UniformBuffer
(
GraphicContext
&gc,
int
block_size,
BufferUsage
usage =
BufferUsage::dynamic_draw
);
58
65
UniformBuffer
(
GraphicContext
&gc,
const
void
*data,
int
size,
BufferUsage
usage =
BufferUsage::dynamic_draw
);
66
72
UniformBuffer
(
GraphicContext
&gc,
ProgramObject
&program,
const
std::string
&name,
int
num_blocks = 1,
BufferUsage
usage =
BufferUsage::dynamic_draw
);
73
75
bool
is_null
()
const
{
return
!impl; }
76
explicit
operator
bool()
const
{
return
bool(impl); }
77
79
void
throw_if_null
()
const
;
80
84
UniformBufferProvider
*
get_provider
()
const
;
85
87
bool
operator==
(
const
UniformBuffer
&other)
const
;
88
92
void
upload_data
(
GraphicContext
&gc,
const
void
*data,
int
size);
93
95
void
copy_from
(
GraphicContext
&gc,
TransferBuffer
&buffer,
int
dest_pos = 0,
int
src_pos = 0,
int
size = -1);
96
98
void
copy_to
(
GraphicContext
&gc,
TransferBuffer
&buffer,
int
dest_pos = 0,
int
src_pos = 0,
int
size = -1);
99
100
private
:
101
std::shared_ptr<UniformBuffer_Impl> impl;
102
};
103
105
}
clan
Definition:
clanapp.h:35
clan::UniformBuffer::throw_if_null
void throw_if_null() const
Throw an exception if this object is invalid.
clan::UniformBuffer::get_provider
UniformBufferProvider * get_provider() const
Get Provider.
clan::UniformBuffer::is_null
bool is_null() const
Returns true if this object is invalid.
Definition:
uniform_buffer.h:75
clan::UniformBuffer::UniformBuffer
UniformBuffer()
Constructs a null instance.
clan::BufferUsage::dynamic_draw
clan::BufferUsage
BufferUsage
Array Buffer usage enum.
Definition:
buffer_usage.h:38
clan::UniformBuffer
Uniform Buffer.
Definition:
uniform_buffer.h:46
clan::UniformBuffer::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::GraphicContext
Interface to drawing graphics.
Definition:
graphic_context.h:256
clan::ProgramObject
Program Object.
Definition:
program_object.h:68
clan::UniformBuffer::upload_data
void upload_data(GraphicContext &gc, const void *data, int size)
Uploads data to uniforms buffer.
clan::UniformBuffer::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::UniformBufferProvider
Uniform Buffer provider.
Definition:
uniform_buffer_provider.h:39
clan::UniformBuffer::operator==
bool operator==(const UniformBuffer &other) const
Handle comparison operator.
clan::JsonType::string
clan::TransferBuffer
Transfer Buffer.
Definition:
transfer_buffer.h:44