2.9.16
Coherent GT
A modern user interface library for games
renoir::IFileManipulator Class Referenceabstract

Object capable of enumerating directories and opening files. More...

#include <Coherent/renoir/include/RenoirCore/CoherentRenderingLibrary.h>

+ Inheritance diagram for renoir::IFileManipulator:

Public Member Functions

virtual bool EnumerateFolder (const char *path)=0
 Prepares the given folder for enumeration. More...
 
virtual const char * NextFile ()=0
 Returns the name of the i-th file in the current folder. More...
 
virtual IStreamReaderOpenFile (const char *path)=0
 Opens the given file for reading. More...
 

Detailed Description

Object capable of enumerating directories and opening files.

Member Function Documentation

◆ EnumerateFolder()

virtual bool renoir::IFileManipulator::EnumerateFolder ( const char *  path)
pure virtual

Prepares the given folder for enumeration.

Parameters
paththe path to the folder
Returns
whether the folder is ready for enumeration

◆ NextFile()

virtual const char* renoir::IFileManipulator::NextFile ( )
pure virtual

Returns the name of the i-th file in the current folder.

Returns
the name of the file (only the name, not its path)

◆ OpenFile()

virtual IStreamReader* renoir::IFileManipulator::OpenFile ( const char *  path)
pure virtual

Opens the given file for reading.

Parameters
pathpath to the file
Returns
a stream reader for the given file or nullptr if the path does not exist