Murl Engine Lua Addon API  Version 1.0 beta
Murl.ISystemFontControl

The system font control interface.


Table members

Inherited


Murl.IControlable

Methods


GetNumberOfSystemFontIds()

Get the number of font identifiers.

Integer GetNumberOfSystemFontIds()

Returns
Integer The number of font identifiers.

GetSystemFontId(index)

Get the font identifier.

String GetSystemFontId(Integer index)

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

CreateSystemFont(fontId, fontSize)

Create a system font object.

Murl.IFont CreateSystemFont(String fontId, Number fontSize)

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

DestroySystemFont(font)

Destroy a system font object.

Murl.IFont DestroySystemFont(Murl.IFont font)

Parameters
fontThe system font object to destroy.
Returns
Murl.IFont font The system font object to destroy.

CreateVideoStream(pixelFormat, pixelSizeX, pixelSizeY)

Create a video stream object for system font rendering.

Murl.IVideoStream CreateVideoStream(Murl.IEnums.PixelFormat pixelFormat, Integer pixelSizeX, Integer pixelSizeY)

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
Murl.IVideoStream The new video stream object or null if not available.

DestroyVideoStream(stream)

Destroy a video stream object.

Murl.IVideoStream DestroyVideoStream(Murl.IVideoStream stream)

Parameters
streamThe video stream object to destroy.
Returns
Murl.IVideoStream stream The video stream object to destroy.