CeresEngine::Platform Class Reference

#include <CeresEngine/Platform/Platform.hpp>

Inheritance diagram for CeresEngine::Platform:

Public Member Functions
	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< PlatformWindow >	createWindow (const PlatformWindowDescriptor &descriptor)=0
	Creates a new platform window.
virtual UPtr< DispatchQueue >	createDispatchQueue (DispatchQueueType type, StringView name="")=0
	Creates a new queue to which you can submit blocks.
virtual IFileSystem *	getLocalFileSystem () const
	Gets the underlying platform local file system implementation.
virtual FileHandle	openFile (const FilePath &path) const
	Opens a file on the local file system.

Static Public Member Functions
static Platform &	get () noexcept
	Gets the current platform. Assets if no platform was initialized.

Constructor & Destructor Documentation

Platform()

CeresEngine::Platform::Platform ( Engine &  engine )

explicit

~Platform()

virtual CeresEngine::Platform::~Platform ( )

virtualnoexcept

Member Function Documentation

createDispatchQueue()

virtual UPtr< DispatchQueue > CeresEngine::Platform::createDispatchQueue ( DispatchQueueType  type, StringView  name = ""  )

pure virtual

Creates a new queue to which you can submit blocks.

Implemented in CeresEngine::ApplePlatform, CeresEngine::EmscriptenPlatform, and CeresEngine::Win32Platform.

createWindow()

virtual UPtr< PlatformWindow > CeresEngine::Platform::createWindow ( const PlatformWindowDescriptor &  descriptor )

pure virtual

Creates a new platform window.

Parameters

descriptor

A descriptor structure that describes the window to be created.

Returns

A newly created window instance.

Implemented in CeresEngine::EmscriptenPlatform, CeresEngine::iOSPlatform, CeresEngine::LinuxPlatform, CeresEngine::MacOSPlatform, and CeresEngine::Win32Platform.

get()

static Platform & CeresEngine::Platform::get ( )

staticnoexcept

Gets the current platform. Assets if no platform was initialized.

getLocalFileSystem()

virtual IFileSystem * CeresEngine::Platform::getLocalFileSystem ( ) const

virtual

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 in CeresEngine::ApplePlatform, CeresEngine::LinuxPlatform, CeresEngine::POSIXPlatform, and CeresEngine::Win32Platform.

openFile()

virtual FileHandle CeresEngine::Platform::openFile ( const FilePath &  path ) const

virtual

Opens a file on the local file system.

Note

Can be a null file handle in case the underlying platform don't expose a local file system. See getLocalFileSystem() for more information.

Parameters

path	The path of the file to be opened.

Returns

A handle to to the file. The file may not exist, you must check with FileHandle::exists().

run()

virtual void CeresEngine::Platform::run ( )

pure virtual

Starts running the main application run loop.

Implemented in CeresEngine::EmscriptenPlatform, CeresEngine::MacOSPlatform, CeresEngine::ApplePlatform, CeresEngine::iOSPlatform, and CeresEngine::Win32Platform.

stop()

virtual void CeresEngine::Platform::stop ( )

pure virtual

Requests the application to stop running.

Implemented in CeresEngine::EmscriptenPlatform, CeresEngine::MacOSPlatform, CeresEngine::ApplePlatform, CeresEngine::iOSPlatform, and CeresEngine::Win32Platform.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Platform/Platform.hpp