Irrlicht 3D Engine
IReadFile.h
Go to the documentation of this file.
1 // Copyright (C) 2002-2012 Nikolaus Gebhardt
2 // This file is part of the "Irrlicht Engine".
3 // For conditions of distribution and use, see copyright notice in irrlicht.h
4 
5 #ifndef __I_READ_FILE_H_INCLUDED__
6 #define __I_READ_FILE_H_INCLUDED__
7 
8 #include "IReferenceCounted.h"
9 #include "coreutil.h"
10 
11 namespace irr
12 {
13 namespace io
14 {
15 
17  class IReadFile : public virtual IReferenceCounted
18  {
19  public:
21 
24  virtual s32 read(void* buffer, u32 sizeToRead) = 0;
25 
27 
32  virtual bool seek(long finalPos, bool relativeMovement = false) = 0;
33 
35 
36  virtual long getSize() const = 0;
37 
39 
40  virtual long getPos() const = 0;
41 
43 
44  virtual const io::path& getFileName() const = 0;
45  };
46 
48  IReadFile* createReadFile(const io::path& fileName);
50  IReadFile* createLimitReadFile(const io::path& fileName, IReadFile* alreadyOpenedFile, long pos, long areaSize);
52  IReadFile* createMemoryReadFile(void* memory, long size, const io::path& fileName, bool deleteMemoryWhenDropped);
53 
54 } // end namespace io
55 } // end namespace irr
56 
57 #endif
58 
Interface providing read acess to a file.
Definition: IReadFile.h:17
IReadFile * createMemoryReadFile(void *memory, long size, const io::path &fileName, bool deleteMemoryWhenDropped)
Internal function, please do not use.
virtual long getPos() const =0
Get the current position in the file.
virtual s32 read(void *buffer, u32 sizeToRead)=0
Reads an amount of bytes from the file.
Everything in the Irrlicht Engine can be found in this namespace.
Definition: aabbox3d.h:12
IReadFile * createLimitReadFile(const io::path &fileName, IReadFile *alreadyOpenedFile, long pos, long areaSize)
Internal function, please do not use.
File containing useful basic utility functions.
signed int s32
32 bit signed variable.
Definition: irrTypes.h:66
virtual long getSize() const =0
Get size of file.
unsigned int u32
32 bit unsigned variable.
Definition: irrTypes.h:58
virtual const io::path & getFileName() const =0
Get name of file.
Base class of most objects of the Irrlicht Engine.
IReadFile * createReadFile(const io::path &fileName)
Internal function, please do not use.
virtual bool seek(long finalPos, bool relativeMovement=false)=0
Changes position in file.