Public Types
enum	ImageType { Simple , Sliced }
	ImageType enum More...

enum	TextHorizontalAlignment { Left , Center , Right }
	TextHorizontalAlignment enum More...

enum	TextVerticalAlignment { Top , Middle , Bottom }
	TextVerticalAlignment enum More...

enum	TextWordWrap { None , WordWrap , BreakWord }
	TextWordWrap enum More...

Static Public Member Functions
static void	Text (string text, Rect rect)
	Draw text More...

static void	Text (string text, Rect rect, Font font)
	Draw text with font More...

static void	Text (string text, Rect rect, Font font, float fontSize)
	Draw text with font and font size More...

static void	Text (string text, Rect rect, Font font, float fontSize, float fontResolution)
	Draw text with font, font size and font resolution More...

static void	Text (string text, Rect rect, Font font, float fontSize, float fontResolution, float lineSpacing)
	Draw text with font, font size, font resolution and line spacing More...

static void	Text (string text, Rect rect, Font font, float fontSize, float fontResolution, float lineSpacing, TextWordWrap wordWrap)
	Draw text with font, font size, font resolution, line spacing and word wrap More...

static void	Text (string text, Rect rect, Font font, float fontSize, float fontResolution, float lineSpacing, TextWordWrap wordWrap, TextHorizontalAlignment horizontalAlignment, TextVerticalAlignment verticalAlignment)
	Draw text with font, font size, font resolution, line spacing, word wrap, horizontal alignment and vertical alignment More...

static void	Text (string text, Rect rect, Font font, float fontSize, float fontResolution, float lineSpacing, TextWordWrap wordWrap, TextHorizontalAlignment horizontalAlignment, TextVerticalAlignment verticalAlignment, Color color)
	Draw text with font, font size, font resolution, line spacing, word wrap, horizontal alignment, vertical alignment and text color More...

static void	Text (string text, Rect rect, float fontSize, Color color)
	Draw text with font size and text color More...

static void	Text (string text, Rect rect, Font font, float fontSize, Color color)
	Draw text with font, font size and text color More...

static void	Text (string text, Rect rect, Font font, float fontSize, float fontResolution, Color color)
	Draw text with font, font size, font resolution and text color More...

static void	Image (Texture texture, Rect rect)
	Draw image More...

static void	Image (Texture texture, Rect rect, Color color)
	Draw image with color tint More...

static void	Image (Texture texture, Rect rect, Color color, ImageType imageType)
	Draw image with color tint and image type More...

static bool	Button (int id, Rect rect, bool interactable)
	Draw enabled or disabled button More...

static bool	Button (int id, Rect rect, Color normalColor, Color hoverColor, Color activeColor, Color disabledColor, bool interactable)
	Draw enabled or disabled button with tint colors More...

static bool	Button (int id, Rect rect, Color normalColor, Color hoverColor, Color activeColor, Color disabledColor, Texture normalTexture, Texture hoverTexture, Texture activeTexture, Texture disabledTexture, ImageType imageType, bool interactable)
	Draw enabled or disabled button with textures and tint colors More...

static bool	Button (int id, Rect rect, Texture normalTexture, Texture hoverTexture, Texture activeTexture, Texture disabledTexture, ImageType imageType, bool interactable)
	Draw enabled or disabled button with textures More...

static bool	Button (int id, Rect rect, Color normalColor, Color hoverColor, Color activeColor, Color disabledColor, Texture texture, ImageType imageType, bool interactable)
	Draw enabled or disabled button with one texture and tint colors More...

Detailed Description

Definition at line 7 of file GUI.cs.

Member Enumeration Documentation

◆ ImageType

enum FalcoEngine.GUI.ImageType

ImageType enum

Enumerator
Simple
Sliced

Definition at line 12 of file GUI.cs.

◆ TextHorizontalAlignment

enum FalcoEngine.GUI.TextHorizontalAlignment

TextHorizontalAlignment enum

Enumerator
Left
Center
Right

Definition at line 21 of file GUI.cs.

◆ TextVerticalAlignment

enum FalcoEngine.GUI.TextVerticalAlignment

TextVerticalAlignment enum

Enumerator
Top
Middle
Bottom

Definition at line 31 of file GUI.cs.

◆ TextWordWrap

enum FalcoEngine.GUI.TextWordWrap

TextWordWrap enum

Enumerator
None
WordWrap
BreakWord

Definition at line 41 of file GUI.cs.

Member Function Documentation

◆ Button() [1/5]

static bool FalcoEngine.GUI.Button	(	int	id,
		Rect	rect,
		bool	interactable
	)

static

Draw enabled or disabled button

Parameters

id	Button id
rect	Rect on the screen
interactable	Button interactability

Returns

