Download
Documentation
Development
Examples
Donations
Contributions
Forum
Sources
API
Display
Render
transfer_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
TransferBufferProvider;
43
class
TransferBuffer_Impl;
44
46
class
CL_API_DISPLAY
TransferBuffer
47
{
50
public
:
52
TransferBuffer
();
53
59
TransferBuffer
(
GraphicContext
&gc,
int
size,
BufferUsage
usage =
usage_dynamic_copy
);
60
67
TransferBuffer
(
GraphicContext
&gc,
const
void
*data,
int
size,
BufferUsage
usage =
usage_dynamic_copy
);
68
69
virtual
~
TransferBuffer
();
71
74
public
:
76
bool
is_null
()
const
{
return
!impl; }
77
79
void
throw_if_null()
const
;
80
82
void
*get_data();
83
87
TransferBufferProvider
*get_provider()
const
;
89
92
public
:
94
bool
operator==(
const
TransferBuffer
&other)
const
;
95
97
void
lock(
GraphicContext
&gc,
BufferAccess
access);
98
100
void
unlock();
101
103
void
upload_data(
GraphicContext
&gc,
int
offset,
const
void
*data,
int
size);
105
108
private
:
109
std::shared_ptr<TransferBuffer_Impl> impl;
111
};
112
113
}
114
clan::TransferBuffer::is_null
bool is_null() const
Returns true if this object is invalid.
Definition:
transfer_buffer.h:76
clan::TransferBufferProvider
Transfer Buffer provider.
Definition:
transfer_buffer_provider.h:42
clan::BufferUsage
BufferUsage
Array Buffer usage enum.
Definition:
buffer_usage.h:41
clan::GraphicContext
Interface to drawing graphics.
Definition:
graphic_context.h:257
clan::usage_dynamic_copy
Definition:
buffer_usage.h:51
clan::BufferAccess
BufferAccess
Array Buffer access enum.
Definition:
buffer_usage.h:55
clan::TransferBuffer
Transfer Buffer.
Definition:
transfer_buffer.h:46