render_buffer.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 ** Harry Storbacka
28 */
29
30
31 #pragma once
32
33 #include <memory>
34 #include "texture.h"
35
36 namespace clan
37 {
40
41 class RenderBuffer;
42 class GraphicContext;
43 class RenderBufferProvider;
44 class RenderBuffer_Impl;
45
47 class RenderBuffer
48 {
51
52 public:
54 RenderBuffer();
55
62 RenderBuffer(GraphicContext &context, int width, int height, TextureFormat texture_format = tf_rgba8, int multisample_samples=0);
63
67
68 public:
70 bool is_null() const { return !impl; }
71
73 void throw_if_null() const;
74
76 const Size &get_size() const;
77
81 RenderBufferProvider *get_provider() const;
82
86
87 public:
89 bool operator==(const RenderBuffer &other) const;
90
94
95 private:
96 std::shared_ptr<RenderBuffer_Impl> impl;
98 };
99
100 }
101
clan::RenderBuffer::get_provider
RenderBufferProvider * get_provider() const
Get Provider.
clan
Definition: clanapp.h:35
clan::RenderBufferProvider
Interface for implementing a RenderBuffer target.
Definition: render_buffer_provider.h:43
clan::RenderBuffer::throw_if_null
void throw_if_null() const
Throw an exception if this object is invalid.
clan::RenderBuffer::get_size
const Size & get_size() const
Returns the render buffer size.
clan::RenderBuffer::RenderBuffer
RenderBuffer()
Constructs a null instance.
clan::TextureFormat
TextureFormat
Texture format.
Definition: texture_format.h:40
clan::GraphicContext
Interface to drawing graphics.
Definition: graphic_context.h:257
clan::RenderBuffer::is_null
bool is_null() const
Returns true if this object is invalid.
Definition: render_buffer.h:70
clan::Size
2D (width,height) size structure - Integer
Definition: size.h:156
clan::RenderBuffer::operator==
bool operator==(const RenderBuffer &other) const
Equality operator.
clan::tf_rgba8
Definition: texture_format.h:43
clan::RenderBuffer
Render-buffer object class.
Definition: render_buffer.h:47