ClanLib  2.3.7
frame_buffer.h
Go to the documentation of this file.
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2011 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 
32 
33 #pragma once
34 
35 #include "../api_display.h"
36 #include "../../Core/System/sharedptr.h"
37 
38 class CL_Size;
39 class CL_Rect;
40 class CL_Texture;
41 class CL_RenderBuffer;
42 class CL_GraphicContext;
44 class CL_FrameBuffer_Impl;
45 
50 {
57 };
58 
63 {
66 };
67 
72 {
75 public:
78 
85 
89 public:
91  bool is_null() const { return !impl; }
92 
94  void throw_if_null() const;
95 
99  CL_FrameBufferProvider *get_provider() const;
100 
104  CL_Size get_size() const;
105 
109  CL_FrameBufferBindTarget get_bind_target() const;
110 
114 public:
116  bool operator==(const CL_FrameBuffer &other) const;
117 
122  void attach_color_buffer(int attachment_index, const CL_RenderBuffer &render_buffer);
123 
128  void detach_color_buffer(int attachment_index, const CL_RenderBuffer &render_buffer);
129 
136  void attach_color_buffer(int attachment_index, const CL_Texture &texture, int level = 0, int zoffset = 0);
137 
145  void attach_color_buffer(int attachment_index, const CL_Texture &texture, CL_TextureSubtype subtype, int level = 0, int zoffset = 0);
146 
153  void detach_color_buffer(int attachment_index, const CL_Texture &texture, int level = 0, int zoffset = 0);
154 
155  void attach_stencil_buffer(const CL_RenderBuffer &render_buffer);
156  void detach_stencil_buffer(const CL_RenderBuffer &render_buffer);
157  void attach_stencil_buffer(const CL_Texture &texture, int level = 0, int zoffset = 0);
158  void attach_stencil_buffer(const CL_Texture &texture, CL_TextureSubtype subtype, int level = 0, int zoffset = 0);
159  void detach_stencil_buffer(const CL_Texture &texture, int level = 0, int zoffset = 0);
160 
161  void attach_depth_buffer(const CL_RenderBuffer &render_buffer);
162  void detach_depth_buffer(const CL_RenderBuffer &render_buffer);
163  void attach_depth_buffer(const CL_Texture &texture, int level = 0, int zoffset = 0);
164  void attach_depth_buffer(const CL_Texture &texture, CL_TextureSubtype subtype, int level = 0, int zoffset = 0);
165  void detach_depth_buffer(const CL_Texture &texture, int level = 0, int zoffset = 0);
166 
167  void attach_depth_stencil_buffer(const CL_RenderBuffer &render_buffer);
168  void detach_depth_stencil_buffer(const CL_RenderBuffer &render_buffer);
169  void attach_depth_stencil_buffer(const CL_Texture &texture, int level = 0, int zoffset = 0);
170  void attach_depth_stencil_buffer(const CL_Texture &texture, CL_TextureSubtype subtype, int level = 0, int zoffset = 0);
171  void detach_depth_stencil_buffer(const CL_Texture &texture, int level = 0, int zoffset = 0);
172 
178  void set_bind_target(CL_FrameBufferBindTarget target);
179 
183 private:
184  CL_SharedPtr<CL_FrameBuffer_Impl> impl;
186 };
187