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

Diligent Engine API Reference

FileStream.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 "Object.h"
30 #include "DataBlob.h"
31
32 namespace Diligent
33 {
34
36 // {E67F386C-6A5A-4A24-A0CE-C66435465D41}
37 static constexpr INTERFACE_ID IID_FileStream =
38 { 0xe67f386c, 0x6a5a, 0x4a24, { 0xa0, 0xce, 0xc6, 0x64, 0x35, 0x46, 0x5d, 0x41 } };
39
41 class IFileStream : public IObject
42 {
43 public:
45 virtual bool Read( void *Data, size_t BufferSize ) = 0;
46
47 virtual void Read( IDataBlob *pData ) = 0;
48
50 virtual bool Write( const void *Data, size_t Size ) = 0;
51
52 virtual size_t GetSize() = 0;
53
54 virtual bool IsValid() = 0;
55 };
56
57 }
Diligent::IFileStream::Read
virtual bool Read(void *Data, size_t BufferSize)=0
Reads data from the stream.
Diligent
Graphics engine namespace.
Definition: AdaptiveFixedBlockAllocator.h:30
Diligent::IDataBlob
Base interface for a file stream.
Definition: DataBlob.h:39
Diligent::IID_FileStream
static constexpr INTERFACE_ID IID_FileStream
IFileStream interface unique identifier.
Definition: FileStream.h:37
Diligent::IFileStream::Write
virtual bool Write(const void *Data, size_t Size)=0
Writes data to the stream.
Diligent::IFileStream
Base interface for a file stream.
Definition: FileStream.h:41
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