Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

TextGenerator.GetPreferredWidth

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public function GetPreferredWidth(str: string, settings: TextGenerationSettings): float;
public float GetPreferredWidth(string str, TextGenerationSettings settings);

Parameters

strGeneration text.
settingsSettings for generation.

Returns

float Preferred width.

Description

Given a string and settings, returns the preferred width for a container that would hold this text.

Copyright © 2015 Unity Technologies
Learn Community Asset Store Buy Download