D2Text command

Requires: Direct2D.lg32

Purpose

Draws text with a single format to the current render target.

Syntax

D2Text x!, y!, text$ [, D2brush] [, options]

x!, y!	: float expression
text$	: string expression
D2brush	: Object
options	: integer expression

Description

D2Text x, y, text$ mimics the GFABASIC Text command. The coordinates x! and y! specify the top left corner of the drawing. The optional brush argument specifies a brush object to draw with. If the brush is omitted a solid color brush based on the foreground color is used. The foreground color is defined using the D2Color or the D2RGBColor command. D2Text uses the font set with D2SetFont (default is DEFAULT_GUI_FONT).

For completeness the application may specify the drawing options. However, to provide GB compatibility to the Text command, the options parameter can be left to its default value. The optional options argument can be a combination of the following DWRITE_DRAW_TEXT_OPTIONS constants:

D2D1_DRAW_TEXT_OPTIONS_NONE = 0x00000000 (default for D2Text) - Text is snapped to pixel boundaries and not clipped.
D2D1_DRAW_TEXT_OPTIONS_NO_SNAP = 0x00000001 - Do not snap the baseline of the text vertically.
D2D1_DRAW_TEXT_OPTIONS_CLIP = 0x00000002 - Clip the text to the content bounds. In case of a string argument the bounds are calculated before the text is drawn and the text is drawn within these bounds.
D2D1_DRAW_TEXT_OPTIONS_ENABLE_COLOR_FONT = 0x00000004 - Render color versions of glyphs if defined by the font.
D2D1_DRAW_TEXT_OPTIONS_DISABLE_COLOR_BITMAP_SNAPPING = 0x00000008 - Bitmap origins of color glyph bitmaps are not snapped.

Example

' D2Text sample (dpi-unaware)

$Library "direct2d"

Global Object Win1RT

OpenW 1, 0, 0, 320, 300, ~15

Set Win1RT = D2GetRT()

Global Object Fnt

Set Fnt = D2Font("Gabriola", 13)

Sleep

Until Me Is Nothing

Sub Win_1_Paint

D2BeginDraw Win1RT, D2C_White

D2SetFont Fnt

D2Text 16, 16, "Hello Direct2D"

D2SetFont "Courier New", 13

D2Text 16, 40, "DirectWrite"

D2EndDraw

EndSub

Sub Win_1_ReSize

D2ResizeRT Win1RT, _X, _Y

Remarks

As with all drawing operations, D2Text must be embedded between D2BeginDraw and D2EndDraw. D2Text invokes the ID2D1RenderTarget::DrawText method.