include/assimp/version.h

0001 /*
0002 ---------------------------------------------------------------------------
0003 Open Asset Import Library (assimp)
0004 ---------------------------------------------------------------------------
0005
0006 Copyright (c) 2006-2024, assimp team
0007
0008 All rights reserved.
0009
0010 Redistribution and use of this software in source and binary forms,
0011 with or without modification, are permitted provided that the following
0012 conditions are met:
0013
0014 * Redistributions of source code must retain the above
0015   copyright notice, this list of conditions and the
0016   following disclaimer.
0017
0018 * Redistributions in binary form must reproduce the above
0019   copyright notice, this list of conditions and the
0020   following disclaimer in the documentation and/or other
0021   materials provided with the distribution.
0022
0023 * Neither the name of the assimp team, nor the names of its
0024   contributors may be used to endorse or promote products
0025   derived from this software without specific prior
0026   written permission of the assimp team.
0027
0028 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0029 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0030 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0031 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0032 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0033 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0034 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0035 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0036 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0037 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0038 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0039 ---------------------------------------------------------------------------
0040 */
0041
0042 /** @file  version.h
0043  *  @brief Functions to query the version of the Assimp runtime, check
0044  *    compile flags, ...
0045  */
0046 #pragma once
0047 #ifndef AI_VERSION_H_INC
0048 #define AI_VERSION_H_INC
0049
0050 #include <assimp/defs.h>
0051
0052 #ifdef __cplusplus
0053 extern "C" {
0054 #endif
0055
0056 // ---------------------------------------------------------------------------
0057 /** @brief Returns a string with legal copyright and licensing information
0058  *  about Assimp. The string may include multiple lines.
0059  *  @return Pointer to static string.
0060  */
0061 ASSIMP_API const char*  aiGetLegalString  (void);
0062
0063 // ---------------------------------------------------------------------------
0064 /** @brief Returns the current patch version number of Assimp.
0065  *  @return Patch version of the Assimp runtime the application was
0066  *    linked/built against
0067  */
0068 ASSIMP_API unsigned int aiGetVersionPatch(void);
0069
0070 // ---------------------------------------------------------------------------
0071 /** @brief Returns the current minor version number of Assimp.
0072  *  @return Minor version of the Assimp runtime the application was
0073  *    linked/built against
0074  */
0075 ASSIMP_API unsigned int aiGetVersionMinor (void);
0076
0077 // ---------------------------------------------------------------------------
0078 /** @brief Returns the current major version number of Assimp.
0079  *  @return Major version of the Assimp runtime the application was
0080  *    linked/built against
0081  */
0082 ASSIMP_API unsigned int aiGetVersionMajor (void);
0083
0084 // ---------------------------------------------------------------------------
0085 /** @brief Returns the repository revision of the Assimp runtime.
0086  *  @return SVN Repository revision number of the Assimp runtime the
0087  *          application was linked/built against.
0088  */
0089 ASSIMP_API unsigned int aiGetVersionRevision (void);
0090
0091 // ---------------------------------------------------------------------------
0092 /** @brief Returns the branch-name of the Assimp runtime.
0093  *  @return The current branch name.
0094  */
0095 ASSIMP_API const char *aiGetBranchName();
0096
0097 //! Assimp was compiled as a shared object (Windows: DLL)
0098 #define ASSIMP_CFLAGS_SHARED  0x1
0099 //! Assimp was compiled against STLport
0100 #define ASSIMP_CFLAGS_STLPORT 0x2
0101 //! Assimp was compiled as a debug build
0102 #define ASSIMP_CFLAGS_DEBUG   0x4
0103
0104 //! Assimp was compiled with ASSIMP_BUILD_BOOST_WORKAROUND defined
0105 #define ASSIMP_CFLAGS_NOBOOST           0x8
0106 //! Assimp was compiled with ASSIMP_BUILD_SINGLETHREADED defined
0107 #define ASSIMP_CFLAGS_SINGLETHREADED    0x10
0108 //! Assimp was compiled with ASSIMP_BUILD_SINGLETHREADED defined
0109 #define ASSIMP_CFLAGS_DOUBLE_SUPPORT 0x20
0110
0111 // ---------------------------------------------------------------------------
0112 /** @brief Returns assimp's compile flags
0113  *  @return Any bitwise combination of the ASSIMP_CFLAGS_xxx constants.
0114  */
0115 ASSIMP_API unsigned int aiGetCompileFlags(void);
0116
0117 #ifdef __cplusplus
0118 } // end extern "C"
0119 #endif
0120
0121 #endif // !! #ifndef AI_VERSION_H_INC
0122