Diligent Engine  v.2.4.g
MemoryFileStream.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 "../../Primitives/interface/FileStream.h"
34 #include "../../Primitives/interface/DataBlob.h"
35 #include "ObjectBase.hpp"
36 #include "RefCountedObjectImpl.hpp"
37 #include "RefCntAutoPtr.hpp"
38 
39 namespace Diligent
40 {
41 
43 class MemoryFileStream : public ObjectBase<IFileStream>
44 {
45 public:
47 
49  IDataBlob* pData);
50 
51  virtual void DILIGENT_CALL_TYPE QueryInterface(const INTERFACE_ID& IID, IObject** ppInterface) override;
52 
54  virtual void DILIGENT_CALL_TYPE ReadBlob(IDataBlob* pData) override;
55 
57  virtual bool DILIGENT_CALL_TYPE Read(void* Data, size_t Size) override;
58 
60  virtual bool DILIGENT_CALL_TYPE Write(const void* Data, size_t Size) override;
61 
62  virtual size_t DILIGENT_CALL_TYPE GetSize() override;
63 
64  virtual bool DILIGENT_CALL_TYPE IsValid() override;
65 
66 private:
67  RefCntAutoPtr<IDataBlob> m_DataBlob;
68  size_t m_CurrentOffset = 0;
69 };
70 
71 } // namespace Diligent
ObjectBase.hpp
Diligent::IReferenceCounters
Base interface for a reference counter object that stores the number of strong and weak references an...
Definition: ReferenceCounters.h:44
Diligent::IDataBlob
Base interface for a file stream.
Definition: DataBlob.h:52
Diligent::MemoryFileStream::IsValid
virtual bool IsValid() override
Definition: MemoryFileStream.cpp:77
Diligent::IObject
Base interface for all dynamic objects in the engine.
Definition: Object.h:41
Diligent::MemoryFileStream::ReadBlob
virtual void ReadBlob(IDataBlob *pData) override
Reads data from the stream.
Definition: MemoryFileStream.cpp:56
Diligent::ObjectBase
Template class implementing base functionality for an object.
Definition: ObjectBase.hpp:66
Diligent::INTERFACE_ID
Unique interface identifier.
Definition: InterfaceID.h:37
Diligent::MemoryFileStream::MemoryFileStream
MemoryFileStream(IReferenceCounters *pRefCounters, IDataBlob *pData)
Definition: MemoryFileStream.cpp:36
Diligent::MemoryFileStream::Read
virtual bool Read(void *Data, size_t Size) override
Reads data from the stream.
Definition: MemoryFileStream.cpp:45
Diligent::MemoryFileStream::Write
virtual bool Write(const void *Data, size_t Size) override
Writes data to the stream.
Definition: MemoryFileStream.cpp:65
Diligent::RefCntAutoPtr
Template class that implements reference counting.
Definition: RefCntAutoPtr.hpp:73
DILIGENT_CALL_TYPE
#define DILIGENT_CALL_TYPE
Definition: CommonDefinitions.h:45
Diligent::MemoryFileStream::GetSize
virtual size_t GetSize() override
Definition: MemoryFileStream.cpp:82
Diligent::MemoryFileStream::QueryInterface
virtual void QueryInterface(const INTERFACE_ID &IID, IObject **ppInterface) override
RefCntAutoPtr.hpp
Diligent::MemoryFileStream
Memory file stream implementation.
Definition: MemoryFileStream.hpp:43
Diligent::MemoryFileStream::TBase
ObjectBase< IFileStream > TBase
Definition: MemoryFileStream.hpp:46
RefCountedObjectImpl.hpp
Diligent
The library uses Direct3D-style math:
Definition: AdvancedMath.hpp:37