From 71e94ee161447b84c0eaabf6567f8fa62262cd3e Mon Sep 17 00:00:00 2001 From: Mirrorbot Date: Sat, 27 Dec 2025 17:53:06 -0600 Subject: Inital commit --- doc/html/classirr_1_1io_1_1_i_read_file.html | 290 +++++++++++++++++++++++++++ 1 file changed, 290 insertions(+) create mode 100644 doc/html/classirr_1_1io_1_1_i_read_file.html (limited to 'doc/html/classirr_1_1io_1_1_i_read_file.html') diff --git a/doc/html/classirr_1_1io_1_1_i_read_file.html b/doc/html/classirr_1_1io_1_1_i_read_file.html new file mode 100644 index 0000000..8e91ea8 --- /dev/null +++ b/doc/html/classirr_1_1io_1_1_i_read_file.html @@ -0,0 +1,290 @@ + + + + +Irrlicht 3D Engine: irr::io::IReadFile Class Reference + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + +
+
Irrlicht 3D Engine + +
+ +
+ + + + + + +
+
+
+ + + + +
+
+ +
+
+
+ +
+
+
+Public Member Functions
+
+
irr::io::IReadFile Class Reference
+
+
+ +

Interface providing read acess to a file. + More...

+ +

#include <IReadFile.h>

+
+ + Inheritance diagram for irr::io::IReadFile:
+
+
+ + +

List of all members.

+

+Public Member Functions

+
    +
  • virtual const io::path & getFileName () const =0 +
    Get name of file.
  • virtual long getPos () const =0 +
    Get the current position in the file.
  • virtual long getSize () const =0 +
    Get size of file.
  • virtual s32 read (void *buffer, u32 sizeToRead)=0 +
    Reads an amount of bytes from the file.
  • virtual bool seek (long finalPos, bool relativeMovement=false)=0 +
    Changes position in file.
+

Detailed Description

+

Interface providing read acess to a file.

+ +

Definition at line 17 of file IReadFile.h.

+

Member Function Documentation

+ +
+
+ + + + + + + +
virtual const io::path& irr::io::IReadFile::getFileName () const [pure virtual]
+
+
+ +

Get name of file.

+
Returns:
File name as zero terminated character string.
+ +
+
+ +
+
+ + + + + + + +
virtual long irr::io::IReadFile::getPos () const [pure virtual]
+
+
+ +

Get the current position in the file.

+
Returns:
Current position in the file in bytes.
+ +
+
+ +
+
+ + + + + + + +
virtual long irr::io::IReadFile::getSize () const [pure virtual]
+
+
+ +

Get size of file.

+
Returns:
Size of the file in bytes.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
virtual s32 irr::io::IReadFile::read (void * buffer,
u32 sizeToRead 
) [pure virtual]
+
+
+ +

Reads an amount of bytes from the file.

+
Parameters:
+ + + +
bufferPointer to buffer where read bytes are written to.
sizeToReadAmount of bytes to read from the file.
+
+
+
Returns:
How many bytes were read.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
virtual bool irr::io::IReadFile::seek (long finalPos,
bool relativeMovement = false 
) [pure virtual]
+
+
+ +

Changes position in file.

+
Parameters:
+ + + +
finalPosDestination position in the file.
relativeMovementIf set to true, the position in the file is changed relative to current position. Otherwise the position is changed from beginning of file.
+
+
+
Returns:
True if successful, otherwise false.
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + + -- cgit v1.2.3-70-g09d2