Simulant  21.12-574
A portable game engine for Windows, OSX, Linux, Dreamcast, and PSP
Public Member Functions | List of all members
smlt::VirtualFileSystem Class Reference
Inheritance diagram for smlt::VirtualFileSystem:
smlt::RefCounted< VirtualFileSystem > smlt::TwoPhaseConstructed

Public Member Functions

const std::list< Path > & search_path ()
optional< Pathlocate_file (const Path &filename, bool use_cache=true, bool fail_silently=false) const
std::shared_ptr< std::istream > open_file (const Path &filename)
std::shared_ptr< std::stringstream > read_file (const Path &filename)
std::vector< std::string > read_file_lines (const Path &filename)
bool add_search_path (const Path &path)
bool insert_search_path (uint32_t index, const Path &path)
void remove_search_path (const Path &path)
std::size_t search_path_size () const
std::size_t location_cache_size () const
void clear_location_cache ()
void set_location_cache_limit (std::size_t entries)
void enable_read_blocking ()
void disable_read_blocking ()
bool read_blocking_enabled () const
- Public Member Functions inherited from smlt::TwoPhaseConstructed
virtual bool init ()
virtual void clean_up ()

Additional Inherited Members

- Public Types inherited from smlt::RefCounted< VirtualFileSystem >
typedef std::shared_ptr< VirtualFileSystemptr
typedef std::weak_ptr< VirtualFileSystemwptr
- Static Public Member Functions inherited from smlt::RefCounted< VirtualFileSystem >
static RefCounted< VirtualFileSystem >::ptr create (Args &&... args)
static RefCounted< VirtualFileSystem >::ptr create ()
- Protected Member Functions inherited from smlt::RefCounted< VirtualFileSystem >
 RefCounted (Args &&...)

Member Function Documentation

◆ enable_read_blocking()

void smlt::VirtualFileSystem::enable_read_blocking ( )

If read blocking is enabled, then all attempts to access the filesyste will fail and an error will be logged. This is useful if you are targetting a device that loads from a CD and plays CD-audio where a read could stop the audio playing

The documentation for this class was generated from the following files: