Diligent Engine  v.2.4.g
EngineFactoryBase.hpp
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 "Object.h"
34 #include "EngineFactory.h"
36 
37 namespace Diligent
38 {
39 
40 const APIInfo& GetAPIInfo();
41 
43 
47 template <class BaseInterface>
48 class EngineFactoryBase : public BaseInterface
49 {
50 public:
51  EngineFactoryBase(const INTERFACE_ID& FactoryIID) noexcept :
52  // clang-format off
53  m_FactoryIID {FactoryIID},
54  m_RefCounters {*this }
55  // clang-format on
56  {
57  }
58 
59  virtual void DILIGENT_CALL_TYPE QueryInterface(const INTERFACE_ID& IID, IObject** ppInterface) override final
60  {
61  if (ppInterface == nullptr)
62  return;
63 
64  *ppInterface = nullptr;
65  if (IID == IID_Unknown || IID == m_FactoryIID || IID == IID_EngineFactory)
66  {
67  *ppInterface = this;
68  (*ppInterface)->AddRef();
69  }
70  }
71 
73  {
74  return m_RefCounters.AddStrongRef();
75  }
76 
78  {
79  return m_RefCounters.ReleaseStrongRef();
80  }
81 
83  {
84  return const_cast<IReferenceCounters*>(static_cast<const IReferenceCounters*>(&m_RefCounters));
85  }
86 
87  virtual const APIInfo& DILIGENT_CALL_TYPE GetAPIInfo() const override final
88  {
89  return Diligent::GetAPIInfo();
90  }
91 
92  virtual void DILIGENT_CALL_TYPE CreateDefaultShaderSourceStreamFactory(const Char* SearchDirectories,
93  IShaderSourceInputStreamFactory** ppShaderSourceFactory) const override final
94  {
95  Diligent::CreateDefaultShaderSourceStreamFactory(SearchDirectories, ppShaderSourceFactory);
96  }
97 
98 private:
99  class DummyReferenceCounters final : public IReferenceCounters
100  {
101  public:
102  DummyReferenceCounters(EngineFactoryBase& Factory) noexcept :
103  m_Factory{Factory}
104  {
105  m_lNumStrongReferences = 0;
106  m_lNumWeakReferences = 0;
107  }
108 
109  virtual ReferenceCounterValueType AddStrongRef() override final
110  {
111  return Atomics::AtomicIncrement(m_lNumStrongReferences);
112  }
113 
114  virtual ReferenceCounterValueType ReleaseStrongRef() override final
115  {
116  return Atomics::AtomicDecrement(m_lNumStrongReferences);
117  }
118 
119  virtual ReferenceCounterValueType AddWeakRef() override final
120  {
121  return Atomics::AtomicIncrement(m_lNumWeakReferences);
122  }
123 
124  virtual ReferenceCounterValueType ReleaseWeakRef() override final
125  {
126  return Atomics::AtomicDecrement(m_lNumWeakReferences);
127  }
128 
129  virtual void GetObject(IObject** ppObject) override final
130  {
131  if (ppObject != nullptr)
132  m_Factory.QueryInterface(IID_Unknown, ppObject);
133  }
134 
135  virtual ReferenceCounterValueType GetNumStrongRefs() const override final
136  {
137  return m_lNumStrongReferences;
138  }
139 
140  virtual ReferenceCounterValueType GetNumWeakRefs() const override final
141  {
142  return m_lNumWeakReferences;
143  }
144 
145  private:
146  EngineFactoryBase& m_Factory;
147  Atomics::AtomicLong m_lNumStrongReferences;
148  Atomics::AtomicLong m_lNumWeakReferences;
149  };
150 
151  const INTERFACE_ID m_FactoryIID;
152  DummyReferenceCounters m_RefCounters;
153 };
154 
155 } // namespace Diligent
Diligent::IShaderSourceInputStreamFactory
Shader source stream factory interface.
Definition: Shader.h:134
Diligent::IReferenceCounters
Base interface for a reference counter object that stores the number of strong and weak references an...
Definition: ReferenceCounters.h:44
Diligent::INTERFACE_ID
struct INTERFACE_ID INTERFACE_ID
Definition: InterfaceID.h:54
Diligent::Char
char Char
Definition: BasicTypes.h:64
Diligent::APIInfo
struct APIInfo APIInfo
Definition: APIInfo.h:104
Diligent::EngineFactoryBase::GetReferenceCounters
virtual IReferenceCounters * GetReferenceCounters() const override final
Definition: EngineFactoryBase.hpp:82
Diligent::IObject
Base interface for all dynamic objects in the engine.
Definition: Object.h:41
Diligent::EngineFactoryBase::CreateDefaultShaderSourceStreamFactory
virtual void CreateDefaultShaderSourceStreamFactory(const Char *SearchDirectories, IShaderSourceInputStreamFactory **ppShaderSourceFactory) const override final
Definition: EngineFactoryBase.hpp:92
Diligent::GetAPIInfo
const APIInfo & GetAPIInfo()
Definition: APIInfo.cpp:118
Diligent::EngineFactoryBase::AddRef
virtual ReferenceCounterValueType AddRef() override final
Definition: EngineFactoryBase.hpp:72
BasicAtomics::AtomicIncrement
static Type AtomicIncrement(std::atomic< Type > &Val)
Definition: BasicAtomics.hpp:41
Diligent::INTERFACE_ID
Unique interface identifier.
Definition: InterfaceID.h:37
Diligent::EngineFactoryBase::QueryInterface
virtual void QueryInterface(const INTERFACE_ID &IID, IObject **ppInterface) override final
Definition: EngineFactoryBase.hpp:59
Diligent::CreateDefaultShaderSourceStreamFactory
void CreateDefaultShaderSourceStreamFactory(const Char *SearchDirectories, IShaderSourceInputStreamFactory **ppShaderSourceStreamFactory)
Creates a default shader source stream factory.
Definition: DefaultShaderSourceStreamFactory.cpp:125
DILIGENT_CALL_TYPE
#define DILIGENT_CALL_TYPE
Definition: CommonDefinitions.h:45
Object.h
BasicAtomics::AtomicLong
std::atomic< Long > AtomicLong
Definition: BasicAtomics.hpp:35
BasicAtomics::AtomicDecrement
static Type AtomicDecrement(std::atomic< Type > &Val)
Definition: BasicAtomics.hpp:48
DefaultShaderSourceStreamFactory.h
EngineFactory.h
Diligent::EngineFactoryBase::EngineFactoryBase
EngineFactoryBase(const INTERFACE_ID &FactoryIID) noexcept
Definition: EngineFactoryBase.hpp:51
Diligent::EngineFactoryBase::GetAPIInfo
virtual const APIInfo & GetAPIInfo() const override final
Definition: EngineFactoryBase.hpp:87
Diligent::APIInfo
Diligent API Info. This tructure can be used to verify API compatibility.
Definition: APIInfo.h:40
Diligent::ReferenceCounterValueType
long ReferenceCounterValueType
Definition: ReferenceCounters.h:37
Diligent::EngineFactoryBase::Release
virtual ReferenceCounterValueType Release() override final
Definition: EngineFactoryBase.hpp:77
Diligent
The library uses Direct3D-style math:
Definition: AdvancedMath.hpp:37
Diligent::EngineFactoryBase
Template class implementing base functionality of the engine factory.
Definition: EngineFactoryBase.hpp:48