static Rect DrawIcon( Rect rect, string iconName, Color color, float fontSize, TextFlag alignment )

book_4_sparkGenerated
code_blocksInput

Description

The DrawIcon method in the Sandbox.Graphics class is used to render an icon within a specified rectangular area on the screen. This method allows you to specify the icon's name, color, font size, and alignment within the rectangle.

Usage

To use the DrawIcon method, you need to provide the following parameters:

  • rect: A Sandbox.Rect object that defines the area where the icon will be drawn.
  • iconName: A string representing the name of the icon to be drawn. This should correspond to a valid icon name in your resources.
  • color: A Color object that specifies the color of the icon.
  • fontSize: A float value that determines the size of the icon.
  • alignment: A Sandbox.TextFlag value that specifies the alignment of the icon within the rectangle.

The method returns a Sandbox.Rect that represents the area occupied by the drawn icon.

Example

// Example usage of the DrawIcon method
Sandbox.Rect iconRect = new Sandbox.Rect(10, 10, 50, 50);
string iconName = "exampleIcon";
Color iconColor = Color.White;
float iconFontSize = 24.0f;
Sandbox.TextFlag iconAlignment = Sandbox.TextFlag.Center;

Sandbox.Rect resultRect = Sandbox.Graphics.DrawIcon(iconRect, iconName, iconColor, iconFontSize, iconAlignment);

// The resultRect now contains the area occupied by the icon.