Getting Started#

Crystal language bindings for Nuklear

Introduction#

Nuklear-cr provides a lightweight immediate-mode GUI for use with the following backends:

SDL3-Renderer
SDL3-OpenGL3

An immediate-mode GUI means that it does not hold the state of its widgets. Instead, you call the functions for the elements you want to draw, and they are drawn every frame.

Example

# Outside the render loop
count = 0

# Inside the render loop
nk.window("demo") do
    nk.row
    count += 1 if nk.button("Increase")
    nk.label "Count: " + count.to_s
end

nk.button returns true if the button was clicked during the current frame. Since everything is redrawn every frame, there is no need to worry about updating the value of a given label instance.

Installation#

Work in progress

API Reference#

class `Nuklear`
inherits `Reference` #

Test

Getting Started#

Introduction#

Installation#

API Reference#

class Nuklear inherits Reference #

Methods#

#button(text)#

#chart_column(amostras, min = 0, max = 100#

#chart_lines(amostras, min = 0, max = 100#

#chart_max(amostras, min = 0, max = 100#

#chart_push_slot(val, index = 0) : ChartEvent#

#check(text, val : Bool) : Bool#

#contextual(width = 150, height = 200, trigger_x = 0, trigger_y = 0, trigger_width = 0, trigger_height = 0#

#contextual_item(label)#

#ctx#

#ctx=(ctx)#

#current_window#

#current_window=(current_window : String)#

#edit(text : String, max : Int)#

#edit_box(text : String, max : Int)#

#edit_editor(text : String, max : Int)#

#image(tex)#

#input_begin#

#input_end#

#label(text = "", align = :left)#

#menu_item_label(label)#

#menu_label(label, width = 200, height = 200#

#menubar#

#option(text, val : Bool) : Bool#

#popup(name, x = 0, y = 0, width = 150, height = 350, title = false, movable = false, scalable = false, minimizable = false, closable = false, border = false, scrollbar = false, scrollbar_autohide = false, background = false, scale_left = false, no_input = false#

#popup_close#

#property(name, val : Int, min = -999999, max = 999999, step = 1, inc_per_pixel = 0.5)#

#property(name, val : Float, min = -999999, max = 999999, step = 1, inc_per_pixel = 0.5)#

#row(cols = 1, height = 0, col_width = 0)#

#tooltip(label : String)#

#tooltip(width = 200#

#tree(title, collapsed = true, is_tab = false#

#widget_hovered?#

#widget_mouse_clicked?#

#widget_tooltip(label : String)#

#widget_tooltip(width = 200#

#window(name : String, x = 0, y = 0, width = 400, height = 300, title = name, movable = true, scalable = true, minimizable = true, closable = true, border = true, scrollbar = true, scrollbar_autohide = false, background = false, scale_left = false, no_input = false#

#window_active?(name)#

#window_any_hovered?#

#window_closed?(name) : Bool#

#window_has_focus?(name) : Bool#

#window_hidden?(name)#

#window_hovered?(name) : Bool#

class `Nuklear`
inherits `Reference` #

`#button(text)`#

`#chart_column(amostras, min = 0, max = 100`#

`#chart_lines(amostras, min = 0, max = 100`#

`#chart_max(amostras, min = 0, max = 100`#

`#chart_push_slot(val, index = 0) : ChartEvent`#

`#check(text, val : Bool) : Bool`#

`#contextual(width = 150, height = 200, trigger_x = 0, trigger_y = 0, trigger_width = 0, trigger_height = 0`#

`#contextual_item(label)`#

`#ctx`#

`#ctx=(ctx)`#

`#current_window`#

`#current_window=(current_window : String)`#

`#edit(text : String, max : Int)`#

`#edit_box(text : String, max : Int)`#

`#edit_editor(text : String, max : Int)`#

`#image(tex)`#

`#input_begin`#

`#input_end`#

`#label(text = "", align = :left)`#

`#menu_item_label(label)`#

`#menu_label(label, width = 200, height = 200`#

`#menubar`#

`#option(text, val : Bool) : Bool`#

`#popup(name, x = 0, y = 0, width = 150, height = 350, title = false, movable = false, scalable = false, minimizable = false, closable = false, border = false, scrollbar = false, scrollbar_autohide = false, background = false, scale_left = false, no_input = false`#

`#popup_close`#

`#property(name, val : Int, min = -999999, max = 999999, step = 1, inc_per_pixel = 0.5)`#

`#property(name, val : Float, min = -999999, max = 999999, step = 1, inc_per_pixel = 0.5)`#

`#row(cols = 1, height = 0, col_width = 0)`#

`#tooltip(label : String)`#

`#tooltip(width = 200`#

`#tree(title, collapsed = true, is_tab = false`#

`#widget_hovered?`#

`#widget_mouse_clicked?`#

`#widget_tooltip(label : String)`#

`#widget_tooltip(width = 200`#

`#window(name : String, x = 0, y = 0, width = 400, height = 300, title = name, movable = true, scalable = true, minimizable = true, closable = true, border = true, scrollbar = true, scrollbar_autohide = false, background = false, scale_left = false, no_input = false`#

`#window_active?(name)`#

`#window_any_hovered?`#

`#window_closed?(name) : Bool`#

`#window_has_focus?(name) : Bool`#

`#window_hidden?(name)`#

`#window_hovered?(name) : Bool`#