Interface providing read acess to a file.
More...
#include <ik_IFileReader.h>
Interface providing read acess to a file.
Definition at line 14 of file ik_IFileReader.h.
| virtual irrklang::IFileReader::~IFileReader |
( |
| ) |
|
|
inlinevirtual |
| virtual const ik_c8* irrklang::IFileReader::getFileName |
( |
| ) |
|
|
pure virtual |
Returns name of file.
- Returns
- Returns the file name as zero terminated character string.
| virtual ik_s32 irrklang::IFileReader::getPos |
( |
| ) |
|
|
pure virtual |
Returns the current position in the file.
- Returns
- Returns the current position in the file in bytes.
| virtual ik_s32 irrklang::IFileReader::getSize |
( |
| ) |
|
|
pure virtual |
Returns size of file.
- Returns
- Returns the size of the file in bytes.
| virtual ik_s32 irrklang::IFileReader::read |
( |
void * |
buffer, |
|
|
ik_u32 |
sizeToRead |
|
) |
| |
|
pure virtual |
Reads an amount of bytes from the file.
- Parameters
-
| buffer | Pointer to buffer where to read bytes will be written to. |
| sizeToRead | Amount of bytes to read from the file. |
- Returns
- Returns how much bytes were read.
| virtual bool irrklang::IFileReader::seek |
( |
ik_s32 |
finalPos, |
|
|
bool |
relativeMovement = false |
|
) |
| |
|
pure virtual |
Changes position in file, returns true if successful.
- Parameters
-
| finalPos | Destination position in the file. |
| 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. |
- Returns
- Returns true if successful, otherwise false.
The documentation for this class was generated from the following file:
Public Member Functions inherited from irrklang::IRefCounted
1.8.9.1 
