render_buffer.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 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 ** Harry Storbacka
28 */
29 
30 
31 #pragma once
32 
33 #include "../api_display.h"
34 #include <memory>
35 #include "texture.h"
36 
37 namespace clan
38 {
41 
42 class RenderBuffer;
43 class GraphicContext;
44 class RenderBufferProvider;
45 class RenderBuffer_Impl;
46 
48 class CL_API_DISPLAY RenderBuffer
49 {
52 
53 public:
55  RenderBuffer();
56 
63  RenderBuffer(GraphicContext &context, int width, int height, TextureFormat texture_format = tf_rgba8, int multisample_samples=0);
64 
68 
69 public:
71  bool is_null() const { return !impl; }
72 
74  void throw_if_null() const;
75 
77  const Size &get_size() const;
78 
82  RenderBufferProvider *get_provider() const;
83 
87 
88 public:
90  bool operator==(const RenderBuffer &other) const;
91 
95 
96 private:
97  std::shared_ptr<RenderBuffer_Impl> impl;
99 };
100 
101 }
102 
Interface for implementing a RenderBuffer target.
Definition: render_buffer_provider.h:44
TextureFormat
Texture format.
Definition: texture_format.h:41
Interface to drawing graphics.
Definition: graphic_context.h:257
bool is_null() const
Returns true if this object is invalid.
Definition: render_buffer.h:71
2D (width,height) size structure - Integer
Definition: size.h:157
Definition: texture_format.h:44
Render-buffer object class.
Definition: render_buffer.h:48