Geogram  Version 1.9.1
A programming library of geometric algorithms
frame_buffer_object.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2000-2022 Inria
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  * * Neither the name of the ALICE Project-Team nor the names of its
14  * contributors may be used to endorse or promote products derived from this
15  * software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  *
29  * Contact: Bruno Levy
30  *
31  * https://www.inria.fr/fr/bruno-levy
32  *
33  * Inria,
34  * Domaine de Voluceau,
35  * 78150 Le Chesnay - Rocquencourt
36  * FRANCE
37  *
38  */
39 
40 #ifndef H_GEOGRAM_GFX_BASIC_FBO_H
41 #define H_GEOGRAM_GFX_BASIC_FBO_H
42 
44 
50 namespace GEO {
51 
56  public:
62 
68 
77  bool initialize(
78  index_t width_in,
79  index_t height_in,
80  bool with_depth_buffer,
81  GLint internal_storage,
82  bool mipmaps = false
83  );
84 
90  void resize(index_t new_width, index_t new_height);
91 
96 
103 
109 
110 
118 
126  void unbind();
127 
128 
134  bool initialized() {
135  return (frame_buffer_id != 0);
136  }
137 
142 
147 
151  GLuint offscreen_id;
152 
157 
162 
167 
173  };
174 
175 }
176 
177 #endif
An OpenGL frame buffer object.
void bind_as_framebuffer()
Binds this framebuffer as the output of OpenGL rendering.
~FrameBufferObject()
FrameBufferObject destructor.
GLuint depth_buffer_id
The id of the texture used for the depth buffer.
GLuint previous_frame_buffer_id
The default frame buffer object associated with the Opengl context.
GLuint frame_buffer_id
The id of the frame buffer.
FrameBufferObject()
FrameBufferObject constructor.
index_t width
The width of this frame buffer, in pixels.
GLuint offscreen_id
The id of the texture used for the color buffer.
GLint internal_storage
The OpenGL internal storage for the color buffer.
void bind_depth_buffer_as_texture()
Binds the depth buffer of this frame buffer as the input 2D texture.
void resize(index_t new_width, index_t new_height)
Resizes the FrameBuferObject.
void unbind()
Unbind this framebuffer.
void bind_as_texture()
Binds this frame buffer as the input 2D texture.
bool initialized()
Tests whether this FrameBufferObject is initialized.
index_t height
The height of this frame buffer, in pixels.
bool is_bound_as_framebuffer() const
Tests whether this framebuffer is bound as a framebuffer.
bool initialize(index_t width_in, index_t height_in, bool with_depth_buffer, GLint internal_storage, bool mipmaps=false)
Initializes the FrameBufferObject.
#define GEOGRAM_GFX_API
Linkage declaration for geogram symbols.
Definition: defs.h:55
Common include file, providing basic definitions. Should be included before anything else by all head...
Global Vorpaline namespace.
Definition: basic.h:55
geo_index_t index_t
The type for storing and manipulating indices.
Definition: numeric.h:329