Class CinemachineDebug
Manages onscreen positions for Cinemachine debugging output
Namespace: Cinemachine.Utility
Syntax
public class CinemachineDebug : objectFields
OnGUIHandlers
Delegate for OnGUI debugging.
This will be called by the CinemachineBrain in its OnGUI (editor only)
Declaration
public static CinemachineDebug.OnGUIDelegate OnGUIHandlersField Value
| Type | Description |
|---|---|
| CinemachineDebug.OnGUIDelegate |
Methods
GetScreenPos(Object, String, GUIStyle)
Reserve an on-screen rectangle for debugging output.
Declaration
public static Rect GetScreenPos(Object client, string text, GUIStyle style)Parameters
| Type | Name | Description |
|---|---|---|
| Object | client | The client caller. This is used as a handle. |
| String | text | Sample text, for determining rectangle size |
| GUIStyle | style | What style will be used to draw, used here for determining rect size |
Returns
| Type | Description |
|---|---|
| Rect | An area on the game screen large enough to print the text in the style indicated |
ReleaseScreenPos(Object)
Release a screen rectangle previously obtained through GetScreenPos()
Declaration
public static void ReleaseScreenPos(Object client)Parameters
| Type | Name | Description |
|---|---|---|
| Object | client | The client caller. Used as a handle. |
ReturnToPool(StringBuilder)
Return a StringBuilder to the preallocated pool
Declaration
public static void ReturnToPool(StringBuilder sb)Parameters
| Type | Name | Description |
|---|---|---|
| StringBuilder | sb | The string builder object to return to the pool |
SBFromPool()
Get a preallocated StringBuilder from the pool
Declaration
public static StringBuilder SBFromPool()Returns
| Type | Description |
|---|---|
| StringBuilder | The preallocated StringBuilder from the pool. |