Engine::Core::Path Class Reference

Centralized accessors for project and asset paths. More...

#include <Path.h>

Static Public Member Functions
static std::string	getEngineRoot ()
	Gets the engine root directory at runtime.
static constexpr std::string	getProjectRoot ()
	Gets the root location of the whole game. This is.
static constexpr auto	engineGeometry ()
	Path to engine geometry assets @lsp_source_path Engine/geometry.
static constexpr auto	gameGeometry ()
	Path to game geometry assets @lsp_source_path AirHockey/Data/geometry.
static constexpr auto	gameAudio ()
	Path to game Audio assets @lsp_source_path AirHockey/Data/Audio.
static constexpr auto	engineShaders ()
	Path to engine shaders @lsp_source_path Engine/shaders.
static constexpr auto	engineTextures ()
	Path to engine textures @lsp_source_path Engine/textures.
static constexpr auto	engineFonts ()
	Path to font assets @lsp_source_path Engine/fonts.
static constexpr auto	engineSounds ()
	Path to engine audio files @lsp_source_path Engine/sounds.
static bool	doesFileExist (const std::filesystem::path &path)
	Checks if a file at a filepath exists.
static bool	doesGltfFileExist (const std::filesystem::path &path)
	Checks if the specified filepath exists at the given path and is a gltf file.
static bool	doesExrFileExist (const std::filesystem::path &path)
	Checks if the specified filepath exists at the given path and if the file is an exr file.
static bool	doesFileOfTypeExist (const std::filesystem::path &path, const std::string &extension)
	Checks if the specified filepath exists and if the file at the path is of a file type.

Detailed Description

Centralized accessors for project and asset paths.

Definition at line 109 of file Path.h.

Member Function Documentation

doesExrFileExist()

bool Engine::Core::Path::doesExrFileExist ( const std::filesystem::path & path )

static

Checks if the specified filepath exists at the given path and if the file is an exr file.

Parameters

path	filepath to check

Returns

ture if the file exists and if it is a exr file

doesFileExist()

bool Engine::Core::Path::doesFileExist ( const std::filesystem::path & path )

static

Checks if a file at a filepath exists.

Parameters

path	filepath to check

Returns

true if the file exists

doesFileOfTypeExist()

bool Engine::Core::Path::doesFileOfTypeExist ( const std::filesystem::path & path, const std::string & extension )

static

Checks if the specified filepath exists and if the file at the path is of a file type.

Parameters

path	filepath to check
extension	filetype extension like ".exr"

Returns

true if the object exists and is of the specified file extension

doesGltfFileExist()

bool Engine::Core::Path::doesGltfFileExist ( const std::filesystem::path & path )

static

Checks if the specified filepath exists at the given path and is a gltf file.

Parameters

path	filepath to check

Returns

true if the file exists and if it is a gltf file

engineFonts()

constexpr auto Engine::Core::Path::engineFonts ( )

inlinestaticconstexpr

Path to font assets @lsp_source_path Engine/fonts.

Definition at line 169 of file Path.h.

References Engine::Core::ConstexprPath().

Here is the call graph for this function:

engineGeometry()

constexpr auto Engine::Core::Path::engineGeometry ( )

inlinestaticconstexpr

Path to engine geometry assets @lsp_source_path Engine/geometry.

Definition at line 126 of file Path.h.

References Engine::Core::ConstexprPath().

Here is the call graph for this function:

engineShaders()

constexpr auto Engine::Core::Path::engineShaders ( )

inlinestaticconstexpr

Path to engine shaders @lsp_source_path Engine/shaders.

Definition at line 153 of file Path.h.

References Engine::Core::ConstexprPath().

Here is the call graph for this function:

engineSounds()

constexpr auto Engine::Core::Path::engineSounds ( )

inlinestaticconstexpr

Path to engine audio files @lsp_source_path Engine/sounds.

Definition at line 178 of file Path.h.

References Engine::Core::ConstexprPath().

Here is the call graph for this function:

engineTextures()

constexpr auto Engine::Core::Path::engineTextures ( )

inlinestaticconstexpr

Path to engine textures @lsp_source_path Engine/textures.

Definition at line 161 of file Path.h.

References Engine::Core::ConstexprPath().

Here is the call graph for this function:

gameAudio()

constexpr auto Engine::Core::Path::gameAudio ( )

inlinestaticconstexpr

Path to game Audio assets @lsp_source_path AirHockey/Data/Audio.

Definition at line 144 of file Path.h.

References Engine::Core::ConstexprPath().

Here is the call graph for this function:

gameGeometry()

constexpr auto Engine::Core::Path::gameGeometry ( )

inlinestaticconstexpr

Path to game geometry assets @lsp_source_path AirHockey/Data/geometry.

Definition at line 135 of file Path.h.

References Engine::Core::ConstexprPath().

Here is the call graph for this function:

getEngineRoot()

std::string Engine::Core::Path::getEngineRoot ( )

static

Gets the engine root directory at runtime.

Returns

Filesystem path string for the engine root.

getProjectRoot()

constexpr std::string Engine::Core::Path::getProjectRoot ( )

staticconstexpr

Gets the root location of the whole game. This is.

---

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

• /home/magerbeton/Documents/gl3-vulkan/Engine/include/Engine/Files/Path.h