Draw XXL documentation


Draw Text.Write(...);

Writes text to the scene.

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


static void DrawText.Write(...);

Code snippet names: drawText_dirViaQuat and drawText_dirViaQuat_func.

Parameters:
Type Parameter Name Description
string text The text that gets drawn. You can supply text with markup tags.
Vector3 position
Color color
float size This defines the worldspace width per letter.
Quaternion rotation The default value of "default(Quaternion)" falls back to AutomaticTextOrientation. If specified: rotation*forward is the viewers direction onto the text. rotation*up is upward inside the text letters. rotation*right is the text direction.
TextAnchorDXXL textAnchor
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 The "rotation" parameter can turn the drawn text in a way that it appears mirror inverted on the screen is therefore is not readable anymore. This can be intended or unintended, and can be remedied with this "autoFlipToPreventMirrorInverted" parameter. The default value is "true".
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.Write(...);

Code snippet names: drawText_dirViaVec and drawText_dirViaVec_func.

Parameters:
Type Parameter Name Description
string text
Vector3 position
Color color
float size
Vector3 textDirection This and "textUp" are the only differences to the previous overload. They replace the "Quaternion rotation" parameter there.
Vector3 textUp This and "textDirection" are the only differences to the previous overload. They replace the "Quaternion rotation" parameter there.
TextAnchorDXXL textAnchor
float forceTextBlockEnlargementToThisMinWidth
float forceRestrictTextBlockSizeToThisMaxTextWidth
float autoLineBreakWidth
bool autoFlipToPreventMirrorInverted
float durationInSec
bool hiddenByNearerObjects