pixel_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 ** Mark Page
28 */
29
30
31 #pragma once
32
33 #include "../Render/element_array_buffer.h"
34 #include "../Image/pixel_buffer.h"
35
36 namespace clan
37 {
40
42 class PixelBufferProvider
43 {
46
47 public:
48 virtual ~PixelBufferProvider() { }
49
58 virtual void create(const void *data, const Size &new_size, PixelBufferDirection direction, TextureFormat new_format, BufferUsage usage) = 0;
59
63
64 public:
66 virtual void *get_data() = 0;
67
69 virtual int get_pitch() const = 0;
70
71 virtual Size get_size() const = 0;
72
74 virtual bool is_gpu() const = 0;
75
77 virtual TextureFormat get_format() const = 0;
78
79
83
84 public:
86 virtual void lock(GraphicContext &gc, BufferAccess access) = 0;
87
89 virtual void unlock() = 0;
90
92 virtual void upload_data(GraphicContext &gc, const Rect &dest_rect, const void *data) = 0;
93
97
98 private:
100 };
101
102 }
103
clan::PixelBufferProvider::upload_data
virtual void upload_data(GraphicContext &gc, const Rect &dest_rect, const void *data)=0
Uploads data to buffer.
clan
Definition: clanapp.h:35
clan::PixelBufferProvider::unlock
virtual void unlock()=0
Unmaps element buffer.
clan::PixelBufferProvider::get_data
virtual void * get_data()=0
Retrieves a pointer to the mapped buffer.
clan::PixelBufferProvider
Element Array Buffer provider.
Definition: pixel_buffer_provider.h:42
clan::PixelBufferProvider::is_gpu
virtual bool is_gpu() const =0
Returns true if this pixel buffer is a GPU based one.
clan::PixelBufferProvider::~PixelBufferProvider
virtual ~PixelBufferProvider()
Definition: pixel_buffer_provider.h:48
clan::PixelBufferDirection
PixelBufferDirection
Pixel buffer prefered direction.
Definition: pixel_buffer.h:58
clan::Rect
2D (left,top,right,bottom) rectangle structure - Integer
Definition: rect.h:470
clan::PixelBufferProvider::get_pitch
virtual int get_pitch() const =0
Retrieves the pitch of the mapped buffer. Use this after get_data()
clan::BufferUsage
BufferUsage
Array Buffer usage enum.
Definition: buffer_usage.h:40
clan::PixelBufferProvider::get_size
virtual Size get_size() const =0
clan::PixelBufferProvider::get_format
virtual TextureFormat get_format() const =0
Returns the pixel format.
clan::TextureFormat
TextureFormat
Texture format.
Definition: texture_format.h:40
clan::PixelBufferProvider::lock
virtual void lock(GraphicContext &gc, BufferAccess access)=0
Maps buffer into system memory.
clan::GraphicContext
Interface to drawing graphics.
Definition: graphic_context.h:257
clan::BufferAccess
BufferAccess
Array Buffer access enum.
Definition: buffer_usage.h:54
clan::Size
2D (width,height) size structure - Integer
Definition: size.h:156
clan::PixelBufferProvider::create
virtual void create(const void *data, const Size &new_size, PixelBufferDirection direction, TextureFormat new_format, BufferUsage usage)=0
Create.