Docs @ Psychtoolbox Wiki : DrawFormattedText

Search PTB Function help:
homepsychtoolbox.orgpage updateslogin



[nx, ny, textbounds, wordbounds] = DrawFormattedText(win, tstring [, sx][, sy][, color][, wrapat][, flipHorizontal][, flipVertical][, vSpacing][, righttoleft][, winRect])

Draws a string of text 'tstring' into Psychtoolbox window 'win'. Allows
some basic formatting.

Please note that all formatting of text and returned information about
the bounding box of the text is only approximative and may be inaccurate
for some text strings, fonts, font settings and combination of parameters
for this function. Centering of text and bounding box calculations work
best for single line text, vertical centering may be a bit off for multi-
line text.

The text string 'tstring' may contain newline characters '\n'.
Whenever a newline character '\n' is encountered, a linefeed and
carriage return is performed, breaking the text string into lines.

'sx' defines the left border of the text: If it is left out, text
starts at x-position zero, otherwise it starts at the specified position
'sx'. If sx=='center', then each line of text is horizontally centered in
the window. If sx=='right', then each line of text is right justified to
the right border of the target window, or of 'winRect', if provided.
The options sx == 'wrapat' and sx == 'justifytomax' try to align the start
of each text line to the left border and the end of each text line to either
the specified 'wrapat' number of columns, or to the width of the widest line
of text in the text string, causing all lines of text to appear of roughly
even width. This is achieved by adjusting the width of blanks between words
in each line of text to even out text line length. The sx == 'wrapat' and
sx == 'justifytomax' options are considered experimental. They only work for
non-flipped, simple text, and even there they may work badly, so don't rely on
them doing the right thing without assistance of your code, e.g., breaking
text into lines of reasonably similar length. The justification functions
will not justify text which deviates by more than ptb_drawformattedtext_padthresh
from the target width of the text, with ptb_drawformattedtext_padthresh being
a global variable you can set. It defaults to 0.333 ie., doesn't justify text
lines if the text lines are more than 33% shorter than the reference line.
If sx=='centerblock' then text is not horizontally centered individually for
each line of text, as with 'center', but for multi-line text, the whole block
of text is roughly centered, by starting all lines left-justified, but then shifting
this whole block of left justified text horizontally so that the longest line
in the block of text is horizontally centered in the target window or 'winRect'.

'sy' defines the baseline of the (first line of the) text. If left out, text starts
roughly at the top of the window, otherwise it starts at the specified vertical
pixel position.

If sy=='center', then the whole text is roughly vertically centered in the
window. 'color' is the color value of the text (color index or [r g b]
triplet or [r g b a] quadruple). If color is left out, the current text
color from previous text drawing commands is used. 'wrapat', if provided,
will automatically break text strings longer than 'wrapat' characters
into newline separated strings of roughly 'wrapat' characters. This is
done by calling the WrapString function (See 'help WrapString'). 'wrapat'
mode may not work reliably with non-ASCII text strings, e.g., UTF-8
encoded uint8 strings on all systems.

The optional flag 'flipHorizontal' if set to 1 will mirror the text
horizontally, whereas the optional flag 'flipVertical' if set to 1 will
mirror the text vertically (upside down).

The optional argument 'vSpacing' sets the spacing between the lines. Default
value is 1.

The optional argument 'righttoleft' if set to 1, will ask to draw the
text string in right-to-left reading direction, e.g., for scripts which
read right to left

The optional argument 'winRect' allows to specify a [left top right bottom]
rectange, in which the text should be centered/placed etc. By default,
the rectangle of the whole 'win'dow is used.

The function employs clipping by default. Text lines that are detected as
lying completely outside the 'win'dow or optional 'winRect' will not be
drawn, but clipped away. This allows to draw multi-page text (multiple
screen heights) without too much loss of drawing speed. If you find the
clipping to interfere with text layout of exotic texts/fonts at exotic
sizes and formatting, you can define the global variable...

global ptb_drawformattedtext_disableClipping;
... and set it like this ...
ptb_drawformattedtext_disableClipping = 1;
... to disable the clipping.

Clipping also gets disabled if you request the optional 3rd return
parameter 'textbounds' to ensure correct computation of a bounding box
that covers the complete text. You can enforce clipping by setting
ptb_drawformattedtext_disableClipping = -1; however, computed bounding
boxes will then only describe the currently visible (non-clipped) text.

The function returns the new (nx, ny) position of the text drawing cursor
and the bounding rectangle 'textbounds' of the drawn string. (nx,ny) can
be used as new start position for connecting further text strings to the
bottom of the drawn text string. Calculation of these bounds is
approximative, so it may give wrong results with some text fonts and
styles on some operating systems, depending on the various settings.

The optional return argument 'wordbounds', if assigned in the calling
function, returns a n-by-4 matrix of per-word bounding boxes. Each row
defines a [left,top,right,bottom] rectangle with the bounding box of a
word in the text string, ie. row 1 = first word, row 2 = 2nd word, ...
white-space characters delimit single words and are not taken into
account, the successive words are defined by the function strtok(tstring).
Per word bounding boxes don't work if flipHorizontal or flipVertical is

See DrawFormattedTextDemo for a usage example.

Path   Retrieve current version from GitHub | View changelog

Valid XHTML 1.0 Transitional :: Valid CSS :: Powered by WikkaWiki
Page was generated in 0.0280 seconds