UserInterface Fields

GeonBit.UI

UserInterface Fields

The UserInterface type exposes the following members.

Fields
  NameDescription
Public fieldStatic memberActive
The currently active user interface instance.
Public fieldActiveEntity
Current active entity, eg last entity user interacted with.
Public fieldAfterDraw
Callback to execute every frame after entity is rendered.
Public fieldAfterUpdate
Callback to execute every frame after entity update.
Public fieldBeforeDraw
Callback to execute every frame before entity is rendered.
Public fieldBeforeUpdate
Callback to execute every frame before entity update.
Public fieldBlendState
Blend state to use when rendering UI.
Public fieldCursorScale
Cursor rendering size.
Public fieldStatic memberDefaultParagraph
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.).
Public fieldDrawUtils
Draw utils helper. Contain general drawing functionality and handle effects replacement.
Public fieldGenerateTooltipFunc
The function used to generate tooltip text on entities.
Public fieldIncludeCursorInRenderTarget
If using render targets, should the curser be rendered inside of it? If false, cursor will draw outside the render target, when presenting it.
Public fieldOnClick
Callback to execute when user clicks on an entity (eg release mouse over it).
Public fieldOnEntitySpawn
Callback to execute every time a new entity is spawned (note: spawn = first time Update() is called on this entity).
Public fieldOnFocusChange
Callback to execute every time an entity focus changes.
Public fieldOnMouseDown
Callback to execute when mouse button is pressed over an entity (called once when button is pressed).
Public fieldOnMouseEnter
Callback to execute when mouse start hovering over an entity (eg enters its region).
Public fieldOnMouseLeave
Callback to execute when mouse stop hovering over an entity (eg leaves its region).
Public fieldOnMouseReleased
Callback to execute when mouse button is released over an entity (called once when button is released).
Public fieldOnMouseWheelScroll
Callback to execute when mouse wheel scrolls and an entity is the active entity.
Public fieldOnStartDrag
Called when entity starts getting dragged (only if draggable).
Public fieldOnStopDrag
Called when entity stop getting dragged (only if draggable).
Public fieldOnValueChange
Callback to execute when any entity value changes (relevant only for entities with value).
Public fieldOnVisiblityChange
Callback to execute every time the visibility property of an entity change.
Public fieldRenderTargetTransformMatrix
Optional transformation matrix to apply when drawing with render targets.
Public fieldSamplerState
Sampler state to use when rendering UI.
Public fieldScreenHeight
Screen height.
Public fieldScreenWidth
Screen width.
Public fieldShowCursor
Weather or not to draw the cursor.
Public fieldSilentSoftErrors
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.
Public fieldStatic memberTimeToShowTooltipText
How long to wait before showing tooltip texts.
Public fieldStatic memberVERSION
Current GeonBit.UI version identifier.
Public fieldWhileDragging
Called every frame while entity is being dragged.
Public fieldWhileMouseDown
Callback to execute every frame while mouse button is pressed over an entity.
Public fieldWhileMouseHover
Callback to execute every frame while mouse is hovering over an entity.
Top
See Also