s&box docs
API Referenceglobal

public sealed struct Sandbox.TextRendering.Scope

Defines a scope of text, all using the same style.

Broader workflow and conceptual references connected to this API.

Undo System

The scope based system works by creating a snapshot of a change set when the scope is entered and another one when the scope is disposed of. The system will automatically take care of restoring the state on undo/redo.

Constructors

Showing 1 constructors

public Scope(string text, Color color, float size, string font = Roboto, int weight = 400)

Parameters

  • font: Default: Roboto
  • weight: Default: 400

Methods

Showing 1 methods

public Vector2 Measure()

Measures the rendered size of the text in this `Sandbox.TextRendering.Scope` using its current style settings. This is non trivial but the underlying style is cached, so if you end up drawing it, it'll re-use the cached data anyway.

Returns

A `Vector2` representing the width and height, in pixels, of the rendered text.

Properties

Showing 1 properties

Metadata

FieldValue
Namespaceglobal
Typeclass
AssemblySandbox.Engine
Doc IDT:Sandbox.TextRendering.Scope

Outline

Previous Page

Shadow

Next Page

On this page

Constructorspublic Scope(System.String text, Color color, System.Single size, System.String font = Roboto, System.Int32 weight = 400)Methodspublic Vector2 Measure()Propertiespublic static Sandbox.TextRendering.Scope Sandbox.TextRendering.Scope.Default { get; set; }Metadata