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.
static constexpr auto	gameGeometry ()
	Path to game geometry assets.
static constexpr auto	gameAudio ()
	Path to game Audio assets.
static constexpr auto	gameTextures ()
	Path to game texture assets.
static constexpr auto	engineShaders ()
	Path to engine shaders.
static constexpr auto	engineTextures ()
	Path to engine textures.
static constexpr auto	engineFonts ()
	Path to font assets.
static constexpr auto	engineSounds ()
	Path to engine audio files.
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 174 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 243 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 191 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 227 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 252 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 235 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 209 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 200 of file Path.h.

References Engine::Core::ConstexprPath().

Here is the call graph for this function:

gameTextures()

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

inlinestaticconstexpr

Path to game texture assets.

LSP source path: AirHockey/Data/textures

Definition at line 218 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:

• /workspace/magerbeton/gl3-vulkan/code/Engine/include/Engine/Files/Path.h