Gamedev Framework (gf) 1.2.0
A C++17 framework for 2D games
Paths.h
1/*
2 * Gamedev Framework (gf)
3 * Copyright (C) 2016-2022 Julien Bernard
4 *
5 * This software is provided 'as-is', without any express or implied
6 * warranty. In no event will the authors be held liable for any damages
7 * arising from the use of this software.
8 *
9 * Permission is granted to anyone to use this software for any purpose,
10 * including commercial applications, and to alter it and redistribute it
11 * freely, subject to the following restrictions:
12 *
13 * 1. The origin of this software must not be misrepresented; you must not
14 * claim that you wrote the original software. If you use this software
15 * in a product, an acknowledgment in the product documentation would be
16 * appreciated but is not required.
17 * 2. Altered source versions must be plainly marked as such, and must not be
18 * misrepresented as being the original software.
19 * 3. This notice may not be removed or altered from any source distribution.
20 */
21#ifndef GF_PATHS_H
22#define GF_PATHS_H
23
24#include <string>
25
26#include "GraphicsApi.h"
27#include "Path.h"
28
29namespace gf {
30#ifndef DOXYGEN_SHOULD_SKIP_THIS
31inline namespace v1 {
32#endif
33
40 struct GF_GRAPHICS_API Paths {
44 Paths() = delete;
45
56 static Path getPrefPath(const std::string& org, const std::string& app);
57
64 static Path getBasePath();
65
72
79 };
80
81#ifndef DOXYGEN_SHOULD_SKIP_THIS
82}
83#endif
84}
85
86#endif // GF_PATHS_H
std::filesystem::path Path
A path in the filesystem.
Definition: Path.h:40
The namespace for gf classes.
Special paths.
Definition: Paths.h:40
static Path getCurrentPath()
Get the current path.
static Path getBasePath()
Get the base path.
static Path getPrefPath(const std::string &org, const std::string &app)
Get the preferences path.
static Path getTemporaryDirectory()
Get a temporary directory.
Paths()=delete
Deleted constructor.