Version
menu_open
link
Wwise SDK 2022.1.4
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  Copyright (c) 2023 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 // AkSoundEngineExport.h
28 
29 /// \file
30 /// Export/calling convention definitions.
31 
32 #ifndef _AK_SOUNDENGINE_EXPORT_H_
33 #define _AK_SOUNDENGINE_EXPORT_H_
34 
35 #include <AK/AkPlatforms.h>
36 
37 #ifndef AK_DLLEXPORT
38 #define AK_DLLEXPORT
39 #endif
40 
41 #ifndef AK_DLLIMPORT
42 #define AK_DLLIMPORT
43 #endif
44 
45 #ifndef AK_ATTR_USED
46 #define AK_ATTR_USED
47 #endif
48 
49 #ifdef AKSOUNDENGINE_DLL
50  #ifdef AKSOUNDENGINE_EXPORTS
51  /// Sound Engine API import/export definition
52  #define AKSOUNDENGINE_API AK_DLLEXPORT
53  #else
54  /// Sound Engine API import/export definition
55  #define AKSOUNDENGINE_API AK_DLLIMPORT
56  #endif // Export
57 #else
58  #define AKSOUNDENGINE_API
59 #endif
60 
61 #ifndef AKSOUNDENGINE_CALL
62  #define AKSOUNDENGINE_CALL
63 #endif
64 
65 /// Declare a function
66 /// \param _type Return type of the function
67 /// \param _name Name of the function
68 /// \remarks This must be followed by the parentheses containing the function arguments declaration
69 #define AK_FUNC( _type, _name ) _type AKSOUNDENGINE_CALL _name
70 
71 /// Declare an extern function
72 /// \param _type Return type of the function
73 /// \param _name Name of the function
74 /// \remarks This must be followed by the parentheses containing the function arguments declaration
75 #define AK_EXTERNFUNC( _type, _name ) extern _type AKSOUNDENGINE_CALL _name
76 
77 /// Declare an extern function that is exported/imported
78 /// \param _type Return type of the function
79 /// \param _name Name of the function
80 /// \remarks This must be followed by the parentheses containing the function arguments declaration
81 #define AK_EXTERNAPIFUNC( _type, _name ) extern AKSOUNDENGINE_API _type AKSOUNDENGINE_CALL _name
82 
83 /// Declare a callback function type
84 /// \param _type Return type of the function
85 /// \param _name Name of the function
86 /// \remarks This must be followed by the parentheses containing the function arguments declaration
87 #define AK_CALLBACK( _type, _name ) typedef _type ( AKSOUNDENGINE_CALL *_name )
88 
89 #endif //_AK_SOUNDENGINE_EXPORT_H_

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise