Version
Wwise SDK 2021.1.8
PluginMFCWindows.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 /**
29  * \brief Wwise Authoring Plug-ins - Provides MFC initialization on plug-in instantiation.
30  * \file AK/Wwise/Plugin/PluginMFCWindows.h
31  *
32  * By default, an MFC-based DLL initializes itself when the DLL is loaded. However, not all plug-ins in a DLL container
33  * require MFC, so this makes sure to initialize MFC only on instantiation of a particular plug-in.
34  *
35  * \sa C++ interfaces
36  * - \ref AK::Wwise::Plugin::PluginMFCWindows
37  */
38 
39 #pragma once
40 
41 #if defined( DOXYGEN_INCLUDE ) || ( \
42  (defined( _WIN32 ) || defined ( _WIN64 ) || defined( WINAPI_FAMILY )) \
43  && ((defined(_AFXDLL) && _AFXDLL) || defined(_MFC_BLD) || defined(__AFX_H__)) )
44 
45 #include <afxwin.h>
46 
47 #ifdef __cplusplus
48 
49 #include <memory>
50 
51 namespace AK::Wwise::Plugin
52 {
53  /**
54  * \brief Initializes MFC for this plug-in.
55  *
56  * By default, an MFC-based DLL initializes itself when the DLL is loaded. However, not all plug-ins in a DLL
57  * container require MFC, so this makes sure to initialize MFC only on instantiation of a particular plug-in.
58  *
59  * If you need to modify the CWinApp class on your own, you can update the template.
60  *
61  * \code
62  * : public AK::Wwise::Plugin::PluginMFCWindows<MyWinApp>
63  * \endcode
64  *
65  * \aknote This should be the first interface of the plug-in, as it needs to be initialized before anything. \endaknote
66  */
67  template<typename CWinApp = ::CWinApp>
68  class PluginMFCWindows
69  {
70  /**
71  * \brief DLL singleton for MFC's CWinApp.
72  *
73  * This singleton is unique in the DLL. It should be initialized in the main app thread.
74  * Please note it is desired behavior to have multiple instances of this singleton in an application. However,
75  * MFC expects to have a single copy per DLL.
76  */
77  static std::unique_ptr<CWinApp> g_theApp;
78 
79  public:
80  /**
81  * \brief Initializes g_theApp singleton
82  */
83  PluginMFCWindows()
84  {
85  if (!g_theApp)
86  {
87  AFX_MANAGE_STATE(AfxGetStaticModuleState());
88  g_theApp.reset(new CWinApp);
89 
90  g_theApp->InitInstance();
91  }
92  }
93 
94  /**
95  * \brief Retrieves the CWinApp singleton.
96  *
97  * \return CWinApp*
98  */
99  static CWinApp* GetMFCApp()
100  {
101  return g_theApp;
102  }
103  };
104 
105  template<typename CWinApp>
106  std::unique_ptr<CWinApp> PluginMFCWindows<CWinApp>::g_theApp;
107 } // of namespace AK::Wwise::Plugin
108 
109 #endif // of __cplusplus
110 #endif // of Windows detection
AK.Wwise::Plugin::PluginMFCWindows::PluginMFCWindows
PluginMFCWindows()
Initializes g_theApp singleton.
Definition: PluginMFCWindows.h:83
AK.Wwise::Plugin::PluginMFCWindows::GetMFCApp
static CWinApp * GetMFCApp()
Retrieves the CWinApp singleton.
Definition: PluginMFCWindows.h:99
AK.Wwise::Plugin::PluginMFCWindows
Initializes MFC for this plug-in.
Definition: PluginMFCWindows.h:69