s&box docs
API ReferenceSandbox.Rendering

public sealed struct Sandbox.Rendering.HudPainter

2D Drawing functions for a `Sandbox.Rendering.CommandList`. `HudPainter` provides a set of methods for drawing shapes, textures, and text onto a command list, typically for HUD or UI rendering.

Broader workflow and conceptual references connected to this API.

HudPainter

Each camera has a HudPainter that can be used to draw onto the HUD. You do this every frame, in any Update function.

Constructors

Showing 1 constructors

public HudPainter(Sandbox.Rendering.CommandList commandList)

Initializes a new instance of the `Sandbox.Rendering.HudPainter` struct for the specified `commandList`.

Parameters

  • commandList: The command list to draw to. Must not be null.

Methods

Showing 11 methods

public void DrawCircle(Vector2 position, Vector2 size, Color color)

Draws a filled circle at the specified position and size.

Parameters

  • position: The center position of the circle.
  • size: The size (diameter) of the circle.
  • color: The color of the circle.

public void DrawLine(Vector2 a, Vector2 b, float width, Color color, Vector4 corners = null)

Draws a line between two points with the specified width and color.

Parameters

  • a: The start point of the line.
  • b: The end point of the line.
  • width: The width of the line.
  • color: The color of the line.
  • corners: Optional corner flags for line end caps. Default: null

public void DrawRect(Sandbox.Rect rect, Color color, Vector4 cornerRadius = null, Vector4 borderWidth = null, Color borderColor = null)

Draws a rectangle with optional corner radius and border.

Parameters

  • rect: The rectangle to draw.
  • color: The fill color of the rectangle.
  • cornerRadius: The radius for each corner (optional). Default: null
  • borderWidth: The width of the border for each edge (optional). Default: null
  • borderColor: The color of the border (optional). Default: null

public void SetBlendMode(Sandbox.BlendMode mode)

Sets the blend mode for subsequent drawing operations.

Parameters

  • mode: The blend mode to use.

public void SetMatrix(Matrix matrix)

Sets the transformation matrix for subsequent drawing operations.

Parameters

  • matrix: The transformation matrix to apply.

Metadata

FieldValue
NamespaceSandbox.Rendering
Typeclass
AssemblySandbox.Engine
Doc IDT:Sandbox.Rendering.HudPainter

GradientFogSetup

Previous Page

ReflectionSetup

Next Page

On this page

Constructorspublic HudPainter(Sandbox.Rendering.CommandList commandList)Methodspublic System.Void DrawCircle(Vector2 position, Vector2 size, Color color)public System.Void DrawLine(Vector2 a, Vector2 b, System.Single width, Color color, Vector4 corners = null)public System.Void DrawRect(Sandbox.Rect rect, Color color, Vector4 cornerRadius = null, Vector4 borderWidth = null, Color borderColor = null)public Sandbox.Rect DrawText(Sandbox.TextRendering.Scope scope, Sandbox.Rect rect, Sandbox.TextFlag flags = 33)public Sandbox.Rect DrawText(Sandbox.TextRendering.Scope scope, Vector2 point, Sandbox.TextFlag flags = 33)public System.Void DrawText(System.String text, System.Single size, Color color, Sandbox.Rect rect, Sandbox.TextFlag flags = 33)public System.Void DrawText(System.String text, System.Single size, Color color, Vector2 point, Sandbox.TextFlag flags = 33)public System.Void DrawTexture(Sandbox.Texture texture, Sandbox.Rect rect, Color tint)public System.Void DrawTexture(Sandbox.Texture texture, Sandbox.Rect rect)public System.Void SetBlendMode(Sandbox.BlendMode mode)public System.Void SetMatrix(Matrix matrix)Metadata