Align
-- Type doc: -
-- Fields: -
-- Methods: -
-diff --git a/Align.html b/Align.html deleted file mode 100644 index 12a682b..0000000 --- a/Align.html +++ /dev/null @@ -1,2293 +0,0 @@ - - - -
- - - - - - - - - -- Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-- Fields: -
-- Methods: -
- visual_bounding_rect: function(CircleShape):(Rect)
- filled: function((Pos2),(number),(Color32)):(CircleShape)
- stroke: function((Pos2),(number),(Stroke)):(CircleShape)
- - Type doc: -
-- Methods: -
- new: function((Rect),(Primitive)):(ClippedPrimitive)
- - Type doc: -
-- Methods: -
- new: function((Rect),(Shape)):(ClippedShape)
- - Type doc: -
-- Fields: -
-r: integer
- g: integer
- b: integer
- a: integer
- - Methods: -
- default: function():(Color32)
- - Type doc: -
-This is the Egui Context
-this will be given to the gui function, and can be used to create windows or other containers
-The containers will take a callback which will be given a Ui struct. that can be used by the callback to actually draw the user interface
- -- Fields: -
-- Type doc: -
-- Fields: -
-- Methods: -
- transform: function(CubicBezierShape,RectTransform):(CubicBezierShape)
- to_path_shapes: function(CubicBezierShape,(number),(number)):({PathShape})
- visual_bounding_rect: function(CubicBezierShape):(Rect)
- logical_bounding_rect: function(CubicBezierShape):(Rect)
- split_range: function(CubicBezierShape,(number),(number)):(CubicBezierShape)
- num_quadratics: function(CubicBezierShape,number):(integer)
- find_cross_t: function(CubicBezierShape,number):(number)
- sample: function(CubicBezierShape,number):(Pos2)
- flatten: function(CubicBezierShape,number):({Pos2})
- flatten_closed: function(CubicBezierShape,(number),(number)):({{Pos2}})
- for_each_flattened_with_t: function(CubicBezierShape,(number),(function(...any):any...)):()
- from_points_stroke: function(({Pos2}),(boolean),(Color32),(Stroke)):(CubicBezierShape)
- - Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-- Fields: -
-- Methods: -
- default: function():(FontFamily)
- - Type doc: -
-- Fields: -
-size: number
- family: FontFamily
- - Methods: -
- new: function((number),(FontFamily)):(FontId)
- proportional: function(number):(FontId)
- monospace: function(number):(FontId)
- - Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-- Fields: -
-resize_grab_radius_side: number
- resize_grab_radius_corner: number
- show_tooltips_only_when_still: boolean
- - Methods: -
-- Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-egui docs link: https://docs.rs/egui/latest/egui/style/struct.Margin.html
- -- Fields: -
-left: number
- right: number
- top: number
- bottom: number
- - Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-- Fields: -
-- Methods: -
- from: function(RectTransform):(Rect)
- to: function(RectTransform):(Rect)
- scale: function(RectTransform):(Vec2)
- inverse: function(RectTransform):(RectTransform)
- transform_pos: function(RectTransform,Pos2):(Pos2)
- transform_rect: function(RectTransform,Rect):(Rect)
- transform_pos_clamped: function(RectTransform,Pos2):(Pos2)
- identity: function(Rect):(RectTransform)
- from_to: function((Rect),(Rect)):(RectTransform)
- - Type doc: -
-This is the Egui Response
- -- Fields: -
-- Methods: -
- clicked: function(Response):(boolean)
- clicked_by: function(Response,PointerButton):(boolean)
- secondary_clicked: function(Response):(boolean)
- middle_clicked: function(Response):(boolean)
- double_clicked: function(Response):(boolean)
- triple_clicked: function(Response):(boolean)
- double_clicked_by: function(Response,PointerButton):(boolean)
- triple_clicked_by: function(Response,PointerButton):(boolean)
- clicked_elsewhere: function(Response):(boolean)
- enabled: function(Response):(boolean)
- hovered: function(Response):(boolean)
- has_focus: function(Response):(boolean)
- gained_focus: function(Response):(boolean)
- lost_focus: function(Response):(boolean)
- request_focus: function(Response):()
- surrender_focus: function(Response):()
- dragged: function(Response):(boolean)
- dragged_by: function(Response,PointerButton):(boolean)
- drag_started: function(Response):(boolean)
- drag_released: function(Response):(boolean)
- is_pointer_button_down_on: function(Response):(boolean)
- changed: function(Response):(boolean)
- on_hover_text_at_pointer: function(Response,string | RichText | WidgetText | Galley):(Response)
- on_hover_text: function(Response,string | RichText | WidgetText | Galley):(Response)
- on_disabled_hover_text: function(Response,string | RichText | WidgetText | Galley):(Response)
- on_hover_cursor: function(Response,CursorIcon):(Response)
- mark_changed: function(Response):()
- - Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-egui docs link: https://docs.rs/egui/latest/egui/struct.Stroke.html
- -- Fields: -
-nw: number
- ne: number
- sw: number
- se: number
- - Type doc: -
-- Fields: -
-click: boolean
- drag: boolean
- focusable: boolean
- - Methods: -
- interactive: function(Sense):(boolean)
- - Type doc: -
-- Fields: -
-extrusion: number
- color: Color32
- - Methods: -
-- Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-egui docs link: https://docs.rs/egui/latest/egui/style/struct.Spacing.html
- -- Fields: -
-item_spacing: Vec2
- window_margin: Margin
- button_padding: Vec2
- indent: number
- interact_size: Vec2
- slider_width: number
- text_edit_width: number
- icon_width: number
- icon_width_inner: number
- icon_spacing: number
- tooltip_width: number
- indent_ends_with_horizontal_line: boolean
- combo_height: number
- scroll_bar_width: number
- - Type doc: -
-egui docs link: https://docs.rs/egui/latest/egui/struct.Stroke.html
- -- Fields: -
-width: number
- color: Color32
- - Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-egui docs link: https://docs.rs/epaint/latest/epaint/struct.TextShape.html#
- -- Fields: -
-- Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-- Fields: -
-- Methods: -
- name: function(TextureHandle):(string)
- aspect_ratio: function(TextureHandle):(number)
- size: function(TextureHandle):({integer})
- id: function(TextureHandle):(TextureId)
- - Type doc: -
-- Fields: -
-- Methods: -
-- Type doc: -
-This is the egui::Ui wrapper type
- -- Fields: -
-- Methods: -
- is_enabled: function(Ui):(boolean)
- is_visible: function(Ui):(boolean)
- wrap_text: function(Ui):(boolean)
- available_width: function(Ui):(number)
- available_height: function(Ui):(number)
- use this function to get a unique ID for your widget. you need to provide something that will remain unique for your widget. maybe its name or its position or whatever. but completely unique to this widget
- ui_contains_pointer: function(Ui):(boolean)
- debug_paint_cursor: function(Ui):()
- child_ui: function(Ui,(Rect),(Layout),(function(...any):any...)):(MultiValue)
- child_ui_with_source: function(Ui,(Rect),(Layout),(string | integer | boolean),(function(...any):any...)):(MultiValue)
- reset_style: function(Ui):()
- set_enabled: function(Ui,boolean):()
- set_visible: function(Ui,boolean):()
- set_max_width: function(Ui,number):()
- set_max_height: function(Ui,number):()
- set_min_width: function(Ui,number):()
- set_min_height: function(Ui,number):()
- shrink_width_to_current: function(Ui):()
- shrink_height_to_current: function(Ui):()
- set_width_range: function(Ui,(number),(number)):()
- set_height_range: function(Ui,(number),(number)):()
- set_width: function(Ui,number):()
- set_height: function(Ui,number):()
- expand_to_include_x: function(Ui,number):()
- expand_to_include_y: function(Ui,number):()
- allocate_ui: function(Ui,(Vec2),(function(...any):any...)):((Response),(MultiValue))
- allocate_ui_with_layout: function(Ui,(Vec2),(Layout),(function(...any):any...)):((Response),(MultiValue))
- allocate_ui_at_rect: function(Ui,(Rect),(function(...any):any...)):((Response),(MultiValue))
- This is a generic function that takes and adds a specific widget to the Ui.
- This takes a table as argument. below, you can see how the table will be used.
- The table represents a generic widget and what the fields mean will be decided by the widget itself.
- The table must have a field called "widget_type" representing the type of widget with any of the following values:
- button, custom
- custom is a widget which is created inside lua itself to help addon makers reuse widgets.
- all widgets will basically use this table and Ui to draw themselves. different widgets need different data.
-
- Button:
- text: string. the text to show inside the button.
- wrap: bool. whether the button should wrap the inside text.
-
- add_enabled_ui: function(Ui,(boolean),(function(...any):any...)):((Response),(MultiValue))
- will create a new scope and add the ui after setting whether it should be enabled or not. won't affect other Ui after this
- add_visible_ui: function(Ui,(boolean),(function(...any):any...)):((Response),(MultiValue))
- add_space: function(Ui,number):()
- button: function(Ui,string | RichText | WidgetText | Galley):(Response)
- checkbox: function(Ui,(boolean),(string | RichText | WidgetText | Galley)):((Response),(boolean))
- hyperlink_to: function(Ui,(string | RichText | WidgetText | Galley),(string)):(Response)
- image: function(Ui,(TextureId | TextureHandle),(Vec2)):(Response)
- label: function(Ui,string | RichText | WidgetText | Galley):(Response)
- link: function(Ui,string | RichText | WidgetText | Galley):(Response)
- radio: function(Ui,(boolean),(string | RichText | WidgetText | Galley)):(Response)
- selectable_label: function(Ui,(boolean),(string | RichText | WidgetText | Galley)):(Response)
- small_button: function(Ui,string | RichText | WidgetText | Galley):(Response)
- toggle_value: function(Ui,(boolean),(string | RichText | WidgetText | Galley)):((Response),(boolean))
- group: function(Ui,function(...any):any...):((Response),(MultiValue))
- push_id: function(Ui,(string | integer | boolean),(function(...any):any...)):((Response),(MultiValue))
- scope: function(Ui,function(...any):any...):((Response),(MultiValue))
- new scope to make some localized changes without affect the rest of the Ui after this
- with_layer_id: function(Ui,(LayerId),(function(...any):any...)):((Response),(MultiValue))
- collapsing: function(Ui,(string | RichText | WidgetText | Galley),(function(...any):any...)):(MultiValue)
- this is one of the functions with a complicated return type
-this returns multiple values in the order of: Response of header, Response of body or nil, inner returns of body, openness (float)
- indent: function(Ui,(string | integer | boolean),(function(...any):any...)):((Response),(MultiValue))
- horizontal: function(Ui,function(...any):any...):((Response),(MultiValue))
- horizontal_centered: function(Ui,function(...any):any...):((Response),(MultiValue))
- horizontal_top: function(Ui,function(...any):any...):((Response),(MultiValue))
- horizontal_wrapped: function(Ui,function(...any):any...):((Response),(MultiValue))
- vertical: function(Ui,function(...any):any...):((Response),(MultiValue))
- vertical_centered: function(Ui,function(...any):any...):((Response),(MultiValue))
- vertical_centered_justified: function(Ui,function(...any):any...):((Response),(MultiValue))
- with_layout: function(Ui,(Layout),(function(...any):any...)):((Response),(MultiValue))
- centered_and_justified: function(Ui,function(...any):any...):((Response),(MultiValue))
- end_row: function(Ui):()
- set_row_height: function(Ui,number):()
- columns: function(Ui,(integer),(function(...any):any...)):(MultiValue)
- unlike other ui callbacks, this callback is given an array (table) of Ui objects
-the ui objects can be indexed by the column number, and used to fill up each column
-WARNING: rust versions of these following three functionsreturn Ui
but the lua versions instead take a function as an extra last argument which will be provide a UiMutRef
as the other callbacks
we never actually return the Ui
struct anywhere. instead we will return whatever the provided callback functions return as is.
- Type doc: -
-- Fields: -
-x: number
- y: number
- - Methods: -
- length: function(Vec2):(number)
- length_sq: function(Vec2):(number)
- angle: function(Vec2):(number)
- is_finite: function(Vec2):(boolean)
- any_nan: function(Vec2):(boolean)
- min_elem: function(Vec2):(number)
- max_elem: function(Vec2):(number)
- default: function():(Vec2)
- new: function((number),(number)):(Vec2)
- splat: function(number):(Vec2)
- angled: function(number):(Vec2)
- - Type doc: -
-- Fields: -
-override_text_color: Color32
- widgets: Widgets
- dark_mode: boolean
- selection: Selection
- hyperlink_color: Color32
- faint_bg_color: Color32
- extreme_bg_color: Color32
- code_bg_color: Color32
- window_rounding: Rounding
- window_shadow: Shadow
- popup_shadow: Shadow
- resize_corner_size: number
- text_cursor_width: number
- text_cursor_preview: boolean
- clip_rect_margin: number
- button_frame: boolean
- collapsing_header_frame: boolean
- - Methods: -
- noninteractive: function(Visuals):(WidgetVisuals)
- - Type doc: -
-- Fields: -
-- Methods: -
- is_empty: function(WidgetText):(boolean)
- text: function(WidgetText):(string)
- - Type doc: -
-- Fields: -
-- Methods: -
- text_color: function(WidgetVisuals):(Color32)
- - Type doc: -
-- Fields: -
-- Methods: -
- open: function(Window,boolean):()
- whether window should be open. when you call the show function, it will return the new status of the window.
- enabled: function(Window,boolean):()
- resize: function(Window,function(...any):any...):()
- the function callback will be given a Resize object. it can use any resizing methods it wants, BUT it must return the resize object at the end of the function callback
- min_width: function(Window,number):()
- min_height: function(Window,number):()
- default_width: function(Window,number):()
- default_height: function(Window,number):()
- resizable: function(Window,boolean):()
- collapsible: function(Window,boolean):()
- title_bar: function(Window,boolean):()
- auto_sized: function(Window):()
- scroll2: function(Window,{boolean}):()
- hscroll: function(Window,boolean):()
- vscroll: function(Window,boolean):()
- show: function(Window,(Context),(function(...any):any...)):(MultiValue)
- This function will consume the window and using the settings from that, display the window.
- it will take the Context as the first argument and the Ui callback function. that callback will be given the temporary Ui Object.
- The callback WILL NOT BE called if the window is collapsed as there's no reason to show anything.
- the return values can vary based on the status of the Window and will be in the following order.
- 1. bool. this will always be the first return value, and represents the status of the Window.
- 2. if the window is not OPEN (closed completely). then, this will be a nil value. if the window is open, this will contain the response form the window.
- 3. if the window is collapsed, this will be null because Ui callback is not run. otherwise, the return values will be from the result of running Ui callback.
-
- new: function((string | RichText | WidgetText | Galley),(Context),(function(...any):any...)):()
- This is the function you use to create a new window. -This function will need three arguments; -1. Title of the window. -2. The egui Context that is provided to the OnGui function -3. A function callback. this function will be called with two arguments. -1. The Context which was provided to us. this needs to be passed the "show" function of the Window. -2. The temporary Window object. just like Ui, you can call functions on it. but you can only call "show" function once on this. -Read the show function docs for other details.
- Windows are temporary much like Ui objects. so, you cannot store them.
-
-Globals:
-Types:
-