Draw XXL documentation


Draw Text.Write2DFramed(...);

Writes text to the XY-2D-plane. Similar to Write2D(), but with a framing box around the text.

Green parameters are required. Yellow parameters are optional, but have to be supplied in order.


static void DrawText.Write2DFramed(...);

Code snippet names: drawText2DFramed_dirViaVec and drawText2DFramed_dirViaVec_func.

Parameters:
Type Parameter Name Description
string text The text that gets drawn. You can supply text with markup tags.
Vector2 position
Color color
float size This defines the worldspace width per letter.
Vector2 textDirection
TextAnchorDXXL textAnchor
float custom_zPos The z position of the XY-plane inside which the thing is drawn. The default value is "infinity", which falls back to DrawBasic2D.Default_zPos_forDrawing.
LineStyle enclosingBoxLineStyle
float enclosingBox_lineWidth_relToTextSize
float enclosingBox_paddingSize_relToTextSize
float forceTextBlockEnlargementToThisMinWidth This overwrites "size" if another value than the default value of 0 is used.
float forceRestrictTextBlockSizeToThisMaxTextWidth This overwrites "size" if another value than the default value of 0 is used.
float autoLineBreakWidth An optional width after which the text should break into the next line.
bool autoFlipToPreventMirrorInverted When looking backward onto the text (that is: looking towards negative z direction, e.g. via Scene View camera) then the text appears mirror inverted and is not readable anymore. This bool will automatically flip the text direction so it stays readable.
float durationInSec The duration in seconds how long the drawn thing stays visible. The default value of 0 means that it stays only during the current Update frame. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.
bool hiddenByNearerObjects This specifies if the drawn thing will get hidden if other geometry is in front of it or if it shines through. It is the same as the depthTest parameter of Unitys Debug.DrawLine(). Not all drawing methods support toggling this in the same way. For some methods the lines are fully hidden, for others the hidden lines shimmer through. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.


static void DrawText.Write2DFramed(...);

Code snippet names: drawText2DFramed_dirViaAngle and drawText2DFramed_dirViaAngle_func.

Parameters:
Type Parameter Name Description
string text
Vector2 position
Color color
float size
float zRotationDegCC This is the only difference to the previous overload. It replaces the "textDirection" parameter there. It is in degrees and counterclockwise (CC).
TextAnchorDXXL textAnchor
float custom_zPos
LineStyle enclosingBoxLineStyle
float enclosingBox_lineWidth_relToTextSize
float enclosingBox_paddingSize_relToTextSize
float forceTextBlockEnlargementToThisMinWidth
float forceRestrictTextBlockSizeToThisMaxTextWidth
float autoLineBreakWidth
bool autoFlipToPreventMirrorInverted
float durationInSec
bool hiddenByNearerObjects