CeresEngine::Win32Platform Class Reference

A platform implementation for win32. More...

#include <CeresEngine/Platform/Win32/Win32Platform.hpp>

Inheritance diagram for CeresEngine::Win32Platform:

Public Member Functions
	Win32Platform (Engine &engine)
	Creates a new Win32 platform instance.
	~Win32Platform () noexcept override
	Creates a new Win32 platform instance.
void	run () override
	Starts running the main application run loop.
void	stop () override
	Requests the application to stop running.
UPtr< PlatformWindow >	createWindow (const PlatformWindowDescriptor &descriptor) override
	Creates a new platform window.
UPtr< DispatchQueue >	createDispatchQueue (DispatchQueueType type, StringView name="") override
	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::Platform
	Platform (Engine &engine)
virtual	~Platform () noexcept
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 win32.

Constructor & Destructor Documentation

Win32Platform()

CeresEngine::Win32Platform::Win32Platform ( Engine &  engine )

explicit

Creates a new Win32 platform instance.

~Win32Platform()

CeresEngine::Win32Platform::~Win32Platform ( )

overridenoexcept

Creates a new Win32 platform instance.

Member Function Documentation

createDispatchQueue()

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

overridevirtual

Creates a new queue to which you can submit blocks.

Implements CeresEngine::Platform.

createWindow()

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

run()

void CeresEngine::Win32Platform::run ( )

overridevirtual

Starts running the main application run loop.

Implements CeresEngine::Platform.

stop()

void CeresEngine::Win32Platform::stop ( )

overridevirtual

Requests the application to stop running.

Implements CeresEngine::Platform.

Friends And Related Symbol Documentation

Pimpl

friend struct Pimpl

friend

Member Data Documentation

m

UPtr<Pimpl> CeresEngine::Win32Platform::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/Win32/Win32Platform.hpp