Definition at line 245 of file GUI.cs.

◆ Button() [2/5]

static bool FalcoEngine.GUI.Button	(	int	id,
		Rect	rect,
		Color	normalColor,
		Color	hoverColor,
		Color	activeColor,
		Color	disabledColor,
		bool	interactable
	)

static

Draw enabled or disabled button with tint colors

Parameters

id	Button id
rect	Rect on the screen
normalColor	Normal color
hoverColor	Hover color
activeColor	Active color
disabledColor	Disabled color
interactable	Button interactability

Returns

Definition at line 266 of file GUI.cs.

◆ Button() [3/5]

static bool FalcoEngine.GUI.Button	(	int	id,
		Rect	rect,
		Color	normalColor,
		Color	hoverColor,
		Color	activeColor,
		Color	disabledColor,
		Texture	normalTexture,
		Texture	hoverTexture,
		Texture	activeTexture,
		Texture	disabledTexture,
		ImageType	imageType,
		bool	interactable
	)

static

Draw enabled or disabled button with textures and tint colors

Parameters

id	Button id
rect	Rect on the screen
normalColor	Normal color
hoverColor	Hover color
activeColor	Active color
disabledColor	Disabled color
normalTexture	Normal texture
hoverTexture	Hover texture
activeTexture	Active texture
disabledTexture	Disabled texture
imageType	Image type
interactable	Button interactability

Returns

Definition at line 287 of file GUI.cs.

◆ Button() [4/5]

static bool FalcoEngine.GUI.Button	(	int	id,
		Rect	rect,
		Color	normalColor,
		Color	hoverColor,
		Color	activeColor,
		Color	disabledColor,
		Texture	texture,
		ImageType	imageType,
		bool	interactable
	)

static

Draw enabled or disabled button with one texture and tint colors

Parameters

id	Button id
rect	Rect on the screen
normalColor	Normal color
hoverColor	Hover color
activeColor	Active color
disabledColor	Disabled color
texture	Texture
imageType	Image type
interactable	Button interactability

Returns

Definition at line 345 of file GUI.cs.

◆ Button() [5/5]

static bool FalcoEngine.GUI.Button	(	int	id,
		Rect	rect,
		Texture	normalTexture,
		Texture	hoverTexture,
		Texture	activeTexture,
		Texture	disabledTexture,
		ImageType	imageType,
		bool	interactable
	)

static

Draw enabled or disabled button with textures

Parameters

id	Button id
rect	Rect on the screen
normalTexture	Normal texture
hoverTexture	Hover texture
activeTexture	Active texture
disabledTexture	Disabled texture
imageType	Image type
interactable	Button interactability

Returns

Definition at line 315 of file GUI.cs.

◆ Image() [1/3]

static void FalcoEngine.GUI.Image	(	Texture	texture,
		Rect	rect
	)

static

Draw image

Parameters

texture	Texture to draw
rect	Rect on the screen

Definition at line 209 of file GUI.cs.

◆ Image() [2/3]

static void FalcoEngine.GUI.Image	(	Texture	texture,
		Rect	rect,
		Color	color
	)

static

Draw image with color tint

Parameters

texture	Texture to draw
rect	Rect on the screen
color	Color tint

Definition at line 221 of file GUI.cs.

◆ Image() [3/3]

static void FalcoEngine.GUI.Image	(	Texture	texture,
		Rect	rect,
		Color	color,
		ImageType	imageType
	)

static

Draw image with color tint and image type

Parameters

texture	Texture to draw
rect	Rect on the screen
color	Color tint
imageType	Image type

Definition at line 233 of file GUI.cs.

◆ Text() [1/11]

static void FalcoEngine.GUI.Text	(	string	text,
		Rect	rect
	)

static

Draw text

Parameters

text	Text to draw
rect	Rect on the screen

Definition at line 53 of file GUI.cs.

◆ Text() [2/11]

static void FalcoEngine.GUI.Text	(	string	text,
		Rect	rect,
		float	fontSize,
		Color	color
	)

static

Draw text with font size and text color

Parameters

text	Text to draw
rect	Rect on the screen
fontSize	Font size
color	Text color

Definition at line 172 of file GUI.cs.

◆ Text() [3/11]

static void FalcoEngine.GUI.Text	(	string	text,
		Rect	rect,
		Font	font
	)

static

Draw text with font

Parameters

text	Text to draw
rect	Rect on the screen
font	Font

Definition at line 65 of file GUI.cs.

◆ Text() [4/11]

static void FalcoEngine.GUI.Text	(	string	text,
		Rect	rect,
		Font	font,
		float	fontSize
	)

static

Draw text with font and font size

Parameters

text	Text to draw
rect	Rect on the screen
font	Font
fontSize	Font size

