Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2024.1.1.8691 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2024.1.1
AkPlatforms.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) 2024 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 /// \file
28 /// Audiokinetic platform checks. This is where we detect which platform
29 /// is being compiled, and where we define the corresponding AK-specific
30 /// symbols.
31 
32 #pragma once
33 
34 #if defined( NN_NINTENDO_SDK )
35  #include "nn/nn_Platform.h"
36 #endif
37 
38 #if defined( AK_NULL_PLATFORM )
39  // AK_NULL_PLATFORM can be defined as a part of standing up a new platform in client code,
40  // which may not be fully supported by Wwise.
41  #include <AK/SoundEngine/Platforms/Generic/AkTypes.h>
42 
43 #elif defined( NN_BUILD_TARGET_PLATFORM_NX )
44 
45  #include <AK/SoundEngine/Platforms/NX/AkTypes.h>
46 
47 #elif defined( _GAMING_XBOX )
48 
49  #include <AK/SoundEngine/Platforms/XboxGC/AkTypes.h>
50 
51 #elif defined( _WIN32 ) || defined ( _WIN64 ) || defined( WINAPI_FAMILY )
52 
53  #include <AK/SoundEngine/Platforms/Windows/AkTypes.h>
54 
55 #elif defined( __APPLE__ )
56 
57  #include <AK/SoundEngine/Platforms/Mac/AkTypes.h>
58 
59 #elif defined( __ORBIS__ )
60 
61  #include <AK/SoundEngine/Platforms/PS4/AkTypes.h>
62 
63 #elif defined(__HARMONY__)
64 
65  #include <AK/SoundEngine/Platforms/OpenHarmony/AkTypes.h>
66 
67 #elif defined( __PROSPERO__ )
68 
69  #include "AK/SoundEngine/Platforms/PS5/AkTypes.h"
70 
71 #elif defined( __ANDROID__ ) && !defined (AK_LINUX_AOSP)
72 
73  #include <AK/SoundEngine/Platforms/Android/AkTypes.h>
74 
75 #elif defined( __linux__ )
76 
77  #include <AK/SoundEngine/Platforms/Linux/AkTypes.h>
78 
79 #elif defined( __EMSCRIPTEN__ )
80 
81  #include <AK/SoundEngine/Platforms/Emscripten/AkTypes.h>
82 
83 #elif defined( __QNX__ )
84 
85  #include <AK/SoundEngine/Platforms/QNX/AkTypes.h>
86 
87 #elif defined(__has_include)
88 
89 // AkTypes included here should have internal guardrails to prevent processing if not applicable for current platform
90 
91 #else
92 
93  #error Unsupported platform, or platform-specific symbols not defined
94 
95 #endif
96 
97 #ifndef AK_ALIGN
98 #if defined(SWIG)
99 #define AK_ALIGN( _declaration_, _alignment_ ) _declaration_
100 #else
101 #if defined(_MSC_VER)
102 #define AK_ALIGN( _declaration_, _alignment_ ) __declspec( align( _alignment_ ) ) _declaration_
103 #else
104 #define AK_ALIGN( _declaration_, _alignment_ ) _declaration_ __attribute__( ( aligned( _alignment_ ) ) )
105 #endif // _MSC_VER
106 #endif // SWIG
107 #endif // AK_ALIGN
108 
109 #define AK_ALIGN_TO_NEXT_BOUNDARY( __num__, __boundary__ ) (((__num__) + ((__boundary__)-1)) & ~((__boundary__)-1))
110 #define AK_IS_POWER_OF_TWO(__num__) (((__num__) & ((__num__) - 1)) == 0)
111 
112 #if !defined(AK_ENDIANNESS_LITTLE) && !defined(AK_ENDIANNESS_BIG)
113 #define AK_ENDIANNESS_LITTLE
114 #endif
115 
116 /// AK_UNALIGNED refers to the __unaligned compilation flag available on some platforms. Note that so far, on the tested platform this should always be placed before the pointer symbol *.
117 #ifndef AK_UNALIGNED
118 #if defined(__GNUC__)
119 #define AK_UNALIGNED __attribute__((aligned(1)))
120 #elif defined(_MSC_VER) && !defined(AK_CPU_X86) // __unaligned not supported on 32-bit x86
121 #define AK_UNALIGNED __unaligned
122 #else
123 #define AK_UNALIGNED
124 #endif
125 #endif // AK_UNALIGNED
126 
127 #ifndef AK_SELECTANY
128 #if defined(__GNUC__)
129 #define AK_SELECTANY __attribute__((weak))
130 #elif defined(_MSC_VER)
131 #define AK_SELECTANY __declspec(selectany)
132 #else
133 #define AK_SELECTANY
134 #endif
135 #endif // AK_SELECTANY
136 
137 #if (defined(__cplusplus) && __cplusplus >= 201703L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L)
138 #define AK_CPP17
139 #endif
140 
141 #if (defined(__cplusplus) && __cplusplus >= 202002L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 202002L)
142 #define AK_CPP20
143 #endif
144 
145 #define AK_NODISCARD [[nodiscard]]
146 
147 #if defined(AK_CPU_X86_64) || defined(AK_CPU_ARM_64)
148 #define AK_POINTER_64
149 #endif // #if defined(AK_CPU_X86_64) || defined(AK_CPU_ARM_64)
150 
151 #if !defined(AK_UNUSEDVAR)
152 // use to mark variables as unused to avoid warnings
153 #define AK_UNUSEDVAR(x) ((void)(x))
154 #endif
155 
156 #if defined(AK_SUPPORT_THREADS)
157 #define AK_THREAD_LOCAL thread_local
158 #else
159 #define AK_THREAD_LOCAL
160 #endif
161 
162 // Helper macro to disable optimizations in a specific file (or part of a file)
163 // (no code using these macros should be checked in)
164 #if defined(__clang__)
165 #define AK_DISABLE_OPTIMIZATIONS _Pragma("clang optimize off")
166 #define AK_ENABLE_OPTIMIZATIONS _Pragma("clang optimize on")
167 #elif defined(__GNUC__)
168 #define AK_DISABLE_OPTIMIZATIONS _Pragma("GCC optimize (\"O0\")")
169 #define AK_ENABLE_OPTIMIZATIONS _Pragma("GCC optimize (\"O2\")")
170 #elif defined(_MSC_VER)
171 #define AK_DISABLE_OPTIMIZATIONS __pragma(optimize("", off))
172 #define AK_ENABLE_OPTIMIZATIONS __pragma(optimize("", on))
173 #endif

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