transfer_buffer_provider.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 "../Render/transfer_buffer.h"
33
34 namespace clan
35 {
38
39 class GraphicContext;
40
42 class TransferBufferProvider
43 {
46 public:
47 virtual ~TransferBufferProvider() { }
48
50 virtual void create(int size, BufferUsage usage) = 0;
51
57 virtual void create(void *data, int size, BufferUsage usage) = 0;
59
62 public:
64 virtual void *get_data() = 0;
66
69 public:
71 virtual void lock(GraphicContext &gc, BufferAccess access) = 0;
72
74 virtual void unlock() = 0;
75
77 virtual void upload_data(GraphicContext &gc, int offset, const void *data, int size) = 0;
79
82 private:
84 };
85
86 }
87
clan
Definition: clanapp.h:35
clan::TransferBufferProvider::upload_data
virtual void upload_data(GraphicContext &gc, int offset, const void *data, int size)=0
Uploads data to buffer.
clan::TransferBufferProvider::~TransferBufferProvider
virtual ~TransferBufferProvider()
Definition: transfer_buffer_provider.h:47
clan::TransferBufferProvider::lock
virtual void lock(GraphicContext &gc, BufferAccess access)=0
Maps buffer into system memory.
clan::TransferBufferProvider
Transfer Buffer provider.
Definition: transfer_buffer_provider.h:42
clan::TransferBufferProvider::create
virtual void create(int size, BufferUsage usage)=0
Constructs a array buffer.
clan::BufferUsage
BufferUsage
Array Buffer usage enum.
Definition: buffer_usage.h:40
clan::GraphicContext
Interface to drawing graphics.
Definition: graphic_context.h:257
clan::TransferBufferProvider::unlock
virtual void unlock()=0
Unmaps buffer.
clan::TransferBufferProvider::get_data
virtual void * get_data()=0
Retrieves a pointer to the mapped buffer.
clan::BufferAccess
BufferAccess
Array Buffer access enum.
Definition: buffer_usage.h:54