Gamedev Framework (gf)  0.11.0
A C++14 framework for 2D games
Public Member Functions | Static Public Member Functions | List of all members
gf::Paths Struct Reference

Special paths. More...

#include <gf/Paths.h>

Public Member Functions

 Paths ()=delete
 Deleted constructor. More...
 

Static Public Member Functions

static Path getPrefPath (StringRef org, StringRef app)
 Get the preferences path. More...
 
static Path getBasePath ()
 Get the base path. More...
 
static Path getCurrentPath ()
 Get the current path. More...
 
static Path getTemporaryDirectory ()
 Get a temporary directory. More...
 
static Path getUniquePath ()
 Get a unique path. More...
 

Detailed Description

Special paths.

See also
gf::SystemInfo

Constructor & Destructor Documentation

◆ Paths()

gf::Paths::Paths ( )
delete

Deleted constructor.

Member Function Documentation

◆ getBasePath()

static Path gf::Paths::getBasePath ( )
static

Get the base path.

The base path is the path where the application is run.

Returns
The base path

◆ getCurrentPath()

static Path gf::Paths::getCurrentPath ( )
static

Get the current path.

Returns
The current path

◆ getPrefPath()

static Path gf::Paths::getPrefPath ( StringRef  org,
StringRef  app 
)
static

Get the preferences path.

The preferences path is where an application can save data. It depends on the user and the application.

Parameters
orgThe name of your organization
appThe name of your application
Returns
The preferences path

◆ getTemporaryDirectory()

static Path gf::Paths::getTemporaryDirectory ( )
static

Get a temporary directory.

Returns
A temporary directory

◆ getUniquePath()

static Path gf::Paths::getUniquePath ( )
static

Get a unique path.

Returns
A unique path