frame_buffer_provider.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 "../Render/frame_buffer.h"
35 #include <vector>
36 
37 namespace clan
38 {
41 
42 class RenderBuffer;
43 class Texture2D;
44 
46 class CL_API_DISPLAY FrameBufferProvider
47 {
50 
51 public:
52  virtual ~FrameBufferProvider() { return; }
53 
57 
58 public:
59 
60  virtual Size get_size() const = 0;
61 
62  virtual FrameBufferBindTarget get_bind_target() const = 0;
63 
67 
68 public:
69 
74  virtual void attach_color(int attachment_index, const RenderBuffer &render_buffer) = 0;
75 
81  virtual void attach_color(int attachment_index, const Texture1D &texture, int level) = 0;
82 
89  virtual void attach_color(int attachment_index, const Texture1DArray &texture, int array_index, int level) = 0;
90 
96  virtual void attach_color(int attachment_index, const Texture2D &texture, int level) = 0;
97 
104  virtual void attach_color(int attachment_index, const Texture2DArray &texture, int array_index, int level) = 0;
105 
112  virtual void attach_color(int attachment_index, const Texture3D &texture, int depth, int level) = 0;
113 
121  virtual void attach_color(int attachment_index, const TextureCube &texture, TextureSubtype subtype, int level) = 0;
122 
129  virtual void detach_color(int attachment_index) = 0;
130 
131  virtual void attach_stencil(const RenderBuffer &render_buffer) = 0;
132  virtual void attach_stencil(const Texture2D &texture, int level) = 0;
133  virtual void attach_stencil(const TextureCube &texture, TextureSubtype subtype, int level) = 0;
134  virtual void detach_stencil() = 0;
135 
136  virtual void attach_depth(const RenderBuffer &render_buffer) = 0;
137  virtual void attach_depth(const Texture2D &texture, int level) = 0;
138  virtual void attach_depth(const TextureCube &texture, TextureSubtype subtype, int level) = 0;
139  virtual void detach_depth() = 0;
140 
141  virtual void attach_depth_stencil(const RenderBuffer &render_buffer) = 0;
142  virtual void attach_depth_stencil(const Texture2D &texture, int level) = 0;
143  virtual void attach_depth_stencil(const TextureCube &texture, TextureSubtype subtype, int level) = 0;
144  virtual void detach_depth_stencil() = 0;
145 
146  virtual void set_bind_target(FrameBufferBindTarget target) = 0;
147 
151 
152 private:
154 };
155 
156 }
157 
3D texture object class.
Definition: texture_3d.h:42
1D texture array object class.
Definition: texture_1d_array.h:42
2D texture cube object class.
Definition: texture_cube.h:53
2D texture object class.
Definition: texture_2d.h:42
virtual ~FrameBufferProvider()
Definition: frame_buffer_provider.h:52
FrameBufferBindTarget
Framebuffer bind target.
Definition: frame_buffer.h:66
TextureSubtype
Texture Subtype.
Definition: frame_buffer.h:55
2D (width,height) size structure - Integer
Definition: size.h:157
Interface for implementing a FrameBuffer target.
Definition: frame_buffer_provider.h:46
1D texture object class.
Definition: texture_1d.h:42
2D texture array object class.
Definition: texture_2d_array.h:44
Render-buffer object class.
Definition: render_buffer.h:48