Jazz2::UI namespace

User interface and menus.

Namespaces

namespace Menu
Menu implementation.
namespace Multiplayer
Multiplayer-related user interface, compiled only if WITH_MULTIPLAYER.

Classes

class Canvas
Canvas.
class Cinematics
Handler that plays a cinematic video.
class DiscordRpcClient
Allows interactions with running Discord client.
class Font
Bitmap font renderer.
class FormattedTextBlock
Formatted text block.
struct FormattedTextBlockParams
Initialization parameters for formatted text block.
class HUD
Player HUD.
class InGameConsole
In-game console.
class LoadingHandler
Handler that only shows the loading indicator.

Enums

enum class Alignment { Center = 0x00, Left = 0x01, Right = 0x02, Top = 0x04, Bottom = 0x08, TopLeft = Top | Left, TopRight = Top | Right, BottomLeft = Bottom | Left, BottomRight = Bottom | Right, HorizontalMask = Left | Center | Right, VerticalMask = Top | Center | Bottom }
Alignment.
enum class MessageLevel { Unknown, Echo, Debug, Info, Chat, Confirm, Important, Warning, Error, Assert, Fatal }
Message importance level.

Enum documentation

enum class Jazz2::UI::Alignment

Alignment.

Describes how content is positioned within its bounds by combining independent horizontal and vertical edges, with convenience corner values and masks for isolating each axis. Supports a bitwise combination of its member values.

Enumerators
Center

Center

Left

Left

Right

Right

Top

Top

Bottom

Bottom

TopLeft

Top-left

TopRight

TopRight

BottomLeft

Bottom-left

BottomRight

Bottom-right

HorizontalMask

Mask of horizontal alignment

VerticalMask

Mask of vertical alignment

enum class Jazz2::UI::MessageLevel

Message importance level.

Classifies a line written to the InGameConsole by severity and purpose, ranging from echoed input and debug output through informational, chat and confirmation messages up to warnings, errors and fatal conditions. It influences how each message is presented in the log.

Enumerators
Unknown

Unspecified

Echo

Echo of the input

Debug

Debug

Info

Info

Chat

Chat

Confirm

Confirmation

Important

Important

Warning

Warning

Error

Error

Assert

Assert

Fatal

Fatal