frame_buffer_utility.h

Go to the documentation of this file.

/*! \file
  \brief  Utility for common frame buffer support

  \par Copyright Information

  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/

#ifndef INCLUDED_FRAME_BUFFER_UTILITY_H
#define INCLUDED_FRAME_BUFFER_UTILITY_H

#include "gls_gl.h"

#if defined( __APPLE__ ) || ( defined( GLES ) && defined( LINUX ) ) || defined( __VXWORKS__ ) || defined( QNX )

#    define GL_DEPTH24_STENCIL8 GL_DEPTH24_STENCIL8_OES
#    define GL_DEPTH_STENCIL GL_DEPTH_STENCIL_OES
#    define GL_UNSIGNED_INT_24_8 GL_UNSIGNED_INT_24_8_OES
#    define GL_DEPTH_COMPONENT24 GL_DEPTH_COMPONENT24_OES

#    ifndef GLES20
#        define GL_FRAMEBUFFER GL_FRAMEBUFFER_OES
#        define GL_FRAMEBUFFER_COMPLETE GL_FRAMEBUFFER_COMPLETE_OES
#        define GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT_OES
#        define GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT_OES
#        define GL_FRAMEBUFFER_UNSUPPORTED GL_FRAMEBUFFER_UNSUPPORTED_OES
#        define GL_COLOR_ATTACHMENT0 GL_COLOR_ATTACHMENT0_OES

#        define GL_DEPTH_ATTACHMENT GL_DEPTH_ATTACHMENT_OES
#        define GL_FRAMEBUFFER_BINDING GL_FRAMEBUFFER_BINDING_OES
#        define GL_RENDERBUFFER GL_RENDERBUFFER_OES
#        define GL_DEPTH_COMPONENT16 GL_DEPTH_COMPONENT16_OES

#        define glCheckFramebufferStatus glCheckFramebufferStatusOES
#        define glBindFramebuffer glBindFramebufferOES
#        define glGenFramebuffers glGenFramebuffersOES
#        define glDeleteFramebuffers glDeleteFramebuffersOES
#        define glDeleteRenderbuffers glDeleteRenderbuffersOES
#        define glFramebufferTexture2D glFramebufferTexture2DOES
#        define glGenerateMipmap glGenerateMipmapOES
#        define glClearBufferfv glClearBufferfvOES
#        define glGenRenderbuffers glGenRenderbuffersOES
#        define glBindRenderbuffer glBindRenderbufferOES
#        define glRenderbufferStorage glRenderbufferStorageOES
#        define glFramebufferRenderbuffer glFramebufferRenderbufferOES
#    endif

#endif

namespace disti
{
class FrameBufferUtility
{
public:
    /** 
         * Determine if the hardware supports Frame buffers.  
         * If it does, then the Frame buffer API is lazily instantiated
         *
         * \return True if frame buffers are supported
         */
    static bool frameBuffersAreSupported();

    /**
         * Check the completeness status of the GL_FRAMEBUFFER.
         *
         * \return true if the status of the GL_FRAMEBUFFER is GL_FRAMEBUFFER_COMPLETE.
         */
    static bool checkFrameBufferStatus();

private:
    static bool frameBufferSupportAvailable;   /*<  True if frame buffer support is available. */
    static bool frameBufferSupportInitialized; /*< True if frame buffer support has been initialized. Allows lazily initialzation. */

    /**
         * Initialize frame buffer support.
         */
    static void initializeFrameBufferSupport();

    // Disallow, this class is designed to be a utiltiy class.
    FrameBufferUtility();
};
} // namespace disti

#endif // INCLUDED_FRAME_BUFFER_UTILITY_H