Diligent Engine API Reference
StandardFile.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 
26 #include <stdio.h>
27 
28 #include "BasicFileSystem.h"
29 #include "DataBlob.h"
30 
31 class StandardFile : public BasicFile
32 {
33 public:
34  StandardFile( const FileOpenAttribs &OpenAttribs, Diligent::Char SlashSymbol );
35  virtual ~StandardFile()override;
36 
37  void Read(Diligent::IDataBlob *pData);
38 
39  bool Read(void *Data, size_t BufferSize);
40 
41  bool Write(const void *Data, size_t BufferSize);
42 
43  size_t GetSize();
44 
45  size_t GetPos();
46 
47  void SetPos(size_t Offset, FilePosOrigin Origin);
48 
49 protected:
50  FILE * m_pFile;
51 };
Base interface for a file stream.
Definition: DataBlob.h:39