GL Studio C++ Runtime API
gls_include.h
Go to the documentation of this file.
1 /*! \file
2  \brief A file for all GL Studio files to include.
3 
4  \par Copyright Information
5 
6  Copyright (c) 2017 by The DiSTI Corporation.<br>
7  11301 Corporate Blvd; Suite 100<br>
8  Orlando, Florida 32817<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 */
40 
41 #ifndef INCLUDED_GLS_INCLUDE_H
42 #define INCLUDED_GLS_INCLUDE_H
43 
44 #if defined( WIN32 ) && ( defined( GLS_DLL ) || defined( GLS_EXPORT_LIBRARY ) || defined( GLS_IMPORT_LIBRARY ) )
45 # if defined( GLS_LIBRARY ) || defined( GLS_EXPORT_LIBRARY )
46 # define GLS_EXPORT __declspec( dllexport )
47 # else /* GLS_DLL || GLS_IMPORT_LIBRARY */
48 # define GLS_EXPORT __declspec( dllimport )
49 # endif /* GLS_LIBRARY */
50 #else
51 # define GLS_EXPORT
52 #endif /* GLS_DLL && WIN32 */
53 
54 // Define imports and exports for GLS_EDITOR
55 #if defined( WIN32 ) && ( defined( GLS_EXPORT_EDITOR ) || defined( GLS_IMPORT_EDITOR ) )
56 # if defined( GLS_EXPORT_EDITOR )
57 # define GLS_EDITOR __declspec( dllexport )
58 # else
59 # define GLS_EDITOR __declspec( dllimport )
60 # endif /* GLS_EXPORT_EDITOR */
61 #else
62 # define GLS_EDITOR
63 #endif
64 
65 // Define imports and exports for Packages
66 #if defined( WIN32 ) && ( defined( GLS_EXPORT_PACKAGES ) || defined( GLS_IMPORT_PACKAGES ) )
67 # if defined( GLS_EXPORT_PACKAGES )
68 # define GLS_EXPORT_PACKAGE __declspec( dllexport )
69 # else
70 # define GLS_EXPORT_PACKAGE __declspec( dllimport )
71 # endif /* GLS_EXPORT_PACKAGES */
72 #else
73 # define GLS_EXPORT_PACKAGE
74 #endif
75 
76 #if defined( GLS_EXPORT_EDITOR ) || defined( GLS_IMPORT_EDITOR )
77 # define GLS_EDITOR_CODE
78 #endif
79 
80 // Platform macros
81 #ifdef WIN32
82 # define IF_WIN32( win32 ) ( win32 )
83 # define IF_WIN32_ELSE( win32, notWin32 ) ( win32 )
84 # define IF_NOT_WIN32( notWin32 )
85 #else
86 # define IF_WIN32( win32 )
87 # define IF_WIN32_ELSE( win32, notWin32 ) ( notWin32 )
88 # define IF_NOT_WIN32( notWin32 ) ( notWin32 )
89 #endif
90 
91 // Emit code depending on whether we're in an OpenGL ES build or not.
92 // Examples:
93 // IF_GLES( SetShader() ); // Calls this function on OpenGL ES only
94 // IF_NOT_GLES( DesktopFileChanged() ); // Calls this function on Desktop OpenGL only
95 // auto fov = IF_GLES_ELSE( esBufferFOV, desktopFOV ); // Selects an expression to be assigned to the variable fov
96 // void MyFunc( IF_GLES_ELSE_TYPE( float, double ) ); // Selects the function parameter's type
97 #ifdef GLES
98 # define IF_GLES( esCode ) ( esCode )
99 # define IF_NOT_GLES( nonEsCode )
100 # define IF_GLES_ELSE( esCode, nonEsCode ) ( esCode )
101 # define IF_GLES_ELSE_TYPE( esType, nonEsType ) esType
102 #else
103 # define IF_GLES( esCode )
104 # define IF_NOT_GLES( nonEsCode ) ( nonEsCode )
105 # define IF_GLES_ELSE( esCode, nonEsCode ) ( nonEsCode )
106 # define IF_GLES_ELSE_TYPE( esType, nonEsType ) nonEsType
107 #endif
108 
109 // Debug/release mode macros
110 #ifdef NDEBUG
111 # define IF_DEBUG( notRelease )
112 # define IF_RELEASE( release ) ( release )
113 # define IF_RELEASE_ELSE( release, notRelease ) ( release )
114 #else
115 # define IF_DEBUG( notRelease ) ( notRelease )
116 # define IF_RELEASE( release )
117 # define IF_RELEASE_ELSE( release, notRelease ) ( notRelease )
118 #endif
119 
120 // Macro for checking bitness (safer macros borrowed from https://www.fluentcpp.com/2019/05/28/better-macros-better-flags/)
121 #define DISTI_IS_BITNESS( X ) DISTI_IS_BITNESS_PRIVATE_DEFINITION_##X()
122 
123 // Bitness checks borrowed from https://stackoverflow.com/a/12338526/201787
124 #if _WIN64 || ( __GNUC__ && __x86_64__ )
125 # define DISTI_IS_BITNESS_PRIVATE_DEFINITION_64() 1
126 # define DISTI_IS_BITNESS_PRIVATE_DEFINITION_32() 0
127 #elif _WIN32 || __GNUC__
128 # define DISTI_IS_BITNESS_PRIVATE_DEFINITION_64() 0
129 # define DISTI_IS_BITNESS_PRIVATE_DEFINITION_32() 1
130 #else
131 # error "Unknown bitness!"
132 #endif
133 #endif