A platform implementation for linux. More...

#include <CeresEngine/Platform/Linux/LinuxPlatform.hpp>

Inheritance diagram for CeresEngine::LinuxPlatform:

Public Member Functions
	LinuxPlatform ()
	Creates a new Linux platform instance.

	~LinuxPlatform () noexcept override
	Creates a new Linux platform instance.

UPtr< PlatformWindow >	createWindow (const PlatformWindowDescriptor &descriptor) override
	Creates a new platform window.

IFileSystem *	getLocalFileSystem () const override
	Gets the underlying platform local file system implementation.

Public Member Functions inherited from CeresEngine::POSIXPlatform
IFileSystem *	getLocalFileSystem () 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< DispatchQueue >	createDispatchQueue (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.

Private Attributes
UPtr< Pimpl >	m
	Hidden implementation class for the platform.

Friends
struct	Pimpl

Additional Inherited Members
Static Public Member Functions inherited from CeresEngine::Platform
static Platform &	get () noexcept
	Gets the current platform. Assets if no platform was initialized.

Detailed Description

A platform implementation for linux.

Constructor & Destructor Documentation

◆ LinuxPlatform()

CeresEngine::LinuxPlatform::LinuxPlatform ( )

Creates a new Linux platform instance.

◆ ~LinuxPlatform()

CeresEngine::LinuxPlatform::~LinuxPlatform ( )

overridenoexcept

Creates a new Linux platform instance.

Member Function Documentation

◆ createWindow()

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

overridevirtual

Creates a new platform window.

Parameters

descriptor A descriptor structure that describes the window to be created.

Returns: A newly created window instance.

Implements CeresEngine::Platform.

◆ getLocalFileSystem()

IFileSystem * CeresEngine::LinuxPlatform::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.

Friends And Related Symbol Documentation

◆ Pimpl

friend struct Pimpl

friend

Member Data Documentation

◆ m

UPtr<Pimpl> CeresEngine::LinuxPlatform::m

private

Hidden implementation class for the platform.

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

/Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Platform/Linux/LinuxPlatform.hpp

Public Member Functions

Private Attributes

Friends

Additional Inherited Members