CeresEngine::MacOSPlatform Class Reference

A platform implementation for macOS. More...

#include <CeresEngine/Platform/Mac/MacOSPlatform.hpp>

Inheritance diagram for CeresEngine::MacOSPlatform:

Public Member Functions
	MacOSPlatform (Engine &engine)
	Creates a new MacOS platform instance.
	~MacOSPlatform () noexcept override
	Creates a new MacOS platform instance.
void	run () final
	Starts running the main application run loop.
void	stop () final
	Requests the application to stop running.
UPtr< PlatformWindow >	createWindow (const PlatformWindowDescriptor &descriptor) override
	Creates a new platform window.
Public Member Functions inherited from CeresEngine::ApplePlatform
	ApplePlatform (Engine &engine)
	Creates a new Apple platform instance.
	~ApplePlatform () noexcept override
	Creates a new Apple platform instance.
UPtr< DispatchQueue >	createDispatchQueue (DispatchQueueType type, StringView name="") final
	Creates a new queue to which you can submit blocks.
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 FileHandle	openFile (const FilePath &path) const
	Opens a file on the local file system.

Private Types
using	super = ApplePlatform

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 macOS.

Member Typedef Documentation

super

using CeresEngine::MacOSPlatform::super = ApplePlatform

private

Constructor & Destructor Documentation

MacOSPlatform()

CeresEngine::MacOSPlatform::MacOSPlatform ( Engine &  engine )

explicit

Creates a new MacOS platform instance.

~MacOSPlatform()

CeresEngine::MacOSPlatform::~MacOSPlatform ( )

overridenoexcept

Creates a new MacOS platform instance.

Member Function Documentation

createWindow()

UPtr< PlatformWindow > CeresEngine::MacOSPlatform::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.

run()

void CeresEngine::MacOSPlatform::run ( )

finalvirtual

Starts running the main application run loop.

Reimplemented from CeresEngine::ApplePlatform.

stop()

void CeresEngine::MacOSPlatform::stop ( )

finalvirtual

Requests the application to stop running.

Reimplemented from CeresEngine::ApplePlatform.

Friends And Related Symbol Documentation

Pimpl

friend struct Pimpl

friend

Member Data Documentation

m

UPtr<Pimpl> CeresEngine::MacOSPlatform::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/Mac/MacOSPlatform.hpp