pixel_buffer_provider.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 ** Mark Page
28 */
29 
30 #pragma once
31 
32 #include "../Render/element_array_buffer.h"
33 #include "../Image/pixel_buffer.h"
34 
35 namespace clan
36 {
39 
42  {
43  public:
44  virtual ~PixelBufferProvider() { }
45 
54  virtual void create(const void *data, const Size &new_size, PixelBufferDirection direction, TextureFormat new_format, BufferUsage usage) = 0;
55 
57  virtual void *get_data() = 0;
58 
60  virtual int get_pitch() const = 0;
61 
62  virtual Size get_size() const = 0;
63 
65  virtual bool is_gpu() const = 0;
66 
68  virtual TextureFormat get_format() const = 0;
69 
71  virtual void lock(GraphicContext &gc, BufferAccess access) = 0;
72 
74  virtual void unlock() = 0;
75 
77  virtual void upload_data(GraphicContext &gc, const Rect &dest_rect, const void *data) = 0;
78  };
79 
81 }
Definition: clanapp.h:35
virtual int get_pitch() const =0
Retrieves the pitch of the mapped buffer. Use this after get_data()
Element Array Buffer provider.
Definition: pixel_buffer_provider.h:41
virtual void unlock()=0
Unmaps element buffer.
PixelBufferDirection
Pixel buffer prefered direction.
Definition: pixel_buffer.h:57
2D (left,top,right,bottom) rectangle structure - Integer
Definition: rect.h:488
virtual void * get_data()=0
Retrieves a pointer to the mapped buffer.
virtual bool is_gpu() const =0
Returns true if this pixel buffer is a GPU based one.
BufferUsage
Array Buffer usage enum.
Definition: buffer_usage.h:38
virtual void upload_data(GraphicContext &gc, const Rect &dest_rect, const void *data)=0
Uploads data to buffer.
TextureFormat
Texture format.
Definition: texture_format.h:38
virtual void create(const void *data, const Size &new_size, PixelBufferDirection direction, TextureFormat new_format, BufferUsage usage)=0
Create.
Interface to drawing graphics.
Definition: graphic_context.h:256
BufferAccess
Array Buffer access enum.
Definition: buffer_usage.h:52
virtual ~PixelBufferProvider()
Definition: pixel_buffer_provider.h:44
2D (width,height) size structure - Integer
Definition: size.h:170
virtual TextureFormat get_format() const =0
Returns the pixel format.
virtual void lock(GraphicContext &gc, BufferAccess access)=0
Maps buffer into system memory.
virtual Size get_size() const =0