Definition at line 78 of file GUI.cs.

◆ Text() [5/11]

static void FalcoEngine.GUI.Text	(	string	text,
		Rect	rect,
		Font	font,
		float	fontSize,
		Color	color
	)

static

Draw text with font, font size and text color

Parameters

text	Text to draw
rect	Rect on the screen
font	Font
fontSize	Font size
color	Text color

Definition at line 185 of file GUI.cs.

◆ Text() [6/11]

static void FalcoEngine.GUI.Text	(	string	text,
		Rect	rect,
		Font	font,
		float	fontSize,
		float	fontResolution
	)

static

Draw text with font, font size and font resolution

Parameters

text	Text to draw
rect	Rect on the screen
font	Font
fontSize	Font size
fontResolution	Font resolution

Definition at line 92 of file GUI.cs.

◆ Text() [7/11]

static void FalcoEngine.GUI.Text	(	string	text,
		Rect	rect,
		Font	font,
		float	fontSize,
		float	fontResolution,
		Color	color
	)

static

Draw text with font, font size, font resolution and text color

Parameters

text	Text to draw
rect	Rect on the screen
font	Font
fontSize	Font size
fontResolution	Font resolution
color	Text color

Definition at line 199 of file GUI.cs.

◆ Text() [8/11]

static void FalcoEngine.GUI.Text	(	string	text,
		Rect	rect,
		Font	font,
		float	fontSize,
		float	fontResolution,
		float	lineSpacing
	)

static

Draw text with font, font size, font resolution and line spacing

Parameters

text	Text to draw
rect	Rect on the screen
font	Font
fontSize	Font size
fontResolution	Font resolution
lineSpacing	Line spacing

Definition at line 107 of file GUI.cs.

◆ Text() [9/11]

static void FalcoEngine.GUI.Text	(	string	text,
		Rect	rect,
		Font	font,
		float	fontSize,
		float	fontResolution,
		float	lineSpacing,
		TextWordWrap	wordWrap
	)

static

Draw text with font, font size, font resolution, line spacing and word wrap

Parameters

text	Text to draw
rect	Rect on the screen
font	Font
fontSize	Font size
fontResolution	Font resolution
lineSpacing	Line spacing
wordWrap	Word wrap

Definition at line 123 of file GUI.cs.

◆ Text() [10/11]

static void FalcoEngine.GUI.Text	(	string	text,
		Rect	rect,
		Font	font,
		float	fontSize,
		float	fontResolution,
		float	lineSpacing,
		TextWordWrap	wordWrap,
		TextHorizontalAlignment	horizontalAlignment,
		TextVerticalAlignment	verticalAlignment
	)

static

Draw text with font, font size, font resolution, line spacing, word wrap, horizontal alignment and vertical alignment

Parameters

text	Text to draw
rect	Rect on the screen
font	Font
fontSize	Font size
fontResolution	Font resolution
lineSpacing	Line spacing
wordWrap	Word wrap
horizontalAlignment	Horizontal alignment
verticalAlignment	Vertical alignment

Definition at line 141 of file GUI.cs.

◆ Text() [11/11]

static void FalcoEngine.GUI.Text	(	string	text,
		Rect	rect,
		Font	font,
		float	fontSize,
		float	fontResolution,
		float	lineSpacing,
		TextWordWrap	wordWrap,
		TextHorizontalAlignment	horizontalAlignment,
		TextVerticalAlignment	verticalAlignment,
		Color	color
	)

static

Draw text with font, font size, font resolution, line spacing, word wrap, horizontal alignment, vertical alignment and text color

Parameters

text	Text to draw
rect	Rect on the screen
font	Font
fontSize	Font size
fontResolution	Font resolution
lineSpacing	Line spacing
wordWrap	Word wrap
horizontalAlignment	Horizontal alignment
verticalAlignment	Vertical alignment
color	Text color

Definition at line 160 of file GUI.cs.

The documentation for this class was generated from the following file:

API/Components/UI/GUI.cs

Public Types

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ImageType

◆ TextHorizontalAlignment

◆ TextVerticalAlignment

◆ TextWordWrap

Member Function Documentation

◆ Button() [1/5]

◆ Button() [2/5]

◆ Button() [3/5]

◆ Button() [4/5]

◆ Button() [5/5]

◆ Image() [1/3]

◆ Image() [2/3]

◆ Image() [3/3]

◆ Text() [1/11]

◆ Text() [2/11]

◆ Text() [3/11]

◆ Text() [4/11]

◆ Text() [5/11]

◆ Text() [6/11]

◆ Text() [7/11]

◆ Text() [8/11]

◆ Text() [9/11]

◆ Text() [10/11]

◆ Text() [11/11]