TextItemSetScale

This function allows the setting of the scale of a text item.

Syntax

bool textItemSetScale ( textitem theTextitem, float scale )             

Required Arguments

• theTextitem: The text item you wish to set the scale of.
• scale: A floating point value indicating the scale of the text you wish to set to. 1.0 is around 12pt.

Returns

Returns true if the scale was successfully set, false otherwise.

Example

This example retreives the scale of the 'theTextitem' text item, and if it is too small it enlarges it so it is more visible.

scale = textItemGetScale ( theTextitem )  --get the scale of theTextitem and define it as 'scale'
if scale < 0.5 then --if the scale is smaller than 0.5
    textItemSetScale ( theTextitem, 1.0 ) --then restore it to default size, 1.0.
end

See Also

• textCreateDisplay
• textCreateTextItem
• textDestroyDisplay
• textDestroyTextItem
• textDisplayAddObserver
• textDisplayAddText
• textDisplayGetObservers
• textDisplayIsObserver
• textDisplayRemoveObserver
• textDisplayRemoveText
• textItemGetColor
• textItemGetPosition
• textItemGetPriority
• textItemGetScale
• textItemGetText
• textItemSetColor
• textItemSetPosition
• textItemSetPriority
• textItemSetScale
• textItemSetText