3712 lines
152 KiB
C++
3712 lines
152 KiB
C++
/*
|
|
This file contains docstrings for use in the Python bindings.
|
|
Do not edit! They were automatically extracted by pybind11_mkdoc.
|
|
*/
|
|
|
|
#define __EXPAND(x) x
|
|
#define __COUNT(_1, _2, _3, _4, _5, _6, _7, COUNT, ...) COUNT
|
|
#define __VA_SIZE(...) __EXPAND(__COUNT(__VA_ARGS__, 7, 6, 5, 4, 3, 2, 1))
|
|
#define __CAT1(a, b) a ## b
|
|
#define __CAT2(a, b) __CAT1(a, b)
|
|
#define __DOC1(n1) __doc_##n1
|
|
#define __DOC2(n1, n2) __doc_##n1##_##n2
|
|
#define __DOC3(n1, n2, n3) __doc_##n1##_##n2##_##n3
|
|
#define __DOC4(n1, n2, n3, n4) __doc_##n1##_##n2##_##n3##_##n4
|
|
#define __DOC5(n1, n2, n3, n4, n5) __doc_##n1##_##n2##_##n3##_##n4##_##n5
|
|
#define __DOC6(n1, n2, n3, n4, n5, n6) __doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6
|
|
#define __DOC7(n1, n2, n3, n4, n5, n6, n7) __doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7
|
|
#define DOC(...) __EXPAND(__EXPAND(__CAT2(__DOC, __VA_SIZE(__VA_ARGS__)))(__VA_ARGS__))
|
|
|
|
#if defined(__GNUG__)
|
|
#pragma GCC diagnostic push
|
|
#pragma GCC diagnostic ignored "-Wunused-variable"
|
|
#endif
|
|
|
|
|
|
static const char *__doc_GLFWcursor = R"doc()doc";
|
|
|
|
static const char *__doc_NVGcolor = R"doc()doc";
|
|
|
|
static const char *__doc_NVGglyphPosition = R"doc()doc";
|
|
|
|
static const char *__doc_enoki_ArrayBase = R"doc(Base class of all Enoki arrays)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_2 =
|
|
R"doc(\class AdvancedGridLayout layout.h nanogui/layout.h
|
|
|
|
Advanced Grid layout.
|
|
|
|
The is a fancier grid layout with support for items that span multiple
|
|
rows or columns, and per-widget alignment flags. Each row and column
|
|
additionally stores a stretch factor that controls how additional
|
|
space is redistributed. The downside of this flexibility is that a
|
|
layout anchor data structure must be provided for each widget.
|
|
|
|
An example:
|
|
|
|
\rst .. code-block:: cpp
|
|
|
|
using Anchor = AdvancedGridLayout::Anchor; Label *label = new
|
|
Label(window, "A label"); // Add a centered label at grid position (1,
|
|
5), which spans two horizontal cells layout->set_anchor(label,
|
|
Anchor(1, 5, 2, 1, Alignment::Middle, Alignment::Middle));
|
|
|
|
\endrst
|
|
|
|
The grid is initialized with user-specified column and row size
|
|
vectors (which can be expanded later on if desired). If a size value
|
|
of zero is specified for a column or row, the size is set to the
|
|
maximum preferred size of any widgets contained in the same row or
|
|
column. Any remaining space is redistributed according to the row and
|
|
column stretch factors.
|
|
|
|
The high level usage somewhat resembles the classic HIG layout:
|
|
|
|
- https://web.archive.org/web/20070813221705/http://www.autel.cz/dmi/t
|
|
utorial.html - https://github.com/jaapgeurts/higlayout)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_AdvancedGridLayout =
|
|
R"doc(Creates an AdvancedGridLayout with specified columns, rows, and
|
|
margin.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_Anchor =
|
|
R"doc(\struct Anchor layout.h nanogui/layout.h
|
|
|
|
Helper struct to coordinate anchor points for the layout.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_Anchor_Anchor = R"doc(Creates a ``0`` Anchor.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_Anchor_Anchor_2 = R"doc(Create an Anchor at position ``(x, y)`` with specified Alignment.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_Anchor_Anchor_3 =
|
|
R"doc(Create an Anchor at position ``(x, y)`` of size ``(w, h)`` with
|
|
specified alignments.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_Anchor_align = R"doc(< The ``(x, y)`` Alignment.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_Anchor_operator_basic_string = R"doc(Allows for printing out Anchor position, size, and alignment.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_Anchor_pos = R"doc(< The ``(x, y)`` position.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_Anchor_size = R"doc(< The ``(x, y)`` size.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_anchor = R"doc(Retrieve the anchor data structure for a given widget)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_append_col = R"doc(Append a column of the given size (and stretch factor))doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_append_row = R"doc(Append a row of the given size (and stretch factor))doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_col_count = R"doc(Return the number of cols)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_compute_layout = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_m_anchor = R"doc(The mapping of widgets to their specified anchor points.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_m_col_stretch = R"doc(The stretch for each column of this AdvancedGridLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_m_cols = R"doc(The columns of this AdvancedGridLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_m_margin = R"doc(The margin around this AdvancedGridLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_m_row_stretch = R"doc(The stretch for each row of this AdvancedGridLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_m_rows = R"doc(The rows of this AdvancedGridLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_margin = R"doc(The margin of this AdvancedGridLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_perform_layout = R"doc(See Layout::perform_layout.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_preferred_size = R"doc(See Layout::preferred_size.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_row_count = R"doc(Return the number of rows)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_set_anchor = R"doc(Specify the anchor data structure for a given widget)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_set_col_stretch = R"doc(Set the stretch factor of a given column)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_set_margin = R"doc(Sets the margin of this AdvancedGridLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_AdvancedGridLayout_set_row_stretch = R"doc(Set the stretch factor of a given row)doc";
|
|
|
|
static const char *__doc_nanogui_Alignment = R"doc(The different kinds of alignments a layout can perform.)doc";
|
|
|
|
static const char *__doc_nanogui_Alignment_Fill = R"doc(< Fill according to preferred sizes.)doc";
|
|
|
|
static const char *__doc_nanogui_Alignment_Maximum = R"doc(< Take as much space as is allowed.)doc";
|
|
|
|
static const char *__doc_nanogui_Alignment_Middle = R"doc(< Center align.)doc";
|
|
|
|
static const char *__doc_nanogui_Alignment_Minimum = R"doc(< Take only as much space as is required.)doc";
|
|
|
|
static const char *__doc_nanogui_Array = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_Array = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_Array_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_Array_3 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_Array_4 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_Array_5 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_Array_6 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_Array_7 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_Array_8 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_operator_array = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_operator_array_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_operator_eq = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_operator_iadd = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_operator_idiv = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_operator_imul = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_operator_isub = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_operator_ne = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_operator_sub = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_v = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_w = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_w_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_x = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_x_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_y = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_y_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_z = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Array_z_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout_2 =
|
|
R"doc(\class BoxLayout layout.h nanogui/layout.h
|
|
|
|
Simple horizontal/vertical box layout
|
|
|
|
This widget stacks up a bunch of widgets horizontally or vertically.
|
|
It adds margins around the entire container and a custom spacing
|
|
between adjacent widgets.)doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout_BoxLayout =
|
|
R"doc(Construct a box layout which packs widgets in the given
|
|
``Orientation``
|
|
|
|
Parameter ``orientation``:
|
|
The Orientation this BoxLayout expands along
|
|
|
|
Parameter ``alignment``:
|
|
Widget alignment perpendicular to the chosen orientation
|
|
|
|
Parameter ``margin``:
|
|
Margin around the layout container
|
|
|
|
Parameter ``spacing``:
|
|
Extra spacing placed between widgets)doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout_alignment = R"doc(The Alignment of this BoxLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout_m_alignment = R"doc(The Alignment of this BoxLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout_m_margin = R"doc(The margin padding of this BoxLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout_m_orientation = R"doc(The Orientation of this BoxLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout_m_spacing = R"doc(The spacing between widgets of this BoxLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout_margin = R"doc(The margin of this BoxLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout_orientation = R"doc(The Orientation this BoxLayout is using.)doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout_perform_layout = R"doc(See Layout::perform_layout.)doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout_preferred_size = R"doc(See Layout::preferred_size.)doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout_set_alignment = R"doc(Sets the Alignment of this BoxLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout_set_margin = R"doc(Sets the margin of this BoxLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout_set_orientation = R"doc(Sets the Orientation of this BoxLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout_set_spacing = R"doc(Sets the spacing of this BoxLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_BoxLayout_spacing = R"doc(The spacing this BoxLayout is using to pad in between widgets.)doc";
|
|
|
|
static const char *__doc_nanogui_Button =
|
|
R"doc(\class Button button.h nanogui/button.h
|
|
|
|
[Normal/Toggle/Radio/Popup] Button widget.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Button_Button =
|
|
R"doc(Creates a button attached to the specified parent.
|
|
|
|
Parameter ``parent``:
|
|
The nanogui::Widget this Button will be attached to.
|
|
|
|
Parameter ``caption``:
|
|
The name of the button (default ``"Untitled"``).
|
|
|
|
Parameter ``icon``:
|
|
The icon to display with this Button. See nanogui::Button::mIcon.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_Flags = R"doc(Flags to specify the button behavior (can be combined with binary OR))doc";
|
|
|
|
static const char *__doc_nanogui_Button_Flags_MenuButton = R"doc(< A menu button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_Flags_NormalButton = R"doc(< A normal button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_Flags_PopupButton = R"doc(< A popup button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_Flags_RadioButton = R"doc(< A radio button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_Flags_ToggleButton = R"doc(< A toggle button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_IconPosition = R"doc(The available icon positions.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_IconPosition_Left = R"doc(< Button icon on the far left.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_IconPosition_LeftCentered = R"doc(< Button icon on the left, centered (depends on caption text length).)doc";
|
|
|
|
static const char *__doc_nanogui_Button_IconPosition_Right = R"doc(< Button icon on the far right.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_IconPosition_RightCentered = R"doc(< Button icon on the right, centered (depends on caption text length).)doc";
|
|
|
|
static const char *__doc_nanogui_Button_background_color = R"doc(Returns the background color of this Button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_button_group = R"doc(Return the button group (for radio buttons))doc";
|
|
|
|
static const char *__doc_nanogui_Button_callback = R"doc(Return the push callback (for any type of button))doc";
|
|
|
|
static const char *__doc_nanogui_Button_caption = R"doc(Returns the caption of this Button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_change_callback = R"doc(Return the change callback (for toggle buttons))doc";
|
|
|
|
static const char *__doc_nanogui_Button_draw = R"doc(Responsible for drawing the Button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_flags =
|
|
R"doc(The current flags of this Button (see nanogui::Button::Flags for
|
|
options).)doc";
|
|
|
|
static const char *__doc_nanogui_Button_icon = R"doc(Returns the icon of this Button. See nanogui::Button::m_icon.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_icon_position = R"doc(The position of the icon for this Button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_m_background_color = R"doc(The background color of this Button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_m_button_group = R"doc(The button group for radio buttons.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_m_callback = R"doc(The callback issued for all types of buttons.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_m_caption = R"doc(The caption of this Button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_m_change_callback = R"doc(The callback issued for toggle buttons.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_m_flags =
|
|
R"doc(The current flags of this button (see nanogui::Button::Flags for
|
|
options).)doc";
|
|
|
|
static const char *__doc_nanogui_Button_m_icon =
|
|
R"doc(The icon of this Button (``0`` means no icon).
|
|
|
|
\rst The icon to display with this Button. If not ``0``, may either be
|
|
a picture icon, or one of the icons enumerated in
|
|
:ref:`file_nanogui_entypo.h`. The kind of icon (image or Entypo) is
|
|
determined by the functions :func:`nanogui::nvgIsImageIcon` and its
|
|
reciprocal counterpart :func:`nanogui::nvgIsFontIcon`. \endrst)doc";
|
|
|
|
static const char *__doc_nanogui_Button_m_icon_position = R"doc(The position to draw the icon at.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_m_pushed = R"doc(Whether or not this Button is currently pushed.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_m_text_color = R"doc(The color of the caption text of this Button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_mouse_button_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Button_mouse_enter_event =
|
|
R"doc(The callback that is called when any type of mouse button event is
|
|
issued to this Button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_preferred_size = R"doc(The preferred size of this Button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_pushed = R"doc(Whether or not this Button is currently pushed.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_set_background_color = R"doc(Sets the background color of this Button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_set_button_group = R"doc(Set the button group (for radio buttons))doc";
|
|
|
|
static const char *__doc_nanogui_Button_set_callback = R"doc(Set the push callback (for any type of button).)doc";
|
|
|
|
static const char *__doc_nanogui_Button_set_caption = R"doc(Sets the caption of this Button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_set_change_callback = R"doc(Set the change callback (for toggle buttons).)doc";
|
|
|
|
static const char *__doc_nanogui_Button_set_flags =
|
|
R"doc(Sets the flags of this Button (see nanogui::Button::Flags for
|
|
options).)doc";
|
|
|
|
static const char *__doc_nanogui_Button_set_icon = R"doc(Sets the icon of this Button. See nanogui::Button::m_icon.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_set_icon_position = R"doc(Sets the position of the icon for this Button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_set_pushed = R"doc(Sets whether or not this Button is currently pushed.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_set_text_color = R"doc(Sets the text color of the caption of this Button.)doc";
|
|
|
|
static const char *__doc_nanogui_Button_text_color = R"doc(Returns the text color of the caption of this Button.)doc";
|
|
|
|
static const char *__doc_nanogui_Canvas =
|
|
R"doc(\class GLCanvas canvas.h nanogui/canvas.h
|
|
|
|
Canvas widget for rendering OpenGL/GLES2/Metal content
|
|
|
|
Canvas widget that can be used to display arbitrary OpenGL content.
|
|
This is useful to display and manipulate 3D objects as part of an
|
|
interactive application. The implementation uses scissoring to ensure
|
|
that rendered objects don't spill into neighboring widgets.
|
|
|
|
\rst **Usage** Override :func:`nanogui::GLCanvas::draw_contents` in
|
|
subclasses to provide custom drawing code. See
|
|
:ref:`nanogui_example_4`.
|
|
|
|
\endrst)doc";
|
|
|
|
static const char *__doc_nanogui_Canvas_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Canvas_Canvas =
|
|
R"doc(Creates a new Canvas widget
|
|
|
|
Parameter ``parent``:
|
|
The parent widget
|
|
|
|
Parameter ``samples``:
|
|
The number of pixel samples (MSAA)
|
|
|
|
Parameter ``has_depth_buffer``:
|
|
Should the widget allocate a depth buffer for the underlying
|
|
render pass?
|
|
|
|
Parameter ``has_stencil_buffer``:
|
|
Should the widget allocate a stencil buffer for the underlying
|
|
render pass?
|
|
|
|
Parameter ``clear``:
|
|
Should the widget clear its color/depth/stencil buffer?)doc";
|
|
|
|
static const char *__doc_nanogui_Canvas_background_color = R"doc(Return whether the widget border is drawn)doc";
|
|
|
|
static const char *__doc_nanogui_Canvas_border_color = R"doc(Return whether the widget border is drawn)doc";
|
|
|
|
static const char *__doc_nanogui_Canvas_draw = R"doc(Draw the widget)doc";
|
|
|
|
static const char *__doc_nanogui_Canvas_draw_border = R"doc(Return whether the widget border will be drawn)doc";
|
|
|
|
static const char *__doc_nanogui_Canvas_draw_contents = R"doc(Draw the widget contents. Override this method.)doc";
|
|
|
|
static const char *__doc_nanogui_Canvas_m_border_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Canvas_m_draw_border = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Canvas_m_render_pass = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Canvas_m_render_to_texture = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Canvas_render_pass = R"doc(Return the render pass associated with the canvas object)doc";
|
|
|
|
static const char *__doc_nanogui_Canvas_set_background_color = R"doc(Specify the widget background color)doc";
|
|
|
|
static const char *__doc_nanogui_Canvas_set_border_color = R"doc(Specify the widget border color)doc";
|
|
|
|
static const char *__doc_nanogui_Canvas_set_draw_border = R"doc(Specify whether to draw the widget border)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox =
|
|
R"doc(\class CheckBox checkbox.h nanogui/checkbox.h
|
|
|
|
Two-state check box widget.
|
|
|
|
Remark:
|
|
This class overrides nanogui::Widget::mIconExtraScale to be
|
|
``1.2f``, which affects all subclasses of this Widget. Subclasses
|
|
must explicitly set a different value if needed (e.g., in their
|
|
constructor).)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_CheckBox =
|
|
R"doc(Adds a CheckBox to the specified ``parent``.
|
|
|
|
Parameter ``parent``:
|
|
The Widget to add this CheckBox to.
|
|
|
|
Parameter ``caption``:
|
|
The caption text of the CheckBox (default ``"Untitled"``).
|
|
|
|
Parameter ``callback``:
|
|
If provided, the callback to execute when the CheckBox is checked
|
|
or unchecked. Default parameter function does nothing. See
|
|
nanogui::CheckBox::mPushed for the difference between "pushed" and
|
|
"checked".)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_callback = R"doc(Returns the current callback of this CheckBox.)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_caption = R"doc(The caption of this CheckBox.)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_checked = R"doc(Whether or not this CheckBox is currently checked.)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_draw = R"doc(Draws this CheckBox.)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_m_callback = R"doc(The function to execute when nanogui::CheckBox::m_checked is changed.)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_m_caption = R"doc(The caption text of this CheckBox.)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_m_checked = R"doc(Whether or not this CheckBox is currently checked or unchecked.)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_m_pushed =
|
|
R"doc(Internal tracking variable to distinguish between mouse click and
|
|
release. nanogui::CheckBox::m_callback is only called upon release.
|
|
See nanogui::CheckBox::mouse_button_event for specific conditions.)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_mouse_button_event = R"doc(Mouse button event processing for this check box)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_preferred_size = R"doc(The preferred size of this CheckBox.)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_pushed =
|
|
R"doc(Whether or not this CheckBox is currently pushed. See
|
|
nanogui::CheckBox::m_pushed.)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_set_callback =
|
|
R"doc(Sets the callback to be executed when this CheckBox is checked /
|
|
unchecked.)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_set_caption = R"doc(Sets the caption of this CheckBox.)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_set_checked = R"doc(Sets whether or not this CheckBox is currently checked.)doc";
|
|
|
|
static const char *__doc_nanogui_CheckBox_set_pushed = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Color =
|
|
R"doc(\class Color common.h nanogui/common.h
|
|
|
|
Stores an RGBA floating point color value.
|
|
|
|
This class simply wraps around an ``Vector4f``, providing some
|
|
convenient methods and terminology for thinking of it as a color. The
|
|
data operates in the same way as ``Vector4f``, and the following
|
|
values are identical:
|
|
|
|
\rst +---------+-------------+----------------+-------------+ |
|
|
Channel | Array Index | Vector4f field | Color field |
|
|
+=========+=============+================+=============+ | Red | ``0``
|
|
| x() | r() | +---------+-------------+----------------+-------------+
|
|
| Green | ``1`` | y() | g() |
|
|
+---------+-------------+----------------+-------------+ | Blue |
|
|
``2`` | z() | b() |
|
|
+---------+-------------+----------------+-------------+ | Alpha |
|
|
``3`` | w() | a() |
|
|
+---------+-------------+----------------+-------------+ \endrst)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker =
|
|
R"doc(\class ColorPicker colorpicker.h nanogui/colorpicker.h
|
|
|
|
Push button with a popup to tweak a color value.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_ColorPicker =
|
|
R"doc(Attaches a ColorPicker to the specified parent.
|
|
|
|
Parameter ``parent``:
|
|
The Widget to add this ColorPicker to.
|
|
|
|
Parameter ``color``:
|
|
The color initially selected by this ColorPicker (default: Red).)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_callback = R"doc(The callback executed when the ColorWheel changes.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_color = R"doc(Get the current color)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_final_callback =
|
|
R"doc(The callback to execute when a new Color is selected on the ColorWheel
|
|
**and** the user clicks the nanogui::ColorPicker::m_pick_button or
|
|
nanogui::ColorPicker::m_reset_button.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_m_callback = R"doc(The "fast" callback executed when the ColorWheel has changed.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_m_color_wheel =
|
|
R"doc(The ColorWheel for this ColorPicker (the actual widget allowing
|
|
selection).)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_m_final_callback =
|
|
R"doc(The callback to execute when a new Color is selected on the ColorWheel
|
|
**and** the user clicks the nanogui::ColorPicker::m_pick_button or
|
|
nanogui::ColorPicker::m_reset_button.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_m_pick_button =
|
|
R"doc(The Button used to signal that the current value on the ColorWheel is
|
|
the desired color to be chosen. The default value for the caption of
|
|
this Button is ``"Pick"``. You can change it using
|
|
nanogui::ColorPicker::set_pick_button_caption if you need.
|
|
|
|
The color of this Button will not affect nanogui::ColorPicker::color
|
|
until the user has actively selected by clicking this pick button.
|
|
Similarly, the nanogui::ColorPicker::m_callback function is only
|
|
called when a user selects a new Color using by clicking this Button.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_m_reset_button =
|
|
R"doc(Remains the Color of the active color selection, until the user picks
|
|
a new Color on the ColorWheel **and** selects the
|
|
nanogui::ColorPicker::m_pick_button. The default value for the caption
|
|
of this Button is ``"Reset"``. You can change it using
|
|
nanogui::ColorPicker::set_reset_button_caption if you need.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_pick_button_caption = R"doc(The current caption of the nanogui::ColorPicker::m_pick_button.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_reset_button_caption = R"doc(The current caption of the nanogui::ColorPicker::m_reset_button.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_set_callback =
|
|
R"doc(Sets the callback is executed as the ColorWheel itself is changed. Set
|
|
this callback if you need to receive updates for the ColorWheel
|
|
changing before the user clicks nanogui::ColorPicker::mPickButton or
|
|
nanogui::ColorPicker::mPickButton.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_set_color = R"doc(Set the current color)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_set_final_callback =
|
|
R"doc(The callback to execute when a new Color is selected on the ColorWheel
|
|
**and** the user clicks the nanogui::ColorPicker::m_pick_button or
|
|
nanogui::ColorPicker::m_reset_button.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_set_pick_button_caption = R"doc(Sets the current caption of the nanogui::ColorPicker::m_pick_button.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorPicker_set_reset_button_caption = R"doc(Sets the current caption of the nanogui::ColorPicker::m_reset_button.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel =
|
|
R"doc(\class ColorWheel colorwheel.h nanogui/colorwheel.h
|
|
|
|
Fancy analog widget to select a color value. This widget was
|
|
contributed by Dmitriy Morozov.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_ColorWheel =
|
|
R"doc(Adds a ColorWheel to the specified parent.
|
|
|
|
Parameter ``parent``:
|
|
The Widget to add this ColorWheel to.
|
|
|
|
Parameter ``color``:
|
|
The initial color of the ColorWheel (default: Red).)doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_Region = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_Region_Both = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_Region_InnerTriangle = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_Region_None = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_Region_OuterCircle = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_adjust_position = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_callback = R"doc(The callback to execute when a user changes the ColorWheel value.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_color = R"doc(The current Color this ColorWheel has selected.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_draw = R"doc(Draws the ColorWheel.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_hue2rgb = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_m_black =
|
|
R"doc(The 'S' (satration) component of the HSV color model. See
|
|
implementation nanogui::ColorWheel::color for its usage. Valid values
|
|
are in the range ``[0, 1]``.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_m_callback = R"doc(The current callback to execute when the color value has changed.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_m_drag_region = R"doc(The current region the mouse is interacting with.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_m_hue = R"doc(The current hue in the HSV color model.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_m_white =
|
|
R"doc(The 'V' (value) component of the HSV color model. See implementation
|
|
nanogui::ColorWheel::color for its usage. Valid values are in the
|
|
range ``[0, 1]``.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_mouse_button_event = R"doc(Handles mouse button click events for the ColorWheel.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_mouse_drag_event = R"doc(Handles mouse drag events for the ColorWheel.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_preferred_size = R"doc(The preferred size of this ColorWheel.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_set_callback = R"doc(Sets the callback to execute when a user changes the ColorWheel value.)doc";
|
|
|
|
static const char *__doc_nanogui_ColorWheel_set_color = R"doc(Sets the current Color this ColorWheel has selected.)doc";
|
|
|
|
static const char *__doc_nanogui_Color_Color = R"doc(Default constructor: represents black (``r, g, b, a = 0``))doc";
|
|
|
|
static const char *__doc_nanogui_Color_Color_2 = R"doc(Initialize from a 4D vector)doc";
|
|
|
|
static const char *__doc_nanogui_Color_Color_3 =
|
|
R"doc(Copies (x, y, z) from the input vector, and uses the value specified
|
|
by the ``alpha`` parameter for this Color object's alpha component.
|
|
|
|
Parameter ``color``:
|
|
The three dimensional float vector being copied.
|
|
|
|
Parameter ``alpha``:
|
|
The value to set this object's alpha component to.)doc";
|
|
|
|
static const char *__doc_nanogui_Color_Color_4 =
|
|
R"doc(Copies (x, y, z) from the input vector, casted as floats first and
|
|
then divided by ``255.0``, and uses the value specified by the
|
|
``alpha`` parameter, casted to a float and divided by ``255.0`` as
|
|
well, for this Color object's alpha component.
|
|
|
|
Parameter ``color``:
|
|
The three dimensional integer vector being copied, will be divided
|
|
by ``255.0``.
|
|
|
|
Parameter ``alpha``:
|
|
The value to set this object's alpha component to, will be divided
|
|
by ``255.0``.)doc";
|
|
|
|
static const char *__doc_nanogui_Color_Color_5 =
|
|
R"doc(Copies (x, y, z) from the input vector, and sets the alpha of this
|
|
color to be ``1.0``.
|
|
|
|
Parameter ``color``:
|
|
The three dimensional float vector being copied.)doc";
|
|
|
|
static const char *__doc_nanogui_Color_Color_6 =
|
|
R"doc(Copies (x, y, z) from the input vector, casting to floats and dividing
|
|
by ``255.0``. The alpha of this color will be set to ``1.0``.
|
|
|
|
Parameter ``color``:
|
|
The three dimensional integer vector being copied, will be divided
|
|
by ``255.0``.)doc";
|
|
|
|
static const char *__doc_nanogui_Color_Color_7 =
|
|
R"doc(Copies (x, y, z, w) from the input vector, casting to floats and
|
|
dividing by ``255.0``.
|
|
|
|
Parameter ``color``:
|
|
The three dimensional integer vector being copied, will be divided
|
|
by ``255.0``.)doc";
|
|
|
|
static const char *__doc_nanogui_Color_Color_8 =
|
|
R"doc(Creates the Color ``(intensity, intensity, intensity, alpha)``.
|
|
|
|
Parameter ``intensity``:
|
|
The value to be used for red, green, and blue.
|
|
|
|
Parameter ``alpha``:
|
|
The alpha component of the color.)doc";
|
|
|
|
static const char *__doc_nanogui_Color_Color_9 =
|
|
R"doc(Creates the Color ``(intensity, intensity, intensity, alpha) /
|
|
255.0``. Values are casted to floats before division.
|
|
|
|
Parameter ``intensity``:
|
|
The value to be used for red, green, and blue, will be divided by
|
|
``255.0``.
|
|
|
|
Parameter ``alpha``:
|
|
The alpha component of the color, will be divided by ``255.0``.)doc";
|
|
|
|
static const char *__doc_nanogui_Color_Color_10 =
|
|
R"doc(Explicit constructor: creates the Color ``(r, g, b, a)``.
|
|
|
|
Parameter ``r``:
|
|
The red component of the color.
|
|
|
|
Parameter ``g``:
|
|
The green component of the color.
|
|
|
|
Parameter ``b``:
|
|
The blue component of the color.
|
|
|
|
Parameter ``a``:
|
|
The alpha component of the color.)doc";
|
|
|
|
static const char *__doc_nanogui_Color_Color_11 =
|
|
R"doc(Explicit constructor: creates the Color ``(r, g, b, a) / 255.0``.
|
|
Values are casted to floats before division.
|
|
|
|
Parameter ``r``:
|
|
The red component of the color, will be divided by ``255.0``.
|
|
|
|
Parameter ``g``:
|
|
The green component of the color, will be divided by ``255.0``.
|
|
|
|
Parameter ``b``:
|
|
The blue component of the color, will be divided by ``255.0``.
|
|
|
|
Parameter ``a``:
|
|
The alpha component of the color, will be divided by ``255.0``.)doc";
|
|
|
|
static const char *__doc_nanogui_Color_a = R"doc(Return a reference to the alpha channel)doc";
|
|
|
|
static const char *__doc_nanogui_Color_a_2 = R"doc(Return a reference to the alpha channel (const version))doc";
|
|
|
|
static const char *__doc_nanogui_Color_b = R"doc(Return a reference to the blue channel)doc";
|
|
|
|
static const char *__doc_nanogui_Color_b_2 = R"doc(Return a reference to the blue channel (const version))doc";
|
|
|
|
static const char *__doc_nanogui_Color_contrasting_color =
|
|
R"doc(Computes the luminance as ``l = 0.299r + 0.587g + 0.144b + 0.0a``. If
|
|
the luminance is less than 0.5, white is returned. If the luminance is
|
|
greater than or equal to 0.5, black is returned. Both returns will
|
|
have an alpha component of 1.0.)doc";
|
|
|
|
static const char *__doc_nanogui_Color_g = R"doc(Return a reference to the green channel)doc";
|
|
|
|
static const char *__doc_nanogui_Color_g_2 = R"doc(Return a reference to the green channel (const version))doc";
|
|
|
|
static const char *__doc_nanogui_Color_operator_const_NVGcolor = R"doc(Allows for conversion between this Color and NanoVG's representation.)doc";
|
|
|
|
static const char *__doc_nanogui_Color_r = R"doc(Return a reference to the red channel)doc";
|
|
|
|
static const char *__doc_nanogui_Color_r_2 = R"doc(Return a reference to the red channel (const version))doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox =
|
|
R"doc(\class ComboBox combobox.h nanogui/combobox.h
|
|
|
|
Simple combo box widget based on a popup button.)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_ComboBox = R"doc(Create an empty combo box)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_ComboBox_2 = R"doc(Create a new combo box with the given items)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_ComboBox_3 =
|
|
R"doc(Create a new combo box with the given items, providing both short and
|
|
long descriptive labels for each item)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_callback = R"doc(The callback to execute for this ComboBox.)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_items = R"doc(The items associated with this ComboBox.)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_items_short = R"doc(The short descriptions associated with this ComboBox.)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_m_callback = R"doc(The callback for this ComboBox.)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_m_container = R"doc(Container containing the buttons)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_m_items = R"doc(The items associated with this ComboBox.)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_m_items_short = R"doc(The short descriptions of items associated with this ComboBox.)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_m_scroll = R"doc(Scroll panel used to store the combo box contents)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_m_selected_index = R"doc(The current index this ComboBox has selected.)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_scroll_event = R"doc(Handles mouse scrolling events for this ComboBox.)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_selected_index = R"doc(The current index this ComboBox has selected.)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_set_callback = R"doc(Sets the callback to execute for this ComboBox.)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_set_items =
|
|
R"doc(Sets the items for this ComboBox, providing both short and long
|
|
descriptive lables for each item.)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_set_items_2 = R"doc(Sets the items for this ComboBox.)doc";
|
|
|
|
static const char *__doc_nanogui_ComboBox_set_selected_index = R"doc(Sets the current index this ComboBox has selected.)doc";
|
|
|
|
static const char *__doc_nanogui_Cursor =
|
|
R"doc(Cursor shapes available to use in GLFW. Shape of actual cursor
|
|
determined by Operating System.)doc";
|
|
|
|
static const char *__doc_nanogui_Cursor_2 =
|
|
R"doc(Cursor shapes available to use in GLFW. Shape of actual cursor
|
|
determined by Operating System.)doc";
|
|
|
|
static const char *__doc_nanogui_Cursor_Arrow = R"doc(< The arrow cursor.)doc";
|
|
|
|
static const char *__doc_nanogui_Cursor_Crosshair = R"doc(< The crosshair cursor.)doc";
|
|
|
|
static const char *__doc_nanogui_Cursor_CursorCount =
|
|
R"doc(< Not a cursor --- should always be last: enables a loop over the
|
|
cursor types.)doc";
|
|
|
|
static const char *__doc_nanogui_Cursor_HResize = R"doc(< The horizontal resize cursor.)doc";
|
|
|
|
static const char *__doc_nanogui_Cursor_Hand = R"doc(< The hand cursor.)doc";
|
|
|
|
static const char *__doc_nanogui_Cursor_IBeam = R"doc(< The I-beam cursor.)doc";
|
|
|
|
static const char *__doc_nanogui_Cursor_VResize = R"doc(< The vertical resize cursor.)doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox =
|
|
R"doc(\class FloatBox textbox.h nanogui/textbox.h
|
|
|
|
A specialization of TextBox representing floating point values.
|
|
|
|
The emplate parametersshould a be floating point type, e.g. ``float``
|
|
or ``double``.)doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_FloatBox = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_m_max_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_m_min_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_m_mouse_down_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_m_number_format = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_m_value_increment = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_mouse_button_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_mouse_drag_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_number_format = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_number_format_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_scroll_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_set_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_set_max_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_set_min_max_values = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_set_min_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_set_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_set_value_increment = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FloatBox_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper =
|
|
R"doc(\class FormHelper formhelper.h nanogui/formhelper.h
|
|
|
|
Convenience class to create simple AntTweakBar-style layouts that
|
|
expose variables of various types using NanoGUI widgets
|
|
|
|
**Example**:
|
|
|
|
\rst .. code-block:: cpp
|
|
|
|
// [ ... initialize NanoGUI, construct screen ... ]
|
|
|
|
FormHelper* h = new FormHelper(screen);
|
|
|
|
// Add a new windows widget h->add_window(Vector2i(10,10),"Menu");
|
|
|
|
// Start a new group h->add_group("Group 1");
|
|
|
|
// Expose an integer variable by reference h->add_variable("integer
|
|
variable", a_int);
|
|
|
|
// Expose a float variable via setter/getter functions
|
|
h->add_variable( [&](float value) { a_float = value; }, [&]() { return
|
|
*a_float; }, "float variable");
|
|
|
|
// add a new button h->add_button("Button", [&]() { std::cout <<
|
|
"Button pressed" << std::endl; });
|
|
|
|
\endrst)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_FormHelper = R"doc(Create a helper class to construct NanoGUI widgets on the given screen)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_add_button = R"doc(Add a button with a custom callback)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_add_group = R"doc(Add a new group that may contain several sub-widgets)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_add_variable = R"doc(Add a new data widget controlled using custom getter/setter functions)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_add_variable_2 = R"doc(Add a new data widget that exposes a raw variable in memory)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_add_widget = R"doc(Add an arbitrary (optionally labeled) widget to the layout)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_add_window = R"doc(Add a new top-level window)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_fixed_size = R"doc(The current fixed size being used for newly added widgets.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_group_font_name = R"doc(The font name being used for group headers.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_group_font_size = R"doc(The size of the font being used for group headers.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_label_font_name = R"doc(The font name being used for labels.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_label_font_size = R"doc(The size of the font being used for labels.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_m_fixed_size = R"doc(The fixed size for newly added widgets.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_m_group_font_name = R"doc(The group header font name.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_m_group_font_size = R"doc(The font size for group headers.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_m_label_font_name = R"doc(The label font name.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_m_label_font_size = R"doc(The font size for labels.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_m_layout =
|
|
R"doc(A reference to the nanogui::AdvancedGridLayout this FormHelper is
|
|
using.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_m_post_group_spacing = R"doc(The spacing used **after** each group.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_m_pre_group_spacing = R"doc(The spacing used **before** new groups.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_m_refresh_callbacks = R"doc(The callbacks associated with all widgets this FormHelper is managing.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_m_screen = R"doc(A reference to the nanogui::Screen this FormHelper is assisting.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_m_variable_spacing = R"doc(The spacing between all other widgets.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_m_widget_font_size = R"doc(The font size for non-group / non-label widgets.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_m_window = R"doc(A reference to the nanogui::Window this FormHelper is controlling.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_refresh = R"doc(Cause all widgets to re-synchronize with the underlying variable state)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_set_fixed_size = R"doc(Specify a fixed size for newly added widgets)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_set_group_font_name = R"doc(Sets the font name to be used for group headers.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_set_group_font_size = R"doc(Sets the size of the font being used for group headers.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_set_label_font_name = R"doc(Sets the font name being used for labels.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_set_label_font_size = R"doc(Sets the size of the font being used for labels.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_set_widget_font_size =
|
|
R"doc(Sets the size of the font being used for non-group / non-label
|
|
widgets.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_set_window = R"doc(Set the active Window instance.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_widget_font_size = R"doc(The size of the font being used for non-group / non-label widgets.)doc";
|
|
|
|
static const char *__doc_nanogui_FormHelper_window = R"doc(Access the currently active Window instance)doc";
|
|
|
|
static const char *__doc_nanogui_GLFramebuffer = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_GLShader = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph =
|
|
R"doc(\class Graph graph.h nanogui/graph.h
|
|
|
|
Simple graph widget for showing a function plot.)doc";
|
|
|
|
static const char *__doc_nanogui_Graph_Graph = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_background_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_caption = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_draw = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_fill_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_footer = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_header = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_m_background_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_m_caption = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_m_fill_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_m_footer = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_m_header = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_m_stroke_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_m_text_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_m_values = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_preferred_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_set_background_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_set_caption = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_set_fill_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_set_footer = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_set_header = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_set_stroke_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_set_text_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_set_values = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_stroke_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_text_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_values = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Graph_values_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_2 =
|
|
R"doc(\class GridLayout layout.h nanogui/layout.h
|
|
|
|
Grid layout.
|
|
|
|
Widgets are arranged in a grid that has a fixed grid resolution
|
|
``resolution`` along one of the axes. The layout orientation indicates
|
|
the fixed dimension; widgets are also appended on this axis. The
|
|
spacing between items can be specified per axis. The
|
|
horizontal/vertical alignment can be specified per row and column.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_GridLayout =
|
|
R"doc(Create a 2-column grid layout by default.
|
|
|
|
Parameter ``orientation``:
|
|
The fixed dimension of this GridLayout.
|
|
|
|
Parameter ``resolution``:
|
|
The number of rows or columns in the grid (depending on the
|
|
Orientation).
|
|
|
|
Parameter ``alignment``:
|
|
How widgets should be aligned within each grid cell.
|
|
|
|
Parameter ``margin``:
|
|
The amount of spacing to add around the border of the grid.
|
|
|
|
Parameter ``spacing``:
|
|
The amount of spacing between widgets added to the grid.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_alignment =
|
|
R"doc(The Alignment of the specified axis (row or column number, depending
|
|
on the Orientation) at the specified index of that row or column.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_compute_layout = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_m_alignment = R"doc(The actual Alignment being used for each column/row)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_m_default_alignment = R"doc(The default Alignment of the GridLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_m_margin = R"doc(The margin around this GridLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_m_orientation = R"doc(The Orientation of the GridLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_m_resolution =
|
|
R"doc(The number of rows or columns before starting a new one, depending on
|
|
the Orientation.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_m_spacing = R"doc(The spacing used for each dimension.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_margin = R"doc(The margin around this GridLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_orientation = R"doc(The Orientation of this GridLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_perform_layout = R"doc(See Layout::perform_layout.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_preferred_size = R"doc(See Layout::preferred_size.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_resolution =
|
|
R"doc(The number of rows or columns (depending on the Orientation) of this
|
|
GridLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_set_col_alignment = R"doc(Sets the Alignment of the columns.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_set_col_alignment_2 = R"doc(Use this to set variable Alignment for columns.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_set_margin = R"doc(Sets the margin of this GridLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_set_orientation = R"doc(Sets the Orientation of this GridLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_set_resolution =
|
|
R"doc(Sets the number of rows or columns (depending on the Orientation) of
|
|
this GridLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_set_row_alignment = R"doc(Sets the Alignment of the rows.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_set_row_alignment_2 = R"doc(Use this to set variable Alignment for rows.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_set_spacing = R"doc(Sets the spacing for a specific axis.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_set_spacing_2 = R"doc(Sets the spacing for all axes.)doc";
|
|
|
|
static const char *__doc_nanogui_GridLayout_spacing =
|
|
R"doc(The spacing at the specified axis (row or column number, depending on
|
|
the Orientation).)doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout_2 =
|
|
R"doc(\class GroupLayout layout.h nanogui/layout.h
|
|
|
|
Special layout for widgets grouped by labels.
|
|
|
|
This widget resembles a box layout in that it arranges a set of
|
|
widgets vertically. All widgets are indented on the horizontal axis
|
|
except for Label widgets, which are not indented.
|
|
|
|
This creates a pleasing layout where a number of widgets are grouped
|
|
under some high-level heading.)doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout_GroupLayout =
|
|
R"doc(Creates a GroupLayout.
|
|
|
|
Parameter ``margin``:
|
|
The margin around the widgets added.
|
|
|
|
Parameter ``spacing``:
|
|
The spacing between widgets added.
|
|
|
|
Parameter ``group_spacing``:
|
|
The spacing between groups (groups are defined by each Label
|
|
added).
|
|
|
|
Parameter ``group_indent``:
|
|
The amount to indent widgets in a group (underneath a Label).)doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout_group_indent =
|
|
R"doc(The indent of widgets in a group (underneath a Label) of this
|
|
GroupLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout_group_spacing = R"doc(The spacing between groups of this GroupLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout_m_group_indent =
|
|
R"doc(The indent amount of a group under its defining Label of this
|
|
GroupLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout_m_group_spacing = R"doc(The spacing between groups of this GroupLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout_m_margin = R"doc(The margin of this GroupLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout_m_spacing = R"doc(The spacing between widgets of this GroupLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout_margin = R"doc(The margin of this GroupLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout_perform_layout = R"doc(See Layout::perform_layout.)doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout_preferred_size = R"doc(See Layout::preferred_size.)doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout_set_group_indent =
|
|
R"doc(Sets the indent of widgets in a group (underneath a Label) of this
|
|
GroupLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout_set_group_spacing = R"doc(Sets the spacing between groups of this GroupLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout_set_margin = R"doc(Sets the margin of this GroupLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout_set_spacing = R"doc(Sets the spacing between widgets of this GroupLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_GroupLayout_spacing = R"doc(The spacing between widgets of this GroupLayout.)doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_2 =
|
|
R"doc(\class ImagePanel imagepanel.h nanogui/imagepanel.h
|
|
|
|
Image panel widget which shows a number of square-shaped icons.)doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_ImagePanel = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_draw = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_grid_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_images = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_index_for_position = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_m_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_m_images = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_m_margin = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_m_mouse_index = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_m_spacing = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_m_thumb_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_mouse_button_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_mouse_motion_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_preferred_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_set_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImagePanel_set_images = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImageView = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_2 =
|
|
R"doc(\class ImageView imageview.h nanogui/imageview.h
|
|
|
|
A widget for displaying, panning, and zooming images. Numerical RGBA
|
|
pixel information is shown at large magnifications.)doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_ImageView = R"doc(Initialize the widget)doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_center = R"doc(Center the image on the screen)doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_draw = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_draw_contents = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_image = R"doc(Return the currently active image)doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_image_2 = R"doc(Return the currently active image (const version))doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_keyboard_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_m_draw_image_border = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_m_image = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_m_image_background_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_m_image_border_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_m_image_shader = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_m_offset = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_m_pixel_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_m_scale = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_mouse_drag_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_offset = R"doc(Return the pixel offset of the zoomed image rectangle)doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_pixel_callback =
|
|
R"doc(Return the callback that is used to acquire information about pixel
|
|
components)doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_pixel_to_pos = R"doc(Convert a pixel position in the image to a position within the widget)doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_pos_to_pixel = R"doc(Convert a position within the widget to a pixel position in the image)doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_reset = R"doc(Center the image on the screen and set the scale to 1:1)doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_scale = R"doc(Return the current magnification of the image)doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_scroll_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_set_image = R"doc(Set the currently active image)doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_set_offset = R"doc(Set the pixel offset of the zoomed image rectangle)doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_set_pixel_callback =
|
|
R"doc(Set the callback that is used to acquire information about pixel
|
|
components)doc";
|
|
|
|
static const char *__doc_nanogui_ImageView_set_scale = R"doc(Set the current magnification of the image)doc";
|
|
|
|
static const char *__doc_nanogui_IntBox =
|
|
R"doc(\class IntBox textbox.h nanogui/textbox.h
|
|
|
|
A specialization of TextBox for representing integral values.
|
|
|
|
Template parameters should be integral types, e.g. ``int``, ``long``,
|
|
``uint32_t``, etc.)doc";
|
|
|
|
static const char *__doc_nanogui_IntBox_IntBox = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_IntBox_m_max_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_IntBox_m_min_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_IntBox_m_mouse_down_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_IntBox_m_value_increment = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_IntBox_mouse_button_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_IntBox_mouse_drag_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_IntBox_scroll_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_IntBox_set_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_IntBox_set_max_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_IntBox_set_min_max_values = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_IntBox_set_min_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_IntBox_set_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_IntBox_set_value_increment = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_IntBox_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Label = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Label_2 =
|
|
R"doc(\class Label label.h nanogui/label.h
|
|
|
|
Text label widget.
|
|
|
|
The font and color can be customized. When Widget::set_fixed_width()
|
|
is used, the text is wrapped when it surpasses the specified width.)doc";
|
|
|
|
static const char *__doc_nanogui_Label_Label = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Label_caption = R"doc(Get the label's text caption)doc";
|
|
|
|
static const char *__doc_nanogui_Label_color = R"doc(Get the label color)doc";
|
|
|
|
static const char *__doc_nanogui_Label_draw = R"doc(Draw the label)doc";
|
|
|
|
static const char *__doc_nanogui_Label_font = R"doc(Get the currently active font)doc";
|
|
|
|
static const char *__doc_nanogui_Label_m_caption = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Label_m_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Label_m_font = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Label_preferred_size = R"doc(Compute the size needed to fully display the label)doc";
|
|
|
|
static const char *__doc_nanogui_Label_set_caption = R"doc(Set the label's text caption)doc";
|
|
|
|
static const char *__doc_nanogui_Label_set_color = R"doc(Set the label color)doc";
|
|
|
|
static const char *__doc_nanogui_Label_set_font =
|
|
R"doc(Set the currently active font (2 are available by default: 'sans' and
|
|
'sans-bold'))doc";
|
|
|
|
static const char *__doc_nanogui_Label_set_theme = R"doc(Set the Theme used to draw this widget)doc";
|
|
|
|
static const char *__doc_nanogui_Layout = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Layout_2 =
|
|
R"doc(\class Layout layout.h nanogui/layout.h
|
|
|
|
Basic interface of a layout engine.)doc";
|
|
|
|
static const char *__doc_nanogui_Layout_perform_layout =
|
|
R"doc(Performs applies all layout computations for the given widget.
|
|
|
|
Parameter ``ctx``:
|
|
The ``NanoVG`` context being used for drawing.
|
|
|
|
Parameter ``widget``:
|
|
The Widget whose child widgets will be positioned by the layout
|
|
class..)doc";
|
|
|
|
static const char *__doc_nanogui_Layout_preferred_size =
|
|
R"doc(Compute the preferred size for a given layout and widget
|
|
|
|
Parameter ``ctx``:
|
|
The ``NanoVG`` context being used for drawing.
|
|
|
|
Parameter ``widget``:
|
|
Widget, whose preferred size should be computed
|
|
|
|
Returns:
|
|
The preferred size, accounting for things such as spacing, padding
|
|
for icons, etc.)doc";
|
|
|
|
static const char *__doc_nanogui_Matrix = R"doc(Simple matrix class with column-major storage)doc";
|
|
|
|
static const char *__doc_nanogui_Matrix_Matrix = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Matrix_Matrix_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Matrix_look_at = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Matrix_m = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Matrix_ortho = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Matrix_perspective = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Matrix_rotate = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Matrix_scale = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Matrix_scale_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Matrix_translate = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_MessageDialog = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_MessageDialog_2 =
|
|
R"doc(\class MessageDialog messagedialog.h nanogui/messagedialog.h
|
|
|
|
Simple "OK" or "Yes/No"-style modal dialogs.)doc";
|
|
|
|
static const char *__doc_nanogui_MessageDialog_MessageDialog = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_MessageDialog_Type = R"doc(Classification of the type of message this MessageDialog represents.)doc";
|
|
|
|
static const char *__doc_nanogui_MessageDialog_Type_Information = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_MessageDialog_Type_Question = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_MessageDialog_Type_Warning = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_MessageDialog_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_MessageDialog_m_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_MessageDialog_m_message_label = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_MessageDialog_message_label = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_MessageDialog_message_label_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_MessageDialog_set_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Object = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Object_2 =
|
|
R"doc(\class Object object.h nanogui/object.h
|
|
|
|
Reference counted object base class.)doc";
|
|
|
|
static const char *__doc_nanogui_Object_Object = R"doc(Default constructor)doc";
|
|
|
|
static const char *__doc_nanogui_Object_Object_2 = R"doc(Copy constructor)doc";
|
|
|
|
static const char *__doc_nanogui_Object_dec_ref =
|
|
R"doc(Decrease the reference count of the object and possibly deallocate it.
|
|
|
|
The object will automatically be deallocated once the reference count
|
|
reaches zero.)doc";
|
|
|
|
static const char *__doc_nanogui_Object_inc_ref = R"doc(Increase the object's reference count by one)doc";
|
|
|
|
static const char *__doc_nanogui_Object_m_ref_count = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Object_ref_count = R"doc(Return the current reference count)doc";
|
|
|
|
static const char *__doc_nanogui_Orientation = R"doc(The direction of data flow for a layout.)doc";
|
|
|
|
static const char *__doc_nanogui_Orientation_Horizontal = R"doc(< Layout expands on horizontal axis.)doc";
|
|
|
|
static const char *__doc_nanogui_Orientation_Vertical = R"doc(< Layout expands on vertical axis.)doc";
|
|
|
|
static const char *__doc_nanogui_Popup = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Popup_2 =
|
|
R"doc(\class Popup popup.h nanogui/popup.h
|
|
|
|
Popup window for combo boxes, popup buttons, nested dialogs etc.
|
|
|
|
Usually the Popup instance is constructed by another widget (e.g.
|
|
PopupButton) and does not need to be created by hand.)doc";
|
|
|
|
static const char *__doc_nanogui_PopupButton = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_PopupButton_2 =
|
|
R"doc(\class PopupButton popupbutton.h nanogui/popupbutton.h
|
|
|
|
Button which launches a popup widget.
|
|
|
|
Remark:
|
|
This class overrides nanogui::Widget::mIconExtraScale to be
|
|
``0.8f``, which affects all subclasses of this Widget. Subclasses
|
|
must explicitly set a different value if needed (e.g., in their
|
|
constructor).)doc";
|
|
|
|
static const char *__doc_nanogui_PopupButton_PopupButton = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_PopupButton_chevron_icon = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_PopupButton_draw = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_PopupButton_m_chevron_icon = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_PopupButton_m_popup = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_PopupButton_perform_layout = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_PopupButton_popup = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_PopupButton_popup_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_PopupButton_preferred_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_PopupButton_set_chevron_icon = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_PopupButton_set_side = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_PopupButton_side = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Popup_Popup =
|
|
R"doc(Create a new popup parented to a screen (first argument) and a parent
|
|
window (if applicable))doc";
|
|
|
|
static const char *__doc_nanogui_Popup_Side = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Popup_Side_Left = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Popup_Side_Right = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Popup_anchor_offset =
|
|
R"doc(Return the anchor height; this determines the vertical shift relative
|
|
to the anchor position)doc";
|
|
|
|
static const char *__doc_nanogui_Popup_anchor_pos =
|
|
R"doc(Set the anchor position in the parent window; the placement of the
|
|
popup is relative to it)doc";
|
|
|
|
static const char *__doc_nanogui_Popup_anchor_size = R"doc(Return the anchor width)doc";
|
|
|
|
static const char *__doc_nanogui_Popup_draw = R"doc(Draw the popup window)doc";
|
|
|
|
static const char *__doc_nanogui_Popup_m_anchor_offset = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Popup_m_anchor_pos = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Popup_m_anchor_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Popup_m_parent_window = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Popup_m_side = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Popup_parent_window = R"doc(Return the parent window of the popup)doc";
|
|
|
|
static const char *__doc_nanogui_Popup_parent_window_2 = R"doc(Return the parent window of the popup)doc";
|
|
|
|
static const char *__doc_nanogui_Popup_perform_layout =
|
|
R"doc(Invoke the associated layout generator to properly place child
|
|
widgets, if any)doc";
|
|
|
|
static const char *__doc_nanogui_Popup_refresh_relative_placement = R"doc(Internal helper function to maintain nested window position values)doc";
|
|
|
|
static const char *__doc_nanogui_Popup_set_anchor_offset =
|
|
R"doc(Set the anchor height; this determines the vertical shift relative to
|
|
the anchor position)doc";
|
|
|
|
static const char *__doc_nanogui_Popup_set_anchor_pos =
|
|
R"doc(Return the anchor position in the parent window; the placement of the
|
|
popup is relative to it)doc";
|
|
|
|
static const char *__doc_nanogui_Popup_set_anchor_size = R"doc(Set the anchor width)doc";
|
|
|
|
static const char *__doc_nanogui_Popup_set_side = R"doc(Set the side of the parent window at which popup will appear)doc";
|
|
|
|
static const char *__doc_nanogui_Popup_side = R"doc(Return the side of the parent window at which popup will appear)doc";
|
|
|
|
static const char *__doc_nanogui_ProgressBar = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ProgressBar_2 =
|
|
R"doc(\class ProgressBar progressbar.h nanogui/progressbar.h
|
|
|
|
Standard widget for visualizing progress.)doc";
|
|
|
|
static const char *__doc_nanogui_ProgressBar_ProgressBar = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ProgressBar_draw = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ProgressBar_m_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ProgressBar_preferred_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ProgressBar_set_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ProgressBar_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_CullMode = R"doc(Culling mode)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_CullMode_Back = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_CullMode_Disabled = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_CullMode_Front = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_DepthTest = R"doc(Depth test)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_DepthTest_Always = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_DepthTest_Equal = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_DepthTest_Greater = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_DepthTest_GreaterEqual = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_DepthTest_Less = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_DepthTest_LessEqual = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_DepthTest_Never = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_DepthTest_NotEqual = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_RenderPass =
|
|
R"doc(Create a new render pass for rendering to a specific set of targets
|
|
|
|
Parameter ``color_targets``:
|
|
One or more target objects to which color information will be
|
|
rendered. Must either be a Screen or a Texture instance.
|
|
|
|
Parameter ``depth_target``:
|
|
Target object to which depth information will be rendered. Must
|
|
either be ``NULL`` or a Texture instance.
|
|
|
|
Parameter ``stencil_target``:
|
|
Target object to which stencil information will be rendered. Must
|
|
either be ``NULL`` or a Texture instance. Can be identical to
|
|
'depth_target' in case the texture has the pixel format
|
|
Texture::PixelFormat::DepthStencil.
|
|
|
|
Parameter ``blit_target``:
|
|
When rendering finishes, the render pass can (optionally) blit the
|
|
framebuffer to another target (which can either be another
|
|
RenderPass instance or a Screen instance). This is mainly useful
|
|
for multisample antialiasing (MSAA) rendering where set of multi-
|
|
sample framebuffers must be converted into ordinary framebuffers
|
|
for display.
|
|
|
|
Parameter ``clear``:
|
|
Should enter() begin by clearing all buffers?)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_begin =
|
|
R"doc(Begin the render pass
|
|
|
|
The specified drawing state (e.g. depth tests, culling mode, blending
|
|
mode) are automatically set up at this point. Later changes between
|
|
begin() and end() are possible but cause additional OpenGL/GLES/Metal
|
|
API calls.
|
|
|
|
The Python bindings also include extra ``__enter__`` and ``__exit__``
|
|
aliases so that the render pass can be activated via Pythons 'with'
|
|
statement.)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_blit_to =
|
|
R"doc(Blit the framebuffer to another target (which can either be another
|
|
RenderPass instance or a Screen instance).)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_clear_color = R"doc(Return the clear color for a given color attachment)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_clear_depth = R"doc(Return the clear depth for the depth attachment)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_clear_stencil = R"doc(Return the clear stencil for the stencil attachment)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_cull_mode = R"doc(Return the culling mode associated with the render pass)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_depth_test = R"doc(Return the depth test and depth write mask of this render pass)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_end = R"doc(Finish the render pass)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_framebuffer_handle = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_active = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_blend_backup = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_blit_target = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_clear = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_clear_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_clear_depth = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_clear_stencil = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_cull_face_backup = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_cull_mode = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_depth_test = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_depth_test_backup = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_depth_write = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_depth_write_backup = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_framebuffer_handle = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_framebuffer_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_scissor_backup = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_scissor_test_backup = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_targets = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_viewport_backup = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_viewport_offset = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_m_viewport_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_resize = R"doc(Resize all texture targets attached to the render pass)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_set_clear_color = R"doc(Set the clear color for a given color attachment)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_set_clear_depth = R"doc(Set the clear depth for the depth attachment)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_set_clear_stencil = R"doc(Set the clear stencil for the stencil attachment)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_set_cull_mode = R"doc(Specify the culling mode associated with the render pass)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_set_depth_test = R"doc(Specify the depth test and depth write mask of this render pass)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_set_viewport = R"doc(Set the pixel offset and size of the viewport region)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_targets =
|
|
R"doc(Return the set of all render targets (including depth + stencil)
|
|
associated with this render pass)doc";
|
|
|
|
static const char *__doc_nanogui_RenderPass_viewport = R"doc(Return the pixel offset and size of the viewport region)doc";
|
|
|
|
static const char *__doc_nanogui_Screen = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_2 =
|
|
R"doc(\class Screen screen.h nanogui/screen.h
|
|
|
|
Represents a display surface (i.e. a full-screen or windowed GLFW
|
|
window) and forms the root element of a hierarchy of nanogui widgets.)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_Screen =
|
|
R"doc(Create a new Screen instance
|
|
|
|
Parameter ``size``:
|
|
Size in pixels at 96 dpi (on high-DPI screens, the actual
|
|
resolution in terms of hardware pixels may be larger by an integer
|
|
factor)
|
|
|
|
Parameter ``caption``:
|
|
Window title (in UTF-8 encoding)
|
|
|
|
Parameter ``resizable``:
|
|
If creating a window, should it be resizable?
|
|
|
|
Parameter ``fullscreen``:
|
|
Specifies whether to create a windowed or full-screen view
|
|
|
|
Parameter ``stencil_buffer``:
|
|
Should an 8-bit stencil buffer be allocated? NanoVG requires this
|
|
to rasterize non-convex polygons. (NanoGUI does not render such
|
|
polygons, but your application might.)
|
|
|
|
Parameter ``float_buffer``:
|
|
Should NanoGUI try to allocate a floating point framebuffer? This
|
|
is useful for HDR and wide-gamut displays.
|
|
|
|
Parameter ``gl_major``:
|
|
The requested OpenGL Major version number. The default is 3, if
|
|
changed the value must correspond to a forward compatible core
|
|
profile (for portability reasons). For example, set this to 4 and
|
|
gl_minor to 1 for a forward compatible core OpenGL 4.1 profile.
|
|
Requesting an invalid profile will result in no context (and
|
|
therefore no GUI) being created. This attribute is ignored when
|
|
targeting OpenGL ES 2 or Metal.
|
|
|
|
Parameter ``gl_minor``:
|
|
The requested OpenGL Minor version number. The default is 2, if
|
|
changed the value must correspond to a forward compatible core
|
|
profile (for portability reasons). For example, set this to 1 and
|
|
gl_major to 4 for a forward compatible core OpenGL 4.1 profile.
|
|
Requesting an invalid profile will result in no context (and
|
|
therefore no GUI) being created. This attribute is ignored when
|
|
targeting OpenGL ES 2 or Metal.)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_Screen_2 =
|
|
R"doc(Default constructor
|
|
|
|
Performs no initialization at all. Use this if the application is
|
|
responsible for setting up GLFW, OpenGL, etc.
|
|
|
|
In this case, override Screen and call initalize() with a pointer to
|
|
an existing ``GLFWwindow`` instance
|
|
|
|
You will also be responsible in this case to deliver GLFW callbacks to
|
|
the appropriate callback event handlers below)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_background = R"doc(Return the screen's background color)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_caption = R"doc(Get the window title bar caption)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_center_window = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_char_callback_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_clear =
|
|
R"doc(Clear the screen with the background color (glClearColor, glClear,
|
|
etc.)
|
|
|
|
You typically won't need to call this function yourself, as it is
|
|
called by the default implementation of draw_contents() (which is
|
|
called by draw_all()))doc";
|
|
|
|
static const char *__doc_nanogui_Screen_component_format = R"doc(Return the component format underlying the screen)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_cursor_pos_callback_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_dispose_window = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_draw_all =
|
|
R"doc(Redraw the screen if the redraw flag is set
|
|
|
|
This function does everything -- it calls draw_setup(),
|
|
draw_contents() (which also clears the screen by default), draw(), and
|
|
finally draw_teardown().
|
|
|
|
See also:
|
|
redraw)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_draw_contents =
|
|
R"doc(Calls clear() and draws the window contents --- put your rendering
|
|
code here.)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_draw_setup =
|
|
R"doc(Prepare the graphics pipeline for the next frame
|
|
|
|
This involves steps such as obtaining a drawable, querying the
|
|
drawable resolution, setting the viewport used for drawing, etc..
|
|
|
|
You typically won't need to call this function yourself, as it is
|
|
called by draw_all(), which is executed by the run loop.)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_draw_teardown =
|
|
R"doc(Wrap up drawing of the current frame
|
|
|
|
This involves steps such as releasing the current drawable, swapping
|
|
the framebuffer, etc.
|
|
|
|
You typically won't need to call this function yourself, as it is
|
|
called by draw_all(), which is executed by the run loop.)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_draw_widgets = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_drop_callback_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_drop_event = R"doc(Handle a file drop event)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_framebuffer_size =
|
|
R"doc(Return the framebuffer size (potentially larger than size() on high-
|
|
DPI screens))doc";
|
|
|
|
static const char *__doc_nanogui_Screen_glfw_window = R"doc(Return a pointer to the underlying GLFW window data structure)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_has_depth_buffer = R"doc(Does the framebuffer have a depth buffer)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_has_float_buffer = R"doc(Does the framebuffer use a floating point representation)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_has_stencil_buffer = R"doc(Does the framebuffer have a stencil buffer)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_initialize = R"doc(Initialize the Screen)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_key_callback_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_keyboard_character_event = R"doc(Text input event handler: codepoint is native endian UTF-32 format)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_keyboard_event = R"doc(Default keyboard event handler)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_background = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_caption = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_cursor = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_cursors = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_depth_buffer = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_drag_active = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_drag_widget = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_fbsize = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_float_buffer = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_focus_path = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_fullscreen = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_glfw_window = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_last_interaction = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_modifiers = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_mouse_pos = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_mouse_state = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_nvg_context = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_pixel_ratio = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_process_events = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_redraw = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_resize_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_shutdown_glfw = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_m_stencil_buffer = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_mouse_button_callback_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_mouse_pos = R"doc(Return the last observed mouse position value)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_move_window_to_front = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_nvg_context = R"doc(Return a pointer to the underlying NanoVG draw context)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_nvg_flush = R"doc(Flush all queued up NanoVG rendering commands)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_perform_layout = R"doc(Compute the layout of all widgets)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_pixel_format = R"doc(Return the pixel format underlying the screen)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_pixel_ratio =
|
|
R"doc(Return the ratio between pixel and device coordinates (e.g. >= 2 on
|
|
Mac Retina displays))doc";
|
|
|
|
static const char *__doc_nanogui_Screen_redraw =
|
|
R"doc(Send an event that will cause the screen to be redrawn at the next
|
|
event loop iteration)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_resize_callback = R"doc(Set the resize callback)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_resize_callback_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_resize_event = R"doc(Window resize event handler)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_scroll_callback_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_set_background = R"doc(Set the screen's background color)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_set_caption = R"doc(Set the window title bar caption)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_set_resize_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_set_shutdown_glfw = R"doc(Shut down GLFW when the window is closed?)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_set_size = R"doc(Set window size)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_set_visible = R"doc(Set the top-level window visibility (no effect on full-screen windows))doc";
|
|
|
|
static const char *__doc_nanogui_Screen_shutdown_glfw = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Screen_tooltip_fade_in_progress = R"doc(Is a tooltip currently fading in?)doc";
|
|
|
|
static const char *__doc_nanogui_Screen_update_focus = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Serializer = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_BlendMode = R"doc(Alpha blending mode)doc";
|
|
|
|
static const char *__doc_nanogui_Shader_BlendMode_AlphaBlend = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_BlendMode_None = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_Buffer = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_BufferType = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_BufferType_FragmentBuffer = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_BufferType_FragmentSampler = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_BufferType_FragmentTexture = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_BufferType_IndexBuffer = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_BufferType_UniformBuffer = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_BufferType_Unknown = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_BufferType_VertexBuffer = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_BufferType_VertexSampler = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_BufferType_VertexTexture = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_Buffer_buffer = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_Buffer_dirty = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_Buffer_dtype = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_Buffer_index = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_Buffer_ndim = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_Buffer_shape = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_Buffer_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_Buffer_to_string = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_Buffer_type = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_PrimitiveType = R"doc(The type of geometry that should be rendered)doc";
|
|
|
|
static const char *__doc_nanogui_Shader_PrimitiveType_Line = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_PrimitiveType_LineStrip = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_PrimitiveType_Point = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_PrimitiveType_Triangle = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_PrimitiveType_TriangleStrip = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_Shader =
|
|
R"doc(Initialize the shader using the specified source strings.
|
|
|
|
Parameter ``render_pass``:
|
|
RenderPass object encoding targets to which color, depth, and
|
|
stencil information will be rendered.
|
|
|
|
Parameter ``name``:
|
|
A name identifying this shader
|
|
|
|
Parameter ``vertex_shader``:
|
|
The source of the vertex shader as a string.
|
|
|
|
Parameter ``fragment_shader``:
|
|
The source of the fragment shader as a string.)doc";
|
|
|
|
static const char *__doc_nanogui_Shader_begin =
|
|
R"doc(Begin drawing using this shader
|
|
|
|
Note that any updates to 'uniform' and 'varying' shader parameters
|
|
*must* occur prior to this method call.
|
|
|
|
The Python bindings also include extra ``__enter__`` and ``__exit__``
|
|
aliases so that the shader can be activated via Pythons 'with'
|
|
statement.)doc";
|
|
|
|
static const char *__doc_nanogui_Shader_blend_mode = R"doc(Return the blending mode of this shader)doc";
|
|
|
|
static const char *__doc_nanogui_Shader_draw_array =
|
|
R"doc(Render geometry arrays, either directly or using an index array.
|
|
|
|
Parameter ``primitive_type``:
|
|
What type of geometry should be rendered?
|
|
|
|
Parameter ``offset``:
|
|
First index to render. Must be a multiple of 2 or 3 for lines and
|
|
triangles, respectively (unless specified using strips).
|
|
|
|
Parameter ``offset``:
|
|
Number of indices to render. Must be a multiple of 2 or 3 for
|
|
lines and triangles, respectively (unless specified using strips).
|
|
|
|
Parameter ``indexed``:
|
|
Render indexed geometry? In this case, an ``uint32_t`` valued
|
|
buffer with name ``indices`` must have been uploaded using set().)doc";
|
|
|
|
static const char *__doc_nanogui_Shader_end = R"doc(End drawing using this shader)doc";
|
|
|
|
static const char *__doc_nanogui_Shader_m_blend_mode = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_m_buffers = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_m_name = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_m_render_pass = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_m_shader_handle = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_m_uses_point_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_m_vertex_array_handle = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_name = R"doc(Return the name of this shader)doc";
|
|
|
|
static const char *__doc_nanogui_Shader_render_pass = R"doc(Return the render pass associated with this shader)doc";
|
|
|
|
static const char *__doc_nanogui_Shader_set_buffer =
|
|
R"doc(Upload a buffer (e.g. vertex positions) that will be associated with a
|
|
named shader parameter.
|
|
|
|
Note that this function should be used both for 'varying' and
|
|
'uniform' data---the implementation takes care of routing the data to
|
|
the right endpoint. Matrices should be specified in column-major
|
|
order.
|
|
|
|
The buffer will be replaced if it is already present.)doc";
|
|
|
|
static const char *__doc_nanogui_Shader_set_buffer_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_set_texture =
|
|
R"doc(Associate a texture with a named shader parameter
|
|
|
|
The association will be replaced if it is already present.)doc";
|
|
|
|
static const char *__doc_nanogui_Shader_set_uniform =
|
|
R"doc(Upload a uniform variable (e.g. a vector or matrix) that will be
|
|
associated with a named shader parameter.)doc";
|
|
|
|
static const char *__doc_nanogui_Shader_shader_handle = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Shader_vertex_array_handle = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_2 =
|
|
R"doc(\class Slider slider.h nanogui/slider.h
|
|
|
|
Fractional slider widget with mouse control.)doc";
|
|
|
|
static const char *__doc_nanogui_Slider_Slider = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_draw = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_final_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_highlight_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_highlighted_range = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_m_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_m_final_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_m_highlight_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_m_highlighted_range = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_m_range = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_m_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_mouse_button_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_mouse_drag_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_preferred_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_range = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_set_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_set_final_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_set_highlight_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_set_highlighted_range = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_set_range = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_set_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Slider_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidget = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidget_2 =
|
|
R"doc(\class TabWidget tabwidget.h nanogui/tabwidget.h
|
|
|
|
A wrapper around the widgets TabHeader and StackedWidget which hooks
|
|
the two classes together.
|
|
|
|
\rst
|
|
|
|
.. warning::
|
|
|
|
Unlike other widgets, children may **not** be added *directly* to a
|
|
TabWidget. For example, the following code will raise an exception:
|
|
|
|
.. code-block:: cpp
|
|
|
|
// `this` might be say a nanogui::Screen instance Window *window = new
|
|
Window(this, "Window Title"); TabWidget *tab_widget =
|
|
window->add<TabWidget>(); // this label would be a direct child of
|
|
tabWidget, // which is forbidden, so an exception will be raised new
|
|
Label(tab_widget, "Some Label");
|
|
|
|
Instead, you are expected to be creating tabs and adding widgets to
|
|
those.
|
|
|
|
.. code-block:: cpp
|
|
|
|
// `this` might e.g. be a nanogui::Screen instance Window *window =
|
|
new Window(this, "Window Title"); TabWidget *tab_widget =
|
|
window->add<TabWidget>(); // Create a tab first Widget *tab = new
|
|
Widget(tab_widget); int tab_id = tab_widget->append_tab("Tab Name",
|
|
tab); // Add children to the created tabs tab->set_layout(new
|
|
GroupLayout()); new Label(tab, "Some Label");
|
|
|
|
A slightly more involved example of creating a TabWidget can also be
|
|
found in :ref:`nanogui_example_1` (search for ``tab_widget`` in the
|
|
file).
|
|
|
|
\endrst)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_2 =
|
|
R"doc(\class TabWidgetBase tabwidget.h nanogui/tabwidget.h
|
|
|
|
Basic implementation of a tab widget with (optionally) draggable and
|
|
closeable tabs and popup menus. No rendering of the content is done---
|
|
for an example implementation, refer to TabWidget.)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_TabWidgetBase = R"doc(Construct a new tab widget)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_append_tab = R"doc(Appends a new tab and returns its ID.)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_background_color = R"doc(Return the widget's background color (a global property))doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_callback =
|
|
R"doc(Callback that is used to notify a listener about tab changes (will be
|
|
called with the tab ID))doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_close_callback =
|
|
R"doc(Callback that is used to notify a listener about tab close events
|
|
(will be called with the tab ID))doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_draw = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_insert_tab = R"doc(Inserts a new tab at the specified position and returns its ID.)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_active_tab = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_background_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_close_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_close_index = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_close_index_pushed = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_close_width = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_font = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_padding = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_popup = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_popup_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_tab_captions = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_tab_counter = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_tab_drag_end = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_tab_drag_index = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_tab_drag_max = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_tab_drag_min = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_tab_drag_start = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_tab_ids = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_tab_offsets = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_tabs_closeable = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_m_tabs_draggable = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_mouse_button_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_mouse_enter_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_mouse_motion_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_padding = R"doc(Return the padding between the tab widget boundary and child widgets)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_perform_layout = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_popup_callback =
|
|
R"doc(Callback that is used to notify a listener about popup events (will be
|
|
called with the tab ID))doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_preferred_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_remove_tab = R"doc(Removes a tab with the specified ID)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_selected_id = R"doc(Return the ID of the currently active tab)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_selected_index = R"doc(Return the index of the currently active tab)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_set_background_color = R"doc(Set the widget's background color (a global property))doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_set_callback =
|
|
R"doc(Set a callback that is used to notify a listener about tab changes
|
|
(will be called with the tab ID))doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_set_close_callback =
|
|
R"doc(Set a callback that is used to notify a listener about tab close
|
|
events (will be called with the tab ID))doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_set_padding = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_set_popup_callback =
|
|
R"doc(Set a callback that is used to notify a listener about popup events
|
|
(will be called with the tab ID))doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_set_selected_id = R"doc(Set the ID of the currently active tab)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_set_selected_index = R"doc(Set the index of the currently active tab)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_set_tab_caption = R"doc(Change the caption of the tab with the given ID)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_set_tabs_closeable = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_set_tabs_draggable = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_tab_at_position = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_tab_caption = R"doc(Return the caption of the tab with the given ID)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_tab_count = R"doc(Return the total number of tabs)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_tab_id = R"doc(Return the ID of the tab at a given index)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_tab_index = R"doc(Return the index of the tab with a given ID (or throw an exception))doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_tabs_closeable = R"doc(Return whether tabs provide a close button)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_tabs_draggable = R"doc(Return whether tabs can be dragged to different positions)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidgetBase_update_visibility = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidget_TabWidget = R"doc(Construct a new tab widget)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidget_append_tab = R"doc(Appends a new tab and returns its ID.)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidget_insert_tab = R"doc(Inserts a new tab at the specified position and returns its ID.)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidget_m_remove_children = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidget_m_widgets = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidget_perform_layout = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidget_preferred_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TabWidget_remove_children = R"doc(Remove child widgets when the associated tab is closed/removed?)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidget_remove_tab = R"doc(Removes a tab with the specified ID)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidget_set_remove_children = R"doc(Remove child widgets when the associated tab is closed/removed?)doc";
|
|
|
|
static const char *__doc_nanogui_TabWidget_update_visibility = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_2 =
|
|
R"doc(\class TextBox textarea.h nanogui/textarea.h
|
|
|
|
Multi-line read-only text widget, ideal for displaying log messages
|
|
etc.
|
|
|
|
Appended text can use different colors, but the font size is fixed for
|
|
the entire widget.)doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_Block = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_Block_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_Block_offset = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_Block_text = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_Block_width = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_TextArea = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_append = R"doc(Append text at the end of the widget)doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_append_line = R"doc(Append a line of text at the bottom)doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_background_color = R"doc(Return the widget's background color (a global property))doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_block_to_position = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_clear = R"doc(Clear all current contents)doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_draw = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_font = R"doc(Return the used font)doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_foreground_color = R"doc(Return the foreground color (applies to all subsequently added text))doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_is_selectable = R"doc(Return whether the text can be selected using the mouse)doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_keyboard_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_m_background_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_m_blocks = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_m_font = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_m_foreground_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_m_max_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_m_offset = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_m_padding = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_m_selectable = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_m_selection_color = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_m_selection_end = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_m_selection_start = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_mouse_button_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_mouse_drag_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_padding = R"doc(Return the amount of padding that is added around the text)doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_position_to_block = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_preferred_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_selection_color = R"doc(Return the widget's selection color (a global property))doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_set_background_color = R"doc(Set the widget's background color (a global property))doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_set_font = R"doc(Set the used font)doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_set_foreground_color = R"doc(Set the foreground color (applies to all subsequently added text))doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_set_padding = R"doc(Set the amount of padding to add around the text)doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_set_selectable = R"doc(Set whether the text can be selected using the mouse)doc";
|
|
|
|
static const char *__doc_nanogui_TextArea_set_selection_color = R"doc(Set the widget's selection color (a global property))doc";
|
|
|
|
static const char *__doc_nanogui_TextBox = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_2 =
|
|
R"doc(\class TextBox textbox.h nanogui/textbox.h
|
|
|
|
Fancy text box with builtin regular expression-based validation.
|
|
|
|
Remark:
|
|
This class overrides nanogui::Widget::mIconExtraScale to be
|
|
``0.8f``, which affects all subclasses of this Widget. Subclasses
|
|
must explicitly set a different value if needed (e.g., in their
|
|
constructor).)doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_Alignment = R"doc(How to align the text in the text box.)doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_Alignment_Center = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_Alignment_Left = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_Alignment_Right = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_SpinArea = R"doc(The location (if any) for the spin area.)doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_SpinArea_Bottom = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_SpinArea_None = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_SpinArea_Top = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_TextBox = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_alignment = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_callback = R"doc(The callback to execute when the value of this TextBox has changed.)doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_check_format = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_copy_selection = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_cursor_index_to_position = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_default_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_delete_selection = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_draw = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_editable = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_focus_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_format = R"doc(Return the underlying regular expression specifying valid formats)doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_keyboard_character_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_keyboard_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_alignment = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_callback = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_committed = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_cursor_pos = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_default_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_editable = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_format = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_last_click = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_mouse_down_modifier = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_mouse_down_pos = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_mouse_drag_pos = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_mouse_pos = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_placeholder = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_selection_pos = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_spinnable = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_text_offset = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_units = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_units_image = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_valid_format = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_m_value_temp = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_mouse_button_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_mouse_drag_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_mouse_enter_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_mouse_motion_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_paste_from_clipboard = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_placeholder =
|
|
R"doc(Return the placeholder text to be displayed while the text box is
|
|
empty.)doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_position_to_cursor_index = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_preferred_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_set_alignment = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_set_callback =
|
|
R"doc(Sets the callback to execute when the value of this TextBox has
|
|
changed.)doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_set_default_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_set_editable = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_set_format = R"doc(Specify a regular expression specifying valid formats)doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_set_placeholder =
|
|
R"doc(Specify a placeholder text to be displayed while the text box is
|
|
empty.)doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_set_spinnable = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_set_theme = R"doc(Set the Theme used to draw this widget)doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_set_units = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_set_units_image = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_set_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_spin_area = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_spinnable = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_units = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_units_image = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_update_cursor = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_TextBox_value = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_3 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_ComponentFormat = R"doc(Number format of pixel components)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_ComponentFormat_Float16 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_ComponentFormat_Float32 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_ComponentFormat_Int16 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_ComponentFormat_Int32 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_ComponentFormat_Int8 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_ComponentFormat_UInt16 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_ComponentFormat_UInt32 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_ComponentFormat_UInt8 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_InterpolationMode = R"doc(Texture interpolation mode)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_InterpolationMode_Bilinear = R"doc(Bilinear ineterpolation)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_InterpolationMode_Nearest = R"doc(Nearest neighbor interpolation)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_InterpolationMode_Trilinear = R"doc(Trilinear interpolation (using MIP mapping))doc";
|
|
|
|
static const char *__doc_nanogui_Texture_PixelFormat = R"doc(Overall format of the texture (e.g. luminance-only or RGBA))doc";
|
|
|
|
static const char *__doc_nanogui_Texture_PixelFormat_BGR = R"doc(BGR bitmap)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_PixelFormat_BGRA = R"doc(BGR bitmap + alpha channel)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_PixelFormat_Depth = R"doc(Depth map)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_PixelFormat_DepthStencil = R"doc(Combined depth + stencil map)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_PixelFormat_R = R"doc(Single-channel bitmap)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_PixelFormat_RA = R"doc(Two-channel bitmap)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_PixelFormat_RGB = R"doc(RGB bitmap)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_PixelFormat_RGBA = R"doc(RGB bitmap + alpha channel)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_Texture =
|
|
R"doc(Allocate memory for a texture with the given configuration
|
|
|
|
\note Certain combinations of pixel and component formats may not be
|
|
natively supported by the hardware. In this case, init() chooses a
|
|
similar supported configuration that can subsequently be queried using
|
|
pixel_format() and component_format(). Some caution must be exercised
|
|
in this case, since upload() will need to provide the data in a
|
|
different storage format.)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_Texture_2 = R"doc(Load an image from the given file using stb-image)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_TextureFlags = R"doc(How will the texture be used? (Must specify at least one))doc";
|
|
|
|
static const char *__doc_nanogui_Texture_TextureFlags_RenderTarget = R"doc(Target framebuffer for rendering)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_TextureFlags_ShaderRead = R"doc(Texture to be read in shaders)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_WrapMode = R"doc(How should out-of-bounds texture evaluations be handled?)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_WrapMode_ClampToEdge = R"doc(Clamp evaluations to the edge of the texture)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_WrapMode_MirrorRepeat = R"doc(Repeat, but flip the texture after crossing the boundary)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_WrapMode_Repeat = R"doc(Repeat the texture)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_bytes_per_pixel = R"doc(Return the number of bytes consumed per pixel of this texture)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_channels = R"doc(Return the number of channels of this texture)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_component_format = R"doc(Return the component format)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_download = R"doc(Download packed pixel data from the GPU to the CPU)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_flags = R"doc(Return a combination of flags (from Texture::TextureFlags))doc";
|
|
|
|
static const char *__doc_nanogui_Texture_init = R"doc(Initialize the texture handle)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_m_component_format = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_m_flags = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_m_mag_interpolation_mode = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_m_min_interpolation_mode = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_m_pixel_format = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_m_renderbuffer_handle = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_m_samples = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_m_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_m_texture_handle = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_m_wrap_mode = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_mag_interpolation_mode = R"doc(Return the interpolation mode for minimization)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_min_interpolation_mode = R"doc(Return the interpolation mode for minimization)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_pixel_format = R"doc(Return the pixel format)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_renderbuffer_handle = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_resize = R"doc(Resize the texture (discards the current contents))doc";
|
|
|
|
static const char *__doc_nanogui_Texture_samples = R"doc(Return the number of samples (MSAA))doc";
|
|
|
|
static const char *__doc_nanogui_Texture_size = R"doc(Return the size of this texture)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_texture_handle = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Texture_upload = R"doc(Upload packed pixel data from the CPU to the GPU)doc";
|
|
|
|
static const char *__doc_nanogui_Texture_wrap_mode = R"doc(Return the wrap mode)doc";
|
|
|
|
static const char *__doc_nanogui_Theme = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Theme_2 =
|
|
R"doc(\class Theme theme.h nanogui/theme.h
|
|
|
|
Storage class for basic theme-related properties.)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_Theme = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_border_dark =
|
|
R"doc(The dark border color (default: intensity=``29``, alpha=``255``; see
|
|
nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_border_light =
|
|
R"doc(The light border color (default: intensity=``92``, alpha=``255``; see
|
|
nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_border_medium =
|
|
R"doc(The medium border color (default: intensity=``35``, alpha=``255``; see
|
|
nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_button_corner_radius =
|
|
R"doc(Rounding radius for Button (and derived types) widgets (default:
|
|
``2``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_button_font_size = R"doc(The font size for buttons (default: ``20``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_button_gradient_bot_focused =
|
|
R"doc(The bottom gradient color for buttons in focus (default:
|
|
intensity=``48``, alpha=``255``; see nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_button_gradient_bot_pushed =
|
|
R"doc(The bottom gradient color for buttons currently pushed (default:
|
|
intensity=``29``, alpha=``255``; see nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_button_gradient_bot_unfocused =
|
|
R"doc(The bottom gradient color for buttons not in focus (default:
|
|
intensity=``58``, alpha=``255``; see nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_button_gradient_top_focused =
|
|
R"doc(The top gradient color for buttons in focus (default:
|
|
intensity=``64``, alpha=``255``; see nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_button_gradient_top_pushed =
|
|
R"doc(The top gradient color for buttons currently pushed (default:
|
|
intensity=``41``, alpha=``255``; see nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_button_gradient_top_unfocused =
|
|
R"doc(The top gradient color for buttons not in focus (default:
|
|
intensity=``74``, alpha=``255``; see nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_check_box_icon = R"doc(Icon to use for check box widgets (default: ``FA_CHECK``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_disabled_text_color =
|
|
R"doc(The disable dtext color (default: intensity=``255``, alpha=``80``; see
|
|
nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_drop_shadow =
|
|
R"doc(The color of the drop shadow drawn behind widgets (default:
|
|
intensity=``0``, alpha=``128``; see nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_font_icons =
|
|
R"doc(The icon font face (default: ``"icons"`` from
|
|
``resources/entypo.ttf``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_font_mono_regular =
|
|
R"doc(The monospace font face (default: ``"mono"`` from
|
|
``resources/inconsolata_regular.ttf``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_font_sans_bold =
|
|
R"doc(The bold font face (default: ``"sans-bold"`` from
|
|
``resources/roboto_regular.ttf``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_font_sans_regular =
|
|
R"doc(The standard font face (default: ``"sans"`` from
|
|
``resources/roboto_regular.ttf``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_icon_color = R"doc(The icon color (default: nanogui::Theme::m_text_color).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_icon_scale =
|
|
R"doc(The amount of scaling that is applied to each icon to fit the size of
|
|
NanoGUI widgets. The default value is ``0.77f``, setting to e.g.
|
|
higher than ``1.0f`` is generally discouraged.)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_message_alt_button_icon =
|
|
R"doc(Icon to use on message dialog alt button (default:
|
|
``FA_CIRCLE_WITH_CROSS``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_message_information_icon =
|
|
R"doc(Icon to use for informational message dialog widgets (default:
|
|
``FA_INFO_CIRCLE``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_message_primary_button_icon = R"doc(Icon to use on message_dialog primary button (default: ``FA_CHECK``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_message_question_icon =
|
|
R"doc(Icon to use for interrogative message dialog widgets (default:
|
|
``FA_QUESTION_CIRCLE``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_message_warning_icon =
|
|
R"doc(Icon to use for warning message dialog widgets (default:
|
|
``FA_EXCLAMATION_TRINAGLE``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_popup_chevron_left_icon =
|
|
R"doc(Icon to use for Popup_button widgets opening to the left (default:
|
|
``FA_CHEVRON_LEFT``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_popup_chevron_right_icon =
|
|
R"doc(Icon to use for Popup_button widgets opening to the right (default:
|
|
``FA_CHEVRON_RIGHT``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_standard_font_size =
|
|
R"doc(The font size for all widgets other than buttons and textboxes
|
|
(default: `` 16``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_tab_border_width = R"doc(The border width for Tab_header widgets (default: ``0.75f``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_tab_button_horizontal_padding =
|
|
R"doc(The amount of horizontal padding for a Tab_header widget (default:
|
|
``10``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_tab_button_vertical_padding =
|
|
R"doc(The amount of vertical padding for a Tab_header widget (default:
|
|
``2``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_tab_control_width =
|
|
R"doc(Used to help specify what lies "in bound" for a Tab_header widget
|
|
(default: ``20``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_tab_inner_margin = R"doc(The inner margin on a Tab_header widget (default: ``5``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_tab_max_button_width =
|
|
R"doc(The maximum size for buttons on a Tab_header widget (default:
|
|
``160``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_tab_min_button_width = R"doc(The minimum size for buttons on a Tab_header widget (default: ``20``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_text_box_down_icon =
|
|
R"doc(Icon to use when a text box has a down toggle (e.g. IntBox) (default:
|
|
``FA_CHEVRON_DOWN``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_text_box_font_size = R"doc(The font size for text boxes (default: ``20``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_text_box_up_icon =
|
|
R"doc(Icon to use when a text box has an up toggle (e.g. IntBox) (default:
|
|
``FA_CHEVRON_UP``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_text_color =
|
|
R"doc(The text color (default: intensity=``255``, alpha=``160``; see
|
|
nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_text_color_shadow =
|
|
R"doc(The text shadow color (default: intensity=``0``, alpha=``160``; see
|
|
nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_transparent =
|
|
R"doc(The transparency color (default: intensity=``0``, alpha=``0``; see
|
|
nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_window_corner_radius = R"doc(Rounding radius for Window widget corners (default: ``2``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_window_drop_shadow_size =
|
|
R"doc(Size of drop shadow rendered behind the Window widgets (default:
|
|
``10``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_window_fill_focused =
|
|
R"doc(The fill color for a Window that is in focus (default:
|
|
intensity=``45``, alpha=``230``; see nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_window_fill_unfocused =
|
|
R"doc(The fill color for a Window that is not in focus (default:
|
|
intensity=``43``, alpha=``230``; see nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_window_header_gradient_bot =
|
|
R"doc(The bottom gradient color for Window headings (default:
|
|
nanogui::Theme::m_button_gradient_bot_unfocused).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_window_header_gradient_top =
|
|
R"doc(The top gradient color for Window headings (default:
|
|
nanogui::Theme::m_button_gradient_top_unfocused).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_window_header_height = R"doc(Default size of Window widget titles (default: ``30``).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_window_header_sep_bot =
|
|
R"doc(The Window header bottom separation color (default:
|
|
nanogui::Theme::m_border_dark).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_window_header_sep_top =
|
|
R"doc(The Window header top separation color (default:
|
|
nanogui::Theme::m_border_light).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_window_popup =
|
|
R"doc(The popup window color (default: intensity=``50``, alpha=``255``; see
|
|
nanogui::Color::Color(int,int))).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_window_popup_transparent =
|
|
R"doc(The transparent popup window color (default: intensity=``50``,
|
|
alpha=``0``; see nanogui::Color::Color(int,int))).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_window_title_focused =
|
|
R"doc(The title color for a Window that is in focus (default:
|
|
intensity=``255``, alpha=``190``; see nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_Theme_m_window_title_unfocused =
|
|
R"doc(The title color for a Window that is not in focus (default:
|
|
intensity=``220``, alpha=``160``; see nanogui::Color::Color(int,int)).)doc";
|
|
|
|
static const char *__doc_nanogui_ToolButton = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ToolButton_2 =
|
|
R"doc(\class ToolButton toolbutton.h nanogui/toolbutton.h
|
|
|
|
Simple radio+toggle button with an icon.)doc";
|
|
|
|
static const char *__doc_nanogui_ToolButton_ToolButton = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VScrollPanel = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VScrollPanel_2 =
|
|
R"doc(\class VScrollPanel vscrollpanel.h nanogui/vscrollpanel.h
|
|
|
|
Adds a vertical scrollbar around a widget that is too big to fit into
|
|
a certain area.)doc";
|
|
|
|
static const char *__doc_nanogui_VScrollPanel_VScrollPanel = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VScrollPanel_draw = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VScrollPanel_m_child_preferred_height = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VScrollPanel_m_scroll = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VScrollPanel_m_update_layout = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VScrollPanel_mouse_button_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VScrollPanel_mouse_drag_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VScrollPanel_perform_layout = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VScrollPanel_preferred_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VScrollPanel_scroll =
|
|
R"doc(Return the current scroll amount as a value between 0 and 1. 0 means
|
|
scrolled to the top and 1 to the bottom.)doc";
|
|
|
|
static const char *__doc_nanogui_VScrollPanel_scroll_event = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VScrollPanel_set_scroll =
|
|
R"doc(Set the scroll amount to a value between 0 and 1. 0 means scrolled to
|
|
the top and 1 to the bottom.)doc";
|
|
|
|
static const char *__doc_nanogui_VariableType =
|
|
R"doc(Listing of various field types that can be used as variables in
|
|
shaders)doc";
|
|
|
|
static const char *__doc_nanogui_VariableType_Bool = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VariableType_Float16 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VariableType_Float32 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VariableType_Float64 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VariableType_Int16 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VariableType_Int32 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VariableType_Int64 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VariableType_Int8 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VariableType_Invalid = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VariableType_UInt16 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VariableType_UInt32 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VariableType_UInt64 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_VariableType_UInt8 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_2 =
|
|
R"doc(\class Widget widget.h nanogui/widget.h
|
|
|
|
Base class of all widgets.
|
|
|
|
Widget is the base class of all widgets in ``nanogui``. It can also be
|
|
used as an panel to arrange an arbitrary number of child widgets using
|
|
a layout generator (see Layout).)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_Widget = R"doc(Construct a new widget with the given parent widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_absolute_position = R"doc(Return the absolute position on screen)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_add = R"doc(Variadic shorthand notation to construct and add a child widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_add_child =
|
|
R"doc(Add a child widget to the current widget at the specified index.
|
|
|
|
This function almost never needs to be called by hand, since the
|
|
constructor of Widget automatically adds the current widget to its
|
|
parent)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_add_child_2 = R"doc(Convenience function which appends a widget at the end)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_child_at = R"doc(Retrieves the child at the specific position)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_child_at_2 = R"doc(Retrieves the child at the specific position)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_child_count = R"doc(Return the number of child widgets)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_child_index = R"doc(Returns the index of a specific child or -1 if not found)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_children = R"doc(Return the list of child widgets of the current widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_contains = R"doc(Check if the widget contains a certain position)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_cursor = R"doc(Return a pointer to the cursor of the widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_draw = R"doc(Draw the widget (and all child widgets))doc";
|
|
|
|
static const char *__doc_nanogui_Widget_enabled = R"doc(Return whether or not this widget is currently enabled)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_find_widget = R"doc(Determine the widget located at the given position value (recursive))doc";
|
|
|
|
static const char *__doc_nanogui_Widget_find_widget_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_fixed_height = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_fixed_size = R"doc(Return the fixed size (see set_fixed_size()))doc";
|
|
|
|
static const char *__doc_nanogui_Widget_fixed_width = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_focus_event =
|
|
R"doc(Handle a focus change event (default implementation: record the focus
|
|
status, but do nothing))doc";
|
|
|
|
static const char *__doc_nanogui_Widget_focused = R"doc(Return whether or not this widget is currently focused)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_font_size =
|
|
R"doc(Return current font size. If not set the default of the current theme
|
|
will be returned)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_has_font_size = R"doc(Return whether the font size is explicitly specified for this widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_height = R"doc(Return the height of the widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_icon_extra_scale =
|
|
R"doc(The amount of extra scaling applied to *icon* fonts. See
|
|
nanogui::Widget::m_icon_extra_scale.)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_icon_scale =
|
|
R"doc(Convenience definition for subclasses to get the full icon scale for
|
|
this class of Widget. It simple returns the value
|
|
``m_theme->m_icon_scale * this->m_icon_extra_scale``.
|
|
|
|
Remark:
|
|
See also: nanogui::Theme::m_icon_scale and
|
|
nanogui::Widget::m_icon_extra_scale. This tiered scaling strategy
|
|
may not be appropriate with fonts other than ``entypo.ttf``.)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_keyboard_character_event = R"doc(Handle text input (UTF-32 format) (default implementation: do nothing))doc";
|
|
|
|
static const char *__doc_nanogui_Widget_keyboard_event = R"doc(Handle a keyboard event (default implementation: do nothing))doc";
|
|
|
|
static const char *__doc_nanogui_Widget_layout = R"doc(Return the used Layout generator)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_layout_2 = R"doc(Return the used Layout generator)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_m_children = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_m_cursor = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_m_enabled =
|
|
R"doc(Whether or not this Widget is currently enabled. Various different
|
|
kinds of derived types use this to determine whether or not user input
|
|
will be accepted. For example, when ``m_enabled == false``, the state
|
|
of a CheckBox cannot be changed, or a TextBox will not allow new
|
|
input.)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_m_fixed_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_m_focused = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_m_font_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_m_icon_extra_scale =
|
|
R"doc(The amount of extra icon scaling used in addition the the theme's
|
|
default icon font scale. Default value is ``1.0``, which implies that
|
|
nanogui::Widget::icon_scale simply returns the value of
|
|
nanogui::Theme::m_icon_scale.
|
|
|
|
Most widgets do not need extra scaling, but some (e.g., CheckBox,
|
|
TextBox) need to adjust the Theme's default icon scaling
|
|
(nanogui::Theme::m_icon_scale) to properly display icons within their
|
|
bounds (upscale, or downscale).
|
|
|
|
\rst .. note::
|
|
|
|
When using ``nvgFontSize`` for icons in subclasses, make sure to call
|
|
the :func:`nanogui::Widget::icon_scale` function. Expected usage when
|
|
*drawing* icon fonts is something like:
|
|
|
|
.. code-block:: cpp
|
|
|
|
virtual void draw(NVGcontext *ctx) { // fontSize depends on the kind
|
|
of Widget. Search for `FontSize` // in the Theme class (e.g., standard
|
|
vs button) float ih = font_size; // assuming your Widget has a
|
|
declared `mIcon` if (nvgIsFontIcon(mIcon)) { ih *= icon_scale();
|
|
nvgFontFace(ctx, "icons"); nvgFontSize(ctx, ih); /// remaining drawing
|
|
code (see button.cpp for more) } } \endrst)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_m_layout = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_m_mouse_focus = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_m_parent = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_m_pos = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_m_size = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_m_theme = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_m_tooltip = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_m_visible =
|
|
R"doc(Whether or not this Widget is currently visible. When a Widget is not
|
|
currently visible, no time is wasted executing its drawing method.)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_mouse_button_event =
|
|
R"doc(Handle a mouse button event (default implementation: propagate to
|
|
children))doc";
|
|
|
|
static const char *__doc_nanogui_Widget_mouse_drag_event = R"doc(Handle a mouse drag event (default implementation: do nothing))doc";
|
|
|
|
static const char *__doc_nanogui_Widget_mouse_enter_event =
|
|
R"doc(Handle a mouse enter/leave event (default implementation: record this
|
|
fact, but do nothing))doc";
|
|
|
|
static const char *__doc_nanogui_Widget_mouse_motion_event =
|
|
R"doc(Handle a mouse motion event (default implementation: propagate to
|
|
children))doc";
|
|
|
|
static const char *__doc_nanogui_Widget_parent = R"doc(Return the parent widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_parent_2 = R"doc(Return the parent widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_perform_layout =
|
|
R"doc(Invoke the associated layout generator to properly place child
|
|
widgets, if any)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_position = R"doc(Return the position relative to the parent widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_preferred_size = R"doc(Compute the preferred size of the widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_remove_child = R"doc(Remove a child widget by value)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_remove_child_at = R"doc(Remove a child widget by index)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_request_focus = R"doc(Request the focus to be moved to this widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_screen = R"doc(Walk up the hierarchy and return the parent screen)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_screen_2 = R"doc(Walk up the hierarchy and return the parent screen (const version))doc";
|
|
|
|
static const char *__doc_nanogui_Widget_scroll_event =
|
|
R"doc(Handle a mouse scroll event (default implementation: propagate to
|
|
children))doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_cursor = R"doc(Set the cursor of the widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_enabled = R"doc(Set whether or not this widget is currently enabled)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_fixed_height = R"doc(Set the fixed height (see set_fixed_size()))doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_fixed_size =
|
|
R"doc(Set the fixed size of this widget
|
|
|
|
If nonzero, components of the fixed size attribute override any values
|
|
computed by a layout generator associated with this widget. Note that
|
|
just setting the fixed size alone is not enough to actually change its
|
|
size; this is done with a call to set_size or a call to
|
|
perform_layout() in the parent widget.)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_fixed_width = R"doc(Set the fixed width (see set_fixed_size()))doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_focused = R"doc(Set whether or not this widget is currently focused)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_font_size = R"doc(Set the font size of this widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_height = R"doc(Set the height of the widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_icon_extra_scale =
|
|
R"doc(Sets the amount of extra scaling applied to *icon* fonts. See
|
|
nanogui::Widget::m_icon_extra_scale.)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_layout = R"doc(Set the used Layout generator)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_parent = R"doc(Set the parent widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_position = R"doc(Set the position relative to the parent widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_size = R"doc(set the size of the widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_theme = R"doc(Set the Theme used to draw this widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_tooltip = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_visible =
|
|
R"doc(Set whether or not the widget is currently visible (assuming all
|
|
parents are visible))doc";
|
|
|
|
static const char *__doc_nanogui_Widget_set_width = R"doc(Set the width of the widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_size = R"doc(Return the size of the widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_theme = R"doc(Return the Theme used to draw this widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_theme_2 = R"doc(Return the Theme used to draw this widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_tooltip = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Widget_visible =
|
|
R"doc(Return whether or not the widget is currently visible (assuming all
|
|
parents are visible))doc";
|
|
|
|
static const char *__doc_nanogui_Widget_visible_recursive =
|
|
R"doc(Check if this widget is currently visible, taking parent widgets into
|
|
account)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_width = R"doc(Return the width of the widget)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_window = R"doc(Walk up the hierarchy and return the parent window)doc";
|
|
|
|
static const char *__doc_nanogui_Widget_window_2 = R"doc(Walk up the hierarchy and return the parent window (const version))doc";
|
|
|
|
static const char *__doc_nanogui_Window = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Window_2 =
|
|
R"doc(\class Window window.h nanogui/window.h
|
|
|
|
Top-level window widget.)doc";
|
|
|
|
static const char *__doc_nanogui_Window_Window = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Window_button_panel = R"doc(Return the panel used to house window buttons)doc";
|
|
|
|
static const char *__doc_nanogui_Window_center = R"doc(Center the window in the current Screen)doc";
|
|
|
|
static const char *__doc_nanogui_Window_dispose = R"doc(Dispose the window)doc";
|
|
|
|
static const char *__doc_nanogui_Window_draw = R"doc(Draw the window)doc";
|
|
|
|
static const char *__doc_nanogui_Window_m_button_panel = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Window_m_drag = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Window_m_modal = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Window_m_title = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_Window_modal = R"doc(Is this a model dialog?)doc";
|
|
|
|
static const char *__doc_nanogui_Window_mouse_button_event =
|
|
R"doc(Handle mouse events recursively and bring the current window to the
|
|
top)doc";
|
|
|
|
static const char *__doc_nanogui_Window_mouse_drag_event = R"doc(Handle window drag events)doc";
|
|
|
|
static const char *__doc_nanogui_Window_mouse_enter_event = R"doc(Handle mouse enter/leave events)doc";
|
|
|
|
static const char *__doc_nanogui_Window_perform_layout =
|
|
R"doc(Invoke the associated layout generator to properly place child
|
|
widgets, if any)doc";
|
|
|
|
static const char *__doc_nanogui_Window_preferred_size = R"doc(Compute the preferred size of the widget)doc";
|
|
|
|
static const char *__doc_nanogui_Window_refresh_relative_placement =
|
|
R"doc(Internal helper function to maintain nested window position values;
|
|
overridden in Popup)doc";
|
|
|
|
static const char *__doc_nanogui_Window_scroll_event =
|
|
R"doc(Accept scroll events and propagate them to the widget under the mouse
|
|
cursor)doc";
|
|
|
|
static const char *__doc_nanogui_Window_set_modal = R"doc(Set whether or not this is a modal dialog)doc";
|
|
|
|
static const char *__doc_nanogui_Window_set_title = R"doc(Set the window title)doc";
|
|
|
|
static const char *__doc_nanogui_Window_title = R"doc(Return the window title)doc";
|
|
|
|
static const char *__doc_nanogui_active = R"doc(Return whether or not a main loop is currently active)doc";
|
|
|
|
static const char *__doc_nanogui_async =
|
|
R"doc(Enqueue a function to be executed executed before the application is
|
|
redrawn the next time.
|
|
|
|
NanoGUI is not thread-safe, and async() provides a mechanism for
|
|
queuing up UI-related state changes from other threads.)doc";
|
|
|
|
static const char *__doc_nanogui_cross = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_detail_FormWidget =
|
|
R"doc(\class FormWidget formhelper.h nanogui/formhelper.h
|
|
|
|
A template wrapper class for assisting in the creation of various form
|
|
widgets.
|
|
|
|
\rst The partial template specializations are:
|
|
|
|
- Inheritance from :class:`nanogui::ComboBox` for ``enum`` types:
|
|
|
|
.. code-block:: cpp
|
|
|
|
template <typename T> class FormWidget<T, typename
|
|
std::is_enum<T>::type> : public ComboBox
|
|
|
|
- Inheritance from :class:`nanogui::IntBox` for integral types:
|
|
|
|
.. code-block:: cpp
|
|
|
|
template <typename T> class FormWidget<T, typename
|
|
std::is_integral<T>::type> : public IntBox<T>
|
|
|
|
- Inheritance from :class:`nanogui::FloatBox` for floating point
|
|
types:
|
|
|
|
.. code-block:: cpp
|
|
|
|
template <typename T> class FormWidget<T, typename
|
|
std::is_floating_point<T>::type> : public FloatBox<T>
|
|
|
|
The full template specializations are:
|
|
|
|
- Inheritance from :class:`nanogui::CheckBox` for booleans:
|
|
|
|
.. code-block:: cpp
|
|
|
|
template <> class FormWidget<bool, std::true_type> : public CheckBox
|
|
|
|
- Inheritance from :class:`nanogui::TextBox` for strings:
|
|
|
|
.. code-block:: cpp
|
|
|
|
template <> class FormWidget<std::string, std::true_type> : public
|
|
TextBox
|
|
|
|
- Inheritance from :class:`nanogui::ColorPicker` for
|
|
:class:`nanogui::Color` types:
|
|
|
|
.. code-block:: cpp
|
|
|
|
template <> class FormWidget<Color, std::true_type> : public
|
|
ColorPicker
|
|
|
|
Please refer to the bottom of
|
|
:ref:`program_listing_file_nanogui_formhelper.h` for the
|
|
implementation details. \endrst)doc";
|
|
|
|
static const char *__doc_nanogui_detail_FormWidget_2 = R"doc(A specialization for adding a CheckBox to a FormHelper.)doc";
|
|
|
|
static const char *__doc_nanogui_detail_FormWidget_3 = R"doc(A specialization for adding a TextBox to a FormHelper.)doc";
|
|
|
|
static const char *__doc_nanogui_detail_FormWidget_4 = R"doc(A specialization for adding a ColorPicker to a FormHelper.)doc";
|
|
|
|
static const char *__doc_nanogui_detail_FormWidget_FormWidget = R"doc(Creates a new FormWidget with underlying type CheckBox.)doc";
|
|
|
|
static const char *__doc_nanogui_detail_FormWidget_FormWidget_2 = R"doc(Creates a new FormWidget with underlying type TextBox.)doc";
|
|
|
|
static const char *__doc_nanogui_detail_FormWidget_FormWidget_3 = R"doc(Creates a new FormWidget with underlying type ColorPicker.)doc";
|
|
|
|
static const char *__doc_nanogui_detail_FormWidget_set_callback = R"doc(Pass-through function for nanogui::TextBox::set_callback.)doc";
|
|
|
|
static const char *__doc_nanogui_detail_FormWidget_set_editable = R"doc(Pass-through function for nanogui::Widget::set-enabled.)doc";
|
|
|
|
static const char *__doc_nanogui_detail_FormWidget_set_editable_2 = R"doc(Pass-through function for nanogui::Widget::set_enabled.)doc";
|
|
|
|
static const char *__doc_nanogui_detail_FormWidget_set_value = R"doc(Pass-through function for nanogui::CheckBox::set_checked.)doc";
|
|
|
|
static const char *__doc_nanogui_detail_FormWidget_set_value_2 = R"doc(Pass-through function for nanogui::ColorPicker::set_color.)doc";
|
|
|
|
static const char *__doc_nanogui_detail_FormWidget_value = R"doc(Returns the value of nanogui::CheckBox::checked.)doc";
|
|
|
|
static const char *__doc_nanogui_detail_FormWidget_value_2 = R"doc(Returns the value of nanogui::ColorPicker::color.)doc";
|
|
|
|
static const char *__doc_nanogui_detail_detector = R"doc(Detector pattern that is used to drive many type traits below)doc";
|
|
|
|
static const char *__doc_nanogui_dot = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_file_dialog =
|
|
R"doc(Open a native file open/save dialog.
|
|
|
|
Parameter ``filetypes``:
|
|
Pairs of permissible formats with descriptions like ``("png",
|
|
"Portable Network Graphics")``.
|
|
|
|
Parameter ``save``:
|
|
Set to ``True`` if you would like subsequent file dialogs to open
|
|
at whatever folder they were in when they close this one.)doc";
|
|
|
|
static const char *__doc_nanogui_file_dialog_2 =
|
|
R"doc(Open a native file open dialog, which allows multiple selection.
|
|
|
|
Parameter ``filetypes``:
|
|
Pairs of permissible formats with descriptions like ``("png",
|
|
"Portable Network Graphics")``.
|
|
|
|
Parameter ``save``:
|
|
Set to ``True`` if you would like subsequent file dialogs to open
|
|
at whatever folder they were in when they close this one.
|
|
|
|
Parameter ``multiple``:
|
|
Set to ``True`` if you would like to be able to select multiple
|
|
files at once. May not be simultaneously true with \p save.)doc";
|
|
|
|
static const char *__doc_nanogui_get_type = R"doc(Convert from a C++ type to an element of VariableType)doc";
|
|
|
|
static const char *__doc_nanogui_init =
|
|
R"doc(Static initialization; should be called once before invoking **any**
|
|
NanoGUI functions **if** you are having NanoGUI manage OpenGL / GLFW.
|
|
This method is effectively a wrapper call to ``glfwInit()``, so if you
|
|
are managing OpenGL / GLFW on your own *do not call this method*.
|
|
|
|
\rst Refer to :ref:`nanogui_example_3` for how you might go about
|
|
managing OpenGL and GLFW on your own, while still using NanoGUI's
|
|
classes. \endrst)doc";
|
|
|
|
static const char *__doc_nanogui_leave =
|
|
R"doc(Request the application main loop to terminate (e.g. if you detached
|
|
mainloop).)doc";
|
|
|
|
static const char *__doc_nanogui_load_image_directory =
|
|
R"doc(Load a directory of PNG images and upload them to the GPU (suitable
|
|
for use with ImagePanel))doc";
|
|
|
|
static const char *__doc_nanogui_mainloop =
|
|
R"doc(Enter the application main loop
|
|
|
|
Parameter ``refresh``:
|
|
NanoGUI issues a redraw call whenever an keyboard/mouse/.. event
|
|
is received. In the absence of any external events, it enforces a
|
|
redraw once every ``refresh`` milliseconds. To disable the refresh
|
|
timer, specify a negative value here.
|
|
|
|
Parameter ``detach``:
|
|
This parameter only exists in the Python bindings. When the active
|
|
``Screen`` instance is provided via the ``detach`` parameter, the
|
|
``mainloop()`` function becomes non-blocking and returns
|
|
immediately (in this case, the main loop runs in parallel on a
|
|
newly created thread). This feature is convenient for prototyping
|
|
user interfaces on an interactive Python command prompt. When
|
|
``detach != None``, the function returns an opaque handle that
|
|
will release any resources allocated by the created thread when
|
|
the handle's ``join()`` method is invoked (or when it is garbage
|
|
collected).
|
|
|
|
Remark:
|
|
Unfortunately, Mac OS X strictly requires all event processing to
|
|
take place on the application's main thread, which is
|
|
fundamentally incompatible with this type of approach. Thus,
|
|
NanoGUI relies on a rather crazy workaround on Mac OS (kudos to
|
|
Dmitriy Morozov): ``mainloop()`` launches a new thread as before
|
|
but then uses libcoro to swap the thread execution environment
|
|
(stack, registers, ..) with the main thread. This means that the
|
|
main application thread is hijacked and processes events in the
|
|
main loop to satisfy the requirements on Mac OS, while the thread
|
|
that actually returns from this function is the newly created one
|
|
(paradoxical, as that may seem). Deleting or ``join()``ing the
|
|
returned handle causes application to wait for the termination of
|
|
the main loop and then swap the two thread environments back into
|
|
their initial configuration.)doc";
|
|
|
|
static const char *__doc_nanogui_max = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_min = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_nanogui_check_glerror =
|
|
R"doc(Check for OpenGL errors and warn if one is found (returns 'true' in
|
|
that case'))doc";
|
|
|
|
static const char *__doc_nanogui_nanogui_get_image = R"doc(Helper function used by nvg_image_icon)doc";
|
|
|
|
static const char *__doc_nanogui_norm = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_normalize = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_nvg_is_font_icon =
|
|
R"doc(Determine whether an icon ID is a font-based icon (e.g. from
|
|
``entypo.ttf``).
|
|
|
|
\rst See :func:`nanogui::nvg_is_image_icon` for details. \endrst
|
|
|
|
Parameter ``value``:
|
|
The integral value of the icon.
|
|
|
|
Returns:
|
|
Whether or not this is a font icon (from ``entypo.ttf``).)doc";
|
|
|
|
static const char *__doc_nanogui_nvg_is_image_icon =
|
|
R"doc(Determine whether an icon ID is a texture loaded via
|
|
``nvg_image_icon``.
|
|
|
|
\rst The implementation defines all ``value < 1024`` as image icons,
|
|
and everything ``>= 1024`` as an Entypo icon (see
|
|
:ref:`file_nanogui_entypo.h`). The value ``1024`` exists to provide a
|
|
generous buffer on how many images may have been loaded by NanoVG.
|
|
\endrst
|
|
|
|
Parameter ``value``:
|
|
The integral value of the icon.
|
|
|
|
Returns:
|
|
Whether or not this is an image icon.)doc";
|
|
|
|
static const char *__doc_nanogui_operator_const_NVGcolor =
|
|
R"doc(Allows for conversion between nanogui::Color and the NanoVG NVGcolor
|
|
class.)doc";
|
|
|
|
static const char *__doc_nanogui_operator_lshift = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_operator_lshift_2 = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ref = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ref_2 =
|
|
R"doc(\class ref object.h nanogui/object.h
|
|
|
|
Reference counting helper.
|
|
|
|
The *ref* template is a simple wrapper to store a pointer to an
|
|
object. It takes care of increasing and decreasing the object's
|
|
reference count as needed. When the last reference goes out of scope,
|
|
the associated object will be deallocated.
|
|
|
|
The advantage over C++ solutions such as ``std::shared_ptr`` is that
|
|
the reference count is very compactly integrated into the base object
|
|
itself.)doc";
|
|
|
|
static const char *__doc_nanogui_ref_get = R"doc(Return a const pointer to the referenced object)doc";
|
|
|
|
static const char *__doc_nanogui_ref_get_2 = R"doc(Return a pointer to the referenced object)doc";
|
|
|
|
static const char *__doc_nanogui_ref_m_ptr = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_ref_operator_T0 = R"doc(Return a pointer to the referenced object)doc";
|
|
|
|
static const char *__doc_nanogui_ref_operator_assign = R"doc(Move another reference into the current one)doc";
|
|
|
|
static const char *__doc_nanogui_ref_operator_assign_2 = R"doc(Overwrite this reference with another reference)doc";
|
|
|
|
static const char *__doc_nanogui_ref_operator_assign_3 = R"doc(Overwrite this reference with a pointer to another object)doc";
|
|
|
|
static const char *__doc_nanogui_ref_operator_bool = R"doc(Check if the object is defined)doc";
|
|
|
|
static const char *__doc_nanogui_ref_operator_eq = R"doc(Compare this reference with another reference)doc";
|
|
|
|
static const char *__doc_nanogui_ref_operator_eq_2 = R"doc(Compare this reference with a pointer)doc";
|
|
|
|
static const char *__doc_nanogui_ref_operator_mul = R"doc(Return a C++ reference to the referenced object)doc";
|
|
|
|
static const char *__doc_nanogui_ref_operator_mul_2 = R"doc(Return a const C++ reference to the referenced object)doc";
|
|
|
|
static const char *__doc_nanogui_ref_operator_ne = R"doc(Compare this reference with another reference)doc";
|
|
|
|
static const char *__doc_nanogui_ref_operator_ne_2 = R"doc(Compare this reference with a pointer)doc";
|
|
|
|
static const char *__doc_nanogui_ref_operator_sub = R"doc(Access the object referenced by this reference)doc";
|
|
|
|
static const char *__doc_nanogui_ref_operator_sub_2 = R"doc(Access the object referenced by this reference)doc";
|
|
|
|
static const char *__doc_nanogui_ref_ref = R"doc(Create a ``nullptr``-valued reference)doc";
|
|
|
|
static const char *__doc_nanogui_ref_ref_2 = R"doc(Construct a reference from a pointer)doc";
|
|
|
|
static const char *__doc_nanogui_ref_ref_3 = R"doc(Copy constructor)doc";
|
|
|
|
static const char *__doc_nanogui_ref_ref_4 = R"doc(Move constructor)doc";
|
|
|
|
static const char *__doc_nanogui_shutdown = R"doc(Static shutdown; should be called before the application terminates.)doc";
|
|
|
|
static const char *__doc_nanogui_squared_norm = R"doc()doc";
|
|
|
|
static const char *__doc_nanogui_type_name =
|
|
R"doc(Return the name (e.g. "uint8") associated with a specific variable
|
|
type)doc";
|
|
|
|
static const char *__doc_nanogui_type_size = R"doc(Return the size in bytes associated with a specific variable type)doc";
|
|
|
|
static const char *__doc_nanogui_utf8 =
|
|
R"doc(Convert a single UTF32 character code to UTF8.
|
|
|
|
\rst NanoGUI uses this to convert the icon character codes defined in
|
|
:ref:`file_nanogui_entypo.h`. \endrst
|
|
|
|
Parameter ``c``:
|
|
The UTF32 character to be converted.)doc";
|
|
|
|
#if defined(__GNUG__)
|
|
#pragma GCC diagnostic pop
|
|
#endif
|
|
|