Documentation

GUI - Open Dev Kit Documentation

Open Dev Kit Documentation :: GUI

GUI

Classes

Config
Window Resource
Resource representing a window
Clipboard
Provides access to the system clipboard, allowing read and write operations for various data types.
Render Context
Handles drawing and graphical transformations within a specified GUI control using methods for various drawing operations
Renderer
Base class for rendering functionality
Control
Base class for all UI controls
Button
Button control that can be clicked by the user to perform an action
Textbox
Textbox control that allows users to input text
Label
Label control used to display text
Picture
Picture control used to display images
Listbox
Control used to display a list of items in various styles
Toggle
Toggle control that can be displayed as either a checkbox or a button.
Scrollbar
Scrollbar control that can be oriented horizontally or vertically.
Slider
Slider control that can be oriented horizontally or vertically.
Toolbar Tool
Tool in a toolbar
Toolbar
Control for the toolbar
Menu
Menu control that can contain various menu items
Menubar
Menubar control
Notebook Tab
Tab within a notebook control
Canvas
Spacer
Popup
Control for popup windows
Container
Container class for organizing other controls
Panel
Panel for organizing other controls
Window
Window in the user interface
RF Font
Font stored as a gui_font
RF Image
Image stored as a gui_image pointer
RF Image List
multiple images
Image Atlas Item Section
Section of an image atlas item
Image Atlas Item
Item in an image atlas
RF Image Atlas
Multiple images atlased on an image

Enumerations

File Dialog Flags
File dialog options
Color Dialog Flags
Color dialog options
Cursor Icon
Canvas Clearing
Options for clearing the canvas

Functions

Do Events ( )
Executes one iteration of the operating system
Key Pressed ( Key Keyboard Key ) Boolean
Returns whether a key is currently pressed
Alert Box ( Title String, Message String )
Basic alert in the operating system with just an OK button
Warning Box ( Title String, Message String ) Boolean
Warning alert in the operating system with OK and Cancel buttons
Question Box ( Title String, Message String ) Boolean
Question alert in the operating system with Yes and No buttons
Error Box ( Title String, Message String )
Basic error in the operating system with just an OK button
Open File Dialog ( Title String, Flags File Dialog Flags, Filters String, Default Filter Integer ) Boolean
Displays the common open file dialog
Save File Dialog ( Title String, Flags File Dialog Flags, Filters String, Default Filter Integer, Default Extension String ) Boolean
Displays the common open file dialog
Show Color Dialog ( Flags Color Dialog Flags ) Boolean
Displays the common color file dialog
Show Input Dialog ( Title String, Message String, Default String ) Boolean
Displays the common text input dialog
Get Text Dimensions ( Text String, Font Font*, Wrap Width Integer ) 2D Vector
Returns the dimensions of text with a specified font; not as optimized as the RenderContext version as an internal context must be used anyway
Create Image ( Width Integer, Height Integer, Color Color, Alpha Boolean ) Image*
Creates a blank image

Properties

Font Families String Array
font families available on the system
Empty Image Image*
empty image (pure white image used internally for certain drawing operations)
Default Stylesheet Stylesheet'
Stylesheet applied to system dialogs (defaults to editor stylesheet while using editor, and the app's configuration if in app)
Editor Stylesheet Stylesheet'
Stylesheet applied to editor dialogs while using editor
File Dialog Selection String Array
selected files in the last open/save file dialog
Color Dialog Selection Color
selected color in the last color dialog
Color Dialog Selection HDR Color HDR
selected HDR color in the last color dialog
Input Text String
last text inputted in the last input dialog
Active Renderer Renderer*
active renderer instance

If you think anything is missing, please feel free to: submit documentation feedback on this page