Table of Contents

include/AK/AkWwiseSDKVersion.h

Go to the documentation of this file.
00001 /*******************************************************************************
00002 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
00003 released in source code form as part of the SDK installer package.
00004 
00005 Commercial License Usage
00006 
00007 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
00008 may use this file in accordance with the end user license agreement provided 
00009 with the software or, alternatively, in accordance with the terms contained in a
00010 written agreement between you and Audiokinetic Inc.
00011 
00012 Apache License Usage
00013 
00014 Alternatively, this file may be used under the Apache License, Version 2.0 (the 
00015 "Apache License"); you may not use this file except in compliance with the 
00016 Apache License. You may obtain a copy of the Apache License at 
00017 http://www.apache.org/licenses/LICENSE-2.0.
00018 
00019 Unless required by applicable law or agreed to in writing, software distributed
00020 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
00021 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
00022 the specific language governing permissions and limitations under the License.
00023 
00024   Version: <VERSION>  Build: <BUILDNUMBER>
00025   Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.
00026 *******************************************************************************/
00027 
00028 #ifndef _AKWWISESDKVERSION_H_
00029 #define _AKWWISESDKVERSION_H_
00030 
00031 /// \file 
00032 /// Audiokinetic Wwise SDK version, build number and copyright defines. These
00033 /// are used by sample projects to display the version and to include it in DLL or
00034 /// EXE resources. They can also be used by games or tools to display the current
00035 /// version and build number of the Wwise Sound Engine.
00036 
00037 /// @name Wwise SDK Version - Numeric values
00038 //@{
00039 
00040 /// Wwise SDK major version
00041 #define AK_WWISESDK_VERSION_MAJOR               2018
00042 
00043 /// Wwise SDK minor version
00044 #define AK_WWISESDK_VERSION_MINOR               1
00045 
00046 /// Wwise SDK sub-minor version
00047 #define AK_WWISESDK_VERSION_SUBMINOR            10
00048 
00049 /// Wwise SDK build number
00050 #define AK_WWISESDK_VERSION_BUILD               6964
00051 
00052 /// Wwise SDK build date (year)
00053 #define AK_WWISESDK_BUILD_YEAR                  2019
00054 
00055 /// Wwise SDK build date (month)
00056 #define AK_WWISESDK_BUILD_MONTH                 10
00057 
00058 /// Wwise SDK build date (day)
00059 #define AK_WWISESDK_BUILD_DAY                   10
00060 
00061 //@}
00062 
00063 /// @name Wwise SDK Version - String values
00064 //@{
00065 
00066 /// Macro that "converts" a numeric define to a string
00067 /// \sa
00068 /// - \ref AK_WWISESDK_NUM2STRING
00069 #define _AK_WWISESDK_NUM2STRING( n )            #n
00070 
00071 /// Macro that "converts" a numeric define to a string
00072 #define AK_WWISESDK_NUM2STRING( n )             _AK_WWISESDK_NUM2STRING( n )
00073 
00074 /// Macro to determine if there's a nickname to add to the full version name
00075 #if defined( AK_WWISESDK_VERSION_NICKNAME )
00076     #define AK_WWISESDK_VERSION_NICKNAME_POSTFIX        "_" AK_WWISESDK_VERSION_NICKNAME
00077 #else
00078     #define AK_WWISESDK_VERSION_NICKNAME_POSTFIX
00079 #endif
00080 
00081 /// String representing the Wwise SDK version without the nickname postfix
00082 #define AK_WWISESDK_VERSIONNAME_SHORT       "v" AK_WWISESDK_NUM2STRING( AK_WWISESDK_VERSION_MAJOR ) \
00083                                             "." AK_WWISESDK_NUM2STRING( AK_WWISESDK_VERSION_MINOR ) \
00084                                             "." AK_WWISESDK_NUM2STRING( AK_WWISESDK_VERSION_SUBMINOR )
00085 
00086 /// String representing the Wwise SDK version
00087 #define AK_WWISESDK_VERSIONNAME             AK_WWISESDK_VERSIONNAME_SHORT \
00088                                             AK_WWISESDK_VERSION_NICKNAME_POSTFIX
00089 
00090 /// Wwise SDK branch
00091 #define AK_WWISESDK_BRANCH                  "wwise_v2018.1"
00092 
00093 /// @name Wwise SDK Copyright Notice
00094 
00095 //@{
00096     /// Wwise SDK copyright notice
00097     #define AK_WWISESDK_COPYRIGHT               "\xA9 2006-2019. Audiokinetic Inc. All rights reserved."
00098     /// Wwise SDK copyright notice
00099     #define AK_WWISESDK_COPYRIGHT_CONSOLE       "(C) 2006-2019. Audiokinetic Inc. All rights reserved."
00100 //@}
00101 
00102 #define AK_WWISESDK_VERSION_COMBINED ((AK_WWISESDK_VERSION_MAJOR<<8) | AK_WWISESDK_VERSION_MINOR)
00103 
00104 #endif // _AKWWISESDKVERSION_H_
00105