void DrawText( Sandbox.TextRendering/Scope& scope, Vector3 point, TextFlag flags )
void DrawText( Sandbox.TextRendering/Scope& scope, Rect rect, TextFlag flags )

book_4_sparkGenerated
code_blocksInput

Description

The DrawText method in the HudPainter class is used to render text at a specified 3D point on the HUD (Heads-Up Display) with specific rendering flags. This method is part of the Sandbox.Rendering namespace and is designed to be used within the context of rendering operations in a game or application using the s&box engine.

Usage

To use the DrawText method, you need to have a valid HudPainter instance. You will also need to provide a Scope reference, which defines the text rendering context, a Vector3 point where the text should be drawn, and a set of TextFlag options that determine how the text is rendered.

Ensure that the Scope is properly initialized and that the Vector3 point is within the visible area of the HUD. The TextFlag can be used to modify the appearance and behavior of the text, such as alignment and wrapping.

Example

// Example usage of HudPainter.DrawText

// Assume 'hudPainter' is an instance of HudPainter
// 'scope' is a properly initialized TextRendering.Scope
// 'position' is a Vector3 indicating where to draw the text
// 'flags' is a TextFlag with desired rendering options

hudPainter.DrawText(ref scope, new Vector3(100, 200, 0), TextFlag.Center);