class UIBackend

The base class from which platform-specific UI backends need to derive.

File location: framework/cauldron/framework/inc/core/uibackend.h

Construction

Return type

Description

Constructor with default behavior.

Methods

Return type

Description

bool

Ready () const
Queries if the UI backend is ready.

void

Update (double deltaTime)
Frame update function for the UIBackend.

void

PlatformUpdate (double deltaTime) = 0
Platform-specific update function. Must be overridden per platform.

bool

MessageHandler (const void* pMessage) = 0
Platform-specific message handler function. Must be overridden per platform.

static UIBackend*

Creates a platform-specific UIBackend. Function must be implemented for each platform supported.

Detailed description

The base class from which platform-specific UI backends need to derive.

Construction

UIBackend

Copied!

UIBackend ()

Constructor with default behavior.


Methods

Ready

Copied!

virtual bool Ready () const

Queries if the UI backend is ready.


Update

Copied!

virtual void Update (double deltaTime)

Frame update function for the UIBackend.


PlatformUpdate

Copied!

virtual void PlatformUpdate (double deltaTime) = 0

Platform-specific update function. Must be overridden per platform.


MessageHandler

Copied!

virtual bool MessageHandler (const void* pMessage) = 0

Platform-specific message handler function. Must be overridden per platform.


CreateUIBackend

Copied!

static UIBackend* CreateUIBackend ()

Creates a platform-specific UIBackend. Function must be implemented for each platform supported.