file_system.h File Reference

#include "core/systems/logging_sys.h"

Go to the source code of this file.

Classes
struct	Ember_File
	Ember file (SDL_stream) More...
struct	Ember_VFS
	Engine virtual file system. More...
class	FileAccess
	A RAII wrapper for SDL3 file operations supporting read/write access. More...

Enumerations
enum class	ModeFlags { READ , WRITE , READ_WRITE , WRITE_READ }
	Flags to indicate access modes. More...

Functions
std::string	load_assets_file (const std::string &file_path)
	Loads a given file from res folder. More...
std::vector< char >	load_file_into_memory (const std::string &file_path)
	Loads a given file from res folder into memory. More...
ma_result	_ember_init_vfs (Ember_VFS *vfs)

Enumeration Type Documentation

ModeFlags

enum ModeFlags

strong

Flags to indicate access modes.

• READ : Read-only access
• WRITE : Write-only access
• READ_WRITE : Read + Write access (read first, then write)
• WRITE_READ : Write + Read access (write first, then read)

Enumerator
READ	Read-only access.
WRITE	Write-only access.
READ_WRITE	Read then Write access.
WRITE_READ	Write then Read access.

Function Documentation

_ember_init_vfs()

ma_result _ember_init_vfs

(

Ember_VFS *

vfs

)

load_assets_file()

std::string load_assets_file

(

const std::string &

file_path

)

Loads a given file from res folder.

• The file path is relative to res folder

Version

0.0.1

Parameters

file_path

the path to the file in res folder

Returns

File content as string

load_file_into_memory()

std::vector<char> load_file_into_memory

(

const std::string &

file_path

)

Loads a given file from res folder into memory.

• The file path is relative to res folder

Version

0.0.2

Parameters

file_path

the path to the file in res folder

Returns

File content as vector<char>