CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::POSIXPlatform Class Reference

A platform implementation for POSIX-based systems. More...

#include <CeresEngine/Platform/POSIX/POSIXPlatform.hpp>

Inheritance diagram for CeresEngine::POSIXPlatform:
CeresEngine::Platform CeresEngine::ApplePlatform CeresEngine::EmscriptenPlatform CeresEngine::LinuxPlatform CeresEngine::MacOSPlatform CeresEngine::iOSPlatform

Public Member Functions

IFileSystemgetLocalFileSystem () const override
 Gets the underlying platform local file system implementation.
 
 Platform (Engine &engine)
 
- Public Member Functions inherited from CeresEngine::Platform
 Platform (Engine &engine)
 
virtual ~Platform () noexcept
 
virtual void run ()=0
 Starts running the main application run loop.
 
virtual void stop ()=0
 Requests the application to stop running.
 
virtual UPtr< PlatformWindowcreateWindow (const PlatformWindowDescriptor &descriptor)=0
 Creates a new platform window.
 
virtual UPtr< DispatchQueuecreateDispatchQueue (DispatchQueueType type, StringView name="")=0
 Creates a new queue to which you can submit blocks.
 
virtual FileHandle openFile (const FilePath &path) const
 Opens a file on the local file system.
 

Additional Inherited Members

- Static Public Member Functions inherited from CeresEngine::Platform
static Platformget () noexcept
 Gets the current platform. Assets if no platform was initialized.
 

Detailed Description

A platform implementation for POSIX-based systems.

Member Function Documentation

◆ getLocalFileSystem()

IFileSystem * CeresEngine::POSIXPlatform::getLocalFileSystem ( ) const
overridevirtual

Gets the underlying platform local file system implementation.

Note
Can be null in case the underlying platform doesn't expose a file system.
The default implementation returns nullptr. Platform implementors should override this method and return the local file system implementation of their platform.
Returns
A pointer to the platform local file system implementation.

Reimplemented from CeresEngine::Platform.

◆ Platform()

CeresEngine::Platform::Platform ( Engine engine)
explicit

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