gls_include.h

Go to the documentation of this file.

/*! \file
  \brief  A file for all GL Studio files to include.
 
  \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_GLS_INCLUDE_H
#define INCLUDED_GLS_INCLUDE_H
 
/// Macro denoting which functions should be visible from the runtime library.
#if defined( WIN32 ) && ( defined( GLS_DLL ) || defined( GLS_EXPORT_LIBRARY ) || defined( GLS_IMPORT_LIBRARY ) )
#    if defined( GLS_LIBRARY ) || defined( GLS_EXPORT_LIBRARY )
#        define GLS_EXPORT __declspec( dllexport )
#    else /* GLS_DLL || GLS_IMPORT_LIBRARY */
#        define GLS_EXPORT __declspec( dllimport )
#    endif /* GLS_LIBRARY */
#else
#    define GLS_EXPORT
#endif /* GLS_DLL && WIN32 */
 
/// Macro denoting which functions should be visible from the editor.
#if defined( WIN32 ) && ( defined( GLS_EXPORT_EDITOR ) || defined( GLS_IMPORT_EDITOR ) )
#    if defined( GLS_EXPORT_EDITOR )
#        define GLS_EDITOR __declspec( dllexport )
#    else
#        define GLS_EDITOR __declspec( dllimport )
#    endif /* GLS_EXPORT_EDITOR */
#else
#    define GLS_EDITOR
#endif
 
/// Macro denoting which functions should be visible from packages.
#if defined( WIN32 ) && ( defined( GLS_EXPORT_PACKAGES ) || defined( GLS_IMPORT_PACKAGES ) )
#    if defined( GLS_EXPORT_PACKAGES )
#        define GLS_EXPORT_PACKAGE __declspec( dllexport )
#    else
#        define GLS_EXPORT_PACKAGE __declspec( dllimport )
#    endif /* GLS_EXPORT_PACKAGES */
#else
#    define GLS_EXPORT_PACKAGE
#endif
 
#if defined( GLS_EXPORT_EDITOR ) || defined( GLS_IMPORT_EDITOR )
#    define GLS_EDITOR_CODE
#endif
 
/// Macro to wrap code that should be present on Windows only.
#ifdef WIN32
#    define IF_WIN32( win32 ) ( win32 )
#else
#    define IF_WIN32( win32 )
#endif
 
/// Macro to wrap code specific to Windows, and an alternate implementation for other platforms.
#ifdef WIN32
#    define IF_WIN32_ELSE( win32, notWin32 ) ( win32 )
#else
#    define IF_WIN32_ELSE( win32, notWin32 ) ( notWin32 )
#endif
 
/// Macro to wrap code that should be present on all platforms except Windows.
#ifdef WIN32
#    define IF_NOT_WIN32( notWin32 )
#else
#    define IF_NOT_WIN32( notWin32 ) ( notWin32 )
#endif
 
/// Macro to wrap code that should be present on macOS only.
#ifdef __APPLE__
#    define IF_APPLE( apple ) ( apple )
#else
#    define IF_APPLE( apple )
#endif
 
/// Macro to wrap code specific to macOS, and an alternate implementation for other platforms.
#ifdef __APPLE__
#    define IF_APPLE_ELSE( apple, notApple ) ( apple )
#else
#    define IF_APPLE_ELSE( apple, notApple ) ( notApple )
#endif
 
/// Macro to wrap code that should be present on all platforms except macOS.
#ifdef __APPLE__
#    define IF_NOT_APPLE( notApple )
#else
#    define IF_NOT_APPLE( notApple ) ( notApple )
#endif
 
/// Macro to wrap code that should be present on Linux only.
#ifdef LINUX
#    define IF_LINUX( linux ) ( linux )
#else
#    define IF_LINUX( linux )
#endif
 
/// Macro to wrap code specific to Linux, and an alternate implementation for other platforms.
#ifdef LINUX
#    define IF_LINUX_ELSE( linux, notLinux ) ( linux )
#else
#    define IF_LINUX_ELSE( linux, notLinux ) ( notLinux )
#endif
 
/// Macro to wrap code that should be present on all platforms except Linux.
#ifdef LINUX
#    define IF_NOT_LINUX( notLinux )
#else
#    define IF_NOT_LINUX( notLinux ) ( notLinux )
#endif
 
/// Macro to wrap code that should only be present in ES.
/// \code{.cpp}
/// IF_GLES( SetShader() ); // Calls this function on OpenGL ES only.
/// \endcode
#ifdef GLES
#    define IF_GLES( esCode ) ( esCode )
#else
#    define IF_GLES( esCode )
#endif
 
/// Macro to wrap code that should not be present in ES (Desktop).
/// \code{.cpp}
/// IF_NOT_GLES( DesktopFileChanged() ); // Calls this function on Desktop OpenGL only.
/// \endcode
#ifdef GLES
#    define IF_NOT_GLES( nonEsCode )
#else
#    define IF_NOT_GLES( nonEsCode ) ( nonEsCode )
#endif
 
/// Macro to wrap code specific to ES, and an alternate implementation for Desktop.
/// \code{.cpp}
/// auto fov = IF_GLES_ELSE( esBufferFOV, desktopFOV ); // Selects an expression to be assigned to the variable fov.
/// \endcode
#ifdef GLES
#    define IF_GLES_ELSE( esCode, nonEsCode ) ( esCode )
#else
#    define IF_GLES_ELSE( esCode, nonEsCode ) ( nonEsCode )
#endif
 
/// Macro to wrap a parameter type specific to ES, and an alternate type for Desktop.
/// This is like IF_GLES_ELSE, but does not add parenthesis.
/// \code{.cpp}
/// void MyFunc( IF_GLES_ELSE_TYPE( float, double ) );  // Selects the function parameter's type.
/// \endcode
#ifdef GLES
#    define IF_GLES_ELSE_TYPE( esType, nonEsType ) esType
#else
#    define IF_GLES_ELSE_TYPE( esType, nonEsType ) nonEsType
#endif
 
/// Macro to wrap code that should only be present in Debug builds.
#ifdef NDEBUG
#    define IF_DEBUG( notRelease )
#else
#    define IF_DEBUG( notRelease ) ( notRelease )
#endif
 
/// Macro to wrap code that should only be present in Release builds.
#ifdef NDEBUG
#    define IF_RELEASE( release ) ( release )
#else
#    define IF_RELEASE( release )
#endif
 
/// Macro to wrap code specific to Release builds, with alternative code for Debug.
#ifdef NDEBUG
#    define IF_RELEASE_ELSE( release, notRelease ) ( release )
#else
#    define IF_RELEASE_ELSE( release, notRelease ) ( notRelease )
#endif
 
/// Macro for checking bitness (safer macros borrowed from https://www.fluentcpp.com/2019/05/28/better-macros-better-flags/)
#define DISTI_IS_BITNESS( X ) DISTI_IS_BITNESS_PRIVATE_DEFINITION_##X()
 
/// Bitness checks borrowed from https://stackoverflow.com/a/12338526/201787
#if _WIN64 || ( __GNUC__ && ( __x86_64__ || __aarch64__ ) )
#    define DISTI_IS_BITNESS_PRIVATE_DEFINITION_64() 1
#    define DISTI_IS_BITNESS_PRIVATE_DEFINITION_32() 0
#elif _WIN32 || __GNUC__
#    define DISTI_IS_BITNESS_PRIVATE_DEFINITION_64() 0
#    define DISTI_IS_BITNESS_PRIVATE_DEFINITION_32() 1
#else
#    error "Unknown bitness!"
#endif
#endif