transfer_buffer.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2016 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 TransferBufferProvider;
41  class TransferBuffer_Impl;
42 
45  {
46  public:
49 
56 
63  TransferBuffer(GraphicContext &gc, const void *data, int size, BufferUsage usage = usage_dynamic_copy);
64 
65  virtual ~TransferBuffer();
66 
68  bool is_null() const { return !impl; }
69  explicit operator bool() const { return bool(impl); }
70 
72  void throw_if_null() const;
73 
75  void *get_data();
76 
81 
83  bool operator==(const TransferBuffer &other) const;
84 
86  void lock(GraphicContext &gc, BufferAccess access);
87 
89  void unlock();
90 
92  void upload_data(GraphicContext &gc, int offset, const void *data, int size);
93 
94  private:
95  std::shared_ptr<TransferBuffer_Impl> impl;
96  };
97 
99 }
Definition: clanapp.h:35
void throw_if_null() const
Throw an exception if this object is invalid.
Transfer Buffer provider.
Definition: transfer_buffer_provider.h:41
void unlock()
Unmaps buffer.
BufferUsage
Array Buffer usage enum.
Definition: buffer_usage.h:38
TransferBuffer()
Constructs a null instance.
bool operator==(const TransferBuffer &other) const
Handle comparison operator.
void lock(GraphicContext &gc, BufferAccess access)
Maps buffer into system memory.
Interface to drawing graphics.
Definition: graphic_context.h:256
void * get_data()
Retrieves a pointer to the mapped buffer.
Definition: buffer_usage.h:48
TransferBufferProvider * get_provider() const
Get Provider.
BufferAccess
Array Buffer access enum.
Definition: buffer_usage.h:52
Transfer Buffer.
Definition: transfer_buffer.h:44
void upload_data(GraphicContext &gc, int offset, const void *data, int size)
Uploads data to transfer buffer.
virtual ~TransferBuffer()
bool is_null() const
Returns true if this object is invalid.
Definition: transfer_buffer.h:68