Diligent Engine API Reference: D:/GitHub/DiligentEngine/DiligentCore/Common/interface/BasicFileStream.h Source File

Diligent Engine API Reference

BasicFileStream.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 "FileStream.h"
30 #include "ObjectBase.h"
31 #include "RefCountedObjectImpl.h"
32 #include "FileWrapper.h"
33 #include "DataBlob.h"
34
35 namespace Diligent
36 {
37
39 class BasicFileStream : public ObjectBase<IFileStream>
40 {
41 public:
42 typedef ObjectBase<IFileStream> TBase;
43
44 BasicFileStream(IReferenceCounters *pRefCounters,
45 const Char *Path,
46 EFileAccessMode Access = EFileAccessMode::Read);
47
48 virtual void QueryInterface( const INTERFACE_ID &IID, IObject **ppInterface )override;
49
51 virtual void Read( IDataBlob *pData )override;
52
54 virtual bool Read( void *Data, size_t BufferSize )override;
55
57 virtual bool Write( const void *Data, size_t Size )override;
58
59 virtual size_t GetSize()override;
60
61 virtual bool IsValid()override;
62
63 private:
64 FileWrapper m_FileWrpr;
65 };
66
67 }
Diligent::ObjectBase
Template class implementing base functionality for an object.
Definition: ObjectBase.h:62
Diligent
Namespace for the OpenGL implementation of the graphics engine.
Definition: BufferD3D11Impl.h:34
Diligent::BasicFileStream::Write
virtual bool Write(const void *Data, size_t Size) override
Writes data to the stream.
Definition: BasicFileStream.cpp:49
Diligent::BasicFileStream::Read
virtual void Read(IDataBlob *pData) override
Reads data from the stream.
Diligent::BasicFileStream
Basic file stream implementation.
Definition: BasicFileStream.h:39