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

#include <CeresEngine/Platform/Emscripten/EmscriptenPlatform.hpp>

Inheritance diagram for CeresEngine::EmscriptenPlatform:
CeresEngine::POSIXPlatform CeresEngine::Platform

Public Member Functions

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

Private Attributes

UPtr< Pimplm
 Hidden implementation class for the platform.
 

Friends

struct Pimpl
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ EmscriptenPlatform()

CeresEngine::EmscriptenPlatform::EmscriptenPlatform ( Engine engine)

Creates a new Emscripten platform instance.

◆ ~EmscriptenPlatform()

CeresEngine::EmscriptenPlatform::~EmscriptenPlatform ( )
overridenoexcept

Creates a new Emscripten platform instance.

Member Function Documentation

◆ createDispatchQueue()

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

Creates a new queue to which you can submit blocks.

Implements CeresEngine::Platform.

◆ createWindow()

UPtr< PlatformWindow > CeresEngine::EmscriptenPlatform::createWindow ( const PlatformWindowDescriptor descriptor)
overridevirtual

Creates a new platform window.

Parameters
descriptorA descriptor structure that describes the window to be created.
Returns
A newly created window instance.

Implements CeresEngine::Platform.

◆ run()

void CeresEngine::EmscriptenPlatform::run ( )
finalvirtual

Starts running the main application run loop.

Implements CeresEngine::Platform.

◆ stop()

void CeresEngine::EmscriptenPlatform::stop ( )
finalvirtual

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::EmscriptenPlatform::m
private

Hidden implementation class for the platform.


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