UserInterface Class

Create the user interface instance.

Scale the entire UI and all the entities in it. This is useful for smaller device screens.

Get the main render target all the UI draws on.

Get the root entity.

The current target entity, eg what cursor points on. Can be null if cursor don't point on any entity.

If true, will draw the UI on a render target before drawing on screen. This mode is required for some of the features.

Add an entity to screen.

Remove all entities from screen.

Dispose unmanaged resources of this user interface.

Draw the UI. This function should be called from your Game 'Draw()' function. Note: if UseRenderTarget is true, this function should be called FIRST in your draw function. If UseRenderTarget is false, this function should be called LAST in your draw function.

Draw the cursor.

Finalize the draw frame and draw all the UI on screen. This function only works if we are in UseRenderTarget mode.

Determines whether the specified object is equal to the current object.

Serves as the default hash function.

Get transformed cursoer position for collision detection. If have transform matrix and curser is included in render target, will transform cursor position too. If don't use transform matrix or drawing cursor outside, will not transform cursor position.

Gets the Type of the current instance.

Initialize UI manager (mostly load resources and set some defaults).

Initialize UI manager (mostly load resources and set some defaults).

Remove an entity from screen.

Set cursor style.

Set cursor graphics from a custom texture.

Returns a string that represents the current object.

Update the UI manager. This function should be called from your Game 'Update()' function, as early as possible (eg before you update your game state).

The currently active user interface instance.

Current active entity, eg last entity user interacted with.

Callback to execute every frame after entity is rendered.

Callback to execute every frame after entity update.

Callback to execute every frame before entity is rendered.

Callback to execute every frame before entity update.

Blend state to use when rendering UI.

Cursor rendering size.

Create a default paragraph instance. GeonBit.UI entities use this method when need to create a paragraph, so you can override this to change which paragraph type the built-in entities will use by-default (for example Buttons text, SelectList items, etc.).

Draw utils helper. Contain general drawing functionality and handle effects replacement.

The function used to generate tooltip text on entities.

If using render targets, should the curser be rendered inside of it? If false, cursor will draw outside the render target, when presenting it.

Callback to execute when user clicks on an entity (eg release mouse over it).

Callback to execute every time a new entity is spawned (note: spawn = first time Update() is called on this entity).

Callback to execute every time an entity focus changes.

Callback to execute when mouse button is pressed over an entity (called once when button is pressed).

Callback to execute when mouse start hovering over an entity (eg enters its region).

Callback to execute when mouse stop hovering over an entity (eg leaves its region).

Callback to execute when mouse button is released over an entity (called once when button is released).

Callback to execute when mouse wheel scrolls and an entity is the active entity.

Called when entity starts getting dragged (only if draggable).

Called when entity stop getting dragged (only if draggable).

Callback to execute when any entity value changes (relevant only for entities with value).

Callback to execute every time the visibility property of an entity change.

Optional transformation matrix to apply when drawing with render targets.

Sampler state to use when rendering UI.

Screen height.

Screen width.

Weather or not to draw the cursor.

If true, GeonBit.UI will not raise exceptions on sanity checks, validations, and errors which are not critical. For example, trying to select a value that doesn't exist from a list would do nothing instead of throwing exception.

How long to wait before showing tooltip texts.

Current GeonBit.UI version identifier.

Called every frame while entity is being dragged.

Callback to execute every frame while mouse button is pressed over an entity.

Callback to execute every frame while mouse is hovering over an entity.