Murl::ISystemFontControl Interface Referenceabstract

The system font control interface. More...

#include "murl_i_system_font_control.h"

Inheritance diagram for Murl::ISystemFontControl:

Public Member Functions

virtual UInt32 GetNumberOfSystemFontIds () const =0
 Get the number of font identifiers. More...
 
virtual const StringGetSystemFontId (UInt32 index) const =0
 Get the font identifier. More...
 
virtual IFontCreateSystemFont (const String &fontId, Real fontSize) const =0
 Create a system font object. More...
 
virtual void DestroySystemFont (IFont *&font) const =0
 Destroy a system font object. More...
 
virtual IVideoStreamCreateVideoStream (IEnums::PixelFormat pixelFormat, UInt32 pixelSizeX, UInt32 pixelSizeY) const =0
 Create a video stream object for system font rendering. More...
 
virtual void DestroyVideoStream (IVideoStream *&stream) const =0
 Destroy a video stream object. More...
 
- Public Member Functions inherited from Murl::IControlable
virtual const StringGetName () const =0
 Get the controlable's name. More...
 
virtual void FrameUpdate ()=0
 Is executed in the platform thread context each frame tick.
 
virtual void LogicUpdate ()=0
 Is executed in the logic thread context each logic tick.
 
virtual void ConfigChanged (const IAppConfiguration *appConfig)=0
 Notification of changed configuration. More...
 

Detailed Description

The system font control interface.

Member Function Documentation

◆ GetNumberOfSystemFontIds()

virtual UInt32 Murl::ISystemFontControl::GetNumberOfSystemFontIds ( ) const
pure virtual

Get the number of font identifiers.

Returns
The number of font identifiers.

◆ GetSystemFontId()

virtual const String& Murl::ISystemFontControl::GetSystemFontId ( UInt32  index) const
pure virtual

Get the font identifier.

Parameters
indexThe index in range [0 .. GetNumberOfSystemFontIds() - 1].
Returns
The font identifier.

◆ CreateSystemFont()

virtual IFont* Murl::ISystemFontControl::CreateSystemFont ( const String fontId,
Real  fontSize 
) const
pure virtual

Create a system font object.

Parameters
fontIdThe font identifier.
fontSizeThe font size.
Returns
The system font object or null if font identifier is unknown.

◆ DestroySystemFont()

virtual void Murl::ISystemFontControl::DestroySystemFont ( IFont *&  font) const
pure virtual

Destroy a system font object.

Parameters
fontThe system font object to destroy.

◆ CreateVideoStream()

virtual IVideoStream* Murl::ISystemFontControl::CreateVideoStream ( IEnums::PixelFormat  pixelFormat,
UInt32  pixelSizeX,
UInt32  pixelSizeY 
) const
pure virtual

Create a video stream object for system font rendering.

Parameters
pixelFormatThe pixel format of the new video object.
pixelSizeXThe number of horizontal pixels of the new video object.
pixelSizeYThe number of vertical pixels of the new video object.
Returns
The new video stream object or null if not available.

◆ DestroyVideoStream()

virtual void Murl::ISystemFontControl::DestroyVideoStream ( IVideoStream *&  stream) const
pure virtual

Destroy a video stream object.

Parameters
streamThe video stream object to destroy.

The documentation for this interface was generated from the following file:
  • murl_i_system_font_control.h


Copyright © 2011-2024 Spraylight GmbH.