GeonBit.UI Documentation
| UserInterface Fields |
The UserInterface type exposes the following members.
Fields| Name | Description | |
|---|---|---|
  | Active |
The currently active user interface instance.
|
| ActiveEntity | Current active entity, eg last entity user interacted with. |
| AfterDraw | Callback to execute every frame after entity is rendered. |
| AfterUpdate | Callback to execute every frame after entity update. |
| BeforeDraw | Callback to execute every frame before entity is rendered. |
| BeforeUpdate | Callback to execute every frame before entity update. |
| BlendState |
Blend state to use when rendering UI.
|
| CursorScale | Cursor rendering size. |
| DefaultParagraph |
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.).
|
| DrawUtils | Draw utils helper. Contain general drawing functionality and handle effects replacement. |
| GenerateTooltipFunc |
The function used to generate tooltip text on entities.
|
| IncludeCursorInRenderTarget |
If using render targets, should the curser be rendered inside of it?
If false, cursor will draw outside the render target, when presenting it.
|
| OnClick | Callback to execute when user clicks on an entity (eg release mouse over it). |
| OnEntitySpawn | Callback to execute every time a new entity is spawned (note: spawn = first time Update() is called on this entity). |
| OnFocusChange | Callback to execute every time an entity focus changes. |
| OnMouseDown | Callback to execute when mouse button is pressed over an entity (called once when button is pressed). |
| OnMouseEnter | Callback to execute when mouse start hovering over an entity (eg enters its region). |
| OnMouseLeave | Callback to execute when mouse stop hovering over an entity (eg leaves its region). |
| OnMouseReleased | Callback to execute when mouse button is released over an entity (called once when button is released). |
| OnMouseWheelScroll | Callback to execute when mouse wheel scrolls and an entity is the active entity. |
| OnStartDrag | Called when entity starts getting dragged (only if draggable). |
| OnStopDrag | Called when entity stop getting dragged (only if draggable). |
| OnValueChange | Callback to execute when any entity value changes (relevant only for entities with value). |
| OnVisiblityChange | Callback to execute every time the visibility property of an entity change. |
| RenderTargetTransformMatrix |
Optional transformation matrix to apply when drawing with render targets.
|
| SamplerState |
Sampler state to use when rendering UI.
|
| ScreenHeight | Screen height. |
| ScreenWidth | Screen width. |
| ShowCursor | Weather or not to draw the cursor. |
| SilentSoftErrors |
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.
|
| TimeToShowTooltipText |
How long to wait before showing tooltip texts.
|
| VERSION | Current GeonBit.UI version identifier. |
| WhileDragging | Called every frame while entity is being dragged. |
| WhileMouseDown | Callback to execute every frame while mouse button is pressed over an entity. |
| WhileMouseHover | Callback to execute every frame while mouse is hovering over an entity. |
See Also