#include <Platform.h>
Inherited by cinder::app::PlatformCocoa, cinder::app::PlatformMsw, and cinder::app::PlatformWinRt.
virtual cinder::app::Platform::~Platform |
( |
| ) |
|
|
virtual |
cinder::app::Platform::Platform |
( |
| ) |
|
|
protected |
Platform * cinder::app::Platform::get |
( |
| ) |
|
|
static |
void cinder::app::Platform::set |
( |
Platform * |
platform | ) |
|
|
static |
virtual void cinder::app::Platform::prepareLaunch |
( |
| ) |
|
|
virtual |
Called at the beginning of a launch, can be overridden for platform-specifc preparation.
Reimplemented in cinder::app::PlatformCocoa.
virtual void cinder::app::Platform::cleanupLaunch |
( |
| ) |
|
|
virtual |
DataSourceRef cinder::app::Platform::loadAsset |
( |
const fs::path & |
relativePath | ) |
|
Returns a DataSourceRef to an application asset. Throws a AssetLoadExc on failure.
fs::path cinder::app::Platform::getAssetPath |
( |
const fs::path & |
relativePath | ) |
const |
Returns a fs::path to an application asset. Returns an empty path on failure.
void cinder::app::Platform::addAssetDirectory |
( |
const fs::path & |
directory | ) |
|
Adds an absolute path to the list of directories which are searched for assets.
- Note
- Not thread-safe, e.g. you should not call this when loadAsset() or getAssetPath() can occur from a different thread.
const vector< fs::path > & cinder::app::Platform::getAssetDirectories |
( |
| ) |
const |
Returns a vector of directories that are searched when looking up an asset path.
virtual DataSourceRef cinder::app::Platform::loadResource |
( |
const fs::path & |
resourcePath, |
|
|
int |
mswID, |
|
|
const std::string & |
mswType |
|
) |
| |
|
pure virtual |
(MSW only) Returns a DataSource to an application resource. mswID and mswType identify the resource as defined the application's .rc file(s).
- See also
- CinderResources
Implemented in cinder::app::PlatformMsw.
virtual fs::path cinder::app::Platform::getResourceDirectory |
( |
| ) |
const |
|
pure virtual |
virtual fs::path cinder::app::Platform::getResourcePath |
( |
const fs::path & |
rsrcRelativePath | ) |
const |
|
pure virtual |
fs::path cinder::app::Platform::getExecutablePath |
( |
| ) |
const |
Returns the path to the associated executable.
void cinder::app::Platform::setExecutablePath |
( |
const fs::path & |
execPath | ) |
|
Sets the path to the associated executable, overriding the default.
virtual fs::path cinder::app::Platform::getOpenFilePath |
( |
const fs::path & |
initialPath = fs::path() , |
|
|
const std::vector< std::string > & |
extensions = std::vector< std::string >() |
|
) |
| |
|
pure virtual |
Presents the user with an open-file dialog and returns the selected file path. The dialog optionally begins at the path initialPath and can be limited to allow selection of files ending in the extensions enumerated in extensions.
- Returns
- the selected file path, or an empty fs::path if the user cancelled or this operation isn't supported on the current platform.
Implemented in cinder::app::PlatformCocoa, cinder::app::PlatformWinRt, and cinder::app::PlatformMsw.
virtual fs::path cinder::app::Platform::getFolderPath |
( |
const fs::path & |
initialPath = fs::path() | ) |
|
|
pure virtual |
virtual fs::path cinder::app::Platform::getSaveFilePath |
( |
const fs::path & |
initialPath = fs::path() , |
|
|
const std::vector< std::string > & |
extensions = std::vector< std::string >() |
|
) |
| |
|
pure virtual |
Presents the user with a save-file dialog and returns the selected file path. The dialog optionally begins at the path initialPath and can be limited to allow selection of files ending in the extensions enumerated in extensions.
- Returns
- the selected file path, or an empty fs::path if the user cancelled or this operation isn't supported on the current platform.
Implemented in cinder::app::PlatformCocoa, cinder::app::PlatformWinRt, and cinder::app::PlatformMsw.
std::ostream & cinder::app::Platform::console |
( |
| ) |
|
|
virtual |
virtual std::map<std::string,std::string> cinder::app::Platform::getEnvironmentVariables |
( |
| ) |
|
|
pure virtual |
virtual fs::path cinder::app::Platform::expandPath |
( |
const fs::path & |
path | ) |
|
|
pure virtual |
virtual fs::path cinder::app::Platform::getHomeDirectory |
( |
| ) |
const |
|
pure virtual |
virtual fs::path cinder::app::Platform::getDocumentsDirectory |
( |
| ) |
const |
|
pure virtual |
virtual fs::path cinder::app::Platform::getDefaultExecutablePath |
( |
| ) |
const |
|
pure virtual |
virtual void cinder::app::Platform::sleep |
( |
float |
milliseconds | ) |
|
|
pure virtual |
virtual void cinder::app::Platform::launchWebBrowser |
( |
const Url & |
url | ) |
|
|
pure virtual |
virtual std::vector<std::string> cinder::app::Platform::stackTrace |
( |
| ) |
|
|
pure virtual |
virtual const std::vector<DisplayRef>& cinder::app::Platform::getDisplays |
( |
| ) |
|
|
pure virtual |
virtual void cinder::app::Platform::prepareAssetLoading |
( |
| ) |
|
|
protectedvirtual |
void cinder::app::Platform::findAndAddDefaultAssetPath |
( |
| ) |
|
|
protectedvirtual |
Called to add the default assets folder by walking up the path from the executable until a folder named 'assets' is found. Subclasses can override this method to disable this functionality.
The documentation for this class was generated from the following files: