Difference between revisions of "Legacy:Font/getColorMask"
From Spherical
(created from http://web.archive.org/web/20110803094047/http://www.spheredev.org/wiki/Font.getColorMask) |
(filled) |
||
Line 1: | Line 1: | ||
− | |||
− | |||
Get the color mask currently being used with the font. | Get the color mask currently being used with the font. | ||
Line 6: | Line 4: | ||
==Usage== | ==Usage== | ||
− | {{Usage|returns=[[API:Color|Color]]|object=Font|func=getColorMask | + | {{Usage|returns=[[API:Color|Color]]|object=Font|func=getColorMask}} |
− | + | ==Examples== | |
− | + | [[API:Font/getColorMask|Font.getColorMask]]() is typically used in conjunction with [[API:Font/setColorMask|Font.setColorMask]](): | |
− | + | <syntaxhighlight> | |
+ | var font = GetSystemFont(); | ||
+ | var green = CreateColor(0, 255, 0); | ||
+ | var red = CreateColor(255, 0, 0); | ||
− | = | + | function game() |
− | ( | + | { |
+ | font.setColorMask(green); | ||
+ | font.drawText(0, 0, "green"); | ||
+ | |||
+ | var old_color = font.getColorMask(); | ||
+ | font.setColorMask(red); | ||
+ | font.drawText(0, 15, "red"); | ||
+ | |||
+ | font.setColorMask(old_color); | ||
+ | font.drawText(0, 30, "green again"); | ||
+ | |||
+ | FlipScreen(); | ||
+ | GetKey(); | ||
+ | } | ||
+ | </syntaxhighlight> | ||
==Notes== | ==Notes== | ||
− | ( | + | * To set the mask color of the font, use [[API:Font/setColorMask|Font.setColorMask]](). |
==See also== | ==See also== | ||
− | * | + | * Sphere [[API:Font|Font]] object |
− | * | + | * Sphere [[API:Color|Color]] object |
− | * | + | * [[Color masking]] |
− | * | + | * [[API:Font/drawText|Font.drawText]]() |
+ | * [[API:Font/setColorMask|Font.setColorMask]]() | ||
+ | * [[API:CreateColor|CreateColor]]() | ||
+ | * [[API:FlipScreen|FlipScreen]]() | ||
+ | * [[API:GetKey|GetKey]]() | ||
+ | * [[API:GetSystemFont|GetSystemFont]]() | ||
{{API:Font/navbox}} | {{API:Font/navbox}} |
Latest revision as of 23:25, 24 June 2013
Get the color mask currently being used with the font.
Contents
Usage
Examples
Font.getColorMask() is typically used in conjunction with Font.setColorMask():
var font = GetSystemFont();
var green = CreateColor(0, 255, 0);
var red = CreateColor(255, 0, 0);
function game()
{
font.setColorMask(green);
font.drawText(0, 0, "green");
var old_color = font.getColorMask();
font.setColorMask(red);
font.drawText(0, 15, "red");
font.setColorMask(old_color);
font.drawText(0, 30, "green again");
FlipScreen();
GetKey();
}
Notes
- To set the mask color of the font, use Font.setColorMask().
See also
- Sphere Font object
- Sphere Color object
- Color masking
- Font.drawText()
- Font.setColorMask()
- CreateColor()
- FlipScreen()
- GetKey()
- GetSystemFont()