Version
Wwise SDK 2021.1.8
AkSoundEngineExport.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Version: v2021.1.8 Build: 7831
25  Copyright (c) 2006-2022 Audiokinetic Inc.
26 *******************************************************************************/
27 
28 // AkSoundEngineExport.h
29 
30 /// \file
31 /// Export/calling convention definitions.
32 
33 #ifndef _AK_SOUNDENGINE_EXPORT_H_
34 #define _AK_SOUNDENGINE_EXPORT_H_
35 
36 #include <AK/AkPlatforms.h>
37 
38 #ifndef AK_DLLEXPORT
39 #define AK_DLLEXPORT
40 #endif
41 
42 #ifndef AK_DLLIMPORT
43 #define AK_DLLIMPORT
44 #endif
45 
46 #ifdef AKSOUNDENGINE_DLL
47  #ifdef AKSOUNDENGINE_EXPORTS
48  /// Sound Engine API import/export definition
49  #define AKSOUNDENGINE_API AK_DLLEXPORT
50  #else
51  /// Sound Engine API import/export definition
52  #define AKSOUNDENGINE_API AK_DLLIMPORT
53  #endif // Export
54 #else
55  #define AKSOUNDENGINE_API
56 #endif
57 
58 #ifndef AKSOUNDENGINE_CALL
59  #define AKSOUNDENGINE_CALL
60 #endif
61 
62 /// Declare a function
63 /// \param _type Return type of the function
64 /// \param _name Name of the function
65 /// \remarks This must be followed by the parentheses containing the function arguments declaration
66 #define AK_FUNC( _type, _name ) _type AKSOUNDENGINE_CALL _name
67 
68 /// Declare an extern function
69 /// \param _type Return type of the function
70 /// \param _name Name of the function
71 /// \remarks This must be followed by the parentheses containing the function arguments declaration
72 #define AK_EXTERNFUNC( _type, _name ) extern _type AKSOUNDENGINE_CALL _name
73 
74 /// Declare an extern function that is exported/imported
75 /// \param _type Return type of the function
76 /// \param _name Name of the function
77 /// \remarks This must be followed by the parentheses containing the function arguments declaration
78 #define AK_EXTERNAPIFUNC( _type, _name ) extern AKSOUNDENGINE_API _type AKSOUNDENGINE_CALL _name
79 
80 /// Declare a callback function type
81 /// \param _type Return type of the function
82 /// \param _name Name of the function
83 /// \remarks This must be followed by the parentheses containing the function arguments declaration
84 #define AK_CALLBACK( _type, _name ) typedef _type ( AKSOUNDENGINE_CALL *_name )
85 
86 #endif //_AK_SOUNDENGINE_EXPORT_H_