GL Studio C++ Runtime API
frame_buffer_utility.h
Go to the documentation of this file.
1/// \file frame_buffer_utility.h
2/// \brief Utility for common frame buffer support
3///
4/// \par Copyright Information
5///
6/// Copyright (c) 2017 by The DiSTI Corporation.<br>
7/// 12249 Science Drive; Suite 300<br>
8/// Orlando, Florida 32826<br>
9/// USA<br>
10/// <br>
11/// All rights reserved.<br>
12///
13/// This Software contains proprietary trade secrets of DiSTI and may not be
14/// reproduced, in whole or part, in any form, or by any means of electronic,
15/// mechanical, or otherwise, without the written permission of DiSTI. Said
16/// permission may be derived through the purchase of applicable DiSTI product
17/// licenses which detail the distribution rights of this content and any
18/// Derivative Works based on this or other copyrighted DiSTI Software.
19///
20/// NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
21/// AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
22/// PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
23/// AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
24/// IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
25/// PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
26///
27/// LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
28/// IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
29/// INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
30/// DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
31/// INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
32/// INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
33/// OF SUCH DAMAGES. DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
34/// EXCEED FIVE DOLLARS (US$5.00).
35///
36/// The aforementioned terms and restrictions are governed by the laws of the
37/// State of Florida and the United States of America.
38
39#ifndef INCLUDED_FRAME_BUFFER_UTILITY_H
40#define INCLUDED_FRAME_BUFFER_UTILITY_H
41
42#include "gls_gl.h"
43
44#if defined( GLES ) || defined( __VXWORKS__ ) || defined( QNX )
45# ifndef DOXYGEN_IGNORE
46# define GL_DEPTH24_STENCIL8 GL_DEPTH24_STENCIL8_OES
47# define GL_DEPTH_STENCIL GL_DEPTH_STENCIL_OES
48# define GL_UNSIGNED_INT_24_8 GL_UNSIGNED_INT_24_8_OES
49# define GL_DEPTH_COMPONENT24 GL_DEPTH_COMPONENT24_OES
50
51# ifndef GLES20
52# define GL_FRAMEBUFFER GL_FRAMEBUFFER_OES
53# define GL_FRAMEBUFFER_COMPLETE GL_FRAMEBUFFER_COMPLETE_OES
54# define GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT_OES
55# define GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT_OES
56# define GL_FRAMEBUFFER_UNSUPPORTED GL_FRAMEBUFFER_UNSUPPORTED_OES
57# define GL_COLOR_ATTACHMENT0 GL_COLOR_ATTACHMENT0_OES
58
59# define GL_DEPTH_ATTACHMENT GL_DEPTH_ATTACHMENT_OES
60# define GL_FRAMEBUFFER_BINDING GL_FRAMEBUFFER_BINDING_OES
61# define GL_RENDERBUFFER GL_RENDERBUFFER_OES
62# define GL_DEPTH_COMPONENT16 GL_DEPTH_COMPONENT16_OES
63
64# define glCheckFramebufferStatus glCheckFramebufferStatusOES
65# define glBindFramebuffer glBindFramebufferOES
66# define glGenFramebuffers glGenFramebuffersOES
67# define glDeleteFramebuffers glDeleteFramebuffersOES
68# define glDeleteRenderbuffers glDeleteRenderbuffersOES
69# define glFramebufferTexture2D glFramebufferTexture2DOES
70# define glGenerateMipmap glGenerateMipmapOES
71# define glClearBufferfv glClearBufferfvOES
72# define glGenRenderbuffers glGenRenderbuffersOES
73# define glBindRenderbuffer glBindRenderbufferOES
74# define glRenderbufferStorage glRenderbufferStorageOES
75# define glFramebufferRenderbuffer glFramebufferRenderbufferOES
76# endif
77
78# endif
79#endif
80
81namespace disti
82{
83/// \details The FrameBufferUtility class. A platform independent way of determining if frame buffer objects are supported.
85{
86public:
87 /**
88 * Determine if the hardware supports Frame buffers.
89 * If it does, then the Frame buffer API is lazily instantiated
90 *
91 * \return True if frame buffers are supported
92 */
94
95 /**
96 * Check the completeness status of the GL_FRAMEBUFFER.
97 *
98 * \return true if the status of the GL_FRAMEBUFFER is GL_FRAMEBUFFER_COMPLETE.
99 */
101
102private:
103 static bool frameBufferSupportAvailable; /*< True if frame buffer support is available. */
104 static bool frameBufferSupportInitialized; /*< True if frame buffer support has been initialized. Allows lazily initialzation. */
105
106 /**
107 * Initialize frame buffer support.
108 */
109 static void initializeFrameBufferSupport();
110
111 // Disallow, this class is designed to be a utiltiy class.
113};
114} // namespace disti
115
116#endif // INCLUDED_FRAME_BUFFER_UTILITY_H
Definition: frame_buffer_utility.h:85
static bool frameBuffersAreSupported()
static bool checkFrameBufferStatus()
The gls_gl.
Definition: bmpimage.h:46