DgsCreateFont: Difference between revisions

Revision as of 23:56, 10 June 2018

This function creates a dgs font element that can be used in dgsSetFont.

Successful font creation is not guaranteed, and may fail due to hardware or memory limitations.

The font file should be in the dgs folder.

Syntax

element dgsCreateFont ( string filepath [, int size=9, bool bold=false, string quality="proof" ] )

Required Arguments

filepath: the name of the file containing the font

Optional Arguments

size: size of the font
bold: flag to indicate if the font should be bold
quality: the font quality
- "default": not the actual default
- "draft"
- "proof": the default
- "nonantialiased"
- "antialiased"
- "cleartype"
- "cleartype_natural"

Returns

Returns a DGS font element if successful, false if invalid arguments were passed to the function, or there is insufficient resources available.

You should always check to see if this function has returned false.

Example

-- Display a dgs label
local myLabel = dgsCreateLabel( 100, 300, 400, 50, "DGS label", false )

-- Use 'toggle' command to switch custom font on and off
addCommandHandler( "toggle",
    function()
        if not myFont then
            myFont = dgsCreateFont( "segoeui.ttf", 20 )  -- Create DGS custom font
            dgsSetFont( myLabel, myFont )                -- Apply font to a widget
        else        
            destroyElement( myFont )                     -- Destroy custom font
            myFont = nil
        end
    end
)

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

dgsCreateBrowser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

dgsCreateCanvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

@@ Line 1: / Line 1: @@
 {{Client function}}
 __NOTOC__
-This function creates a dgs font element that can be used in [[dgsSetFont]]. Successful font creation is not guaranteed, and may fail due to hardware or memory limitations.
+This function creates a dgs font element that can be used in [[dgsSetFont]].
+Successful font creation is not guaranteed, and may fail due to hardware or memory limitations.
+The font file should be in the dgs folder.
 ==Syntax==