struct `GUIContentSpriteCreateInformation`

Structure used for initializing GUIContentSprites.

Public

Constructors

GUIContentSpriteCreateInformation

GUIContentSpriteCreateInformation(const Size2UI &size, const GUIContent &content, const GUIStyleSheetRules &rules, const Color &tint, float fontScale, u64 batchId)

Fields

Content

GUIContent Content

Image and/or text content to display.

Offset

Vector2I Offset

Offset relative to the parent GUI element's content area to place the sprite at.

ContentArea

Area2I ContentArea

Area relative to parent GUI element, in which to place the contents.

Any sprite elements outside of this area will be clipped.

Depth

u32 Depth

Depth at which to render the sprites.

Higher depth means a sprite is rendered behind sprites with lower depth.

Tint

Color Tint

Runtime color tint to apply to the sprite.

BatchId

u64 BatchId

ID that specifies if the sprite is allowed to be batched with other sprites.

Only sprites with the same batch ID can be batched.

FontScale

float FontScale

Scale to apply to font size.

WordWrap

bool WordWrap

If true, text will wrap to a new line if it exceeds the content area width.

If false, the text will be clipped.

Rules

const GUIStyleSheetRules & Rules

Style sheet rules that determine how to style the sprites.