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

A platform implementation for iOS. More...

#include <CeresEngine/Platform/iOS/iOSPlatform.hpp>

Inheritance diagram for CeresEngine::iOSPlatform:
CeresEngine::ApplePlatform CeresEngine::POSIXPlatform CeresEngine::Platform

Public Member Functions

 iOSPlatform (Engine &engine)
 Creates a new iOS platform instance.
 
 ~iOSPlatform () noexcept override
 Creates a new iOS platform instance.
 
void run () override
 Starts running the main application run loop.
 
void stop () override
 Requests the application to stop running.
 
UPtr< PlatformWindowcreateWindow (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< DispatchQueuecreateDispatchQueue (DispatchQueueType type, StringView name="") final
 Creates a new queue to which you can submit blocks.
 
IFileSystemgetLocalFileSystem () const override
 Gets the underlying platform local file system implementation.
 
- 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.
 

Static Public Member Functions

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

Private Attributes

UPtr< Pimplm
 Hidden implementation class for the platform.
 

Friends

struct Pimpl
 

Detailed Description

A platform implementation for iOS.

Constructor & Destructor Documentation

◆ iOSPlatform()

CeresEngine::iOSPlatform::iOSPlatform ( Engine engine)
explicit

Creates a new iOS platform instance.

◆ ~iOSPlatform()

CeresEngine::iOSPlatform::~iOSPlatform ( )
overridenoexcept

Creates a new iOS platform instance.

Member Function Documentation

◆ createWindow()

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

◆ getResourcesDirectory()

static String CeresEngine::iOSPlatform::getResourcesDirectory ( )
static

◆ main()

static void CeresEngine::iOSPlatform::main ( )
static

◆ run()

void CeresEngine::iOSPlatform::run ( )
overridevirtual

Starts running the main application run loop.

Reimplemented from CeresEngine::ApplePlatform.

◆ stop()

void CeresEngine::iOSPlatform::stop ( )
overridevirtual

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

Hidden implementation class for the platform.


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