diff options
| author | Mirrorbot <mirrorbot@cogarr.net> | 2025-12-27 17:53:06 -0600 |
|---|---|---|
| committer | Mirrorbot <mirrorbot@cogarr.net> | 2025-12-27 17:53:06 -0600 |
| commit | 71e94ee161447b84c0eaabf6567f8fa62262cd3e (patch) | |
| tree | 391064cc6173a6fe75069af2fdc1978af12f623e /include/IReadFile.h | |
| download | irrlicht-71e94ee161447b84c0eaabf6567f8fa62262cd3e.tar.gz irrlicht-71e94ee161447b84c0eaabf6567f8fa62262cd3e.tar.bz2 irrlicht-71e94ee161447b84c0eaabf6567f8fa62262cd3e.zip | |
Diffstat (limited to 'include/IReadFile.h')
| -rw-r--r-- | include/IReadFile.h | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/include/IReadFile.h b/include/IReadFile.h new file mode 100644 index 0000000..e925690 --- /dev/null +++ b/include/IReadFile.h @@ -0,0 +1,58 @@ +// Copyright (C) 2002-2012 Nikolaus Gebhardt
+// This file is part of the "Irrlicht Engine".
+// For conditions of distribution and use, see copyright notice in irrlicht.h
+
+#ifndef __I_READ_FILE_H_INCLUDED__
+#define __I_READ_FILE_H_INCLUDED__
+
+#include "IReferenceCounted.h"
+#include "coreutil.h"
+
+namespace irr
+{
+namespace io
+{
+
+ //! Interface providing read acess to a file.
+ class IReadFile : public virtual IReferenceCounted
+ {
+ public:
+ //! Reads an amount of bytes from the file.
+ /** \param buffer Pointer to buffer where read bytes are written to.
+ \param sizeToRead Amount of bytes to read from the file.
+ \return How many bytes were read. */
+ virtual s32 read(void* buffer, u32 sizeToRead) = 0;
+
+ //! Changes position in file
+ /** \param finalPos Destination position in the file.
+ \param relativeMovement If set to true, the position in the file is
+ changed relative to current position. Otherwise the position is changed
+ from beginning of file.
+ \return True if successful, otherwise false. */
+ virtual bool seek(long finalPos, bool relativeMovement = false) = 0;
+
+ //! Get size of file.
+ /** \return Size of the file in bytes. */
+ virtual long getSize() const = 0;
+
+ //! Get the current position in the file.
+ /** \return Current position in the file in bytes. */
+ virtual long getPos() const = 0;
+
+ //! Get name of file.
+ /** \return File name as zero terminated character string. */
+ virtual const io::path& getFileName() const = 0;
+ };
+
+ //! Internal function, please do not use.
+ IReadFile* createReadFile(const io::path& fileName);
+ //! Internal function, please do not use.
+ IReadFile* createLimitReadFile(const io::path& fileName, IReadFile* alreadyOpenedFile, long pos, long areaSize);
+ //! Internal function, please do not use.
+ IReadFile* createMemoryReadFile(void* memory, long size, const io::path& fileName, bool deleteMemoryWhenDropped);
+
+} // end namespace io
+} // end namespace irr
+
+#endif
+
|