Diligent Engine  v.2.4.g
EngineFactory.h
Go to the documentation of this file.
1 /*
2  * Copyright 2019-2021 Diligent Graphics LLC
3  * Copyright 2015-2019 Egor Yusov
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  * In no event and under no legal theory, whether in tort (including negligence),
18  * contract, or otherwise, unless required by applicable law (such as deliberate
19  * and grossly negligent acts) or agreed to in writing, shall any Contributor be
20  * liable for any damages, including any direct, indirect, special, incidental,
21  * or consequential damages of any character arising as a result of this License or
22  * out of the use or inability to use the software (including but not limited to damages
23  * for loss of goodwill, work stoppage, computer failure or malfunction, or any and
24  * all other commercial damages or losses), even if such Contributor has been advised
25  * of the possibility of such damages.
26  */
27 
28 #pragma once
29 
32 
33 #include "../../../Primitives/interface/Object.h"
34 #include "APIInfo.h"
35 
36 
37 #if PLATFORM_ANDROID
38 struct ANativeActivity;
39 struct AAssetManager;
40 #endif
41 
43 
44 struct IShaderSourceInputStreamFactory;
45 
46 // {D932B052-4ED6-4729-A532-F31DEEC100F3}
47 static const INTERFACE_ID IID_EngineFactory =
48  {0xd932b052, 0x4ed6, 0x4729, {0xa5, 0x32, 0xf3, 0x1d, 0xee, 0xc1, 0x0, 0xf3}};
49 
50 #define DILIGENT_INTERFACE_NAME IEngineFactory
51 #include "../../../Primitives/interface/DefineInterfaceHelperMacros.h"
52 
53 #define IEngineFactoryInclusiveMethods \
54  IObjectInclusiveMethods; \
55  IEngineFactoryMethods EngineFactory
56 
57 // clang-format off
58 
61 {
64 
69  THIS_
70  const Char* SearchDirectories,
71  struct IShaderSourceInputStreamFactory** ppShaderSourceFactory) CONST PURE;
72 
73 #if PLATFORM_ANDROID
74  VIRTUAL void METHOD(InitAndroidFileSystem)(THIS_
82  struct ANativeActivity* NativeActivity,
83  const char* NativeActivityClassName,
84  struct AAssetManager* AssetManager) CONST PURE;
85 #endif
86 };
88 
89 // clang-format on
90 
91 #include "../../../Primitives/interface/UndefInterfaceHelperMacros.h"
92 
93 #if DILIGENT_C_INTERFACE
94 
95 // clang-format off
96 
97 # define IEngineFactory_GetAPIInfo(This) CALL_IFACE_METHOD(EngineFactory, GetAPIInfo, This)
98 # define IEngineFactory_CreateDefaultShaderSourceStreamFactory(This, ...) CALL_IFACE_METHOD(EngineFactory, CreateDefaultShaderSourceStreamFactory, This, __VA_ARGS__)
99 # define IEngineFactory_InitAndroidFileSystem(This, ...) CALL_IFACE_METHOD(EngineFactory, InitAndroidFileSystem, This, __VA_ARGS__)
100 
101 // clang-format on
102 
103 #endif
104 
105 DILIGENT_END_NAMESPACE // namespace Diligent
Diligent::IShaderSourceInputStreamFactory
Shader source stream factory interface.
Definition: Shader.h:134
DILIGENT_END_INTERFACE
#define DILIGENT_END_INTERFACE
Definition: DefineInterfaceHelperMacros.h:88
Diligent::INTERFACE_ID
struct INTERFACE_ID INTERFACE_ID
Definition: InterfaceID.h:54
VIRTUAL
#define VIRTUAL
Definition: DefineInterfaceHelperMacros.h:83
Diligent::Char
char Char
Definition: BasicTypes.h:64
DILIGENT_BEGIN_INTERFACE
#define DILIGENT_BEGIN_INTERFACE(Name, Base)
Definition: CommonDefinitions.h:97
APIInfo.h
Diligent::IObject
Base interface for all dynamic objects in the engine.
Definition: Object.h:41
Diligent::GetAPIInfo
const APIInfo & GetAPIInfo()
Definition: APIInfo.cpp:118
THIS
#define THIS
Definition: DefineInterfaceHelperMacros.h:81
PURE
#define PURE
Definition: DefineInterfaceHelperMacros.h:85
Diligent::CreateDefaultShaderSourceStreamFactory
void CreateDefaultShaderSourceStreamFactory(const Char *SearchDirectories, IShaderSourceInputStreamFactory **ppShaderSourceStreamFactory)
Creates a default shader source stream factory.
Definition: DefaultShaderSourceStreamFactory.cpp:125
DILIGENT_END_NAMESPACE
#define DILIGENT_END_NAMESPACE
Definition: CommonDefinitions.h:86
CONST
#define CONST
Definition: DefineInterfaceHelperMacros.h:84
REF
#define REF
Definition: DefineGlobalFuncHelperMacros.h:39
METHOD
#define METHOD(Name)
Definition: DefineInterfaceHelperMacros.h:87
DILIGENT_BEGIN_NAMESPACE
#define DILIGENT_BEGIN_NAMESPACE(Name)
Definition: CommonDefinitions.h:82
Diligent::APIInfo
Diligent API Info. This tructure can be used to verify API compatibility.
Definition: APIInfo.h:40
Diligent::IEngineFactory
Engine factory base interface.
Definition: EngineFactory.h:60
Diligent
The library uses Direct3D-style math:
Definition: AdvancedMath.hpp:37
THIS_
#define THIS_
Definition: DefineInterfaceHelperMacros.h:82