Platform

#include <Ultralight/platform/Platform.h>

Overview

Global platform singleton, manages user-defined platform handlers and global config.

The library uses the Platform API for most platform-specific operations (eg, file access, clipboard, font loading, GPU access, pixel buffer transport, etc.).

Motivation

Ultralight is designed to work in as many platforms and environments as possible. To achieve this, we've factored out most platform-specific code into a set of interfaces that you can implement and set on the Platform singleton.

Default Implementations

We provide a number of default implementations for desktop platforms (eg, Windows, macOS, Linux) for you when you call App::Create(). These implementations are defined in the AppCore repository, we recommend using their source code as a starting point for your own implementations.

Required Handlers

When using Renderer::Create() directly, you'll need to provide your own implementations for FileSystem and FontLoader at a minimum.

Overview of which platform handlers are required / optional / provided:

	Renderer::Create()	App::Create()
FileSystem	Required	Provided
FontLoader	Required	Provided
Clipboard	Optional	Provided
GPUDriver	Optional	Provided
Logger	Optional	Provided
SurfaceFactory	Provided	Provided
ThreadFactory	Optional	Optional

Note

This singleton should be set up before creating the Renderer or App.

Static Public Member Functions
static Platform &	instance ()
	Get the Platform singleton.

Public Member Functions
virtual	~Platform ()
virtual void	set_config (const Config &config)=0
	Set the Config.
virtual const Config &	config () const =0
	Get the Config.
virtual void	set_logger (Logger *logger)=0
	Set the Logger (to handle error messages and debug output).
virtual Logger *	logger () const =0
	Get the Logger.
virtual void	set_gpu_driver (GPUDriver *gpu_driver)=0
	Set the GPU Driver (will handle all rendering)
virtual GPUDriver *	gpu_driver () const =0
	Get the GPU Driver.
virtual void	set_font_loader (FontLoader *font_loader)=0
	Set the Font Loader (will be used to map font families to actual fonts)
virtual FontLoader *	font_loader () const =0
	Get the Font Loader.
virtual void	set_file_system (FileSystem *file_system)=0
	Set the File System (will be used for all file system operations)
virtual FileSystem *	file_system () const =0
	Get the File System.
virtual void	set_clipboard (Clipboard *clipboard)=0
	Set the Clipboard (will be used for all clipboard operations)
virtual Clipboard *	clipboard () const =0
	Get the Clipboard.
virtual void	set_surface_factory (SurfaceFactory *surface_factory)=0
	Set the SurfaceFactory.
virtual SurfaceFactory *	surface_factory () const =0
	Get the SurfaceFactory.
virtual void	set_thread_factory (ThreadFactory *thread_factory)=0
	Set the ThreadFactory.
virtual ThreadFactory *	thread_factory () const =0
	Get the ThreadFactory.

Constructor & Destructor Documentation

~Platform()

virtual ~Platform ( )

virtual

Member Function Documentation

clipboard()

virtual Clipboard * clipboard ( ) const

pure virtual

Get the Clipboard.

config()

virtual const Config & config ( ) const

pure virtual

Get the Config.

file_system()

virtual FileSystem * file_system ( ) const

pure virtual

Get the File System.

font_loader()

virtual FontLoader * font_loader ( ) const

pure virtual

Get the Font Loader.

gpu_driver()

virtual GPUDriver * gpu_driver ( ) const

pure virtual

Get the GPU Driver.

instance()

static Platform & instance ( )

static

Get the Platform singleton.

logger()

virtual Logger * logger ( ) const

pure virtual

Get the Logger.

set_clipboard()

virtual void set_clipboard ( Clipboard * clipboard )

pure virtual

Set the Clipboard (will be used for all clipboard operations)

Parameters

clipboard

A user-defined Clipboard implementation, ownership remains with the caller.

set_config()

virtual void set_config ( const Config & config )

pure virtual

Set the Config.

set_file_system()

virtual void set_file_system ( FileSystem * file_system )

pure virtual

Set the File System (will be used for all file system operations)

Parameters

file_system

A user-defined FileSystem implementation, ownership remains with the caller.

set_font_loader()

virtual void set_font_loader ( FontLoader * font_loader )

pure virtual

Set the Font Loader (will be used to map font families to actual fonts)

Parameters

font_loader

A user-defined FontLoader implementation, ownership remains with the caller.

set_gpu_driver()

virtual void set_gpu_driver ( GPUDriver * gpu_driver )

pure virtual

Set the GPU Driver (will handle all rendering)

Parameters

gpu_driver

A user-defined GPUDriver implementation, ownership remains with the caller.

set_logger()

virtual void set_logger ( Logger * logger )

pure virtual

Set the Logger (to handle error messages and debug output).

Parameters

logger

A user-defined Logger implementation, ownership remains with the caller.

set_surface_factory()

virtual void set_surface_factory ( SurfaceFactory * surface_factory )

pure virtual

Set the SurfaceFactory.

This can be used to provide a platform-specific bitmap surface for View to paint into when the CPU renderer is enabled. See View::surface().

Parameters

surface_factory

A user-defined SurfaceFactory implementation, ownership remains with the caller.

Note

A default BitmapSurfaceFactory is defined if you never call this, View::surface() can be safely cast to BitmapSurface.

set_thread_factory()

virtual void set_thread_factory ( ThreadFactory * thread_factory )

pure virtual

Set the ThreadFactory.

This can be used to provide a platform-specific ThreadFactory implementation for the library to use when creating threads.

Parameters

thread_factory

A user-defined ThreadFactory implementation, ownership remains with the caller.

surface_factory()

virtual SurfaceFactory * surface_factory ( ) const

pure virtual

Get the SurfaceFactory.

Note

A default BitmapSurfaceFactory is set by default, View::surface() can be safely cast to BitmapSurface if you don't define your own.

thread_factory()

virtual ThreadFactory * thread_factory ( ) const

pure virtual

Get the ThreadFactory.

---

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

• Ultralight/platform/Platform.h