transfer_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 TransferBufferProvider;
42 class TransferBuffer_Impl;
43
45 class TransferBuffer
46 {
49 public:
51 TransferBuffer();
52
58 TransferBuffer(GraphicContext &gc, int size, BufferUsage usage = usage_dynamic_copy);
59
66 TransferBuffer(GraphicContext &gc, const void *data, int size, BufferUsage usage = usage_dynamic_copy);
67
68 virtual ~TransferBuffer();
70
73 public:
75 bool is_null() const { return !impl; }
76
78 void throw_if_null() const;
79
81 void *get_data();
82
86 TransferBufferProvider *get_provider() const;
88
91 public:
93 bool operator==(const TransferBuffer &other) const;
94
96 void lock(GraphicContext &gc, BufferAccess access);
97
99 void unlock();
100
102 void upload_data(GraphicContext &gc, int offset, const void *data, int size);
104
107 private:
108 std::shared_ptr<TransferBuffer_Impl> impl;
110 };
111
112 }
113
clan
Definition: clanapp.h:35
clan::TransferBuffer::unlock
void unlock()
Unmaps buffer.
clan::TransferBuffer::upload_data
void upload_data(GraphicContext &gc, int offset, const void *data, int size)
Uploads data to transfer buffer.
clan::TransferBuffer::lock
void lock(GraphicContext &gc, BufferAccess access)
Maps buffer into system memory.
clan::TransferBuffer::operator==
bool operator==(const TransferBuffer &other) const
Handle comparison operator.
clan::TransferBuffer::is_null
bool is_null() const
Returns true if this object is invalid.
Definition: transfer_buffer.h:75
clan::TransferBufferProvider
Transfer Buffer provider.
Definition: transfer_buffer_provider.h:42
clan::TransferBuffer::~TransferBuffer
virtual ~TransferBuffer()
clan::BufferUsage
BufferUsage
Array Buffer usage enum.
Definition: buffer_usage.h:40
clan::TransferBuffer::throw_if_null
void throw_if_null() const
Throw an exception if this object is invalid.
clan::TransferBuffer::TransferBuffer
TransferBuffer()
Constructs a null instance.
clan::TransferBuffer::get_data
void * get_data()
Retrieves a pointer to the mapped buffer.
clan::GraphicContext
Interface to drawing graphics.
Definition: graphic_context.h:257
clan::usage_dynamic_copy
Definition: buffer_usage.h:50
clan::BufferAccess
BufferAccess
Array Buffer access enum.
Definition: buffer_usage.h:54
clan::TransferBuffer
Transfer Buffer.
Definition: transfer_buffer.h:45
clan::TransferBuffer::get_provider
TransferBufferProvider * get_provider() const
Get Provider.