GdiGraphics
Classes
Methods
-
CalcTextHeight(str, font) → {number}
-
Calculates text height for GdiGraphics#GdiDrawText.
Note: this will only calculate the text height of one line.Parameters:
Name Type Description strstring fontGdiFont Returns:
number -
CalcTextWidth(str, font, use_exactopt) → {number}
-
Calculates text width for GdiGraphics#GdiDrawText. Note: When the str contains a kerning pair that is found in the specified font, the return value will be larger than the actual drawn width of the text. If accurate values are required, set use_exact to true.
Parameters:
Name Type Attributes Default Description strstring fontGdiFont use_exactboolean <optional>
false Uses a slower, but more accurate method of calculating text width which accounts for kerning pairs. Returns:
number -
DrawEllipse(x, y, w, h, line_width, colour)
-
Parameters:
Name Type Description xnumber ynumber wnumber hnumber line_widthnumber colournumber -
DrawImage(img, dstX, dstY, dstW, dstH, srcX, srcY, srcW, srcH, angleopt, alphaopt)
-
Parameters:
Name Type Attributes Default Description imgGdiBitmap dstXnumber dstYnumber dstWnumber dstHnumber srcXnumber srcYnumber srcWnumber srcHnumber anglefloat <optional>
0 alphanumber <optional>
255 Valid values 0-255. -
DrawLine(x1, y1, x2, y2, line_width, colour)
-
Parameters:
Name Type Description x1number y1number x2number y2number line_widthnumber colournumber -
DrawPolygon(colour, line_width, points)
-
Parameters:
Name Type Description colournumber line_widthnumber pointsArray.<Array.<number>> -
DrawRect(x, y, w, h, line_width, colour)
-
Parameters:
Name Type Description xnumber ynumber wnumber hnumber line_widthnumber colournumber -
DrawRoundRect(x, y, w, h, arc_width, arc_height, line_width, colour)
-
Parameters:
Name Type Description xnumber ynumber wnumber hnumber arc_widthnumber arc_heightnumber line_widthnumber colournumber -
DrawString(str, font, colour, x, y, w, h, flagsopt)
-
Should be only used when GdiGraphics#GdiDrawText is not applicable.
Parameters:
Name Type Attributes Default Description strstring fontGdiFont colournumber xnumber ynumber wnumber hnumber flagsnumber <optional>
0 See Flags.js > StringFormatFlags -
EstimateLineWrap(str, font, max_width) → {Array.<Array>}
-
Parameters:
Name Type Description strstring fontGdiFont max_widthnumber Returns:
Array.<Array> - index | meaning
[0] text line 1
[1] width of text line 1 (in pixel)
[2] text line 2
[3] width of text line 2 (in pixel)
...
[2n + 2] text line n
[2n + 3] width of text line n (px) -
FillEllipse(x, y, w, h, colour)
-
Parameters:
Name Type Description xnumber ynumber wnumber hnumber colournumber -
FillGradRect(x, y, w, h, angle, colour1, colour2, focusopt)
-
Note: this may appear buggy depending on rectangle size. The easiest fix is to adjust the "angle" by a degree or two.
Parameters:
Name Type Attributes Default Description xnumber ynumber wnumber hnumber anglefloat colour1number colour2number focusfloat <optional>
1.0 Specify where the centred colour will be at its highest intensity. Valid values between 0 and 1. -
FillPolygon(colour, fillmode, points)
-
Parameters:
Name Type Description colournumber fillmodenumber 0 alternate, 1 winding. pointsArray.<Array.<number>> -
FillRoundRect(x, y, w, h, arc_width, arc_height, colour)
-
Parameters:
Name Type Description xnumber ynumber wnumber hnumber arc_widthnumber arc_heightnumber colournumber -
FillSolidRect(x, y, w, h, colour)
-
Parameters:
Name Type Description xnumber ynumber wnumber hnumber colournumber -
GdiAlphaBlend(img, dstX, dstY, dstW, dstH, srcX, srcY, srcW, srcH, alphaopt)
-
Parameters:
Name Type Attributes Default Description imgGdiRawBitmap dstXnumber dstYnumber dstWnumber dstHnumber srcXnumber srcYnumber srcWnumber srcHnumber alphanumber <optional>
255 Valid values 0-255. -
GdiDrawBitmap(img, dstX, dstY, dstW, dstH, srcX, srcY, srcW, srcH)
-
Always faster than GdiGraphics#DrawImage, does not support alpha channel.
Parameters:
Name Type Description imgGdiRawBitmap dstXnumber dstYnumber dstWnumber dstHnumber srcXnumber srcYnumber srcWnumber srcHnumber -
GdiDrawText(str, font, colour, x, y, w, h, formatopt)
-
Provides faster and better rendering than GdiGraphics#DrawString.
Do not use this to draw text on transparent background or with GdiGraphics other than the one passed in on_paint callback: this will result in visual artifacts caused by ClearType hinting.
Use GdiGraphics#DrawString instead in such cases.
To calculate text dimensions use GdiGraphics#CalcTextHeight, GdiGraphics#CalcTextWidth.
Note: uses special rules for `&` character by default, which consumes the `&` and causes the next character to be underscored. This behaviour can be changed (or disabled) via `format` parameter.Parameters:
Name Type Attributes Default Description strstring fontGdiFont colournumber xnumber ynumber wnumber hnumber formatnumber <optional>
0 See Flags.js > DT_* -
MeasureString(str, font, x, y, w, h, flagsopt) → {MeasureStringInfo}
-
Calculates text dimensions for GdiGraphics#DrawString.
Parameters:
Name Type Attributes Default Description strstring fontGdiFont xnumber ynumber wnumber hnumber flagsnumber <optional>
0 See Flags.js > StringFormatFlags Returns:
MeasureStringInfo -
SetInterpolationMode(modeopt)
-
Parameters:
Name Type Attributes Default Description modenumber <optional>
0 See Flags.js > InterpolationMode -
SetSmoothingMode(modeopt)
-
Parameters:
Name Type Attributes Default Description modenumber <optional>
0 See Flags.js > SmoothingMode -
SetTextRenderingHint(modeopt)
-
Parameters:
Name Type Attributes Default Description modenumber <optional>
0 See Flags.js > TextRenderingHint