Diligent Engine  v.2.4.g
DataBlob.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 "Object.h"
34 
36 
37 
38 // {F578FF0D-ABD2-4514-9D32-7CB454D4A73B}
39 static const struct INTERFACE_ID IID_DataBlob =
40  {0xf578ff0d, 0xabd2, 0x4514, {0x9d, 0x32, 0x7c, 0xb4, 0x54, 0xd4, 0xa7, 0x3b}};
41 
42 // clang-format off
43 
44 #define DILIGENT_INTERFACE_NAME IDataBlob
46 
47 #define IDataBlobInclusiveMethods \
48  IObjectInclusiveMethods; \
49  IDataBlobMethods DataBlob
50 
53 {
55  VIRTUAL void METHOD(Resize)(THIS_
56  size_t NewSize) PURE;
57 
59  VIRTUAL size_t METHOD(GetSize)(THIS) CONST PURE;
60 
62  VIRTUAL void* METHOD(GetDataPtr)(THIS) PURE;
63 
65  VIRTUAL const void* METHOD(GetConstDataPtr)(THIS) CONST PURE;
66 };
68 
70 
71 #if DILIGENT_C_INTERFACE
72 
73 // clang-format off
74 
75 # define IDataBlob_Resize(This, ...) CALL_IFACE_METHOD(DataBlob, Resize, This, __VA_ARGS__)
76 # define IDataBlob_GetSize(This) CALL_IFACE_METHOD(DataBlob, GetSize, This)
77 # define IDataBlob_GetDataPtr(This) CALL_IFACE_METHOD(DataBlob, GetDataPtr, This)
78 # define IDataBlob_GetConstDataPtr(This) CALL_IFACE_METHOD(DataBlob, GetConstDataPtr, This)
79 
80 // clang-format on
81 
82 #endif
83 
84 DILIGENT_END_NAMESPACE // namespace Diligent
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
DefineInterfaceHelperMacros.h
Diligent::IDataBlob
Base interface for a file stream.
Definition: DataBlob.h:52
DILIGENT_BEGIN_INTERFACE
#define DILIGENT_BEGIN_INTERFACE(Name, Base)
Definition: CommonDefinitions.h:97
Diligent::IObject
Base interface for all dynamic objects in the engine.
Definition: Object.h:41
THIS
#define THIS
Definition: DefineInterfaceHelperMacros.h:81
PURE
#define PURE
Definition: DefineInterfaceHelperMacros.h:85
DILIGENT_END_NAMESPACE
#define DILIGENT_END_NAMESPACE
Definition: CommonDefinitions.h:86
CONST
#define CONST
Definition: DefineInterfaceHelperMacros.h:84
UndefInterfaceHelperMacros.h
Object.h
METHOD
#define METHOD(Name)
Definition: DefineInterfaceHelperMacros.h:87
DILIGENT_BEGIN_NAMESPACE
#define DILIGENT_BEGIN_NAMESPACE(Name)
Definition: CommonDefinitions.h:82
Diligent
The library uses Direct3D-style math:
Definition: AdvancedMath.hpp:37
THIS_
#define THIS_
Definition: DefineInterfaceHelperMacros.h:82