Version
menu_open
link
Wwise SDK 2023.1.4
AkLock.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 // AkLock.h
28 
29 /// \file
30 /// Platform independent synchronization services for plug-ins.
31 
32 #ifndef _AK_TOOLS_COMMON_AKLOCK_H
33 #define _AK_TOOLS_COMMON_AKLOCK_H
34 
35 #include <AK/AkPlatforms.h>
36 
37 #if defined(AK_NULL_PLATFORM)
38 // null platform can just rely on std::mutex for locking
39 #include <mutex>
40 class CAkLock
41 {
42 public:
43  inline AKRESULT Lock(void)
44  {
45  m_lock.lock();
46  return AK_Success;
47  }
48  inline AKRESULT Unlock(void)
49  {
50  m_lock.unlock();
51  return AK_Success;
52  }
53 private:
54  std::mutex m_lock;
55 };
56 
57 #elif defined(AK_WIN) || defined(AK_XBOX)
58 #include <AK/Tools/Win32/AkLock.h>
59 
60 #elif defined (AK_APPLE)
61 #include <AK/Tools/POSIX/AkLock.h>
62 
63 #elif defined (AK_ANDROID)
64 #include <AK/Tools/POSIX/AkLock.h>
65 
66 #elif defined (AK_PS4)
67 #include <AK/Tools/PS4/AkLock.h>
68 
69 #elif defined (AK_PS5)
70 #include <AK/Tools/PS5/AkLock.h>
71 
72 #elif defined (AK_LINUX)
73 #include <AK/Tools/POSIX/AkLock.h>
74 
75 #elif defined (AK_EMSCRIPTEN)
76 #include <AK/Tools/POSIX/AkLock.h>
77 
78 #elif defined (AK_QNX)
79 #include <AK/Tools/POSIX/AkLock.h>
80 
81 #elif defined (AK_NX)
82 #include <AK/Tools/NX/AkLock.h>
83 
84 #else
85 #error AkLock.h: Undefined platform
86 #endif
87 
88 #endif // _AK_TOOLS_COMMON_AKLOCK_H
AKRESULT
Standard function call result.
Definition: AkTypes.h:131
@ AK_Success
The operation was successful.
Definition: AkTypes.h:133
Definition: AkLock.h:38
AKRESULT Unlock(void)
Unlock.
Definition: AkLock.h:71
AKRESULT Lock(void)
Lock.
Definition: AkLock.h:61

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