Diligent Engine API Reference: D:/GitHub/DiligentEngine/DiligentCore/Primitives/interface/Object.h Source File

Diligent Engine API Reference

Object.h
1 /* Copyright 2015-2018 Egor Yusov
2 *
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
10 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
11 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF ANY PROPRIETARY RIGHTS.
12 *
13 * In no event and under no legal theory, whether in tort (including negligence),
14 * contract, or otherwise, unless required by applicable law (such as deliberate
15 * and grossly negligent acts) or agreed to in writing, shall any Contributor be
16 * liable for any damages, including any direct, indirect, special, incidental,
17 * or consequential damages of any character arising as a result of this License or
18 * out of the use or inability to use the software (including but not limited to damages
19 * for loss of goodwill, work stoppage, computer failure or malfunction, or any and
20 * all other commercial damages or losses), even if such Contributor has been advised
21 * of the possibility of such damages.
22 */
23
24 #pragma once
25
28
29 #include "InterfaceID.h"
30 #include "ReferenceCounters.h"
31
32 namespace Diligent
33 {
34
36 class IObject
37 {
38 public:
39 using CounterValueType = IReferenceCounters::CounterValueType;
40
42
48 virtual void QueryInterface( const Diligent::INTERFACE_ID &IID, IObject **ppInterface ) = 0;
49
50
52
58 virtual CounterValueType AddRef() = 0;
59
60
63
71 virtual CounterValueType Release() = 0;
72
73
77 virtual IReferenceCounters* GetReferenceCounters()const = 0;
78 };
79
80 }
Diligent::IObject::AddRef
virtual CounterValueType AddRef()=0
Increments the number of strong references by 1.
Diligent
Graphics engine namespace.
Definition: AdaptiveFixedBlockAllocator.h:30
Diligent::IObject::GetReferenceCounters
virtual IReferenceCounters * GetReferenceCounters() const =0
Returns the pointer to IReferenceCounters interface of the associated reference counters object...
Diligent::IReferenceCounters
Base interface for a reference counter object that stores the number of strong and weak references an...
Definition: ReferenceCounters.h:37
Diligent::IObject
Base interface for all dynamic objects in the engine.
Definition: Object.h:36
Diligent::INTERFACE_ID
Describes unique identifier.
Definition: InterfaceID.h:33
Diligent::IObject::Release
virtual CounterValueType Release()=0
Decrements the number of strong references by 1 and destroys the object when the counter reaches zero...
Diligent::IObject::QueryInterface
virtual void QueryInterface(const Diligent::INTERFACE_ID &IID, IObject **ppInterface)=0
Queries the specific interface.