ReaImGui Documentation
Generated for ReaImGui v0.8.5
Forum thread
· Source repository
Table of Contents
Most widgets return true when the value has been changed or when pressed/selected.
You may also use one of the many IsItem* functions (e.g. IsItemActive,
IsItemHovered, etc.) to query widget state.
Function: ArrowButton
| C++ | bool ImGui_ArrowButton(ImGui_Context* ctx, const char* str_id, int dir) |
|---|
| EEL | bool ImGui_ArrowButton(ImGui_Context ctx, "str_id", int dir) |
|---|
| Legacy EEL | bool extension_api("ImGui_ArrowButton", ImGui_Context ctx, "str_id", int dir) |
|---|
| Lua | boolean retval = reaper.ImGui_ArrowButton(ImGui_Context ctx, string str_id, number dir) |
|---|
| Python | bool retval = ImGui_ArrowButton(ImGui_Context ctx, str str_id, int dir) |
|---|
Square button with an arrow shape. 'dir' is one of the Dir_* values
View source
Function: Button
| C++ | bool ImGui_Button(ImGui_Context* ctx, const char* label, double* size_wInOptional = 0.0, double* size_hInOptional = 0.0) |
|---|
| EEL | bool ImGui_Button(ImGui_Context ctx, "label", size_w = 0.0, size_h = 0.0) |
|---|
| Legacy EEL | bool extension_api("ImGui_Button", ImGui_Context ctx, "label", size_w = 0.0, size_h = 0.0) |
|---|
| Lua | boolean retval = reaper.ImGui_Button(ImGui_Context ctx, string label, number size_w = 0.0, number size_h = 0.0) |
|---|
| Python | bool retval = ImGui_Button(ImGui_Context ctx, str label, float size_w = 0.0, float size_h = 0.0) |
|---|
View source
Function: Checkbox
| C++ | bool ImGui_Checkbox(ImGui_Context* ctx, const char* label, bool* vInOut) |
|---|
| EEL | bool ImGui_Checkbox(ImGui_Context ctx, "label", bool &v) |
|---|
| Legacy EEL | bool extension_api("ImGui_Checkbox", ImGui_Context ctx, "label", bool &v) |
|---|
| Lua | boolean retval, boolean v = reaper.ImGui_Checkbox(ImGui_Context ctx, string label, boolean v) |
|---|
| Python | (bool retval, bool v) = ImGui_Checkbox(ImGui_Context ctx, str label, bool v) |
|---|
View source
Function: CheckboxFlags
| C++ | bool ImGui_CheckboxFlags(ImGui_Context* ctx, const char* label, int* flagsInOut, int flags_value) |
|---|
| EEL | bool ImGui_CheckboxFlags(ImGui_Context ctx, "label", int &flags, int flags_value) |
|---|
| Legacy EEL | bool extension_api("ImGui_CheckboxFlags", ImGui_Context ctx, "label", int &flags, int flags_value) |
|---|
| Lua | boolean retval, number flags = reaper.ImGui_CheckboxFlags(ImGui_Context ctx, string label, number flags, number flags_value) |
|---|
| Python | (bool retval, int flags) = ImGui_CheckboxFlags(ImGui_Context ctx, str label, int flags, int flags_value) |
|---|
View source
Function: InvisibleButton
| C++ | bool ImGui_InvisibleButton(ImGui_Context* ctx, const char* str_id, double size_w, double size_h, int* flagsInOptional = ButtonFlags_None) |
|---|
| EEL | bool ImGui_InvisibleButton(ImGui_Context ctx, "str_id", size_w, size_h, int flags = ButtonFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_InvisibleButton", ImGui_Context ctx, "str_id", size_w, size_h, int flags = ButtonFlags_None) |
|---|
| Lua | boolean retval = reaper.ImGui_InvisibleButton(ImGui_Context ctx, string str_id, number size_w, number size_h, number flags = ButtonFlags_None) |
|---|
| Python | bool retval = ImGui_InvisibleButton(ImGui_Context ctx, str str_id, float size_w, float size_h, int flags = ButtonFlags_None) |
|---|
Flexible button behavior without the visuals, frequently useful to build
custom behaviors using the public api (along with IsItemActive, IsItemHovered, etc.).
View source
Function: PopButtonRepeat
| C++ | void ImGui_PopButtonRepeat(ImGui_Context* ctx) |
|---|
| EEL | ImGui_PopButtonRepeat(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_PopButtonRepeat", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_PopButtonRepeat(ImGui_Context ctx) |
|---|
| Python | ImGui_PopButtonRepeat(ImGui_Context ctx) |
|---|
See PushButtonRepeat
View source
Function: PushButtonRepeat
| C++ | void ImGui_PushButtonRepeat(ImGui_Context* ctx, bool repeat) |
|---|
| EEL | ImGui_PushButtonRepeat(ImGui_Context ctx, bool repeat) |
|---|
| Legacy EEL | extension_api("ImGui_PushButtonRepeat", ImGui_Context ctx, bool repeat) |
|---|
| Lua | reaper.ImGui_PushButtonRepeat(ImGui_Context ctx, boolean repeat) |
|---|
| Python | ImGui_PushButtonRepeat(ImGui_Context ctx, bool repeat) |
|---|
In 'repeat' mode, Button*() functions return repeated true in a typematic
manner (using ConfigVar_KeyRepeatDelay/ConfigVar_KeyRepeatRate settings).
Note that you can call IsItemActive after any Button to tell if the button is
held in the current frame.
View source
Function: RadioButton
| C++ | bool ImGui_RadioButton(ImGui_Context* ctx, const char* label, bool active) |
|---|
| EEL | bool ImGui_RadioButton(ImGui_Context ctx, "label", bool active) |
|---|
| Legacy EEL | bool extension_api("ImGui_RadioButton", ImGui_Context ctx, "label", bool active) |
|---|
| Lua | boolean retval = reaper.ImGui_RadioButton(ImGui_Context ctx, string label, boolean active) |
|---|
| Python | bool retval = ImGui_RadioButton(ImGui_Context ctx, str label, bool active) |
|---|
Use with e.g. if (RadioButton("one", my_value==1)) { my_value = 1; }
View source
Function: RadioButtonEx
| C++ | bool ImGui_RadioButtonEx(ImGui_Context* ctx, const char* label, int* vInOut, int v_button) |
|---|
| EEL | bool ImGui_RadioButtonEx(ImGui_Context ctx, "label", int &v, int v_button) |
|---|
| Legacy EEL | bool extension_api("ImGui_RadioButtonEx", ImGui_Context ctx, "label", int &v, int v_button) |
|---|
| Lua | boolean retval, number v = reaper.ImGui_RadioButtonEx(ImGui_Context ctx, string label, number v, number v_button) |
|---|
| Python | (bool retval, int v) = ImGui_RadioButtonEx(ImGui_Context ctx, str label, int v, int v_button) |
|---|
Shortcut to handle RadioButton's example pattern when value is an integer
View source
Function: SmallButton
| C++ | bool ImGui_SmallButton(ImGui_Context* ctx, const char* label) |
|---|
| EEL | bool ImGui_SmallButton(ImGui_Context ctx, "label") |
|---|
| Legacy EEL | bool extension_api("ImGui_SmallButton", ImGui_Context ctx, "label") |
|---|
| Lua | boolean retval = reaper.ImGui_SmallButton(ImGui_Context ctx, string label) |
|---|
| Python | bool retval = ImGui_SmallButton(ImGui_Context ctx, str label) |
|---|
Button with StyleVar_FramePadding=(0,0) to easily embed within text.
View source
For ArrowButton.
Constant: Dir_Down
| C++ | int ImGui_Dir_Down |
|---|
| EEL | int ImGui_Dir_Down() |
|---|
| Legacy EEL | int extension_api("ImGui_Dir_Down") |
|---|
| Lua | number retval = reaper.ImGui_Dir_Down() |
|---|
| Python | int retval = ImGui_Dir_Down() |
|---|
View source
Constant: Dir_Left
| C++ | int ImGui_Dir_Left |
|---|
| EEL | int ImGui_Dir_Left() |
|---|
| Legacy EEL | int extension_api("ImGui_Dir_Left") |
|---|
| Lua | number retval = reaper.ImGui_Dir_Left() |
|---|
| Python | int retval = ImGui_Dir_Left() |
|---|
View source
Constant: Dir_None
| C++ | int ImGui_Dir_None |
|---|
| EEL | int ImGui_Dir_None() |
|---|
| Legacy EEL | int extension_api("ImGui_Dir_None") |
|---|
| Lua | number retval = reaper.ImGui_Dir_None() |
|---|
| Python | int retval = ImGui_Dir_None() |
|---|
View source
Constant: Dir_Right
| C++ | int ImGui_Dir_Right |
|---|
| EEL | int ImGui_Dir_Right() |
|---|
| Legacy EEL | int extension_api("ImGui_Dir_Right") |
|---|
| Lua | number retval = reaper.ImGui_Dir_Right() |
|---|
| Python | int retval = ImGui_Dir_Right() |
|---|
View source
Constant: Dir_Up
| C++ | int ImGui_Dir_Up |
|---|
| EEL | int ImGui_Dir_Up() |
|---|
| Legacy EEL | int extension_api("ImGui_Dir_Up") |
|---|
| Lua | number retval = reaper.ImGui_Dir_Up() |
|---|
| Python | int retval = ImGui_Dir_Up() |
|---|
View source
For InvisibleButton.
Constant: ButtonFlags_MouseButtonLeft
| C++ | int ImGui_ButtonFlags_MouseButtonLeft |
|---|
| EEL | int ImGui_ButtonFlags_MouseButtonLeft() |
|---|
| Legacy EEL | int extension_api("ImGui_ButtonFlags_MouseButtonLeft") |
|---|
| Lua | number retval = reaper.ImGui_ButtonFlags_MouseButtonLeft() |
|---|
| Python | int retval = ImGui_ButtonFlags_MouseButtonLeft() |
|---|
React on left mouse button (default).
View source
Constant: ButtonFlags_MouseButtonMiddle
| C++ | int ImGui_ButtonFlags_MouseButtonMiddle |
|---|
| EEL | int ImGui_ButtonFlags_MouseButtonMiddle() |
|---|
| Legacy EEL | int extension_api("ImGui_ButtonFlags_MouseButtonMiddle") |
|---|
| Lua | number retval = reaper.ImGui_ButtonFlags_MouseButtonMiddle() |
|---|
| Python | int retval = ImGui_ButtonFlags_MouseButtonMiddle() |
|---|
React on center mouse button.
View source
Constant: ButtonFlags_MouseButtonRight
| C++ | int ImGui_ButtonFlags_MouseButtonRight |
|---|
| EEL | int ImGui_ButtonFlags_MouseButtonRight() |
|---|
| Legacy EEL | int extension_api("ImGui_ButtonFlags_MouseButtonRight") |
|---|
| Lua | number retval = reaper.ImGui_ButtonFlags_MouseButtonRight() |
|---|
| Python | int retval = ImGui_ButtonFlags_MouseButtonRight() |
|---|
React on right mouse button.
View source
Constant: ButtonFlags_None
| C++ | int ImGui_ButtonFlags_None |
|---|
| EEL | int ImGui_ButtonFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_ButtonFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_ButtonFlags_None() |
|---|
| Python | int retval = ImGui_ButtonFlags_None() |
|---|
View source
Color Edit
Tip: the ColorEdit* functions have a little color square that can be
left-clicked to open a picker, and right-clicked to open an option menu.
Function: ColorButton
| C++ | bool ImGui_ColorButton(ImGui_Context* ctx, const char* desc_id, int col_rgba, int* flagsInOptional = ColorEditFlags_None, double* size_wInOptional = 0.0, double* size_hInOptional = 0.0) |
|---|
| EEL | bool ImGui_ColorButton(ImGui_Context ctx, "desc_id", int col_rgba, int flags = ColorEditFlags_None, size_w = 0.0, size_h = 0.0) |
|---|
| Legacy EEL | bool extension_api("ImGui_ColorButton", ImGui_Context ctx, "desc_id", int col_rgba, int flags = ColorEditFlags_None, size_w = 0.0, size_h = 0.0) |
|---|
| Lua | boolean retval = reaper.ImGui_ColorButton(ImGui_Context ctx, string desc_id, number col_rgba, number flags = ColorEditFlags_None, number size_w = 0.0, number size_h = 0.0) |
|---|
| Python | bool retval = ImGui_ColorButton(ImGui_Context ctx, str desc_id, int col_rgba, int flags = ColorEditFlags_None, float size_w = 0.0, float size_h = 0.0) |
|---|
Display a color square/button, hover for details, return true when pressed.
Color is in 0xRRGGBBAA or, if ColorEditFlags_NoAlpha is set, 0xRRGGBB.
View source
Function: ColorEdit3
| C++ | bool ImGui_ColorEdit3(ImGui_Context* ctx, const char* label, int* col_rgbInOut, int* flagsInOptional = ColorEditFlags_None) |
|---|
| EEL | bool ImGui_ColorEdit3(ImGui_Context ctx, "label", int &col_rgb, int flags = ColorEditFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_ColorEdit3", ImGui_Context ctx, "label", int &col_rgb, int flags = ColorEditFlags_None) |
|---|
| Lua | boolean retval, number col_rgb = reaper.ImGui_ColorEdit3(ImGui_Context ctx, string label, number col_rgb, number flags = ColorEditFlags_None) |
|---|
| Python | (bool retval, int col_rgb) = ImGui_ColorEdit3(ImGui_Context ctx, str label, int col_rgb, int flags = ColorEditFlags_None) |
|---|
Color is in 0xXXRRGGBB. XX is ignored and will not be modified.
View source
Function: ColorEdit4
| C++ | bool ImGui_ColorEdit4(ImGui_Context* ctx, const char* label, int* col_rgbaInOut, int* flagsInOptional = ColorEditFlags_None) |
|---|
| EEL | bool ImGui_ColorEdit4(ImGui_Context ctx, "label", int &col_rgba, int flags = ColorEditFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_ColorEdit4", ImGui_Context ctx, "label", int &col_rgba, int flags = ColorEditFlags_None) |
|---|
| Lua | boolean retval, number col_rgba = reaper.ImGui_ColorEdit4(ImGui_Context ctx, string label, number col_rgba, number flags = ColorEditFlags_None) |
|---|
| Python | (bool retval, int col_rgba) = ImGui_ColorEdit4(ImGui_Context ctx, str label, int col_rgba, int flags = ColorEditFlags_None) |
|---|
Color is in 0xRRGGBBAA or, if ColorEditFlags_NoAlpha is set, 0xXXRRGGBB
(XX is ignored and will not be modified).
View source
Function: ColorPicker3
| C++ | bool ImGui_ColorPicker3(ImGui_Context* ctx, const char* label, int* col_rgbInOut, int* flagsInOptional = ColorEditFlags_None) |
|---|
| EEL | bool ImGui_ColorPicker3(ImGui_Context ctx, "label", int &col_rgb, int flags = ColorEditFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_ColorPicker3", ImGui_Context ctx, "label", int &col_rgb, int flags = ColorEditFlags_None) |
|---|
| Lua | boolean retval, number col_rgb = reaper.ImGui_ColorPicker3(ImGui_Context ctx, string label, number col_rgb, number flags = ColorEditFlags_None) |
|---|
| Python | (bool retval, int col_rgb) = ImGui_ColorPicker3(ImGui_Context ctx, str label, int col_rgb, int flags = ColorEditFlags_None) |
|---|
Color is in 0xXXRRGGBB. XX is ignored and will not be modified.
View source
Function: ColorPicker4
| C++ | bool ImGui_ColorPicker4(ImGui_Context* ctx, const char* label, int* col_rgbaInOut, int* flagsInOptional = ColorEditFlags_None, int* ref_colInOptional = nullptr) |
|---|
| EEL | bool ImGui_ColorPicker4(ImGui_Context ctx, "label", int &col_rgba, int flags = ColorEditFlags_None, int ref_col = nullptr) |
|---|
| Legacy EEL | bool extension_api("ImGui_ColorPicker4", ImGui_Context ctx, "label", int &col_rgba, int flags = ColorEditFlags_None, int ref_col = nullptr) |
|---|
| Lua | boolean retval, number col_rgba = reaper.ImGui_ColorPicker4(ImGui_Context ctx, string label, number col_rgba, number flags = ColorEditFlags_None, number ref_col = nullptr) |
|---|
| Python | (bool retval, int col_rgba) = ImGui_ColorPicker4(ImGui_Context ctx, str label, int col_rgba, int flags = ColorEditFlags_None, int ref_col = nullptr) |
|---|
View source
Function: SetColorEditOptions
| C++ | void ImGui_SetColorEditOptions(ImGui_Context* ctx, int flags) |
|---|
| EEL | ImGui_SetColorEditOptions(ImGui_Context ctx, int flags) |
|---|
| Legacy EEL | extension_api("ImGui_SetColorEditOptions", ImGui_Context ctx, int flags) |
|---|
| Lua | reaper.ImGui_SetColorEditOptions(ImGui_Context ctx, number flags) |
|---|
| Python | ImGui_SetColorEditOptions(ImGui_Context ctx, int flags) |
|---|
Picker type, etc. User will be able to change many settings, unless you pass
the _NoOptions flag to your calls.
View source
Flags
Constant: ColorEditFlags_NoAlpha
| C++ | int ImGui_ColorEditFlags_NoAlpha |
|---|
| EEL | int ImGui_ColorEditFlags_NoAlpha() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_NoAlpha") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_NoAlpha() |
|---|
| Python | int retval = ImGui_ColorEditFlags_NoAlpha() |
|---|
ColorEdit, ColorPicker, ColorButton: ignore Alpha component
(will only read 3 components from the input pointer).
View source
Constant: ColorEditFlags_NoBorder
| C++ | int ImGui_ColorEditFlags_NoBorder |
|---|
| EEL | int ImGui_ColorEditFlags_NoBorder() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_NoBorder") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_NoBorder() |
|---|
| Python | int retval = ImGui_ColorEditFlags_NoBorder() |
|---|
ColorButton: disable border (which is enforced by default).
View source
Constant: ColorEditFlags_NoDragDrop
| C++ | int ImGui_ColorEditFlags_NoDragDrop |
|---|
| EEL | int ImGui_ColorEditFlags_NoDragDrop() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_NoDragDrop") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_NoDragDrop() |
|---|
| Python | int retval = ImGui_ColorEditFlags_NoDragDrop() |
|---|
ColorEdit: disable drag and drop target. ColorButton: disable drag and drop source.
View source
Constant: ColorEditFlags_NoInputs
| C++ | int ImGui_ColorEditFlags_NoInputs |
|---|
| EEL | int ImGui_ColorEditFlags_NoInputs() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_NoInputs") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_NoInputs() |
|---|
| Python | int retval = ImGui_ColorEditFlags_NoInputs() |
|---|
ColorEdit, ColorPicker: disable inputs sliders/text widgets
(e.g. to show only the small preview color square).
View source
Constant: ColorEditFlags_NoLabel
| C++ | int ImGui_ColorEditFlags_NoLabel |
|---|
| EEL | int ImGui_ColorEditFlags_NoLabel() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_NoLabel") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_NoLabel() |
|---|
| Python | int retval = ImGui_ColorEditFlags_NoLabel() |
|---|
ColorEdit, ColorPicker: disable display of inline text label
(the label is still forwarded to the tooltip and picker).
View source
Constant: ColorEditFlags_NoOptions
| C++ | int ImGui_ColorEditFlags_NoOptions |
|---|
| EEL | int ImGui_ColorEditFlags_NoOptions() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_NoOptions") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_NoOptions() |
|---|
| Python | int retval = ImGui_ColorEditFlags_NoOptions() |
|---|
ColorEdit: disable toggling options menu when right-clicking on inputs/small preview.
View source
Constant: ColorEditFlags_NoPicker
| C++ | int ImGui_ColorEditFlags_NoPicker |
|---|
| EEL | int ImGui_ColorEditFlags_NoPicker() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_NoPicker") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_NoPicker() |
|---|
| Python | int retval = ImGui_ColorEditFlags_NoPicker() |
|---|
ColorEdit: disable picker when clicking on color square.
View source
Constant: ColorEditFlags_NoSidePreview
| C++ | int ImGui_ColorEditFlags_NoSidePreview |
|---|
| EEL | int ImGui_ColorEditFlags_NoSidePreview() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_NoSidePreview") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_NoSidePreview() |
|---|
| Python | int retval = ImGui_ColorEditFlags_NoSidePreview() |
|---|
ColorPicker: disable bigger color preview on right side of the picker,
use small color square preview instead.
View source
Constant: ColorEditFlags_NoSmallPreview
| C++ | int ImGui_ColorEditFlags_NoSmallPreview |
|---|
| EEL | int ImGui_ColorEditFlags_NoSmallPreview() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_NoSmallPreview") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_NoSmallPreview() |
|---|
| Python | int retval = ImGui_ColorEditFlags_NoSmallPreview() |
|---|
ColorEdit, ColorPicker: disable color square preview next to the inputs.
(e.g. to show only the inputs).
View source
Constant: ColorEditFlags_NoTooltip
| C++ | int ImGui_ColorEditFlags_NoTooltip |
|---|
| EEL | int ImGui_ColorEditFlags_NoTooltip() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_NoTooltip") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_NoTooltip() |
|---|
| Python | int retval = ImGui_ColorEditFlags_NoTooltip() |
|---|
ColorEdit, ColorPicker, ColorButton: disable tooltip when hovering the preview.
View source
Constant: ColorEditFlags_None
| C++ | int ImGui_ColorEditFlags_None |
|---|
| EEL | int ImGui_ColorEditFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_None() |
|---|
| Python | int retval = ImGui_ColorEditFlags_None() |
|---|
View source
User Options
(right-click on widget to change some of them)
Constant: ColorEditFlags_AlphaBar
| C++ | int ImGui_ColorEditFlags_AlphaBar |
|---|
| EEL | int ImGui_ColorEditFlags_AlphaBar() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_AlphaBar") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_AlphaBar() |
|---|
| Python | int retval = ImGui_ColorEditFlags_AlphaBar() |
|---|
ColorEdit, ColorPicker: show vertical alpha bar/gradient in picker.
View source
Constant: ColorEditFlags_AlphaPreview
| C++ | int ImGui_ColorEditFlags_AlphaPreview |
|---|
| EEL | int ImGui_ColorEditFlags_AlphaPreview() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_AlphaPreview") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_AlphaPreview() |
|---|
| Python | int retval = ImGui_ColorEditFlags_AlphaPreview() |
|---|
ColorEdit, ColorPicker, ColorButton: display preview as a transparent color
over a checkerboard, instead of opaque.
View source
Constant: ColorEditFlags_AlphaPreviewHalf
| C++ | int ImGui_ColorEditFlags_AlphaPreviewHalf |
|---|
| EEL | int ImGui_ColorEditFlags_AlphaPreviewHalf() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_AlphaPreviewHalf") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_AlphaPreviewHalf() |
|---|
| Python | int retval = ImGui_ColorEditFlags_AlphaPreviewHalf() |
|---|
ColorEdit, ColorPicker, ColorButton: display half opaque / half checkerboard,
instead of opaque.
View source
Constant: ColorEditFlags_DisplayHSV
| C++ | int ImGui_ColorEditFlags_DisplayHSV |
|---|
| EEL | int ImGui_ColorEditFlags_DisplayHSV() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_DisplayHSV") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_DisplayHSV() |
|---|
| Python | int retval = ImGui_ColorEditFlags_DisplayHSV() |
|---|
ColorEdit: override display type to HSV. ColorPicker:
select any combination using one or more of RGB/HSV/Hex.
View source
Constant: ColorEditFlags_DisplayHex
| C++ | int ImGui_ColorEditFlags_DisplayHex |
|---|
| EEL | int ImGui_ColorEditFlags_DisplayHex() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_DisplayHex") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_DisplayHex() |
|---|
| Python | int retval = ImGui_ColorEditFlags_DisplayHex() |
|---|
ColorEdit: override display type to Hex. ColorPicker:
select any combination using one or more of RGB/HSV/Hex.
View source
Constant: ColorEditFlags_DisplayRGB
| C++ | int ImGui_ColorEditFlags_DisplayRGB |
|---|
| EEL | int ImGui_ColorEditFlags_DisplayRGB() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_DisplayRGB") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_DisplayRGB() |
|---|
| Python | int retval = ImGui_ColorEditFlags_DisplayRGB() |
|---|
ColorEdit: override display type to RGB. ColorPicker:
select any combination using one or more of RGB/HSV/Hex.
View source
Constant: ColorEditFlags_Float
| C++ | int ImGui_ColorEditFlags_Float |
|---|
| EEL | int ImGui_ColorEditFlags_Float() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_Float") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_Float() |
|---|
| Python | int retval = ImGui_ColorEditFlags_Float() |
|---|
ColorEdit, ColorPicker, ColorButton: display values formatted as 0.0..1.0
floats instead of 0..255 integers. No round-trip of value via integers.
View source
Constant: ColorEditFlags_InputHSV
| C++ | int ImGui_ColorEditFlags_InputHSV |
|---|
| EEL | int ImGui_ColorEditFlags_InputHSV() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_InputHSV") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_InputHSV() |
|---|
| Python | int retval = ImGui_ColorEditFlags_InputHSV() |
|---|
ColorEdit, ColorPicker: input and output data in HSV format.
View source
Constant: ColorEditFlags_InputRGB
| C++ | int ImGui_ColorEditFlags_InputRGB |
|---|
| EEL | int ImGui_ColorEditFlags_InputRGB() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_InputRGB") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_InputRGB() |
|---|
| Python | int retval = ImGui_ColorEditFlags_InputRGB() |
|---|
ColorEdit, ColorPicker: input and output data in RGB format.
View source
Constant: ColorEditFlags_PickerHueBar
| C++ | int ImGui_ColorEditFlags_PickerHueBar |
|---|
| EEL | int ImGui_ColorEditFlags_PickerHueBar() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_PickerHueBar") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_PickerHueBar() |
|---|
| Python | int retval = ImGui_ColorEditFlags_PickerHueBar() |
|---|
ColorPicker: bar for Hue, rectangle for Sat/Value.
View source
Constant: ColorEditFlags_PickerHueWheel
| C++ | int ImGui_ColorEditFlags_PickerHueWheel |
|---|
| EEL | int ImGui_ColorEditFlags_PickerHueWheel() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_PickerHueWheel") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_PickerHueWheel() |
|---|
| Python | int retval = ImGui_ColorEditFlags_PickerHueWheel() |
|---|
ColorPicker: wheel for Hue, triangle for Sat/Value.
View source
Constant: ColorEditFlags_Uint8
| C++ | int ImGui_ColorEditFlags_Uint8 |
|---|
| EEL | int ImGui_ColorEditFlags_Uint8() |
|---|
| Legacy EEL | int extension_api("ImGui_ColorEditFlags_Uint8") |
|---|
| Lua | number retval = reaper.ImGui_ColorEditFlags_Uint8() |
|---|
| Python | int retval = ImGui_ColorEditFlags_Uint8() |
|---|
ColorEdit, ColorPicker, ColorButton: display values formatted as 0..255.
View source
Combo & List
Combo Box (Dropdown)
Function: BeginCombo
| C++ | bool ImGui_BeginCombo(ImGui_Context* ctx, const char* label, const char* preview_value, int* flagsInOptional = ComboFlags_None) |
|---|
| EEL | bool ImGui_BeginCombo(ImGui_Context ctx, "label", "preview_value", int flags = ComboFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_BeginCombo", ImGui_Context ctx, "label", "preview_value", int flags = ComboFlags_None) |
|---|
| Lua | boolean retval = reaper.ImGui_BeginCombo(ImGui_Context ctx, string label, string preview_value, number flags = ComboFlags_None) |
|---|
| Python | bool retval = ImGui_BeginCombo(ImGui_Context ctx, str label, str preview_value, int flags = ComboFlags_None) |
|---|
The BeginCombo/EndCombo API allows you to manage your contents and selection
state however you want it, by creating e.g. Selectable items.
View source
Function: Combo
| C++ | bool ImGui_Combo(ImGui_Context* ctx, const char* label, int* current_itemInOut, const char* items, int items_sz, int* popup_max_height_in_itemsInOptional = -1) |
|---|
| EEL | bool ImGui_Combo(ImGui_Context ctx, "label", int ¤t_item, "items", int popup_max_height_in_items = -1) |
|---|
| Legacy EEL | bool extension_api("ImGui_Combo", ImGui_Context ctx, "label", int ¤t_item, "items", int popup_max_height_in_items = -1) |
|---|
| Lua | boolean retval, number current_item = reaper.ImGui_Combo(ImGui_Context ctx, string label, number current_item, string items, number popup_max_height_in_items = -1) |
|---|
| Python | (bool retval, int current_item) = ImGui_Combo(ImGui_Context ctx, str label, int current_item, str items, int popup_max_height_in_items = -1) |
|---|
Helper over BeginCombo/EndCombo for convenience purpose. Each item must be
null-terminated (requires REAPER v6.44 or newer for EEL and Lua).
View source
Constant: ComboFlags_HeightLarge
| C++ | int ImGui_ComboFlags_HeightLarge |
|---|
| EEL | int ImGui_ComboFlags_HeightLarge() |
|---|
| Legacy EEL | int extension_api("ImGui_ComboFlags_HeightLarge") |
|---|
| Lua | number retval = reaper.ImGui_ComboFlags_HeightLarge() |
|---|
| Python | int retval = ImGui_ComboFlags_HeightLarge() |
|---|
Max ~20 items visible.
View source
Constant: ComboFlags_HeightLargest
| C++ | int ImGui_ComboFlags_HeightLargest |
|---|
| EEL | int ImGui_ComboFlags_HeightLargest() |
|---|
| Legacy EEL | int extension_api("ImGui_ComboFlags_HeightLargest") |
|---|
| Lua | number retval = reaper.ImGui_ComboFlags_HeightLargest() |
|---|
| Python | int retval = ImGui_ComboFlags_HeightLargest() |
|---|
As many fitting items as possible.
View source
Constant: ComboFlags_HeightRegular
| C++ | int ImGui_ComboFlags_HeightRegular |
|---|
| EEL | int ImGui_ComboFlags_HeightRegular() |
|---|
| Legacy EEL | int extension_api("ImGui_ComboFlags_HeightRegular") |
|---|
| Lua | number retval = reaper.ImGui_ComboFlags_HeightRegular() |
|---|
| Python | int retval = ImGui_ComboFlags_HeightRegular() |
|---|
Max ~8 items visible (default).
View source
Constant: ComboFlags_HeightSmall
| C++ | int ImGui_ComboFlags_HeightSmall |
|---|
| EEL | int ImGui_ComboFlags_HeightSmall() |
|---|
| Legacy EEL | int extension_api("ImGui_ComboFlags_HeightSmall") |
|---|
| Lua | number retval = reaper.ImGui_ComboFlags_HeightSmall() |
|---|
| Python | int retval = ImGui_ComboFlags_HeightSmall() |
|---|
Max ~4 items visible. Tip: If you want your combo popup to be a specific size
you can use SetNextWindowSizeConstraints prior to calling BeginCombo.
View source
Constant: ComboFlags_NoArrowButton
| C++ | int ImGui_ComboFlags_NoArrowButton |
|---|
| EEL | int ImGui_ComboFlags_NoArrowButton() |
|---|
| Legacy EEL | int extension_api("ImGui_ComboFlags_NoArrowButton") |
|---|
| Lua | number retval = reaper.ImGui_ComboFlags_NoArrowButton() |
|---|
| Python | int retval = ImGui_ComboFlags_NoArrowButton() |
|---|
Display on the preview box without the square arrow button.
View source
Constant: ComboFlags_NoPreview
| C++ | int ImGui_ComboFlags_NoPreview |
|---|
| EEL | int ImGui_ComboFlags_NoPreview() |
|---|
| Legacy EEL | int extension_api("ImGui_ComboFlags_NoPreview") |
|---|
| Lua | number retval = reaper.ImGui_ComboFlags_NoPreview() |
|---|
| Python | int retval = ImGui_ComboFlags_NoPreview() |
|---|
Display only a square arrow button.
View source
Constant: ComboFlags_None
| C++ | int ImGui_ComboFlags_None |
|---|
| EEL | int ImGui_ComboFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_ComboFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_ComboFlags_None() |
|---|
| Python | int retval = ImGui_ComboFlags_None() |
|---|
View source
Function: EndCombo
| C++ | void ImGui_EndCombo(ImGui_Context* ctx) |
|---|
| EEL | ImGui_EndCombo(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_EndCombo", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_EndCombo(ImGui_Context ctx) |
|---|
| Python | ImGui_EndCombo(ImGui_Context ctx) |
|---|
Only call EndCombo() if BeginCombo returns true!
View source
List Boxes
This is essentially a thin wrapper to using BeginChild/EndChild with some
stylistic changes.
Function: BeginListBox
| C++ | bool ImGui_BeginListBox(ImGui_Context* ctx, const char* label, double* size_wInOptional = 0.0, double* size_hInOptional = 0.0) |
|---|
| EEL | bool ImGui_BeginListBox(ImGui_Context ctx, "label", size_w = 0.0, size_h = 0.0) |
|---|
| Legacy EEL | bool extension_api("ImGui_BeginListBox", ImGui_Context ctx, "label", size_w = 0.0, size_h = 0.0) |
|---|
| Lua | boolean retval = reaper.ImGui_BeginListBox(ImGui_Context ctx, string label, number size_w = 0.0, number size_h = 0.0) |
|---|
| Python | bool retval = ImGui_BeginListBox(ImGui_Context ctx, str label, float size_w = 0.0, float size_h = 0.0) |
|---|
Open a framed scrolling region. This is essentially a thin wrapper to using
BeginChild/EndChild with some stylistic changes.
The BeginListBox/EndListBox API allows you to manage your contents and selection
state however you want it, by creating e.g. Selectable or any items.
- Choose frame width:
- width > 0.0: custom
- width < 0.0 or -FLT_MIN: right-align
- width = 0.0 (default): use current ItemWidth
- Choose frame height:
- height > 0.0: custom
- height < 0.0 or -FLT_MIN: bottom-align
- height = 0.0 (default): arbitrary default height which can fit ~7 items
See EndListBox.
View source
Function: EndListBox
| C++ | void ImGui_EndListBox(ImGui_Context* ctx) |
|---|
| EEL | ImGui_EndListBox(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_EndListBox", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_EndListBox(ImGui_Context ctx) |
|---|
| Python | ImGui_EndListBox(ImGui_Context ctx) |
|---|
Only call EndListBox() if BeginListBox returned true!
View source
Function: ListBox
| C++ | bool ImGui_ListBox(ImGui_Context* ctx, const char* label, int* current_itemInOut, const char* items, int items_sz, int* height_in_itemsInOptional = -1) |
|---|
| EEL | bool ImGui_ListBox(ImGui_Context ctx, "label", int ¤t_item, "items", int height_in_items = -1) |
|---|
| Legacy EEL | bool extension_api("ImGui_ListBox", ImGui_Context ctx, "label", int ¤t_item, "items", int height_in_items = -1) |
|---|
| Lua | boolean retval, number current_item = reaper.ImGui_ListBox(ImGui_Context ctx, string label, number current_item, string items, number height_in_items = -1) |
|---|
| Python | (bool retval, int current_item) = ImGui_ListBox(ImGui_Context ctx, str label, int current_item, str items, int height_in_items = -1) |
|---|
This is an helper over BeginListBox/EndListBox for convenience purpose.
Each item must be null-terminated (requires REAPER v6.44 or newer for EEL and Lua).
View source
Selectables
A selectable highlights when hovered, and can display another color when
selected. Neighbors selectable extend their highlight bounds in order to leave
no gap between them. This is so a series of selected Selectable appear
contiguous.
Function: Selectable
| C++ | bool ImGui_Selectable(ImGui_Context* ctx, const char* label, bool* p_selectedInOut, int* flagsInOptional = SelectableFlags_None, double* size_wInOptional = 0.0, double* size_hInOptional = 0.0) |
|---|
| EEL | bool ImGui_Selectable(ImGui_Context ctx, "label", bool &p_selected, int flags = SelectableFlags_None, size_w = 0.0, size_h = 0.0) |
|---|
| Legacy EEL | bool extension_api("ImGui_Selectable", ImGui_Context ctx, "label", bool &p_selected, int flags = SelectableFlags_None, size_w = 0.0, size_h = 0.0) |
|---|
| Lua | boolean retval, boolean p_selected = reaper.ImGui_Selectable(ImGui_Context ctx, string label, boolean p_selected, number flags = SelectableFlags_None, number size_w = 0.0, number size_h = 0.0) |
|---|
| Python | (bool retval, bool p_selected) = ImGui_Selectable(ImGui_Context ctx, str label, bool p_selected, int flags = SelectableFlags_None, float size_w = 0.0, float size_h = 0.0) |
|---|
View source
Constant: SelectableFlags_AllowDoubleClick
| C++ | int ImGui_SelectableFlags_AllowDoubleClick |
|---|
| EEL | int ImGui_SelectableFlags_AllowDoubleClick() |
|---|
| Legacy EEL | int extension_api("ImGui_SelectableFlags_AllowDoubleClick") |
|---|
| Lua | number retval = reaper.ImGui_SelectableFlags_AllowDoubleClick() |
|---|
| Python | int retval = ImGui_SelectableFlags_AllowDoubleClick() |
|---|
Generate press events on double clicks too.
View source
Constant: SelectableFlags_AllowItemOverlap
| C++ | int ImGui_SelectableFlags_AllowItemOverlap |
|---|
| EEL | int ImGui_SelectableFlags_AllowItemOverlap() |
|---|
| Legacy EEL | int extension_api("ImGui_SelectableFlags_AllowItemOverlap") |
|---|
| Lua | number retval = reaper.ImGui_SelectableFlags_AllowItemOverlap() |
|---|
| Python | int retval = ImGui_SelectableFlags_AllowItemOverlap() |
|---|
Hit testing to allow subsequent widgets to overlap this one.
View source
Constant: SelectableFlags_Disabled
| C++ | int ImGui_SelectableFlags_Disabled |
|---|
| EEL | int ImGui_SelectableFlags_Disabled() |
|---|
| Legacy EEL | int extension_api("ImGui_SelectableFlags_Disabled") |
|---|
| Lua | number retval = reaper.ImGui_SelectableFlags_Disabled() |
|---|
| Python | int retval = ImGui_SelectableFlags_Disabled() |
|---|
Cannot be selected, display grayed out text.
View source
Constant: SelectableFlags_None
| C++ | int ImGui_SelectableFlags_None |
|---|
| EEL | int ImGui_SelectableFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_SelectableFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_SelectableFlags_None() |
|---|
| Python | int retval = ImGui_SelectableFlags_None() |
|---|
View source
Constant: SelectableFlags_SpanAllColumns
| C++ | int ImGui_SelectableFlags_SpanAllColumns |
|---|
| EEL | int ImGui_SelectableFlags_SpanAllColumns() |
|---|
| Legacy EEL | int extension_api("ImGui_SelectableFlags_SpanAllColumns") |
|---|
| Lua | number retval = reaper.ImGui_SelectableFlags_SpanAllColumns() |
|---|
| Python | int retval = ImGui_SelectableFlags_SpanAllColumns() |
|---|
Selectable frame can span all columns (text will still fit in current column).
View source
Context
Function: Attach
| C++ | void ImGui_Attach(ImGui_Context* ctx, ImGui_Resource* obj) |
|---|
| EEL | ImGui_Attach(ImGui_Context ctx, ImGui_Resource obj) |
|---|
| Legacy EEL | extension_api("ImGui_Attach", ImGui_Context ctx, ImGui_Resource obj) |
|---|
| Lua | reaper.ImGui_Attach(ImGui_Context ctx, ImGui_Resource obj) |
|---|
| Python | ImGui_Attach(ImGui_Context ctx, ImGui_Resource obj) |
|---|
Link the object's lifetime to the given context.
Objects can be draw list splitters, fonts, images, list clippers, etc.
Call Detach to let the object be garbage-collected after unuse again.
List clipper objects may only be attached to the context they were created for.
Fonts are (currently) a special case: they must be attached to the context
before usage. Furthermore, fonts may only be attached or detached immediately
after the context is created or before any other function calls modifying the
context per defer cycle. See "limitations" in the font API documentation.
View source
Function: CreateContext
| C++ | ImGui_Context* ImGui_CreateContext(const char* label, int* config_flagsInOptional = ConfigFlags_None) |
|---|
| EEL | ImGui_Context* ImGui_CreateContext("label", int config_flags = ConfigFlags_None) |
|---|
| Legacy EEL | ImGui_Context* extension_api("ImGui_CreateContext", "label", int config_flags = ConfigFlags_None) |
|---|
| Lua | ImGui_Context retval = reaper.ImGui_CreateContext(string label, number config_flags = ConfigFlags_None) |
|---|
| Python | ImGui_Context retval = ImGui_CreateContext(str label, int config_flags = ConfigFlags_None) |
|---|
Create a new ReaImGui context.
The context will remain valid as long as it is used in each defer cycle.
The label is used for the tab text when windows are docked in REAPER
and also as a unique identifier for storing settings.
View source
Function: DestroyContext
| C++ | void ImGui_DestroyContext(ImGui_Context* ctx) |
|---|
| EEL | ImGui_DestroyContext(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_DestroyContext", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_DestroyContext(ImGui_Context ctx) |
|---|
| Python | ImGui_DestroyContext(ImGui_Context ctx) |
|---|
Free the resources used by a context.
Calling this function is usually not required as all ReaImGui objects are
automatically garbage-collected when unused.
View source
Function: Detach
| C++ | void ImGui_Detach(ImGui_Context* ctx, ImGui_Resource* obj) |
|---|
| EEL | ImGui_Detach(ImGui_Context ctx, ImGui_Resource obj) |
|---|
| Legacy EEL | extension_api("ImGui_Detach", ImGui_Context ctx, ImGui_Resource obj) |
|---|
| Lua | reaper.ImGui_Detach(ImGui_Context ctx, ImGui_Resource obj) |
|---|
| Python | ImGui_Detach(ImGui_Context ctx, ImGui_Resource obj) |
|---|
Unlink the object's lifetime. Unattached objects are automatically destroyed
when left unused. You may check whether an object has been destroyed using
ValidatePtr.
View source
Function: GetDeltaTime
| C++ | double ImGui_GetDeltaTime(ImGui_Context* ctx) |
|---|
| EEL | double ImGui_GetDeltaTime(ImGui_Context ctx) |
|---|
| Legacy EEL | double extension_api("ImGui_GetDeltaTime", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetDeltaTime(ImGui_Context ctx) |
|---|
| Python | float retval = ImGui_GetDeltaTime(ImGui_Context ctx) |
|---|
Time elapsed since last frame, in seconds.
View source
Function: GetFrameCount
| C++ | int ImGui_GetFrameCount(ImGui_Context* ctx) |
|---|
| EEL | int ImGui_GetFrameCount(ImGui_Context ctx) |
|---|
| Legacy EEL | int extension_api("ImGui_GetFrameCount", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetFrameCount(ImGui_Context ctx) |
|---|
| Python | int retval = ImGui_GetFrameCount(ImGui_Context ctx) |
|---|
Get global imgui frame count. incremented by 1 every frame.
View source
Function: GetFramerate
| C++ | double ImGui_GetFramerate(ImGui_Context* ctx) |
|---|
| EEL | double ImGui_GetFramerate(ImGui_Context ctx) |
|---|
| Legacy EEL | double extension_api("ImGui_GetFramerate", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetFramerate(ImGui_Context ctx) |
|---|
| Python | float retval = ImGui_GetFramerate(ImGui_Context ctx) |
|---|
Estimate of application framerate (rolling average over 60 frames, based on
GetDeltaTime), in frame per second. Solely for convenience.
View source
Function: GetTime
| C++ | double ImGui_GetTime(ImGui_Context* ctx) |
|---|
| EEL | double ImGui_GetTime(ImGui_Context ctx) |
|---|
| Legacy EEL | double extension_api("ImGui_GetTime", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetTime(ImGui_Context ctx) |
|---|
| Python | float retval = ImGui_GetTime(ImGui_Context ctx) |
|---|
Get global imgui time. Incremented every frame.
View source
Flags
For CreateContext and SetConfigVar(ConfigVar_Flags()).
Constant: ConfigFlags_DockingEnable
| C++ | int ImGui_ConfigFlags_DockingEnable |
|---|
| EEL | int ImGui_ConfigFlags_DockingEnable() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigFlags_DockingEnable") |
|---|
| Lua | number retval = reaper.ImGui_ConfigFlags_DockingEnable() |
|---|
| Python | int retval = ImGui_ConfigFlags_DockingEnable() |
|---|
[BETA] Enable docking functionality.
View source
Constant: ConfigFlags_NavEnableKeyboard
| C++ | int ImGui_ConfigFlags_NavEnableKeyboard |
|---|
| EEL | int ImGui_ConfigFlags_NavEnableKeyboard() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigFlags_NavEnableKeyboard") |
|---|
| Lua | number retval = reaper.ImGui_ConfigFlags_NavEnableKeyboard() |
|---|
| Python | int retval = ImGui_ConfigFlags_NavEnableKeyboard() |
|---|
Master keyboard navigation enable flag.
Enable full Tabbing + directional arrows + space/enter to activate.
View source
Constant: ConfigFlags_NavEnableSetMousePos
| C++ | int ImGui_ConfigFlags_NavEnableSetMousePos |
|---|
| EEL | int ImGui_ConfigFlags_NavEnableSetMousePos() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigFlags_NavEnableSetMousePos") |
|---|
| Lua | number retval = reaper.ImGui_ConfigFlags_NavEnableSetMousePos() |
|---|
| Python | int retval = ImGui_ConfigFlags_NavEnableSetMousePos() |
|---|
Instruct navigation to move the mouse cursor.
View source
Constant: ConfigFlags_NavNoCaptureKeyboard
| C++ | int ImGui_ConfigFlags_NavNoCaptureKeyboard |
|---|
| EEL | int ImGui_ConfigFlags_NavNoCaptureKeyboard() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigFlags_NavNoCaptureKeyboard") |
|---|
| Lua | number retval = reaper.ImGui_ConfigFlags_NavNoCaptureKeyboard() |
|---|
| Python | int retval = ImGui_ConfigFlags_NavNoCaptureKeyboard() |
|---|
Instruct navigation to not capture global keyboard input when
ConfigFlags_NavEnableKeyboard is set (see SetNextFrameWantCaptureKeyboard).
View source
Constant: ConfigFlags_NoMouse
| C++ | int ImGui_ConfigFlags_NoMouse |
|---|
| EEL | int ImGui_ConfigFlags_NoMouse() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigFlags_NoMouse") |
|---|
| Lua | number retval = reaper.ImGui_ConfigFlags_NoMouse() |
|---|
| Python | int retval = ImGui_ConfigFlags_NoMouse() |
|---|
Instruct imgui to ignore mouse position/buttons.
View source
Constant: ConfigFlags_NoMouseCursorChange
| C++ | int ImGui_ConfigFlags_NoMouseCursorChange |
|---|
| EEL | int ImGui_ConfigFlags_NoMouseCursorChange() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigFlags_NoMouseCursorChange") |
|---|
| Lua | number retval = reaper.ImGui_ConfigFlags_NoMouseCursorChange() |
|---|
| Python | int retval = ImGui_ConfigFlags_NoMouseCursorChange() |
|---|
Instruct backend to not alter mouse cursor shape and visibility.
View source
Constant: ConfigFlags_NoSavedSettings
| C++ | int ImGui_ConfigFlags_NoSavedSettings |
|---|
| EEL | int ImGui_ConfigFlags_NoSavedSettings() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigFlags_NoSavedSettings") |
|---|
| Lua | number retval = reaper.ImGui_ConfigFlags_NoSavedSettings() |
|---|
| Python | int retval = ImGui_ConfigFlags_NoSavedSettings() |
|---|
Disable state restoration and persistence for the whole context.
View source
Constant: ConfigFlags_None
| C++ | int ImGui_ConfigFlags_None |
|---|
| EEL | int ImGui_ConfigFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_ConfigFlags_None() |
|---|
| Python | int retval = ImGui_ConfigFlags_None() |
|---|
View source
Options
Constant: ConfigVar_DebugBeginReturnValueLoop
| C++ | int ImGui_ConfigVar_DebugBeginReturnValueLoop |
|---|
| EEL | int ImGui_ConfigVar_DebugBeginReturnValueLoop() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_DebugBeginReturnValueLoop") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_DebugBeginReturnValueLoop() |
|---|
| Python | int retval = ImGui_ConfigVar_DebugBeginReturnValueLoop() |
|---|
Some calls to Begin()/BeginChild() will return false.
Will cycle through window depths then repeat. Suggested use: add
"SetConfigVar(ConfigVar_DebugBeginReturnValueLoop(), GetKeyMods() == Mod_Shift"
in your main loop then occasionally press SHIFT.
Windows should be flickering while running.
View source
Constant: ConfigVar_DebugBeginReturnValueOnce
| C++ | int ImGui_ConfigVar_DebugBeginReturnValueOnce |
|---|
| EEL | int ImGui_ConfigVar_DebugBeginReturnValueOnce() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_DebugBeginReturnValueOnce") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_DebugBeginReturnValueOnce() |
|---|
| Python | int retval = ImGui_ConfigVar_DebugBeginReturnValueOnce() |
|---|
First-time calls to Begin()/BeginChild() will return false.
Needs to be set at context startup time if you don't want to miss windows.
View source
Constant: ConfigVar_DockingNoSplit
| C++ | int ImGui_ConfigVar_DockingNoSplit |
|---|
| EEL | int ImGui_ConfigVar_DockingNoSplit() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_DockingNoSplit") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_DockingNoSplit() |
|---|
| Python | int retval = ImGui_ConfigVar_DockingNoSplit() |
|---|
Simplified docking mode: disable window splitting, so docking is limited to
merging multiple windows together into tab-bars.
View source
Constant: ConfigVar_DockingTransparentPayload
| C++ | int ImGui_ConfigVar_DockingTransparentPayload |
|---|
| EEL | int ImGui_ConfigVar_DockingTransparentPayload() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_DockingTransparentPayload") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_DockingTransparentPayload() |
|---|
| Python | int retval = ImGui_ConfigVar_DockingTransparentPayload() |
|---|
Make window or viewport transparent when docking and only display docking
boxes on the target viewport.
View source
Constant: ConfigVar_DockingWithShift
| C++ | int ImGui_ConfigVar_DockingWithShift |
|---|
| EEL | int ImGui_ConfigVar_DockingWithShift() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_DockingWithShift") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_DockingWithShift() |
|---|
| Python | int retval = ImGui_ConfigVar_DockingWithShift() |
|---|
Enable docking with holding Shift key
(reduce visual noise, allows dropping in wider space
View source
Constant: ConfigVar_DragClickToInputText
| C++ | int ImGui_ConfigVar_DragClickToInputText |
|---|
| EEL | int ImGui_ConfigVar_DragClickToInputText() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_DragClickToInputText") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_DragClickToInputText() |
|---|
| Python | int retval = ImGui_ConfigVar_DragClickToInputText() |
|---|
Enable turning Drag* widgets into text input with a simple mouse
click-release (without moving). Not desirable on devices without a keyboard.
View source
Constant: ConfigVar_Flags
| C++ | int ImGui_ConfigVar_Flags |
|---|
| EEL | int ImGui_ConfigVar_Flags() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_Flags") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_Flags() |
|---|
| Python | int retval = ImGui_ConfigVar_Flags() |
|---|
ConfigFlags_*
View source
Constant: ConfigVar_HoverDelayNormal
| C++ | int ImGui_ConfigVar_HoverDelayNormal |
|---|
| EEL | int ImGui_ConfigVar_HoverDelayNormal() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_HoverDelayNormal") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_HoverDelayNormal() |
|---|
| Python | int retval = ImGui_ConfigVar_HoverDelayNormal() |
|---|
Delay on hovering before IsItemHovered(HoveredFlags_DelayNormal) returns true.
View source
Constant: ConfigVar_HoverDelayShort
| C++ | int ImGui_ConfigVar_HoverDelayShort |
|---|
| EEL | int ImGui_ConfigVar_HoverDelayShort() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_HoverDelayShort") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_HoverDelayShort() |
|---|
| Python | int retval = ImGui_ConfigVar_HoverDelayShort() |
|---|
Delay on hovering before IsItemHovered(HoveredFlags_DelayShort) returns true.
View source
Constant: ConfigVar_InputTextCursorBlink
| C++ | int ImGui_ConfigVar_InputTextCursorBlink |
|---|
| EEL | int ImGui_ConfigVar_InputTextCursorBlink() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_InputTextCursorBlink") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_InputTextCursorBlink() |
|---|
| Python | int retval = ImGui_ConfigVar_InputTextCursorBlink() |
|---|
Enable blinking cursor (optional as some users consider it to be distracting).
View source
Constant: ConfigVar_InputTextEnterKeepActive
| C++ | int ImGui_ConfigVar_InputTextEnterKeepActive |
|---|
| EEL | int ImGui_ConfigVar_InputTextEnterKeepActive() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_InputTextEnterKeepActive") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_InputTextEnterKeepActive() |
|---|
| Python | int retval = ImGui_ConfigVar_InputTextEnterKeepActive() |
|---|
Pressing Enter will keep item active and select contents (single-line only).
View source
Constant: ConfigVar_InputTrickleEventQueue
| C++ | int ImGui_ConfigVar_InputTrickleEventQueue |
|---|
| EEL | int ImGui_ConfigVar_InputTrickleEventQueue() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_InputTrickleEventQueue") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_InputTrickleEventQueue() |
|---|
| Python | int retval = ImGui_ConfigVar_InputTrickleEventQueue() |
|---|
Enable input queue trickling: some types of events submitted during the same
frame (e.g. button down + up) will be spread over multiple frames, improving
interactions with low framerates.
View source
Constant: ConfigVar_KeyRepeatDelay
| C++ | int ImGui_ConfigVar_KeyRepeatDelay |
|---|
| EEL | int ImGui_ConfigVar_KeyRepeatDelay() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_KeyRepeatDelay") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_KeyRepeatDelay() |
|---|
| Python | int retval = ImGui_ConfigVar_KeyRepeatDelay() |
|---|
When holding a key/button, time before it starts repeating, in seconds
(for buttons in Repeat mode, etc.).
View source
Constant: ConfigVar_KeyRepeatRate
| C++ | int ImGui_ConfigVar_KeyRepeatRate |
|---|
| EEL | int ImGui_ConfigVar_KeyRepeatRate() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_KeyRepeatRate") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_KeyRepeatRate() |
|---|
| Python | int retval = ImGui_ConfigVar_KeyRepeatRate() |
|---|
When holding a key/button, rate at which it repeats, in seconds.
View source
Constant: ConfigVar_MacOSXBehaviors
| C++ | int ImGui_ConfigVar_MacOSXBehaviors |
|---|
| EEL | int ImGui_ConfigVar_MacOSXBehaviors() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_MacOSXBehaviors") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_MacOSXBehaviors() |
|---|
| Python | int retval = ImGui_ConfigVar_MacOSXBehaviors() |
|---|
OS X style: Text editing cursor movement using Alt instead of Ctrl, Shortcuts
using Cmd/Super instead of Ctrl, Line/Text Start and End using Cmd+Arrows
instead of Home/End, Double click selects by word instead of selecting whole
text, Multi-selection in lists uses Cmd/Super instead of Ctrl.
View source
Constant: ConfigVar_MouseDoubleClickMaxDist
| C++ | int ImGui_ConfigVar_MouseDoubleClickMaxDist |
|---|
| EEL | int ImGui_ConfigVar_MouseDoubleClickMaxDist() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_MouseDoubleClickMaxDist") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_MouseDoubleClickMaxDist() |
|---|
| Python | int retval = ImGui_ConfigVar_MouseDoubleClickMaxDist() |
|---|
Distance threshold to stay in to validate a double-click, in pixels.
View source
Constant: ConfigVar_MouseDoubleClickTime
| C++ | int ImGui_ConfigVar_MouseDoubleClickTime |
|---|
| EEL | int ImGui_ConfigVar_MouseDoubleClickTime() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_MouseDoubleClickTime") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_MouseDoubleClickTime() |
|---|
| Python | int retval = ImGui_ConfigVar_MouseDoubleClickTime() |
|---|
Time for a double-click, in seconds.
View source
Constant: ConfigVar_MouseDragThreshold
| C++ | int ImGui_ConfigVar_MouseDragThreshold |
|---|
| EEL | int ImGui_ConfigVar_MouseDragThreshold() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_MouseDragThreshold") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_MouseDragThreshold() |
|---|
| Python | int retval = ImGui_ConfigVar_MouseDragThreshold() |
|---|
Distance threshold before considering we are dragging.
View source
Constant: ConfigVar_ViewportsNoDecoration
| C++ | int ImGui_ConfigVar_ViewportsNoDecoration |
|---|
| EEL | int ImGui_ConfigVar_ViewportsNoDecoration() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_ViewportsNoDecoration") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_ViewportsNoDecoration() |
|---|
| Python | int retval = ImGui_ConfigVar_ViewportsNoDecoration() |
|---|
Disable default OS window decoration. Enabling decoration can create
subsequent issues at OS levels (e.g. minimum window size).
View source
Constant: ConfigVar_WindowsMoveFromTitleBarOnly
| C++ | int ImGui_ConfigVar_WindowsMoveFromTitleBarOnly |
|---|
| EEL | int ImGui_ConfigVar_WindowsMoveFromTitleBarOnly() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_WindowsMoveFromTitleBarOnly") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_WindowsMoveFromTitleBarOnly() |
|---|
| Python | int retval = ImGui_ConfigVar_WindowsMoveFromTitleBarOnly() |
|---|
Enable allowing to move windows only when clicking on their title bar.
Does not apply to windows without a title bar.
View source
Constant: ConfigVar_WindowsResizeFromEdges
| C++ | int ImGui_ConfigVar_WindowsResizeFromEdges |
|---|
| EEL | int ImGui_ConfigVar_WindowsResizeFromEdges() |
|---|
| Legacy EEL | int extension_api("ImGui_ConfigVar_WindowsResizeFromEdges") |
|---|
| Lua | number retval = reaper.ImGui_ConfigVar_WindowsResizeFromEdges() |
|---|
| Python | int retval = ImGui_ConfigVar_WindowsResizeFromEdges() |
|---|
Enable resizing of windows from their edges and from the lower-left corner.
View source
Function: GetConfigVar
| C++ | double ImGui_GetConfigVar(ImGui_Context* ctx, int var_idx) |
|---|
| EEL | double ImGui_GetConfigVar(ImGui_Context ctx, int var_idx) |
|---|
| Legacy EEL | double extension_api("ImGui_GetConfigVar", ImGui_Context ctx, int var_idx) |
|---|
| Lua | number retval = reaper.ImGui_GetConfigVar(ImGui_Context ctx, number var_idx) |
|---|
| Python | float retval = ImGui_GetConfigVar(ImGui_Context ctx, int var_idx) |
|---|
View source
Function: SetConfigVar
| C++ | void ImGui_SetConfigVar(ImGui_Context* ctx, int var_idx, double value) |
|---|
| EEL | ImGui_SetConfigVar(ImGui_Context ctx, int var_idx, value) |
|---|
| Legacy EEL | extension_api("ImGui_SetConfigVar", ImGui_Context ctx, int var_idx, value) |
|---|
| Lua | reaper.ImGui_SetConfigVar(ImGui_Context ctx, number var_idx, number value) |
|---|
| Python | ImGui_SetConfigVar(ImGui_Context ctx, int var_idx, float value) |
|---|
View source
Drag & Drop
On source items, call BeginDragDropSource(),
if it returns true also call SetDragDropPayload() + EndDragDropSource().
On target candidates, call BeginDragDropTarget(),
if it returns true also call AcceptDragDropPayload() + EndDragDropTarget().
An item can be both a drag source and a drop target.
Function: AcceptDragDropPayload
| C++ | bool ImGui_AcceptDragDropPayload(ImGui_Context* ctx, const char* type, char* payloadOutNeedBig, int payloadOutNeedBig_sz, int* flagsInOptional = DragDropFlags_None) |
|---|
| EEL | bool ImGui_AcceptDragDropPayload(ImGui_Context ctx, "type", #payload, int flags = DragDropFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_AcceptDragDropPayload", ImGui_Context ctx, "type", #payload, int flags = DragDropFlags_None) |
|---|
| Lua | boolean retval, string payload = reaper.ImGui_AcceptDragDropPayload(ImGui_Context ctx, string type, nil, number flags = DragDropFlags_None) |
|---|
| Python | (bool retval, str payload) = ImGui_AcceptDragDropPayload(ImGui_Context ctx, str type, int flags = DragDropFlags_None) |
|---|
Accept contents of a given type. If DragDropFlags_AcceptBeforeDelivery is set
you can peek into the payload before the mouse button is released.
View source
Function: AcceptDragDropPayloadFiles
| C++ | bool ImGui_AcceptDragDropPayloadFiles(ImGui_Context* ctx, int* countOut, int* flagsInOptional = DragDropFlags_None) |
|---|
| EEL | bool ImGui_AcceptDragDropPayloadFiles(ImGui_Context ctx, int &count, int flags = DragDropFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_AcceptDragDropPayloadFiles", ImGui_Context ctx, int &count, int flags = DragDropFlags_None) |
|---|
| Lua | boolean retval, number count = reaper.ImGui_AcceptDragDropPayloadFiles(ImGui_Context ctx, nil, number flags = DragDropFlags_None) |
|---|
| Python | (bool retval, int count) = ImGui_AcceptDragDropPayloadFiles(ImGui_Context ctx, int flags = DragDropFlags_None) |
|---|
Accept a list of dropped files. See AcceptDragDropPayload and GetDragDropPayloadFile.
View source
Function: AcceptDragDropPayloadRGB
| C++ | bool ImGui_AcceptDragDropPayloadRGB(ImGui_Context* ctx, int* rgbOut, int* flagsInOptional = DragDropFlags_None) |
|---|
| EEL | bool ImGui_AcceptDragDropPayloadRGB(ImGui_Context ctx, int &rgb, int flags = DragDropFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_AcceptDragDropPayloadRGB", ImGui_Context ctx, int &rgb, int flags = DragDropFlags_None) |
|---|
| Lua | boolean retval, number rgb = reaper.ImGui_AcceptDragDropPayloadRGB(ImGui_Context ctx, nil, number flags = DragDropFlags_None) |
|---|
| Python | (bool retval, int rgb) = ImGui_AcceptDragDropPayloadRGB(ImGui_Context ctx, int flags = DragDropFlags_None) |
|---|
Accept a RGB color. See AcceptDragDropPayload.
View source
Function: AcceptDragDropPayloadRGBA
| C++ | bool ImGui_AcceptDragDropPayloadRGBA(ImGui_Context* ctx, int* rgbaOut, int* flagsInOptional = DragDropFlags_None) |
|---|
| EEL | bool ImGui_AcceptDragDropPayloadRGBA(ImGui_Context ctx, int &rgba, int flags = DragDropFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_AcceptDragDropPayloadRGBA", ImGui_Context ctx, int &rgba, int flags = DragDropFlags_None) |
|---|
| Lua | boolean retval, number rgba = reaper.ImGui_AcceptDragDropPayloadRGBA(ImGui_Context ctx, nil, number flags = DragDropFlags_None) |
|---|
| Python | (bool retval, int rgba) = ImGui_AcceptDragDropPayloadRGBA(ImGui_Context ctx, int flags = DragDropFlags_None) |
|---|
Accept a RGBA color. See AcceptDragDropPayload.
View source
Function: BeginDragDropSource
| C++ | bool ImGui_BeginDragDropSource(ImGui_Context* ctx, int* flagsInOptional = DragDropFlags_None) |
|---|
| EEL | bool ImGui_BeginDragDropSource(ImGui_Context ctx, int flags = DragDropFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_BeginDragDropSource", ImGui_Context ctx, int flags = DragDropFlags_None) |
|---|
| Lua | boolean retval = reaper.ImGui_BeginDragDropSource(ImGui_Context ctx, number flags = DragDropFlags_None) |
|---|
| Python | bool retval = ImGui_BeginDragDropSource(ImGui_Context ctx, int flags = DragDropFlags_None) |
|---|
Call after submitting an item which may be dragged. when this return true,
you can call SetDragDropPayload() + EndDragDropSource()
If you stop calling BeginDragDropSource() the payload is preserved however
it won't have a preview tooltip (we currently display a fallback "..." tooltip
as replacement).
View source
Function: BeginDragDropTarget
| C++ | bool ImGui_BeginDragDropTarget(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_BeginDragDropTarget(ImGui_Context ctx) |
|---|
| Legacy EEL | bool extension_api("ImGui_BeginDragDropTarget", ImGui_Context ctx) |
|---|
| Lua | boolean retval = reaper.ImGui_BeginDragDropTarget(ImGui_Context ctx) |
|---|
| Python | bool retval = ImGui_BeginDragDropTarget(ImGui_Context ctx) |
|---|
Call after submitting an item that may receive a payload.
If this returns true, you can call AcceptDragDropPayload + EndDragDropTarget.
View source
Function: EndDragDropSource
| C++ | void ImGui_EndDragDropSource(ImGui_Context* ctx) |
|---|
| EEL | ImGui_EndDragDropSource(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_EndDragDropSource", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_EndDragDropSource(ImGui_Context ctx) |
|---|
| Python | ImGui_EndDragDropSource(ImGui_Context ctx) |
|---|
Only call EndDragDropSource() if BeginDragDropSource returns true!
View source
Function: EndDragDropTarget
| C++ | void ImGui_EndDragDropTarget(ImGui_Context* ctx) |
|---|
| EEL | ImGui_EndDragDropTarget(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_EndDragDropTarget", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_EndDragDropTarget(ImGui_Context ctx) |
|---|
| Python | ImGui_EndDragDropTarget(ImGui_Context ctx) |
|---|
Only call EndDragDropTarget() if BeginDragDropTarget returns true!
View source
Function: GetDragDropPayload
| C++ | bool ImGui_GetDragDropPayload(ImGui_Context* ctx, char* typeOut, int typeOut_sz, char* payloadOutNeedBig, int payloadOutNeedBig_sz, bool* is_previewOut, bool* is_deliveryOut) |
|---|
| EEL | bool ImGui_GetDragDropPayload(ImGui_Context ctx, #type, #payload, bool &is_preview, bool &is_delivery) |
|---|
| Legacy EEL | bool extension_api("ImGui_GetDragDropPayload", ImGui_Context ctx, #type, #payload, bool &is_preview, bool &is_delivery) |
|---|
| Lua | boolean retval, string type, string payload, boolean is_preview, boolean is_delivery = reaper.ImGui_GetDragDropPayload(ImGui_Context ctx) |
|---|
| Python | (bool retval, str type, str payload, bool is_preview, bool is_delivery) = ImGui_GetDragDropPayload(ImGui_Context ctx) |
|---|
Peek directly into the current payload from anywhere.
View source
Function: GetDragDropPayloadFile
| C++ | bool ImGui_GetDragDropPayloadFile(ImGui_Context* ctx, int index, char* filenameOut, int filenameOut_sz) |
|---|
| EEL | bool ImGui_GetDragDropPayloadFile(ImGui_Context ctx, int index, #filename) |
|---|
| Legacy EEL | bool extension_api("ImGui_GetDragDropPayloadFile", ImGui_Context ctx, int index, #filename) |
|---|
| Lua | boolean retval, string filename = reaper.ImGui_GetDragDropPayloadFile(ImGui_Context ctx, number index) |
|---|
| Python | (bool retval, str filename) = ImGui_GetDragDropPayloadFile(ImGui_Context ctx, int index) |
|---|
Get a filename from the list of dropped files.
Returns false if index is out of bounds.
View source
Function: SetDragDropPayload
| C++ | bool ImGui_SetDragDropPayload(ImGui_Context* ctx, const char* type, const char* data, int* condInOptional = Cond_Always) |
|---|
| EEL | bool ImGui_SetDragDropPayload(ImGui_Context ctx, "type", "data", int cond = Cond_Always) |
|---|
| Legacy EEL | bool extension_api("ImGui_SetDragDropPayload", ImGui_Context ctx, "type", "data", int cond = Cond_Always) |
|---|
| Lua | boolean retval = reaper.ImGui_SetDragDropPayload(ImGui_Context ctx, string type, string data, number cond = Cond_Always) |
|---|
| Python | bool retval = ImGui_SetDragDropPayload(ImGui_Context ctx, str type, str data, int cond = Cond_Always) |
|---|
The type is a user defined string of maximum 32 characters.
Strings starting with '_' are reserved for dear imgui internal types.
Data is copied and held by imgui.
View source
Flags
Constant: DragDropFlags_None
| C++ | int ImGui_DragDropFlags_None |
|---|
| EEL | int ImGui_DragDropFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_DragDropFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_DragDropFlags_None() |
|---|
| Python | int retval = ImGui_DragDropFlags_None() |
|---|
View source
Payload
For AcceptDragDropPayload
Constant: DragDropFlags_AcceptBeforeDelivery
| C++ | int ImGui_DragDropFlags_AcceptBeforeDelivery |
|---|
| EEL | int ImGui_DragDropFlags_AcceptBeforeDelivery() |
|---|
| Legacy EEL | int extension_api("ImGui_DragDropFlags_AcceptBeforeDelivery") |
|---|
| Lua | number retval = reaper.ImGui_DragDropFlags_AcceptBeforeDelivery() |
|---|
| Python | int retval = ImGui_DragDropFlags_AcceptBeforeDelivery() |
|---|
AcceptDragDropPayload will returns true even before the mouse button is
released. You can then check GetDragDropPayload/is_delivery to test if the
payload needs to be delivered.
View source
Constant: DragDropFlags_AcceptNoDrawDefaultRect
| C++ | int ImGui_DragDropFlags_AcceptNoDrawDefaultRect |
|---|
| EEL | int ImGui_DragDropFlags_AcceptNoDrawDefaultRect() |
|---|
| Legacy EEL | int extension_api("ImGui_DragDropFlags_AcceptNoDrawDefaultRect") |
|---|
| Lua | number retval = reaper.ImGui_DragDropFlags_AcceptNoDrawDefaultRect() |
|---|
| Python | int retval = ImGui_DragDropFlags_AcceptNoDrawDefaultRect() |
|---|
Do not draw the default highlight rectangle when hovering over target.
View source
Constant: DragDropFlags_AcceptNoPreviewTooltip
| C++ | int ImGui_DragDropFlags_AcceptNoPreviewTooltip |
|---|
| EEL | int ImGui_DragDropFlags_AcceptNoPreviewTooltip() |
|---|
| Legacy EEL | int extension_api("ImGui_DragDropFlags_AcceptNoPreviewTooltip") |
|---|
| Lua | number retval = reaper.ImGui_DragDropFlags_AcceptNoPreviewTooltip() |
|---|
| Python | int retval = ImGui_DragDropFlags_AcceptNoPreviewTooltip() |
|---|
Request hiding the BeginDragDropSource tooltip from the BeginDragDropTarget site.
View source
Constant: DragDropFlags_AcceptPeekOnly
| C++ | int ImGui_DragDropFlags_AcceptPeekOnly |
|---|
| EEL | int ImGui_DragDropFlags_AcceptPeekOnly() |
|---|
| Legacy EEL | int extension_api("ImGui_DragDropFlags_AcceptPeekOnly") |
|---|
| Lua | number retval = reaper.ImGui_DragDropFlags_AcceptPeekOnly() |
|---|
| Python | int retval = ImGui_DragDropFlags_AcceptPeekOnly() |
|---|
For peeking ahead and inspecting the payload before delivery.
Equivalent to DragDropFlags_AcceptBeforeDelivery |
DragDropFlags_AcceptNoDrawDefaultRect.
View source
Source
For BeginDragDropSource
Constant: DragDropFlags_SourceAllowNullID
| C++ | int ImGui_DragDropFlags_SourceAllowNullID |
|---|
| EEL | int ImGui_DragDropFlags_SourceAllowNullID() |
|---|
| Legacy EEL | int extension_api("ImGui_DragDropFlags_SourceAllowNullID") |
|---|
| Lua | number retval = reaper.ImGui_DragDropFlags_SourceAllowNullID() |
|---|
| Python | int retval = ImGui_DragDropFlags_SourceAllowNullID() |
|---|
Allow items such as Text, Image that have no unique identifier to be used as
drag source, by manufacturing a temporary identifier based on their
window-relative position. This is extremely unusual within the dear imgui
ecosystem and so we made it explicit.
View source
Constant: DragDropFlags_SourceAutoExpirePayload
| C++ | int ImGui_DragDropFlags_SourceAutoExpirePayload |
|---|
| EEL | int ImGui_DragDropFlags_SourceAutoExpirePayload() |
|---|
| Legacy EEL | int extension_api("ImGui_DragDropFlags_SourceAutoExpirePayload") |
|---|
| Lua | number retval = reaper.ImGui_DragDropFlags_SourceAutoExpirePayload() |
|---|
| Python | int retval = ImGui_DragDropFlags_SourceAutoExpirePayload() |
|---|
Automatically expire the payload if the source cease to be submitted
(otherwise payloads are persisting while being dragged).
View source
Constant: DragDropFlags_SourceExtern
| C++ | int ImGui_DragDropFlags_SourceExtern |
|---|
| EEL | int ImGui_DragDropFlags_SourceExtern() |
|---|
| Legacy EEL | int extension_api("ImGui_DragDropFlags_SourceExtern") |
|---|
| Lua | number retval = reaper.ImGui_DragDropFlags_SourceExtern() |
|---|
| Python | int retval = ImGui_DragDropFlags_SourceExtern() |
|---|
External source (from outside of dear imgui), won't attempt to read current
item/window info. Will always return true.
Only one Extern source can be active simultaneously.
View source
Constant: DragDropFlags_SourceNoDisableHover
| C++ | int ImGui_DragDropFlags_SourceNoDisableHover |
|---|
| EEL | int ImGui_DragDropFlags_SourceNoDisableHover() |
|---|
| Legacy EEL | int extension_api("ImGui_DragDropFlags_SourceNoDisableHover") |
|---|
| Lua | number retval = reaper.ImGui_DragDropFlags_SourceNoDisableHover() |
|---|
| Python | int retval = ImGui_DragDropFlags_SourceNoDisableHover() |
|---|
By default, when dragging we clear data so that IsItemHovered will return
false, to avoid subsequent user code submitting tooltips. This flag disables
this behavior so you can still call IsItemHovered on the source item.
View source
Constant: DragDropFlags_SourceNoHoldToOpenOthers
| C++ | int ImGui_DragDropFlags_SourceNoHoldToOpenOthers |
|---|
| EEL | int ImGui_DragDropFlags_SourceNoHoldToOpenOthers() |
|---|
| Legacy EEL | int extension_api("ImGui_DragDropFlags_SourceNoHoldToOpenOthers") |
|---|
| Lua | number retval = reaper.ImGui_DragDropFlags_SourceNoHoldToOpenOthers() |
|---|
| Python | int retval = ImGui_DragDropFlags_SourceNoHoldToOpenOthers() |
|---|
Disable the behavior that allows to open tree nodes and collapsing header by
holding over them while dragging a source item.
View source
Constant: DragDropFlags_SourceNoPreviewTooltip
| C++ | int ImGui_DragDropFlags_SourceNoPreviewTooltip |
|---|
| EEL | int ImGui_DragDropFlags_SourceNoPreviewTooltip() |
|---|
| Legacy EEL | int extension_api("ImGui_DragDropFlags_SourceNoPreviewTooltip") |
|---|
| Lua | number retval = reaper.ImGui_DragDropFlags_SourceNoPreviewTooltip() |
|---|
| Python | int retval = ImGui_DragDropFlags_SourceNoPreviewTooltip() |
|---|
By default, a successful call to BeginDragDropSource opens a tooltip so you
can display a preview or description of the source contents.
This flag disables this behavior.
View source
Drag & Slider
We use the same sets of flags for Drag*() and Slider*() functions as the
features are the same and it makes it easier to swap them.
CTRL+Click on any drag box or slider to turn them into an input box.
Manually input values aren't clamped by default and can go off-bounds.
Use SliderFlags_AlwaysClamp to always clamp.
Adjust format string to decorate the value with a prefix, a suffix, or adapt the
editing and display precision e.g. "%.3f" -> 1.234; "%5.2f secs" -> 01.23 secs;
"Biscuit: %.0f" -> Biscuit: 1; etc.
Format string may also be set to nil or use the default format ("%f" or "%d").
Drag Sliders
Speed are per-pixel of mouse movement (v_speed=0.2: mouse needs to move by 5
pixels to increase value by 1). For gamepad/keyboard navigation, minimum speed
is Max(v_speed, minimum_step_at_given_precision).
Use v_min < v_max to clamp edits to given limits. Note that CTRL+Click manual
input can override those limits if SliderFlags_AlwaysClamp is not used.
Use v_max = FLT_MAX / INT_MAX etc to avoid clamping to a maximum, same with
v_min = -FLT_MAX / INT_MIN to avoid clamping to a minimum.
Function: DragDouble
| C++ | bool ImGui_DragDouble(ImGui_Context* ctx, const char* label, double* vInOut, double* v_speedInOptional = 1.0, double* v_minInOptional = 0.0, double* v_maxInOptional = 0.0, const char* formatInOptional = "%.3f", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_DragDouble(ImGui_Context ctx, "label", &v, v_speed = 1.0, v_min = 0.0, v_max = 0.0, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_DragDouble", ImGui_Context ctx, "label", &v, v_speed = 1.0, v_min = 0.0, v_max = 0.0, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v = reaper.ImGui_DragDouble(ImGui_Context ctx, string label, number v, number v_speed = 1.0, number v_min = 0.0, number v_max = 0.0, string format = "%.3f", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, float v) = ImGui_DragDouble(ImGui_Context ctx, str label, float v, float v_speed = 1.0, float v_min = 0.0, float v_max = 0.0, str format = "%.3f", int flags = SliderFlags_None) |
|---|
View source
Function: DragDouble2
| C++ | bool ImGui_DragDouble2(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v_speedInOptional = 1.0, double* v_minInOptional = 0.0, double* v_maxInOptional = 0.0, const char* formatInOptional = "%.3f", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_DragDouble2(ImGui_Context ctx, "label", &v1, &v2, v_speed = 1.0, v_min = 0.0, v_max = 0.0, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_DragDouble2", ImGui_Context ctx, "label", &v1, &v2, v_speed = 1.0, v_min = 0.0, v_max = 0.0, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2 = reaper.ImGui_DragDouble2(ImGui_Context ctx, string label, number v1, number v2, number v_speed = 1.0, number v_min = 0.0, number v_max = 0.0, string format = "%.3f", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, float v1, float v2) = ImGui_DragDouble2(ImGui_Context ctx, str label, float v1, float v2, float v_speed = 1.0, float v_min = 0.0, float v_max = 0.0, str format = "%.3f", int flags = SliderFlags_None) |
|---|
View source
Function: DragDouble3
| C++ | bool ImGui_DragDouble3(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, double* v_speedInOptional = 1.0, double* v_minInOptional = 0.0, double* v_maxInOptional = 0.0, const char* formatInOptional = "%.3f", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_DragDouble3(ImGui_Context ctx, "label", &v1, &v2, &v3, v_speed = 1.0, v_min = 0.0, v_max = 0.0, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_DragDouble3", ImGui_Context ctx, "label", &v1, &v2, &v3, v_speed = 1.0, v_min = 0.0, v_max = 0.0, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2, number v3 = reaper.ImGui_DragDouble3(ImGui_Context ctx, string label, number v1, number v2, number v3, number v_speed = 1.0, number v_min = 0.0, number v_max = 0.0, string format = "%.3f", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, float v1, float v2, float v3) = ImGui_DragDouble3(ImGui_Context ctx, str label, float v1, float v2, float v3, float v_speed = 1.0, float v_min = 0.0, float v_max = 0.0, str format = "%.3f", int flags = SliderFlags_None) |
|---|
View source
Function: DragDouble4
| C++ | bool ImGui_DragDouble4(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, double* v4InOut, double* v_speedInOptional = 1.0, double* v_minInOptional = 0.0, double* v_maxInOptional = 0.0, const char* formatInOptional = "%.3f", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_DragDouble4(ImGui_Context ctx, "label", &v1, &v2, &v3, &v4, v_speed = 1.0, v_min = 0.0, v_max = 0.0, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_DragDouble4", ImGui_Context ctx, "label", &v1, &v2, &v3, &v4, v_speed = 1.0, v_min = 0.0, v_max = 0.0, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2, number v3, number v4 = reaper.ImGui_DragDouble4(ImGui_Context ctx, string label, number v1, number v2, number v3, number v4, number v_speed = 1.0, number v_min = 0.0, number v_max = 0.0, string format = "%.3f", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, float v1, float v2, float v3, float v4) = ImGui_DragDouble4(ImGui_Context ctx, str label, float v1, float v2, float v3, float v4, float v_speed = 1.0, float v_min = 0.0, float v_max = 0.0, str format = "%.3f", int flags = SliderFlags_None) |
|---|
View source
Function: DragDoubleN
| C++ | bool ImGui_DragDoubleN(ImGui_Context* ctx, const char* label, reaper_array* values, double* speedInOptional = 1.0, double* minInOptional = 0.0, double* maxInOptional = 0.0, const char* formatInOptional = "%.3f", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_DragDoubleN(ImGui_Context ctx, "label", reaper_array values, speed = 1.0, min = 0.0, max = 0.0, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_DragDoubleN", ImGui_Context ctx, "label", reaper_array values, speed = 1.0, min = 0.0, max = 0.0, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval = reaper.ImGui_DragDoubleN(ImGui_Context ctx, string label, reaper_array values, number speed = 1.0, number min = 0.0, number max = 0.0, string format = "%.3f", number flags = SliderFlags_None) |
|---|
| Python | bool retval = ImGui_DragDoubleN(ImGui_Context ctx, str label, reaper_array values, float speed = 1.0, float min = 0.0, float max = 0.0, str format = "%.3f", int flags = SliderFlags_None) |
|---|
View source
Function: DragFloatRange2
| C++ | bool ImGui_DragFloatRange2(ImGui_Context* ctx, const char* label, double* v_current_minInOut, double* v_current_maxInOut, double* v_speedInOptional = 1.0, double* v_minInOptional = 0.0, double* v_maxInOptional = 0.0, const char* formatInOptional = "%.3f", const char* format_maxInOptional = nullptr, int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_DragFloatRange2(ImGui_Context ctx, "label", &v_current_min, &v_current_max, v_speed = 1.0, v_min = 0.0, v_max = 0.0, "format" = "%.3f", "format_max" = nullptr, int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_DragFloatRange2", ImGui_Context ctx, "label", &v_current_min, &v_current_max, v_speed = 1.0, v_min = 0.0, v_max = 0.0, "format" = "%.3f", "format_max" = nullptr, int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v_current_min, number v_current_max = reaper.ImGui_DragFloatRange2(ImGui_Context ctx, string label, number v_current_min, number v_current_max, number v_speed = 1.0, number v_min = 0.0, number v_max = 0.0, string format = "%.3f", string format_max = nullptr, number flags = SliderFlags_None) |
|---|
| Python | (bool retval, float v_current_min, float v_current_max) = ImGui_DragFloatRange2(ImGui_Context ctx, str label, float v_current_min, float v_current_max, float v_speed = 1.0, float v_min = 0.0, float v_max = 0.0, str format = "%.3f", str format_max = nullptr, int flags = SliderFlags_None) |
|---|
View source
Function: DragInt
| C++ | bool ImGui_DragInt(ImGui_Context* ctx, const char* label, int* vInOut, double* v_speedInOptional = 1.0, int* v_minInOptional = 0, int* v_maxInOptional = 0, const char* formatInOptional = "%d", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_DragInt(ImGui_Context ctx, "label", int &v, v_speed = 1.0, int v_min = 0, int v_max = 0, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_DragInt", ImGui_Context ctx, "label", int &v, v_speed = 1.0, int v_min = 0, int v_max = 0, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v = reaper.ImGui_DragInt(ImGui_Context ctx, string label, number v, number v_speed = 1.0, number v_min = 0, number v_max = 0, string format = "%d", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, int v) = ImGui_DragInt(ImGui_Context ctx, str label, int v, float v_speed = 1.0, int v_min = 0, int v_max = 0, str format = "%d", int flags = SliderFlags_None) |
|---|
View source
Function: DragInt2
| C++ | bool ImGui_DragInt2(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, double* v_speedInOptional = 1.0, int* v_minInOptional = 0, int* v_maxInOptional = 0, const char* formatInOptional = "%d", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_DragInt2(ImGui_Context ctx, "label", int &v1, int &v2, v_speed = 1.0, int v_min = 0, int v_max = 0, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_DragInt2", ImGui_Context ctx, "label", int &v1, int &v2, v_speed = 1.0, int v_min = 0, int v_max = 0, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2 = reaper.ImGui_DragInt2(ImGui_Context ctx, string label, number v1, number v2, number v_speed = 1.0, number v_min = 0, number v_max = 0, string format = "%d", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, int v1, int v2) = ImGui_DragInt2(ImGui_Context ctx, str label, int v1, int v2, float v_speed = 1.0, int v_min = 0, int v_max = 0, str format = "%d", int flags = SliderFlags_None) |
|---|
View source
Function: DragInt3
| C++ | bool ImGui_DragInt3(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, double* v_speedInOptional = 1.0, int* v_minInOptional = 0, int* v_maxInOptional = 0, const char* formatInOptional = "%d", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_DragInt3(ImGui_Context ctx, "label", int &v1, int &v2, int &v3, v_speed = 1.0, int v_min = 0, int v_max = 0, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_DragInt3", ImGui_Context ctx, "label", int &v1, int &v2, int &v3, v_speed = 1.0, int v_min = 0, int v_max = 0, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2, number v3 = reaper.ImGui_DragInt3(ImGui_Context ctx, string label, number v1, number v2, number v3, number v_speed = 1.0, number v_min = 0, number v_max = 0, string format = "%d", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, int v1, int v2, int v3) = ImGui_DragInt3(ImGui_Context ctx, str label, int v1, int v2, int v3, float v_speed = 1.0, int v_min = 0, int v_max = 0, str format = "%d", int flags = SliderFlags_None) |
|---|
View source
Function: DragInt4
| C++ | bool ImGui_DragInt4(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, int* v4InOut, double* v_speedInOptional = 1.0, int* v_minInOptional = 0, int* v_maxInOptional = 0, const char* formatInOptional = "%d", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_DragInt4(ImGui_Context ctx, "label", int &v1, int &v2, int &v3, int &v4, v_speed = 1.0, int v_min = 0, int v_max = 0, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_DragInt4", ImGui_Context ctx, "label", int &v1, int &v2, int &v3, int &v4, v_speed = 1.0, int v_min = 0, int v_max = 0, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2, number v3, number v4 = reaper.ImGui_DragInt4(ImGui_Context ctx, string label, number v1, number v2, number v3, number v4, number v_speed = 1.0, number v_min = 0, number v_max = 0, string format = "%d", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, int v1, int v2, int v3, int v4) = ImGui_DragInt4(ImGui_Context ctx, str label, int v1, int v2, int v3, int v4, float v_speed = 1.0, int v_min = 0, int v_max = 0, str format = "%d", int flags = SliderFlags_None) |
|---|
View source
Function: DragIntRange2
| C++ | bool ImGui_DragIntRange2(ImGui_Context* ctx, const char* label, int* v_current_minInOut, int* v_current_maxInOut, double* v_speedInOptional = 1.0, int* v_minInOptional = 0, int* v_maxInOptional = 0, const char* formatInOptional = "%d", const char* format_maxInOptional = nullptr, int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_DragIntRange2(ImGui_Context ctx, "label", int &v_current_min, int &v_current_max, v_speed = 1.0, int v_min = 0, int v_max = 0, "format" = "%d", "format_max" = nullptr, int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_DragIntRange2", ImGui_Context ctx, "label", int &v_current_min, int &v_current_max, v_speed = 1.0, int v_min = 0, int v_max = 0, "format" = "%d", "format_max" = nullptr, int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v_current_min, number v_current_max = reaper.ImGui_DragIntRange2(ImGui_Context ctx, string label, number v_current_min, number v_current_max, number v_speed = 1.0, number v_min = 0, number v_max = 0, string format = "%d", string format_max = nullptr, number flags = SliderFlags_None) |
|---|
| Python | (bool retval, int v_current_min, int v_current_max) = ImGui_DragIntRange2(ImGui_Context ctx, str label, int v_current_min, int v_current_max, float v_speed = 1.0, int v_min = 0, int v_max = 0, str format = "%d", str format_max = nullptr, int flags = SliderFlags_None) |
|---|
View source
Flags
For DragDouble, DragInt, SliderDouble, SliderInt etc. (Those are per-item
flags. There are shared flags in SetConfigVar: ConfigVar_DragClickToInputText
Constant: SliderFlags_AlwaysClamp
| C++ | int ImGui_SliderFlags_AlwaysClamp |
|---|
| EEL | int ImGui_SliderFlags_AlwaysClamp() |
|---|
| Legacy EEL | int extension_api("ImGui_SliderFlags_AlwaysClamp") |
|---|
| Lua | number retval = reaper.ImGui_SliderFlags_AlwaysClamp() |
|---|
| Python | int retval = ImGui_SliderFlags_AlwaysClamp() |
|---|
Clamp value to min/max bounds when input manually with CTRL+Click.
By default CTRL+Click allows going out of bounds.
View source
Constant: SliderFlags_Logarithmic
| C++ | int ImGui_SliderFlags_Logarithmic |
|---|
| EEL | int ImGui_SliderFlags_Logarithmic() |
|---|
| Legacy EEL | int extension_api("ImGui_SliderFlags_Logarithmic") |
|---|
| Lua | number retval = reaper.ImGui_SliderFlags_Logarithmic() |
|---|
| Python | int retval = ImGui_SliderFlags_Logarithmic() |
|---|
Make the widget logarithmic (linear otherwise).
Consider using SliderFlags_NoRoundToFormat with this if using a format-string
with small amount of digits.
View source
Constant: SliderFlags_NoInput
| C++ | int ImGui_SliderFlags_NoInput |
|---|
| EEL | int ImGui_SliderFlags_NoInput() |
|---|
| Legacy EEL | int extension_api("ImGui_SliderFlags_NoInput") |
|---|
| Lua | number retval = reaper.ImGui_SliderFlags_NoInput() |
|---|
| Python | int retval = ImGui_SliderFlags_NoInput() |
|---|
Disable CTRL+Click or Enter key allowing to input text directly into the widget.
View source
Constant: SliderFlags_NoRoundToFormat
| C++ | int ImGui_SliderFlags_NoRoundToFormat |
|---|
| EEL | int ImGui_SliderFlags_NoRoundToFormat() |
|---|
| Legacy EEL | int extension_api("ImGui_SliderFlags_NoRoundToFormat") |
|---|
| Lua | number retval = reaper.ImGui_SliderFlags_NoRoundToFormat() |
|---|
| Python | int retval = ImGui_SliderFlags_NoRoundToFormat() |
|---|
Disable rounding underlying value to match precision of the display format
string (e.g. %.3f values are rounded to those 3 digits).
View source
Constant: SliderFlags_None
| C++ | int ImGui_SliderFlags_None |
|---|
| EEL | int ImGui_SliderFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_SliderFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_SliderFlags_None() |
|---|
| Python | int retval = ImGui_SliderFlags_None() |
|---|
View source
Regular Sliders
Function: SliderAngle
| C++ | bool ImGui_SliderAngle(ImGui_Context* ctx, const char* label, double* v_radInOut, double* v_degrees_minInOptional = -360.0, double* v_degrees_maxInOptional = +360.0, const char* formatInOptional = "%.0f deg", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_SliderAngle(ImGui_Context ctx, "label", &v_rad, v_degrees_min = -360.0, v_degrees_max = +360.0, "format" = "%.0f deg", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_SliderAngle", ImGui_Context ctx, "label", &v_rad, v_degrees_min = -360.0, v_degrees_max = +360.0, "format" = "%.0f deg", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v_rad = reaper.ImGui_SliderAngle(ImGui_Context ctx, string label, number v_rad, number v_degrees_min = -360.0, number v_degrees_max = +360.0, string format = "%.0f deg", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, float v_rad) = ImGui_SliderAngle(ImGui_Context ctx, str label, float v_rad, float v_degrees_min = -360.0, float v_degrees_max = +360.0, str format = "%.0f deg", int flags = SliderFlags_None) |
|---|
View source
Function: SliderDouble
| C++ | bool ImGui_SliderDouble(ImGui_Context* ctx, const char* label, double* vInOut, double v_min, double v_max, const char* formatInOptional = "%.3f", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_SliderDouble(ImGui_Context ctx, "label", &v, v_min, v_max, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_SliderDouble", ImGui_Context ctx, "label", &v, v_min, v_max, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v = reaper.ImGui_SliderDouble(ImGui_Context ctx, string label, number v, number v_min, number v_max, string format = "%.3f", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, float v) = ImGui_SliderDouble(ImGui_Context ctx, str label, float v, float v_min, float v_max, str format = "%.3f", int flags = SliderFlags_None) |
|---|
View source
Function: SliderDouble2
| C++ | bool ImGui_SliderDouble2(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double v_min, double v_max, const char* formatInOptional = "%.3f", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_SliderDouble2(ImGui_Context ctx, "label", &v1, &v2, v_min, v_max, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_SliderDouble2", ImGui_Context ctx, "label", &v1, &v2, v_min, v_max, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2 = reaper.ImGui_SliderDouble2(ImGui_Context ctx, string label, number v1, number v2, number v_min, number v_max, string format = "%.3f", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, float v1, float v2) = ImGui_SliderDouble2(ImGui_Context ctx, str label, float v1, float v2, float v_min, float v_max, str format = "%.3f", int flags = SliderFlags_None) |
|---|
View source
Function: SliderDouble3
| C++ | bool ImGui_SliderDouble3(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, double v_min, double v_max, const char* formatInOptional = "%.3f", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_SliderDouble3(ImGui_Context ctx, "label", &v1, &v2, &v3, v_min, v_max, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_SliderDouble3", ImGui_Context ctx, "label", &v1, &v2, &v3, v_min, v_max, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2, number v3 = reaper.ImGui_SliderDouble3(ImGui_Context ctx, string label, number v1, number v2, number v3, number v_min, number v_max, string format = "%.3f", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, float v1, float v2, float v3) = ImGui_SliderDouble3(ImGui_Context ctx, str label, float v1, float v2, float v3, float v_min, float v_max, str format = "%.3f", int flags = SliderFlags_None) |
|---|
View source
Function: SliderDouble4
| C++ | bool ImGui_SliderDouble4(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, double* v4InOut, double v_min, double v_max, const char* formatInOptional = "%.3f", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_SliderDouble4(ImGui_Context ctx, "label", &v1, &v2, &v3, &v4, v_min, v_max, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_SliderDouble4", ImGui_Context ctx, "label", &v1, &v2, &v3, &v4, v_min, v_max, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2, number v3, number v4 = reaper.ImGui_SliderDouble4(ImGui_Context ctx, string label, number v1, number v2, number v3, number v4, number v_min, number v_max, string format = "%.3f", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, float v1, float v2, float v3, float v4) = ImGui_SliderDouble4(ImGui_Context ctx, str label, float v1, float v2, float v3, float v4, float v_min, float v_max, str format = "%.3f", int flags = SliderFlags_None) |
|---|
View source
Function: SliderDoubleN
| C++ | bool ImGui_SliderDoubleN(ImGui_Context* ctx, const char* label, reaper_array* values, double v_min, double v_max, const char* formatInOptional = "%.3f", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_SliderDoubleN(ImGui_Context ctx, "label", reaper_array values, v_min, v_max, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_SliderDoubleN", ImGui_Context ctx, "label", reaper_array values, v_min, v_max, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval = reaper.ImGui_SliderDoubleN(ImGui_Context ctx, string label, reaper_array values, number v_min, number v_max, string format = "%.3f", number flags = SliderFlags_None) |
|---|
| Python | bool retval = ImGui_SliderDoubleN(ImGui_Context ctx, str label, reaper_array values, float v_min, float v_max, str format = "%.3f", int flags = SliderFlags_None) |
|---|
View source
Function: SliderInt
| C++ | bool ImGui_SliderInt(ImGui_Context* ctx, const char* label, int* vInOut, int v_min, int v_max, const char* formatInOptional = "%d", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_SliderInt(ImGui_Context ctx, "label", int &v, int v_min, int v_max, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_SliderInt", ImGui_Context ctx, "label", int &v, int v_min, int v_max, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v = reaper.ImGui_SliderInt(ImGui_Context ctx, string label, number v, number v_min, number v_max, string format = "%d", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, int v) = ImGui_SliderInt(ImGui_Context ctx, str label, int v, int v_min, int v_max, str format = "%d", int flags = SliderFlags_None) |
|---|
View source
Function: SliderInt2
| C++ | bool ImGui_SliderInt2(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int v_min, int v_max, const char* formatInOptional = "%d", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_SliderInt2(ImGui_Context ctx, "label", int &v1, int &v2, int v_min, int v_max, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_SliderInt2", ImGui_Context ctx, "label", int &v1, int &v2, int v_min, int v_max, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2 = reaper.ImGui_SliderInt2(ImGui_Context ctx, string label, number v1, number v2, number v_min, number v_max, string format = "%d", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, int v1, int v2) = ImGui_SliderInt2(ImGui_Context ctx, str label, int v1, int v2, int v_min, int v_max, str format = "%d", int flags = SliderFlags_None) |
|---|
View source
Function: SliderInt3
| C++ | bool ImGui_SliderInt3(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, int v_min, int v_max, const char* formatInOptional = "%d", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_SliderInt3(ImGui_Context ctx, "label", int &v1, int &v2, int &v3, int v_min, int v_max, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_SliderInt3", ImGui_Context ctx, "label", int &v1, int &v2, int &v3, int v_min, int v_max, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2, number v3 = reaper.ImGui_SliderInt3(ImGui_Context ctx, string label, number v1, number v2, number v3, number v_min, number v_max, string format = "%d", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, int v1, int v2, int v3) = ImGui_SliderInt3(ImGui_Context ctx, str label, int v1, int v2, int v3, int v_min, int v_max, str format = "%d", int flags = SliderFlags_None) |
|---|
View source
Function: SliderInt4
| C++ | bool ImGui_SliderInt4(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, int* v4InOut, int v_min, int v_max, const char* formatInOptional = "%d", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_SliderInt4(ImGui_Context ctx, "label", int &v1, int &v2, int &v3, int &v4, int v_min, int v_max, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_SliderInt4", ImGui_Context ctx, "label", int &v1, int &v2, int &v3, int &v4, int v_min, int v_max, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2, number v3, number v4 = reaper.ImGui_SliderInt4(ImGui_Context ctx, string label, number v1, number v2, number v3, number v4, number v_min, number v_max, string format = "%d", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, int v1, int v2, int v3, int v4) = ImGui_SliderInt4(ImGui_Context ctx, str label, int v1, int v2, int v3, int v4, int v_min, int v_max, str format = "%d", int flags = SliderFlags_None) |
|---|
View source
Function: VSliderDouble
| C++ | bool ImGui_VSliderDouble(ImGui_Context* ctx, const char* label, double size_w, double size_h, double* vInOut, double v_min, double v_max, const char* formatInOptional = "%.3f", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_VSliderDouble(ImGui_Context ctx, "label", size_w, size_h, &v, v_min, v_max, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_VSliderDouble", ImGui_Context ctx, "label", size_w, size_h, &v, v_min, v_max, "format" = "%.3f", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v = reaper.ImGui_VSliderDouble(ImGui_Context ctx, string label, number size_w, number size_h, number v, number v_min, number v_max, string format = "%.3f", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, float v) = ImGui_VSliderDouble(ImGui_Context ctx, str label, float size_w, float size_h, float v, float v_min, float v_max, str format = "%.3f", int flags = SliderFlags_None) |
|---|
View source
Function: VSliderInt
| C++ | bool ImGui_VSliderInt(ImGui_Context* ctx, const char* label, double size_w, double size_h, int* vInOut, int v_min, int v_max, const char* formatInOptional = "%d", int* flagsInOptional = SliderFlags_None) |
|---|
| EEL | bool ImGui_VSliderInt(ImGui_Context ctx, "label", size_w, size_h, int &v, int v_min, int v_max, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_VSliderInt", ImGui_Context ctx, "label", size_w, size_h, int &v, int v_min, int v_max, "format" = "%d", int flags = SliderFlags_None) |
|---|
| Lua | boolean retval, number v = reaper.ImGui_VSliderInt(ImGui_Context ctx, string label, number size_w, number size_h, number v, number v_min, number v_max, string format = "%d", number flags = SliderFlags_None) |
|---|
| Python | (bool retval, int v) = ImGui_VSliderInt(ImGui_Context ctx, str label, float size_w, float size_h, int v, int v_min, int v_max, str format = "%d", int flags = SliderFlags_None) |
|---|
View source
Draw List
This is the low-level list of polygons that ImGui functions are filling.
At the end of the frame, all draw lists are passed to the GPU for rendering.
Each dear imgui window contains its own Draw List.
You can use GetWindowDrawList() to access the current window draw list and draw
custom primitives.
The Draw List API uses absolute coordinates (0,0 is the top-left corner of the
rimary monitor, not of your window!). See GetCursorScreenPos.
Constant: DrawFlags_Closed
| C++ | int ImGui_DrawFlags_Closed |
|---|
| EEL | int ImGui_DrawFlags_Closed() |
|---|
| Legacy EEL | int extension_api("ImGui_DrawFlags_Closed") |
|---|
| Lua | number retval = reaper.ImGui_DrawFlags_Closed() |
|---|
| Python | int retval = ImGui_DrawFlags_Closed() |
|---|
DrawList_PathStroke, DrawList_AddPolyline: specify that shape should be
closed (Important: this is always == 1 for legacy reason).
View source
Constant: DrawFlags_None
| C++ | int ImGui_DrawFlags_None |
|---|
| EEL | int ImGui_DrawFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_DrawFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_DrawFlags_None() |
|---|
| Python | int retval = ImGui_DrawFlags_None() |
|---|
View source
Constant: DrawFlags_RoundCornersAll
| C++ | int ImGui_DrawFlags_RoundCornersAll |
|---|
| EEL | int ImGui_DrawFlags_RoundCornersAll() |
|---|
| Legacy EEL | int extension_api("ImGui_DrawFlags_RoundCornersAll") |
|---|
| Lua | number retval = reaper.ImGui_DrawFlags_RoundCornersAll() |
|---|
| Python | int retval = ImGui_DrawFlags_RoundCornersAll() |
|---|
View source
Constant: DrawFlags_RoundCornersBottom
| C++ | int ImGui_DrawFlags_RoundCornersBottom |
|---|
| EEL | int ImGui_DrawFlags_RoundCornersBottom() |
|---|
| Legacy EEL | int extension_api("ImGui_DrawFlags_RoundCornersBottom") |
|---|
| Lua | number retval = reaper.ImGui_DrawFlags_RoundCornersBottom() |
|---|
| Python | int retval = ImGui_DrawFlags_RoundCornersBottom() |
|---|
View source
Constant: DrawFlags_RoundCornersBottomLeft
| C++ | int ImGui_DrawFlags_RoundCornersBottomLeft |
|---|
| EEL | int ImGui_DrawFlags_RoundCornersBottomLeft() |
|---|
| Legacy EEL | int extension_api("ImGui_DrawFlags_RoundCornersBottomLeft") |
|---|
| Lua | number retval = reaper.ImGui_DrawFlags_RoundCornersBottomLeft() |
|---|
| Python | int retval = ImGui_DrawFlags_RoundCornersBottomLeft() |
|---|
DrawList_AddRect, DrawList_AddRectFilled, DrawList_PathRect: enable rounding
bottom-left corner only (when rounding > 0.0, we default to all corners).
View source
Constant: DrawFlags_RoundCornersBottomRight
| C++ | int ImGui_DrawFlags_RoundCornersBottomRight |
|---|
| EEL | int ImGui_DrawFlags_RoundCornersBottomRight() |
|---|
| Legacy EEL | int extension_api("ImGui_DrawFlags_RoundCornersBottomRight") |
|---|
| Lua | number retval = reaper.ImGui_DrawFlags_RoundCornersBottomRight() |
|---|
| Python | int retval = ImGui_DrawFlags_RoundCornersBottomRight() |
|---|
DrawList_AddRect, DrawList_AddRectFilled, DrawList_PathRect: enable rounding
bottom-right corner only (when rounding > 0.0, we default to all corners).
View source
Constant: DrawFlags_RoundCornersLeft
| C++ | int ImGui_DrawFlags_RoundCornersLeft |
|---|
| EEL | int ImGui_DrawFlags_RoundCornersLeft() |
|---|
| Legacy EEL | int extension_api("ImGui_DrawFlags_RoundCornersLeft") |
|---|
| Lua | number retval = reaper.ImGui_DrawFlags_RoundCornersLeft() |
|---|
| Python | int retval = ImGui_DrawFlags_RoundCornersLeft() |
|---|
View source
Constant: DrawFlags_RoundCornersNone
| C++ | int ImGui_DrawFlags_RoundCornersNone |
|---|
| EEL | int ImGui_DrawFlags_RoundCornersNone() |
|---|
| Legacy EEL | int extension_api("ImGui_DrawFlags_RoundCornersNone") |
|---|
| Lua | number retval = reaper.ImGui_DrawFlags_RoundCornersNone() |
|---|
| Python | int retval = ImGui_DrawFlags_RoundCornersNone() |
|---|
DrawList_AddRect, DrawList_AddRectFilled, DrawList_PathRect: disable rounding
on all corners (when rounding > 0.0). This is NOT zero, NOT an implicit flag!.
View source
Constant: DrawFlags_RoundCornersRight
| C++ | int ImGui_DrawFlags_RoundCornersRight |
|---|
| EEL | int ImGui_DrawFlags_RoundCornersRight() |
|---|
| Legacy EEL | int extension_api("ImGui_DrawFlags_RoundCornersRight") |
|---|
| Lua | number retval = reaper.ImGui_DrawFlags_RoundCornersRight() |
|---|
| Python | int retval = ImGui_DrawFlags_RoundCornersRight() |
|---|
View source
Constant: DrawFlags_RoundCornersTop
| C++ | int ImGui_DrawFlags_RoundCornersTop |
|---|
| EEL | int ImGui_DrawFlags_RoundCornersTop() |
|---|
| Legacy EEL | int extension_api("ImGui_DrawFlags_RoundCornersTop") |
|---|
| Lua | number retval = reaper.ImGui_DrawFlags_RoundCornersTop() |
|---|
| Python | int retval = ImGui_DrawFlags_RoundCornersTop() |
|---|
View source
Constant: DrawFlags_RoundCornersTopLeft
| C++ | int ImGui_DrawFlags_RoundCornersTopLeft |
|---|
| EEL | int ImGui_DrawFlags_RoundCornersTopLeft() |
|---|
| Legacy EEL | int extension_api("ImGui_DrawFlags_RoundCornersTopLeft") |
|---|
| Lua | number retval = reaper.ImGui_DrawFlags_RoundCornersTopLeft() |
|---|
| Python | int retval = ImGui_DrawFlags_RoundCornersTopLeft() |
|---|
DrawList_AddRect, DrawList_AddRectFilled, DrawList_PathRect: enable rounding
top-left corner only (when rounding > 0.0, we default to all corners).
View source
Constant: DrawFlags_RoundCornersTopRight
| C++ | int ImGui_DrawFlags_RoundCornersTopRight |
|---|
| EEL | int ImGui_DrawFlags_RoundCornersTopRight() |
|---|
| Legacy EEL | int extension_api("ImGui_DrawFlags_RoundCornersTopRight") |
|---|
| Lua | number retval = reaper.ImGui_DrawFlags_RoundCornersTopRight() |
|---|
| Python | int retval = ImGui_DrawFlags_RoundCornersTopRight() |
|---|
DrawList_AddRect, DrawList_AddRectFilled, DrawList_PathRect: enable rounding
top-right corner only (when rounding > 0.0, we default to all corners).
View source
Function: DrawList_PopClipRect
| C++ | void ImGui_DrawList_PopClipRect(ImGui_DrawList* draw_list) |
|---|
| EEL | ImGui_DrawList_PopClipRect(ImGui_DrawList draw_list) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_PopClipRect", ImGui_DrawList draw_list) |
|---|
| Lua | reaper.ImGui_DrawList_PopClipRect(ImGui_DrawList draw_list) |
|---|
| Python | ImGui_DrawList_PopClipRect(ImGui_DrawList draw_list) |
|---|
See DrawList_PushClipRect
View source
Function: DrawList_PushClipRect
| C++ | void ImGui_DrawList_PushClipRect(ImGui_DrawList* draw_list, double clip_rect_min_x, double clip_rect_min_y, double clip_rect_max_x, double clip_rect_max_y, bool* intersect_with_current_clip_rectInOptional = false) |
|---|
| EEL | ImGui_DrawList_PushClipRect(ImGui_DrawList draw_list, clip_rect_min_x, clip_rect_min_y, clip_rect_max_x, clip_rect_max_y, bool intersect_with_current_clip_rect = false) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_PushClipRect", ImGui_DrawList draw_list, clip_rect_min_x, clip_rect_min_y, clip_rect_max_x, clip_rect_max_y, bool intersect_with_current_clip_rect = false) |
|---|
| Lua | reaper.ImGui_DrawList_PushClipRect(ImGui_DrawList draw_list, number clip_rect_min_x, number clip_rect_min_y, number clip_rect_max_x, number clip_rect_max_y, boolean intersect_with_current_clip_rect = false) |
|---|
| Python | ImGui_DrawList_PushClipRect(ImGui_DrawList draw_list, float clip_rect_min_x, float clip_rect_min_y, float clip_rect_max_x, float clip_rect_max_y, bool intersect_with_current_clip_rect = false) |
|---|
Render-level scissoring. Prefer using higher-level PushClipRect to affect
logic (hit-testing and widget culling).
View source
Function: DrawList_PushClipRectFullScreen
| C++ | void ImGui_DrawList_PushClipRectFullScreen(ImGui_DrawList* draw_list) |
|---|
| EEL | ImGui_DrawList_PushClipRectFullScreen(ImGui_DrawList draw_list) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_PushClipRectFullScreen", ImGui_DrawList draw_list) |
|---|
| Lua | reaper.ImGui_DrawList_PushClipRectFullScreen(ImGui_DrawList draw_list) |
|---|
| Python | ImGui_DrawList_PushClipRectFullScreen(ImGui_DrawList draw_list) |
|---|
View source
Function: GetBackgroundDrawList
| C++ | ImGui_DrawList* ImGui_GetBackgroundDrawList(ImGui_Context* ctx) |
|---|
| EEL | ImGui_DrawList* ImGui_GetBackgroundDrawList(ImGui_Context ctx) |
|---|
| Legacy EEL | ImGui_DrawList* extension_api("ImGui_GetBackgroundDrawList", ImGui_Context ctx) |
|---|
| Lua | ImGui_DrawList retval = reaper.ImGui_GetBackgroundDrawList(ImGui_Context ctx) |
|---|
| Python | ImGui_DrawList retval = ImGui_GetBackgroundDrawList(ImGui_Context ctx) |
|---|
This draw list will be the first rendering one. Useful to quickly draw
shapes/text behind dear imgui contents.
View source
Function: GetForegroundDrawList
| C++ | ImGui_DrawList* ImGui_GetForegroundDrawList(ImGui_Context* ctx) |
|---|
| EEL | ImGui_DrawList* ImGui_GetForegroundDrawList(ImGui_Context ctx) |
|---|
| Legacy EEL | ImGui_DrawList* extension_api("ImGui_GetForegroundDrawList", ImGui_Context ctx) |
|---|
| Lua | ImGui_DrawList retval = reaper.ImGui_GetForegroundDrawList(ImGui_Context ctx) |
|---|
| Python | ImGui_DrawList retval = ImGui_GetForegroundDrawList(ImGui_Context ctx) |
|---|
This draw list will be the last rendered one. Useful to quickly draw
shapes/text over dear imgui contents.
View source
Function: GetWindowDrawList
| C++ | ImGui_DrawList* ImGui_GetWindowDrawList(ImGui_Context* ctx) |
|---|
| EEL | ImGui_DrawList* ImGui_GetWindowDrawList(ImGui_Context ctx) |
|---|
| Legacy EEL | ImGui_DrawList* extension_api("ImGui_GetWindowDrawList", ImGui_Context ctx) |
|---|
| Lua | ImGui_DrawList retval = reaper.ImGui_GetWindowDrawList(ImGui_Context ctx) |
|---|
| Python | ImGui_DrawList retval = ImGui_GetWindowDrawList(ImGui_Context ctx) |
|---|
The draw list associated to the current window, to append your own drawing primitives
View source
Primitives
Filled shapes must always use clockwise winding order. The anti-aliasing
fringe depends on it. Counter-clockwise shapes will have "inward" anti-aliasing.
For rectangular primitives, "p_min" and "p_max" represent the upper-left and
lower-right corners.
For circle primitives, use "num_segments == 0" to automatically calculate
tessellation (preferred).
Function: DrawList_AddBezierCubic
| C++ | void ImGui_DrawList_AddBezierCubic(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, double p4_x, double p4_y, int col_rgba, double thickness, int* num_segmentsInOptional = 0) |
|---|
| EEL | ImGui_DrawList_AddBezierCubic(ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, p4_x, p4_y, int col_rgba, thickness, int num_segments = 0) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddBezierCubic", ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, p4_x, p4_y, int col_rgba, thickness, int num_segments = 0) |
|---|
| Lua | reaper.ImGui_DrawList_AddBezierCubic(ImGui_DrawList draw_list, number p1_x, number p1_y, number p2_x, number p2_y, number p3_x, number p3_y, number p4_x, number p4_y, number col_rgba, number thickness, number num_segments = 0) |
|---|
| Python | ImGui_DrawList_AddBezierCubic(ImGui_DrawList draw_list, float p1_x, float p1_y, float p2_x, float p2_y, float p3_x, float p3_y, float p4_x, float p4_y, int col_rgba, float thickness, int num_segments = 0) |
|---|
Cubic Bezier (4 control points)
View source
Function: DrawList_AddBezierQuadratic
| C++ | void ImGui_DrawList_AddBezierQuadratic(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, int col_rgba, double thickness, int* num_segmentsInOptional = 0) |
|---|
| EEL | ImGui_DrawList_AddBezierQuadratic(ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, int col_rgba, thickness, int num_segments = 0) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddBezierQuadratic", ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, int col_rgba, thickness, int num_segments = 0) |
|---|
| Lua | reaper.ImGui_DrawList_AddBezierQuadratic(ImGui_DrawList draw_list, number p1_x, number p1_y, number p2_x, number p2_y, number p3_x, number p3_y, number col_rgba, number thickness, number num_segments = 0) |
|---|
| Python | ImGui_DrawList_AddBezierQuadratic(ImGui_DrawList draw_list, float p1_x, float p1_y, float p2_x, float p2_y, float p3_x, float p3_y, int col_rgba, float thickness, int num_segments = 0) |
|---|
Quadratic Bezier (3 control points)
View source
Function: DrawList_AddCircle
| C++ | void ImGui_DrawList_AddCircle(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, int col_rgba, int* num_segmentsInOptional = 0, double* thicknessInOptional = 1.0) |
|---|
| EEL | ImGui_DrawList_AddCircle(ImGui_DrawList draw_list, center_x, center_y, radius, int col_rgba, int num_segments = 0, thickness = 1.0) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddCircle", ImGui_DrawList draw_list, center_x, center_y, radius, int col_rgba, int num_segments = 0, thickness = 1.0) |
|---|
| Lua | reaper.ImGui_DrawList_AddCircle(ImGui_DrawList draw_list, number center_x, number center_y, number radius, number col_rgba, number num_segments = 0, number thickness = 1.0) |
|---|
| Python | ImGui_DrawList_AddCircle(ImGui_DrawList draw_list, float center_x, float center_y, float radius, int col_rgba, int num_segments = 0, float thickness = 1.0) |
|---|
Use "num_segments == 0" to automatically calculate tessellation (preferred).
View source
Function: DrawList_AddCircleFilled
| C++ | void ImGui_DrawList_AddCircleFilled(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, int col_rgba, int* num_segmentsInOptional = 0) |
|---|
| EEL | ImGui_DrawList_AddCircleFilled(ImGui_DrawList draw_list, center_x, center_y, radius, int col_rgba, int num_segments = 0) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddCircleFilled", ImGui_DrawList draw_list, center_x, center_y, radius, int col_rgba, int num_segments = 0) |
|---|
| Lua | reaper.ImGui_DrawList_AddCircleFilled(ImGui_DrawList draw_list, number center_x, number center_y, number radius, number col_rgba, number num_segments = 0) |
|---|
| Python | ImGui_DrawList_AddCircleFilled(ImGui_DrawList draw_list, float center_x, float center_y, float radius, int col_rgba, int num_segments = 0) |
|---|
Use "num_segments == 0" to automatically calculate tessellation (preferred).
View source
Function: DrawList_AddConvexPolyFilled
| C++ | void ImGui_DrawList_AddConvexPolyFilled(ImGui_DrawList* draw_list, reaper_array* points, int col_rgba) |
|---|
| EEL | ImGui_DrawList_AddConvexPolyFilled(ImGui_DrawList draw_list, reaper_array points, int col_rgba) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddConvexPolyFilled", ImGui_DrawList draw_list, reaper_array points, int col_rgba) |
|---|
| Lua | reaper.ImGui_DrawList_AddConvexPolyFilled(ImGui_DrawList draw_list, reaper_array points, number col_rgba) |
|---|
| Python | ImGui_DrawList_AddConvexPolyFilled(ImGui_DrawList draw_list, reaper_array points, int col_rgba) |
|---|
Note: Anti-aliased filling requires points to be in clockwise order.
View source
Function: DrawList_AddImage
| C++ | void ImGui_DrawList_AddImage(ImGui_DrawList* draw_list, ImGui_Image* img, double p_min_x, double p_min_y, double p_max_x, double p_max_y, double* uv_min_xInOptional = 0.0, double* uv_min_yInOptional = 0.0, double* uv_max_xInOptional = 1.0, double* uv_max_yInOptional = 1.0, int* col_rgbaInOptional = 0xFFFFFFFF) |
|---|
| EEL | ImGui_DrawList_AddImage(ImGui_DrawList draw_list, ImGui_Image img, p_min_x, p_min_y, p_max_x, p_max_y, uv_min_x = 0.0, uv_min_y = 0.0, uv_max_x = 1.0, uv_max_y = 1.0, int col_rgba = 0xFFFFFFFF) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddImage", ImGui_DrawList draw_list, ImGui_Image img, p_min_x, p_min_y, p_max_x, p_max_y, uv_min_x = 0.0, uv_min_y = 0.0, uv_max_x = 1.0, uv_max_y = 1.0, int col_rgba = 0xFFFFFFFF) |
|---|
| Lua | reaper.ImGui_DrawList_AddImage(ImGui_DrawList draw_list, ImGui_Image img, number p_min_x, number p_min_y, number p_max_x, number p_max_y, number uv_min_x = 0.0, number uv_min_y = 0.0, number uv_max_x = 1.0, number uv_max_y = 1.0, number col_rgba = 0xFFFFFFFF) |
|---|
| Python | ImGui_DrawList_AddImage(ImGui_DrawList draw_list, ImGui_Image img, float p_min_x, float p_min_y, float p_max_x, float p_max_y, float uv_min_x = 0.0, float uv_min_y = 0.0, float uv_max_x = 1.0, float uv_max_y = 1.0, int col_rgba = 0xFFFFFFFF) |
|---|
View source
Function: DrawList_AddImageQuad
| C++ | void ImGui_DrawList_AddImageQuad(ImGui_DrawList* draw_list, ImGui_Image* img, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, double p4_x, double p4_y, double* uv1_xInOptional = 0.0, double* uv1_yInOptional = 0.0, double* uv2_xInOptional = 1.0, double* uv2_yInOptional = 0.0, double* uv3_xInOptional = 1.0, double* uv3_yInOptional = 1.0, double* uv4_xInOptional = 0.0, double* uv4_yInOptional = 1.0, int* col_rgbaInOptional = 0xFFFFFFFF) |
|---|
| EEL | ImGui_DrawList_AddImageQuad(ImGui_DrawList draw_list, ImGui_Image img, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, p4_x, p4_y, uv1_x = 0.0, uv1_y = 0.0, uv2_x = 1.0, uv2_y = 0.0, uv3_x = 1.0, uv3_y = 1.0, uv4_x = 0.0, uv4_y = 1.0, int col_rgba = 0xFFFFFFFF) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddImageQuad", ImGui_DrawList draw_list, ImGui_Image img, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, p4_x, p4_y, uv1_x = 0.0, uv1_y = 0.0, uv2_x = 1.0, uv2_y = 0.0, uv3_x = 1.0, uv3_y = 1.0, uv4_x = 0.0, uv4_y = 1.0, int col_rgba = 0xFFFFFFFF) |
|---|
| Lua | reaper.ImGui_DrawList_AddImageQuad(ImGui_DrawList draw_list, ImGui_Image img, number p1_x, number p1_y, number p2_x, number p2_y, number p3_x, number p3_y, number p4_x, number p4_y, number uv1_x = 0.0, number uv1_y = 0.0, number uv2_x = 1.0, number uv2_y = 0.0, number uv3_x = 1.0, number uv3_y = 1.0, number uv4_x = 0.0, number uv4_y = 1.0, number col_rgba = 0xFFFFFFFF) |
|---|
| Python | ImGui_DrawList_AddImageQuad(ImGui_DrawList draw_list, ImGui_Image img, float p1_x, float p1_y, float p2_x, float p2_y, float p3_x, float p3_y, float p4_x, float p4_y, float uv1_x = 0.0, float uv1_y = 0.0, float uv2_x = 1.0, float uv2_y = 0.0, float uv3_x = 1.0, float uv3_y = 1.0, float uv4_x = 0.0, float uv4_y = 1.0, int col_rgba = 0xFFFFFFFF) |
|---|
View source
Function: DrawList_AddImageRounded
| C++ | void ImGui_DrawList_AddImageRounded(ImGui_DrawList* draw_list, ImGui_Image* img, double p_min_x, double p_min_y, double p_max_x, double p_max_y, double uv_min_x, double uv_min_y, double uv_max_x, double uv_max_y, int col_rgba, double rounding, int* flagsInOptional = DrawFlags_None) |
|---|
| EEL | ImGui_DrawList_AddImageRounded(ImGui_DrawList draw_list, ImGui_Image img, p_min_x, p_min_y, p_max_x, p_max_y, uv_min_x, uv_min_y, uv_max_x, uv_max_y, int col_rgba, rounding, int flags = DrawFlags_None) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddImageRounded", ImGui_DrawList draw_list, ImGui_Image img, p_min_x, p_min_y, p_max_x, p_max_y, uv_min_x, uv_min_y, uv_max_x, uv_max_y, int col_rgba, rounding, int flags = DrawFlags_None) |
|---|
| Lua | reaper.ImGui_DrawList_AddImageRounded(ImGui_DrawList draw_list, ImGui_Image img, number p_min_x, number p_min_y, number p_max_x, number p_max_y, number uv_min_x, number uv_min_y, number uv_max_x, number uv_max_y, number col_rgba, number rounding, number flags = DrawFlags_None) |
|---|
| Python | ImGui_DrawList_AddImageRounded(ImGui_DrawList draw_list, ImGui_Image img, float p_min_x, float p_min_y, float p_max_x, float p_max_y, float uv_min_x, float uv_min_y, float uv_max_x, float uv_max_y, int col_rgba, float rounding, int flags = DrawFlags_None) |
|---|
View source
Function: DrawList_AddLine
| C++ | void ImGui_DrawList_AddLine(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, int col_rgba, double* thicknessInOptional = 1.0) |
|---|
| EEL | ImGui_DrawList_AddLine(ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, int col_rgba, thickness = 1.0) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddLine", ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, int col_rgba, thickness = 1.0) |
|---|
| Lua | reaper.ImGui_DrawList_AddLine(ImGui_DrawList draw_list, number p1_x, number p1_y, number p2_x, number p2_y, number col_rgba, number thickness = 1.0) |
|---|
| Python | ImGui_DrawList_AddLine(ImGui_DrawList draw_list, float p1_x, float p1_y, float p2_x, float p2_y, int col_rgba, float thickness = 1.0) |
|---|
View source
Function: DrawList_AddNgon
| C++ | void ImGui_DrawList_AddNgon(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, int col_rgba, int num_segments, double* thicknessInOptional = 1.0) |
|---|
| EEL | ImGui_DrawList_AddNgon(ImGui_DrawList draw_list, center_x, center_y, radius, int col_rgba, int num_segments, thickness = 1.0) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddNgon", ImGui_DrawList draw_list, center_x, center_y, radius, int col_rgba, int num_segments, thickness = 1.0) |
|---|
| Lua | reaper.ImGui_DrawList_AddNgon(ImGui_DrawList draw_list, number center_x, number center_y, number radius, number col_rgba, number num_segments, number thickness = 1.0) |
|---|
| Python | ImGui_DrawList_AddNgon(ImGui_DrawList draw_list, float center_x, float center_y, float radius, int col_rgba, int num_segments, float thickness = 1.0) |
|---|
View source
Function: DrawList_AddNgonFilled
| C++ | void ImGui_DrawList_AddNgonFilled(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, int col_rgba, int num_segments) |
|---|
| EEL | ImGui_DrawList_AddNgonFilled(ImGui_DrawList draw_list, center_x, center_y, radius, int col_rgba, int num_segments) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddNgonFilled", ImGui_DrawList draw_list, center_x, center_y, radius, int col_rgba, int num_segments) |
|---|
| Lua | reaper.ImGui_DrawList_AddNgonFilled(ImGui_DrawList draw_list, number center_x, number center_y, number radius, number col_rgba, number num_segments) |
|---|
| Python | ImGui_DrawList_AddNgonFilled(ImGui_DrawList draw_list, float center_x, float center_y, float radius, int col_rgba, int num_segments) |
|---|
View source
Function: DrawList_AddPolyline
| C++ | void ImGui_DrawList_AddPolyline(ImGui_DrawList* draw_list, reaper_array* points, int col_rgba, int flags, double thickness) |
|---|
| EEL | ImGui_DrawList_AddPolyline(ImGui_DrawList draw_list, reaper_array points, int col_rgba, int flags, thickness) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddPolyline", ImGui_DrawList draw_list, reaper_array points, int col_rgba, int flags, thickness) |
|---|
| Lua | reaper.ImGui_DrawList_AddPolyline(ImGui_DrawList draw_list, reaper_array points, number col_rgba, number flags, number thickness) |
|---|
| Python | ImGui_DrawList_AddPolyline(ImGui_DrawList draw_list, reaper_array points, int col_rgba, int flags, float thickness) |
|---|
Points is a list of x,y coordinates.
View source
Function: DrawList_AddQuad
| C++ | void ImGui_DrawList_AddQuad(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, double p4_x, double p4_y, int col_rgba, double* thicknessInOptional = 1.0) |
|---|
| EEL | ImGui_DrawList_AddQuad(ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, p4_x, p4_y, int col_rgba, thickness = 1.0) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddQuad", ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, p4_x, p4_y, int col_rgba, thickness = 1.0) |
|---|
| Lua | reaper.ImGui_DrawList_AddQuad(ImGui_DrawList draw_list, number p1_x, number p1_y, number p2_x, number p2_y, number p3_x, number p3_y, number p4_x, number p4_y, number col_rgba, number thickness = 1.0) |
|---|
| Python | ImGui_DrawList_AddQuad(ImGui_DrawList draw_list, float p1_x, float p1_y, float p2_x, float p2_y, float p3_x, float p3_y, float p4_x, float p4_y, int col_rgba, float thickness = 1.0) |
|---|
View source
Function: DrawList_AddQuadFilled
| C++ | void ImGui_DrawList_AddQuadFilled(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, double p4_x, double p4_y, int col_rgba) |
|---|
| EEL | ImGui_DrawList_AddQuadFilled(ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, p4_x, p4_y, int col_rgba) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddQuadFilled", ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, p4_x, p4_y, int col_rgba) |
|---|
| Lua | reaper.ImGui_DrawList_AddQuadFilled(ImGui_DrawList draw_list, number p1_x, number p1_y, number p2_x, number p2_y, number p3_x, number p3_y, number p4_x, number p4_y, number col_rgba) |
|---|
| Python | ImGui_DrawList_AddQuadFilled(ImGui_DrawList draw_list, float p1_x, float p1_y, float p2_x, float p2_y, float p3_x, float p3_y, float p4_x, float p4_y, int col_rgba) |
|---|
View source
Function: DrawList_AddRect
| C++ | void ImGui_DrawList_AddRect(ImGui_DrawList* draw_list, double p_min_x, double p_min_y, double p_max_x, double p_max_y, int col_rgba, double* roundingInOptional = 0.0, int* flagsInOptional = DrawFlags_None, double* thicknessInOptional = 1.0) |
|---|
| EEL | ImGui_DrawList_AddRect(ImGui_DrawList draw_list, p_min_x, p_min_y, p_max_x, p_max_y, int col_rgba, rounding = 0.0, int flags = DrawFlags_None, thickness = 1.0) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddRect", ImGui_DrawList draw_list, p_min_x, p_min_y, p_max_x, p_max_y, int col_rgba, rounding = 0.0, int flags = DrawFlags_None, thickness = 1.0) |
|---|
| Lua | reaper.ImGui_DrawList_AddRect(ImGui_DrawList draw_list, number p_min_x, number p_min_y, number p_max_x, number p_max_y, number col_rgba, number rounding = 0.0, number flags = DrawFlags_None, number thickness = 1.0) |
|---|
| Python | ImGui_DrawList_AddRect(ImGui_DrawList draw_list, float p_min_x, float p_min_y, float p_max_x, float p_max_y, int col_rgba, float rounding = 0.0, int flags = DrawFlags_None, float thickness = 1.0) |
|---|
View source
Function: DrawList_AddRectFilled
| C++ | void ImGui_DrawList_AddRectFilled(ImGui_DrawList* draw_list, double p_min_x, double p_min_y, double p_max_x, double p_max_y, int col_rgba, double* roundingInOptional = 0.0, int* flagsInOptional = DrawFlags_None) |
|---|
| EEL | ImGui_DrawList_AddRectFilled(ImGui_DrawList draw_list, p_min_x, p_min_y, p_max_x, p_max_y, int col_rgba, rounding = 0.0, int flags = DrawFlags_None) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddRectFilled", ImGui_DrawList draw_list, p_min_x, p_min_y, p_max_x, p_max_y, int col_rgba, rounding = 0.0, int flags = DrawFlags_None) |
|---|
| Lua | reaper.ImGui_DrawList_AddRectFilled(ImGui_DrawList draw_list, number p_min_x, number p_min_y, number p_max_x, number p_max_y, number col_rgba, number rounding = 0.0, number flags = DrawFlags_None) |
|---|
| Python | ImGui_DrawList_AddRectFilled(ImGui_DrawList draw_list, float p_min_x, float p_min_y, float p_max_x, float p_max_y, int col_rgba, float rounding = 0.0, int flags = DrawFlags_None) |
|---|
View source
Function: DrawList_AddRectFilledMultiColor
| C++ | void ImGui_DrawList_AddRectFilledMultiColor(ImGui_DrawList* draw_list, double p_min_x, double p_min_y, double p_max_x, double p_max_y, int col_upr_left, int col_upr_right, int col_bot_right, int col_bot_left) |
|---|
| EEL | ImGui_DrawList_AddRectFilledMultiColor(ImGui_DrawList draw_list, p_min_x, p_min_y, p_max_x, p_max_y, int col_upr_left, int col_upr_right, int col_bot_right, int col_bot_left) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddRectFilledMultiColor", ImGui_DrawList draw_list, p_min_x, p_min_y, p_max_x, p_max_y, int col_upr_left, int col_upr_right, int col_bot_right, int col_bot_left) |
|---|
| Lua | reaper.ImGui_DrawList_AddRectFilledMultiColor(ImGui_DrawList draw_list, number p_min_x, number p_min_y, number p_max_x, number p_max_y, number col_upr_left, number col_upr_right, number col_bot_right, number col_bot_left) |
|---|
| Python | ImGui_DrawList_AddRectFilledMultiColor(ImGui_DrawList draw_list, float p_min_x, float p_min_y, float p_max_x, float p_max_y, int col_upr_left, int col_upr_right, int col_bot_right, int col_bot_left) |
|---|
View source
Function: DrawList_AddText
| C++ | void ImGui_DrawList_AddText(ImGui_DrawList* draw_list, double x, double y, int col_rgba, const char* text) |
|---|
| EEL | ImGui_DrawList_AddText(ImGui_DrawList draw_list, x, y, int col_rgba, "text") |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddText", ImGui_DrawList draw_list, x, y, int col_rgba, "text") |
|---|
| Lua | reaper.ImGui_DrawList_AddText(ImGui_DrawList draw_list, number x, number y, number col_rgba, string text) |
|---|
| Python | ImGui_DrawList_AddText(ImGui_DrawList draw_list, float x, float y, int col_rgba, str text) |
|---|
View source
Function: DrawList_AddTextEx
| C++ | void ImGui_DrawList_AddTextEx(ImGui_DrawList* draw_list, ImGui_Font* font, double font_size, double pos_x, double pos_y, int col_rgba, const char* text, double* wrap_widthInOptional = 0.0, double* cpu_fine_clip_rect_xInOptional = nullptr, double* cpu_fine_clip_rect_yInOptional = nullptr, double* cpu_fine_clip_rect_wInOptional = nullptr, double* cpu_fine_clip_rect_hInOptional = nullptr) |
|---|
| EEL | ImGui_DrawList_AddTextEx(ImGui_DrawList draw_list, ImGui_Font font, font_size, pos_x, pos_y, int col_rgba, "text", wrap_width = 0.0, cpu_fine_clip_rect_x = nullptr, cpu_fine_clip_rect_y = nullptr, cpu_fine_clip_rect_w = nullptr, cpu_fine_clip_rect_h = nullptr) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddTextEx", ImGui_DrawList draw_list, ImGui_Font font, font_size, pos_x, pos_y, int col_rgba, "text", wrap_width = 0.0, cpu_fine_clip_rect_x = nullptr, cpu_fine_clip_rect_y = nullptr, cpu_fine_clip_rect_w = nullptr, cpu_fine_clip_rect_h = nullptr) |
|---|
| Lua | reaper.ImGui_DrawList_AddTextEx(ImGui_DrawList draw_list, ImGui_Font font, number font_size, number pos_x, number pos_y, number col_rgba, string text, number wrap_width = 0.0, number cpu_fine_clip_rect_x = nullptr, number cpu_fine_clip_rect_y = nullptr, number cpu_fine_clip_rect_w = nullptr, number cpu_fine_clip_rect_h = nullptr) |
|---|
| Python | ImGui_DrawList_AddTextEx(ImGui_DrawList draw_list, ImGui_Font font, float font_size, float pos_x, float pos_y, int col_rgba, str text, float wrap_width = 0.0, float cpu_fine_clip_rect_x = nullptr, float cpu_fine_clip_rect_y = nullptr, float cpu_fine_clip_rect_w = nullptr, float cpu_fine_clip_rect_h = nullptr) |
|---|
The last pushed font is used if font is nil.
The size of the last pushed font is used if font_size is 0.
cpu_fine_clip_rect_* only takes effect if all four are non-nil.
View source
Function: DrawList_AddTriangle
| C++ | void ImGui_DrawList_AddTriangle(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, int col_rgba, double* thicknessInOptional = 1.0) |
|---|
| EEL | ImGui_DrawList_AddTriangle(ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, int col_rgba, thickness = 1.0) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddTriangle", ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, int col_rgba, thickness = 1.0) |
|---|
| Lua | reaper.ImGui_DrawList_AddTriangle(ImGui_DrawList draw_list, number p1_x, number p1_y, number p2_x, number p2_y, number p3_x, number p3_y, number col_rgba, number thickness = 1.0) |
|---|
| Python | ImGui_DrawList_AddTriangle(ImGui_DrawList draw_list, float p1_x, float p1_y, float p2_x, float p2_y, float p3_x, float p3_y, int col_rgba, float thickness = 1.0) |
|---|
View source
Function: DrawList_AddTriangleFilled
| C++ | void ImGui_DrawList_AddTriangleFilled(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, int col_rgba) |
|---|
| EEL | ImGui_DrawList_AddTriangleFilled(ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, int col_rgba) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_AddTriangleFilled", ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, int col_rgba) |
|---|
| Lua | reaper.ImGui_DrawList_AddTriangleFilled(ImGui_DrawList draw_list, number p1_x, number p1_y, number p2_x, number p2_y, number p3_x, number p3_y, number col_rgba) |
|---|
| Python | ImGui_DrawList_AddTriangleFilled(ImGui_DrawList draw_list, float p1_x, float p1_y, float p2_x, float p2_y, float p3_x, float p3_y, int col_rgba) |
|---|
View source
Splitter
Split/Merge functions are used to split the draw list into different layers
which can be drawn into out of order (e.g. submit FG primitives before BG primitives).
Use to minimize draw calls (e.g. if going back-and-forth between multiple
clipping rectangles, prefer to append into separate channels then merge at the end).
Usage:
if not reaper.ImGui_ValidatePtr(splitter, 'ImGui_DrawListSplitter*') then
splitter = reaper.ImGui_CreateDrawListSplitter(draw_list)
end
reaper.ImGui_DrawListSplitter_Split(splitter, 2)
reaper.ImGui_DrawListSplitter_SetCurrentChannel(splitter, 0)
reaper.ImGui_DrawList_AddRectFilled(draw_list, ...) -- background
reaper.ImGui_DrawListSplitter_SetCurrentChannel(splitter, 1)
reaper.ImGui_DrawList_AddRectFilled(draw_list, ...) -- foreground
reaper.ImGui_DrawListSplitter_SetCurrentChannel(splitter, 0)
reaper.ImGui_DrawList_AddRectFilled(draw_list, ...) -- background
reaper.ImGui_DrawListSplitter_Merge(splitter)
Function: CreateDrawListSplitter
| C++ | ImGui_DrawListSplitter* ImGui_CreateDrawListSplitter(ImGui_DrawList* draw_list) |
|---|
| EEL | ImGui_DrawListSplitter* ImGui_CreateDrawListSplitter(ImGui_DrawList draw_list) |
|---|
| Legacy EEL | ImGui_DrawListSplitter* extension_api("ImGui_CreateDrawListSplitter", ImGui_DrawList draw_list) |
|---|
| Lua | ImGui_DrawListSplitter retval = reaper.ImGui_CreateDrawListSplitter(ImGui_DrawList draw_list) |
|---|
| Python | ImGui_DrawListSplitter retval = ImGui_CreateDrawListSplitter(ImGui_DrawList draw_list) |
|---|
View source
Function: DrawListSplitter_Clear
| C++ | void ImGui_DrawListSplitter_Clear(ImGui_DrawListSplitter* splitter) |
|---|
| EEL | ImGui_DrawListSplitter_Clear(ImGui_DrawListSplitter splitter) |
|---|
| Legacy EEL | extension_api("ImGui_DrawListSplitter_Clear", ImGui_DrawListSplitter splitter) |
|---|
| Lua | reaper.ImGui_DrawListSplitter_Clear(ImGui_DrawListSplitter splitter) |
|---|
| Python | ImGui_DrawListSplitter_Clear(ImGui_DrawListSplitter splitter) |
|---|
View source
Function: DrawListSplitter_Merge
| C++ | void ImGui_DrawListSplitter_Merge(ImGui_DrawListSplitter* splitter) |
|---|
| EEL | ImGui_DrawListSplitter_Merge(ImGui_DrawListSplitter splitter) |
|---|
| Legacy EEL | extension_api("ImGui_DrawListSplitter_Merge", ImGui_DrawListSplitter splitter) |
|---|
| Lua | reaper.ImGui_DrawListSplitter_Merge(ImGui_DrawListSplitter splitter) |
|---|
| Python | ImGui_DrawListSplitter_Merge(ImGui_DrawListSplitter splitter) |
|---|
View source
Function: DrawListSplitter_SetCurrentChannel
| C++ | void ImGui_DrawListSplitter_SetCurrentChannel(ImGui_DrawListSplitter* splitter, int channel_idx) |
|---|
| EEL | ImGui_DrawListSplitter_SetCurrentChannel(ImGui_DrawListSplitter splitter, int channel_idx) |
|---|
| Legacy EEL | extension_api("ImGui_DrawListSplitter_SetCurrentChannel", ImGui_DrawListSplitter splitter, int channel_idx) |
|---|
| Lua | reaper.ImGui_DrawListSplitter_SetCurrentChannel(ImGui_DrawListSplitter splitter, number channel_idx) |
|---|
| Python | ImGui_DrawListSplitter_SetCurrentChannel(ImGui_DrawListSplitter splitter, int channel_idx) |
|---|
View source
Function: DrawListSplitter_Split
| C++ | void ImGui_DrawListSplitter_Split(ImGui_DrawListSplitter* splitter, int count) |
|---|
| EEL | ImGui_DrawListSplitter_Split(ImGui_DrawListSplitter splitter, int count) |
|---|
| Legacy EEL | extension_api("ImGui_DrawListSplitter_Split", ImGui_DrawListSplitter splitter, int count) |
|---|
| Lua | reaper.ImGui_DrawListSplitter_Split(ImGui_DrawListSplitter splitter, number count) |
|---|
| Python | ImGui_DrawListSplitter_Split(ImGui_DrawListSplitter splitter, int count) |
|---|
View source
Stateful Path
Stateful path API, add points then finish with PathFillConvex() or PathStroke().
Function: DrawList_PathArcTo
| C++ | void ImGui_DrawList_PathArcTo(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, double a_min, double a_max, int* num_segmentsInOptional = 0) |
|---|
| EEL | ImGui_DrawList_PathArcTo(ImGui_DrawList draw_list, center_x, center_y, radius, a_min, a_max, int num_segments = 0) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_PathArcTo", ImGui_DrawList draw_list, center_x, center_y, radius, a_min, a_max, int num_segments = 0) |
|---|
| Lua | reaper.ImGui_DrawList_PathArcTo(ImGui_DrawList draw_list, number center_x, number center_y, number radius, number a_min, number a_max, number num_segments = 0) |
|---|
| Python | ImGui_DrawList_PathArcTo(ImGui_DrawList draw_list, float center_x, float center_y, float radius, float a_min, float a_max, int num_segments = 0) |
|---|
View source
Function: DrawList_PathArcToFast
| C++ | void ImGui_DrawList_PathArcToFast(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, int a_min_of_12, int a_max_of_12) |
|---|
| EEL | ImGui_DrawList_PathArcToFast(ImGui_DrawList draw_list, center_x, center_y, radius, int a_min_of_12, int a_max_of_12) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_PathArcToFast", ImGui_DrawList draw_list, center_x, center_y, radius, int a_min_of_12, int a_max_of_12) |
|---|
| Lua | reaper.ImGui_DrawList_PathArcToFast(ImGui_DrawList draw_list, number center_x, number center_y, number radius, number a_min_of_12, number a_max_of_12) |
|---|
| Python | ImGui_DrawList_PathArcToFast(ImGui_DrawList draw_list, float center_x, float center_y, float radius, int a_min_of_12, int a_max_of_12) |
|---|
Use precomputed angles for a 12 steps circle.
View source
Function: DrawList_PathBezierCubicCurveTo
| C++ | void ImGui_DrawList_PathBezierCubicCurveTo(ImGui_DrawList* draw_list, double p2_x, double p2_y, double p3_x, double p3_y, double p4_x, double p4_y, int* num_segmentsInOptional = 0) |
|---|
| EEL | ImGui_DrawList_PathBezierCubicCurveTo(ImGui_DrawList draw_list, p2_x, p2_y, p3_x, p3_y, p4_x, p4_y, int num_segments = 0) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_PathBezierCubicCurveTo", ImGui_DrawList draw_list, p2_x, p2_y, p3_x, p3_y, p4_x, p4_y, int num_segments = 0) |
|---|
| Lua | reaper.ImGui_DrawList_PathBezierCubicCurveTo(ImGui_DrawList draw_list, number p2_x, number p2_y, number p3_x, number p3_y, number p4_x, number p4_y, number num_segments = 0) |
|---|
| Python | ImGui_DrawList_PathBezierCubicCurveTo(ImGui_DrawList draw_list, float p2_x, float p2_y, float p3_x, float p3_y, float p4_x, float p4_y, int num_segments = 0) |
|---|
Cubic Bezier (4 control points)
View source
Function: DrawList_PathBezierQuadraticCurveTo
| C++ | void ImGui_DrawList_PathBezierQuadraticCurveTo(ImGui_DrawList* draw_list, double p2_x, double p2_y, double p3_x, double p3_y, int* num_segmentsInOptional = 0) |
|---|
| EEL | ImGui_DrawList_PathBezierQuadraticCurveTo(ImGui_DrawList draw_list, p2_x, p2_y, p3_x, p3_y, int num_segments = 0) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_PathBezierQuadraticCurveTo", ImGui_DrawList draw_list, p2_x, p2_y, p3_x, p3_y, int num_segments = 0) |
|---|
| Lua | reaper.ImGui_DrawList_PathBezierQuadraticCurveTo(ImGui_DrawList draw_list, number p2_x, number p2_y, number p3_x, number p3_y, number num_segments = 0) |
|---|
| Python | ImGui_DrawList_PathBezierQuadraticCurveTo(ImGui_DrawList draw_list, float p2_x, float p2_y, float p3_x, float p3_y, int num_segments = 0) |
|---|
Quadratic Bezier (3 control points)
View source
Function: DrawList_PathClear
| C++ | void ImGui_DrawList_PathClear(ImGui_DrawList* draw_list) |
|---|
| EEL | ImGui_DrawList_PathClear(ImGui_DrawList draw_list) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_PathClear", ImGui_DrawList draw_list) |
|---|
| Lua | reaper.ImGui_DrawList_PathClear(ImGui_DrawList draw_list) |
|---|
| Python | ImGui_DrawList_PathClear(ImGui_DrawList draw_list) |
|---|
View source
Function: DrawList_PathFillConvex
| C++ | void ImGui_DrawList_PathFillConvex(ImGui_DrawList* draw_list, int col_rgba) |
|---|
| EEL | ImGui_DrawList_PathFillConvex(ImGui_DrawList draw_list, int col_rgba) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_PathFillConvex", ImGui_DrawList draw_list, int col_rgba) |
|---|
| Lua | reaper.ImGui_DrawList_PathFillConvex(ImGui_DrawList draw_list, number col_rgba) |
|---|
| Python | ImGui_DrawList_PathFillConvex(ImGui_DrawList draw_list, int col_rgba) |
|---|
Note: Anti-aliased filling requires points to be in clockwise order.
View source
Function: DrawList_PathLineTo
| C++ | void ImGui_DrawList_PathLineTo(ImGui_DrawList* draw_list, double pos_x, double pos_y) |
|---|
| EEL | ImGui_DrawList_PathLineTo(ImGui_DrawList draw_list, pos_x, pos_y) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_PathLineTo", ImGui_DrawList draw_list, pos_x, pos_y) |
|---|
| Lua | reaper.ImGui_DrawList_PathLineTo(ImGui_DrawList draw_list, number pos_x, number pos_y) |
|---|
| Python | ImGui_DrawList_PathLineTo(ImGui_DrawList draw_list, float pos_x, float pos_y) |
|---|
View source
Function: DrawList_PathRect
| C++ | void ImGui_DrawList_PathRect(ImGui_DrawList* draw_list, double rect_min_x, double rect_min_y, double rect_max_x, double rect_max_y, double* roundingInOptional = 0.0, int* flagsInOptional = DrawFlags_None) |
|---|
| EEL | ImGui_DrawList_PathRect(ImGui_DrawList draw_list, rect_min_x, rect_min_y, rect_max_x, rect_max_y, rounding = 0.0, int flags = DrawFlags_None) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_PathRect", ImGui_DrawList draw_list, rect_min_x, rect_min_y, rect_max_x, rect_max_y, rounding = 0.0, int flags = DrawFlags_None) |
|---|
| Lua | reaper.ImGui_DrawList_PathRect(ImGui_DrawList draw_list, number rect_min_x, number rect_min_y, number rect_max_x, number rect_max_y, number rounding = 0.0, number flags = DrawFlags_None) |
|---|
| Python | ImGui_DrawList_PathRect(ImGui_DrawList draw_list, float rect_min_x, float rect_min_y, float rect_max_x, float rect_max_y, float rounding = 0.0, int flags = DrawFlags_None) |
|---|
View source
Function: DrawList_PathStroke
| C++ | void ImGui_DrawList_PathStroke(ImGui_DrawList* draw_list, int col_rgba, int* flagsInOptional = DrawFlags_None, double* thicknessInOptional = 1.0) |
|---|
| EEL | ImGui_DrawList_PathStroke(ImGui_DrawList draw_list, int col_rgba, int flags = DrawFlags_None, thickness = 1.0) |
|---|
| Legacy EEL | extension_api("ImGui_DrawList_PathStroke", ImGui_DrawList draw_list, int col_rgba, int flags = DrawFlags_None, thickness = 1.0) |
|---|
| Lua | reaper.ImGui_DrawList_PathStroke(ImGui_DrawList draw_list, number col_rgba, number flags = DrawFlags_None, number thickness = 1.0) |
|---|
| Python | ImGui_DrawList_PathStroke(ImGui_DrawList draw_list, int col_rgba, int flags = DrawFlags_None, float thickness = 1.0) |
|---|
View source
Font
Supports loading fonts from the system by family name or from a file.
Glyphs may contain colors in COLR/CPAL format.
This API currently has multiple limitations (v1.0 blockers):
- ReaImGui rasterizes glyphs only from the Basic Latin and Latin Supplement
Unicode blocks (U+0020 to U+00FF). UTF-8 is fully supported internally,
however characters outside those blocks are displayed as '?'.
See issue #5.
- Dear ImGui does not support using new fonts in the middle of a frame.
Because of this, fonts must first be registered using Attach before any
other context functions are used in the same defer cycle.
(Attaching a font is a heavy operation and should ideally be done outside
of the defer loop.)
Function: CreateFont
| C++ | ImGui_Font* ImGui_CreateFont(const char* family_or_file, int size, int* flagsInOptional = ReaImGuiFontFlags_None) |
|---|
| EEL | ImGui_Font* ImGui_CreateFont("family_or_file", int size, int flags = ReaImGuiFontFlags_None) |
|---|
| Legacy EEL | ImGui_Font* extension_api("ImGui_CreateFont", "family_or_file", int size, int flags = ReaImGuiFontFlags_None) |
|---|
| Lua | ImGui_Font retval = reaper.ImGui_CreateFont(string family_or_file, number size, number flags = ReaImGuiFontFlags_None) |
|---|
| Python | ImGui_Font retval = ImGui_CreateFont(str family_or_file, int size, int flags = ReaImGuiFontFlags_None) |
|---|
Load a font matching a font family name or from a font file.
The font will remain valid while it's attached to a context. See Attach.
The family name can be an installed font or one of the generic fonts:
sans-serif, serif, monospace, cursive, fantasy.
If 'family_or_file' specifies a path to a font file (contains a / or ):
- The first byte of 'flags' is used as the font index within the file
- The font styles in 'flags' are simulated by the font renderer
View source
Constant: FontFlags_Bold
| C++ | int ImGui_FontFlags_Bold |
|---|
| EEL | int ImGui_FontFlags_Bold() |
|---|
| Legacy EEL | int extension_api("ImGui_FontFlags_Bold") |
|---|
| Lua | number retval = reaper.ImGui_FontFlags_Bold() |
|---|
| Python | int retval = ImGui_FontFlags_Bold() |
|---|
View source
Constant: FontFlags_Italic
| C++ | int ImGui_FontFlags_Italic |
|---|
| EEL | int ImGui_FontFlags_Italic() |
|---|
| Legacy EEL | int extension_api("ImGui_FontFlags_Italic") |
|---|
| Lua | number retval = reaper.ImGui_FontFlags_Italic() |
|---|
| Python | int retval = ImGui_FontFlags_Italic() |
|---|
View source
Constant: FontFlags_None
| C++ | int ImGui_FontFlags_None |
|---|
| EEL | int ImGui_FontFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_FontFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_FontFlags_None() |
|---|
| Python | int retval = ImGui_FontFlags_None() |
|---|
View source
Function: GetFont
| C++ | ImGui_Font* ImGui_GetFont(ImGui_Context* ctx) |
|---|
| EEL | ImGui_Font* ImGui_GetFont(ImGui_Context ctx) |
|---|
| Legacy EEL | ImGui_Font* extension_api("ImGui_GetFont", ImGui_Context ctx) |
|---|
| Lua | ImGui_Font retval = reaper.ImGui_GetFont(ImGui_Context ctx) |
|---|
| Python | ImGui_Font retval = ImGui_GetFont(ImGui_Context ctx) |
|---|
Get the current font
View source
Function: GetFontSize
| C++ | double ImGui_GetFontSize(ImGui_Context* ctx) |
|---|
| EEL | double ImGui_GetFontSize(ImGui_Context ctx) |
|---|
| Legacy EEL | double extension_api("ImGui_GetFontSize", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetFontSize(ImGui_Context ctx) |
|---|
| Python | float retval = ImGui_GetFontSize(ImGui_Context ctx) |
|---|
Get current font size (= height in pixels) of current font with current scale
applied.
View source
Function: PopFont
| C++ | void ImGui_PopFont(ImGui_Context* ctx) |
|---|
| EEL | ImGui_PopFont(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_PopFont", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_PopFont(ImGui_Context ctx) |
|---|
| Python | ImGui_PopFont(ImGui_Context ctx) |
|---|
See PushFont.
View source
Function: PushFont
| C++ | void ImGui_PushFont(ImGui_Context* ctx, ImGui_Font* font) |
|---|
| EEL | ImGui_PushFont(ImGui_Context ctx, ImGui_Font font) |
|---|
| Legacy EEL | extension_api("ImGui_PushFont", ImGui_Context ctx, ImGui_Font font) |
|---|
| Lua | reaper.ImGui_PushFont(ImGui_Context ctx, ImGui_Font font) |
|---|
| Python | ImGui_PushFont(ImGui_Context ctx, ImGui_Font font) |
|---|
Change the current font. Use nil to push the default font.
The font object must have been registered using Attach. See PopFont.
View source
Function
Create reusable programs that can passed to and called back from functions
such as InputText* and SetNextWindowSizeConstraints.
They can also be used standalone with Function_Execute
(eg. faster-than-Lua DSP processing).
Function: CreateFunctionFromEEL
| C++ | ImGui_Function* ImGui_CreateFunctionFromEEL(const char* code) |
|---|
| EEL | ImGui_Function* ImGui_CreateFunctionFromEEL("code") |
|---|
| Legacy EEL | ImGui_Function* extension_api("ImGui_CreateFunctionFromEEL", "code") |
|---|
| Lua | ImGui_Function retval = reaper.ImGui_CreateFunctionFromEEL(string code) |
|---|
| Python | ImGui_Function retval = ImGui_CreateFunctionFromEEL(str code) |
|---|
Compile an EEL program.
Standard EEL math
and string
functions are available in addition to callback-specific functions
(see InputTextCallback_*).
View source
Function: Function_Execute
| C++ | void ImGui_Function_Execute(ImGui_Function* func) |
|---|
| EEL | ImGui_Function_Execute(ImGui_Function func) |
|---|
| Legacy EEL | extension_api("ImGui_Function_Execute", ImGui_Function func) |
|---|
| Lua | reaper.ImGui_Function_Execute(ImGui_Function func) |
|---|
| Python | ImGui_Function_Execute(ImGui_Function func) |
|---|
View source
Function: Function_GetValue
| C++ | double ImGui_Function_GetValue(ImGui_Function* func, const char* name) |
|---|
| EEL | double ImGui_Function_GetValue(ImGui_Function func, "name") |
|---|
| Legacy EEL | double extension_api("ImGui_Function_GetValue", ImGui_Function func, "name") |
|---|
| Lua | number retval = reaper.ImGui_Function_GetValue(ImGui_Function func, string name) |
|---|
| Python | float retval = ImGui_Function_GetValue(ImGui_Function func, str name) |
|---|
View source
Function: Function_GetValue_Array
| C++ | void ImGui_Function_GetValue_Array(ImGui_Function* func, const char* name, reaper_array* values) |
|---|
| EEL | ImGui_Function_GetValue_Array(ImGui_Function func, "name", reaper_array values) |
|---|
| Legacy EEL | extension_api("ImGui_Function_GetValue_Array", ImGui_Function func, "name", reaper_array values) |
|---|
| Lua | reaper.ImGui_Function_GetValue_Array(ImGui_Function func, string name, reaper_array values) |
|---|
| Python | ImGui_Function_GetValue_Array(ImGui_Function func, str name, reaper_array values) |
|---|
Copy the values in the function's memory starting at the address stored
in the given variable into the array.
View source
Function: Function_GetValue_String
| C++ | void ImGui_Function_GetValue_String(ImGui_Function* func, const char* name, char* valueOutNeedBig, int valueOutNeedBig_sz) |
|---|
| EEL | ImGui_Function_GetValue_String(ImGui_Function func, "name", #value) |
|---|
| Legacy EEL | extension_api("ImGui_Function_GetValue_String", ImGui_Function func, "name", #value) |
|---|
| Lua | string value = reaper.ImGui_Function_GetValue_String(ImGui_Function func, string name) |
|---|
| Python | (str value) = ImGui_Function_GetValue_String(ImGui_Function func, str name) |
|---|
Read from a string slot or a named string (when name starts with a #).
View source
Function: Function_SetValue
| C++ | void ImGui_Function_SetValue(ImGui_Function* func, const char* name, double value) |
|---|
| EEL | ImGui_Function_SetValue(ImGui_Function func, "name", value) |
|---|
| Legacy EEL | extension_api("ImGui_Function_SetValue", ImGui_Function func, "name", value) |
|---|
| Lua | reaper.ImGui_Function_SetValue(ImGui_Function func, string name, number value) |
|---|
| Python | ImGui_Function_SetValue(ImGui_Function func, str name, float value) |
|---|
View source
Function: Function_SetValue_Array
| C++ | void ImGui_Function_SetValue_Array(ImGui_Function* func, const char* name, reaper_array* values) |
|---|
| EEL | ImGui_Function_SetValue_Array(ImGui_Function func, "name", reaper_array values) |
|---|
| Legacy EEL | extension_api("ImGui_Function_SetValue_Array", ImGui_Function func, "name", reaper_array values) |
|---|
| Lua | reaper.ImGui_Function_SetValue_Array(ImGui_Function func, string name, reaper_array values) |
|---|
| Python | ImGui_Function_SetValue_Array(ImGui_Function func, str name, reaper_array values) |
|---|
Copy the values in the array to the function's memory at the address stored
in the given variable.
View source
Function: Function_SetValue_String
| C++ | void ImGui_Function_SetValue_String(ImGui_Function* func, const char* name, const char* value, int value_sz) |
|---|
| EEL | ImGui_Function_SetValue_String(ImGui_Function func, "name", "value") |
|---|
| Legacy EEL | extension_api("ImGui_Function_SetValue_String", ImGui_Function func, "name", "value") |
|---|
| Lua | reaper.ImGui_Function_SetValue_String(ImGui_Function func, string name, string value) |
|---|
| Python | ImGui_Function_SetValue_String(ImGui_Function func, str name, str value) |
|---|
Write to a string slot or a named string (when name starts with a #).
View source
Image
ReaImGui currently supports loading PNG and JPEG bitmap images.
Flat vector images may be loaded as fonts, see CreateFont.
UV parameters are texture coordinates in a scale of 0.0 (top/left) to 1.0
(bottom/right). Use values below 0.0 or above 1.0 to tile the image.
There are also image functions in the DrawList API such as
DrawList_AddImageQuad and DrawList_AddImageRounded.
Function: CreateImage
| C++ | ImGui_Image* ImGui_CreateImage(const char* file, int* flagsInOptional = nullptr) |
|---|
| EEL | ImGui_Image* ImGui_CreateImage("file", int flags = nullptr) |
|---|
| Legacy EEL | ImGui_Image* extension_api("ImGui_CreateImage", "file", int flags = nullptr) |
|---|
| Lua | ImGui_Image retval = reaper.ImGui_CreateImage(string file, number flags = nullptr) |
|---|
| Python | ImGui_Image retval = ImGui_CreateImage(str file, int flags = nullptr) |
|---|
The returned object is valid as long as it is used in each defer cycle
unless attached to a context (see Attach).
('flags' currently unused and reserved for future expansion)
View source
Function: CreateImageFromMem
| C++ | ImGui_Image* ImGui_CreateImageFromMem(const char* data, int data_sz) |
|---|
| EEL | ImGui_Image* ImGui_CreateImageFromMem("data") |
|---|
| Legacy EEL | ImGui_Image* extension_api("ImGui_CreateImageFromMem", "data") |
|---|
| Lua | ImGui_Image retval = reaper.ImGui_CreateImageFromMem(string data) |
|---|
| Python | ImGui_Image retval = ImGui_CreateImageFromMem(str data) |
|---|
Requires REAPER v6.44 or newer for EEL and Lua. Load from a file using
CreateImage or explicitely specify data_sz if supporting older versions.
View source
Function: Image
| C++ | void ImGui_Image(ImGui_Context* ctx, ImGui_Image* img, double size_w, double size_h, double* uv0_xInOptional = 0.0, double* uv0_yInOptional = 0.0, double* uv1_xInOptional = 1.0, double* uv1_yInOptional = 1.0, int* tint_col_rgbaInOptional = 0xFFFFFFFF, int* border_col_rgbaInOptional = 0x00000000) |
|---|
| EEL | ImGui_Image(ImGui_Context ctx, ImGui_Image img, size_w, size_h, uv0_x = 0.0, uv0_y = 0.0, uv1_x = 1.0, uv1_y = 1.0, int tint_col_rgba = 0xFFFFFFFF, int border_col_rgba = 0x00000000) |
|---|
| Legacy EEL | extension_api("ImGui_Image", ImGui_Context ctx, ImGui_Image img, size_w, size_h, uv0_x = 0.0, uv0_y = 0.0, uv1_x = 1.0, uv1_y = 1.0, int tint_col_rgba = 0xFFFFFFFF, int border_col_rgba = 0x00000000) |
|---|
| Lua | reaper.ImGui_Image(ImGui_Context ctx, ImGui_Image img, number size_w, number size_h, number uv0_x = 0.0, number uv0_y = 0.0, number uv1_x = 1.0, number uv1_y = 1.0, number tint_col_rgba = 0xFFFFFFFF, number border_col_rgba = 0x00000000) |
|---|
| Python | ImGui_Image(ImGui_Context ctx, ImGui_Image img, float size_w, float size_h, float uv0_x = 0.0, float uv0_y = 0.0, float uv1_x = 1.0, float uv1_y = 1.0, int tint_col_rgba = 0xFFFFFFFF, int border_col_rgba = 0x00000000) |
|---|
View source
Function: ImageButton
| C++ | bool ImGui_ImageButton(ImGui_Context* ctx, const char* str_id, ImGui_Image* img, double size_w, double size_h, double* uv0_xInOptional = 0.0, double* uv0_yInOptional = 0.0, double* uv1_xInOptional = 1.0, double* uv1_yInOptional = 1.0, int* bg_col_rgbaInOptional = 0x00000000, int* tint_col_rgbaInOptional = 0xFFFFFFFF) |
|---|
| EEL | bool ImGui_ImageButton(ImGui_Context ctx, "str_id", ImGui_Image img, size_w, size_h, uv0_x = 0.0, uv0_y = 0.0, uv1_x = 1.0, uv1_y = 1.0, int bg_col_rgba = 0x00000000, int tint_col_rgba = 0xFFFFFFFF) |
|---|
| Legacy EEL | bool extension_api("ImGui_ImageButton", ImGui_Context ctx, "str_id", ImGui_Image img, size_w, size_h, uv0_x = 0.0, uv0_y = 0.0, uv1_x = 1.0, uv1_y = 1.0, int bg_col_rgba = 0x00000000, int tint_col_rgba = 0xFFFFFFFF) |
|---|
| Lua | boolean retval = reaper.ImGui_ImageButton(ImGui_Context ctx, string str_id, ImGui_Image img, number size_w, number size_h, number uv0_x = 0.0, number uv0_y = 0.0, number uv1_x = 1.0, number uv1_y = 1.0, number bg_col_rgba = 0x00000000, number tint_col_rgba = 0xFFFFFFFF) |
|---|
| Python | bool retval = ImGui_ImageButton(ImGui_Context ctx, str str_id, ImGui_Image img, float size_w, float size_h, float uv0_x = 0.0, float uv0_y = 0.0, float uv1_x = 1.0, float uv1_y = 1.0, int bg_col_rgba = 0x00000000, int tint_col_rgba = 0xFFFFFFFF) |
|---|
View source
Function: Image_GetSize
| C++ | void ImGui_Image_GetSize(ImGui_Image* img, double* wOut, double* hOut) |
|---|
| EEL | ImGui_Image_GetSize(ImGui_Image img, &w, &h) |
|---|
| Legacy EEL | extension_api("ImGui_Image_GetSize", ImGui_Image img, &w, &h) |
|---|
| Lua | number w, number h = reaper.ImGui_Image_GetSize(ImGui_Image img) |
|---|
| Python | (float w, float h) = ImGui_Image_GetSize(ImGui_Image img) |
|---|
View source
Image Set
Helper to automatically select and scale an image to the DPI scale of
the current window upon usage.
ImGui_ImageSet objects can be given to any function that expect an image as
parameter.
Usage:
local set = reaper.ImGui_CreateImageSet()
reaper.ImGui_ImageSet_Add(set, 1.0, reaper.ImGui_CreateImage('32x32.png'))
reaper.ImGui_ImageSet_Add(set, 2.0, reaper.ImGui_CreateImage('64x64.png'))
local function frame()
reaper.ImGui_Image(ctx, set, reaper.ImGui_Image_GetSize(set))
-- ...
end
Function: CreateImageSet
| C++ | ImGui_ImageSet* ImGui_CreateImageSet() |
|---|
| EEL | ImGui_ImageSet* ImGui_CreateImageSet() |
|---|
| Legacy EEL | ImGui_ImageSet* extension_api("ImGui_CreateImageSet") |
|---|
| Lua | ImGui_ImageSet retval = reaper.ImGui_CreateImageSet() |
|---|
| Python | ImGui_ImageSet retval = ImGui_CreateImageSet() |
|---|
View source
Function: ImageSet_Add
| C++ | void ImGui_ImageSet_Add(ImGui_ImageSet* set, double scale, ImGui_Image* img) |
|---|
| EEL | ImGui_ImageSet_Add(ImGui_ImageSet set, scale, ImGui_Image img) |
|---|
| Legacy EEL | extension_api("ImGui_ImageSet_Add", ImGui_ImageSet set, scale, ImGui_Image img) |
|---|
| Lua | reaper.ImGui_ImageSet_Add(ImGui_ImageSet set, number scale, ImGui_Image img) |
|---|
| Python | ImGui_ImageSet_Add(ImGui_ImageSet set, float scale, ImGui_Image img) |
|---|
'img' cannot be another ImageSet.
View source
Item & Status
Function: BeginDisabled
| C++ | void ImGui_BeginDisabled(ImGui_Context* ctx, bool* disabledInOptional = true) |
|---|
| EEL | ImGui_BeginDisabled(ImGui_Context ctx, bool disabled = true) |
|---|
| Legacy EEL | extension_api("ImGui_BeginDisabled", ImGui_Context ctx, bool disabled = true) |
|---|
| Lua | reaper.ImGui_BeginDisabled(ImGui_Context ctx, boolean disabled = true) |
|---|
| Python | ImGui_BeginDisabled(ImGui_Context ctx, bool disabled = true) |
|---|
Disable all user interactions and dim items visuals
(applying StyleVar_DisabledAlpha over current colors).
BeginDisabled(false) essentially does nothing useful but is provided to
facilitate use of boolean expressions.
If you can avoid calling BeginDisabled(false)/EndDisabled() best to avoid it.
View source
Function: EndDisabled
| C++ | void ImGui_EndDisabled(ImGui_Context* ctx) |
|---|
| EEL | ImGui_EndDisabled(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_EndDisabled", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_EndDisabled(ImGui_Context ctx) |
|---|
| Python | ImGui_EndDisabled(ImGui_Context ctx) |
|---|
See BeginDisabled.
View source
Function: SetItemAllowOverlap
| C++ | void ImGui_SetItemAllowOverlap(ImGui_Context* ctx) |
|---|
| EEL | ImGui_SetItemAllowOverlap(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_SetItemAllowOverlap", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_SetItemAllowOverlap(ImGui_Context ctx) |
|---|
| Python | ImGui_SetItemAllowOverlap(ImGui_Context ctx) |
|---|
Allow last item to be overlapped by a subsequent item. sometimes useful with
invisible buttons, selectables, etc. to catch unused area.
View source
Dimensions
Function: CalcItemWidth
| C++ | double ImGui_CalcItemWidth(ImGui_Context* ctx) |
|---|
| EEL | double ImGui_CalcItemWidth(ImGui_Context ctx) |
|---|
| Legacy EEL | double extension_api("ImGui_CalcItemWidth", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_CalcItemWidth(ImGui_Context ctx) |
|---|
| Python | float retval = ImGui_CalcItemWidth(ImGui_Context ctx) |
|---|
Width of item given pushed settings and current cursor position.
NOT necessarily the width of last item unlike most 'Item' functions.
View source
Function: GetItemRectMax
| C++ | void ImGui_GetItemRectMax(ImGui_Context* ctx, double* xOut, double* yOut) |
|---|
| EEL | ImGui_GetItemRectMax(ImGui_Context ctx, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_GetItemRectMax", ImGui_Context ctx, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_GetItemRectMax(ImGui_Context ctx) |
|---|
| Python | (float x, float y) = ImGui_GetItemRectMax(ImGui_Context ctx) |
|---|
Get lower-right bounding rectangle of the last item (screen space)
View source
Function: GetItemRectMin
| C++ | void ImGui_GetItemRectMin(ImGui_Context* ctx, double* xOut, double* yOut) |
|---|
| EEL | ImGui_GetItemRectMin(ImGui_Context ctx, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_GetItemRectMin", ImGui_Context ctx, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_GetItemRectMin(ImGui_Context ctx) |
|---|
| Python | (float x, float y) = ImGui_GetItemRectMin(ImGui_Context ctx) |
|---|
Get upper-left bounding rectangle of the last item (screen space)
View source
Function: GetItemRectSize
| C++ | void ImGui_GetItemRectSize(ImGui_Context* ctx, double* wOut, double* hOut) |
|---|
| EEL | ImGui_GetItemRectSize(ImGui_Context ctx, &w, &h) |
|---|
| Legacy EEL | extension_api("ImGui_GetItemRectSize", ImGui_Context ctx, &w, &h) |
|---|
| Lua | number w, number h = reaper.ImGui_GetItemRectSize(ImGui_Context ctx) |
|---|
| Python | (float w, float h) = ImGui_GetItemRectSize(ImGui_Context ctx) |
|---|
Get size of last item
View source
Function: PopItemWidth
| C++ | void ImGui_PopItemWidth(ImGui_Context* ctx) |
|---|
| EEL | ImGui_PopItemWidth(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_PopItemWidth", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_PopItemWidth(ImGui_Context ctx) |
|---|
| Python | ImGui_PopItemWidth(ImGui_Context ctx) |
|---|
See PushItemWidth
View source
Function: PushItemWidth
| C++ | void ImGui_PushItemWidth(ImGui_Context* ctx, double item_width) |
|---|
| EEL | ImGui_PushItemWidth(ImGui_Context ctx, item_width) |
|---|
| Legacy EEL | extension_api("ImGui_PushItemWidth", ImGui_Context ctx, item_width) |
|---|
| Lua | reaper.ImGui_PushItemWidth(ImGui_Context ctx, number item_width) |
|---|
| Python | ImGui_PushItemWidth(ImGui_Context ctx, float item_width) |
|---|
Push width of items for common large "item+label" widgets.
- >0.0: width in pixels
- <0.0 align xx pixels to the right of window
(so -FLT_MIN always align width to the right side)
- 0.0 = default to ~2/3 of windows width.
View source
Function: SetNextItemWidth
| C++ | void ImGui_SetNextItemWidth(ImGui_Context* ctx, double item_width) |
|---|
| EEL | ImGui_SetNextItemWidth(ImGui_Context ctx, item_width) |
|---|
| Legacy EEL | extension_api("ImGui_SetNextItemWidth", ImGui_Context ctx, item_width) |
|---|
| Lua | reaper.ImGui_SetNextItemWidth(ImGui_Context ctx, number item_width) |
|---|
| Python | ImGui_SetNextItemWidth(ImGui_Context ctx, float item_width) |
|---|
Set width of the next common large "item+label" widget.
- >0.0: width in pixels
- <0.0 align xx pixels to the right of window
(so -FLT_MIN always align width to the right side)
View source
Focus & Activation
Prefer using "SetItemDefaultFocus()" over
"if(IsWindowAppearing()) SetScrollHereY()" when applicable to signify
"this is the default item".
Function: PopTabStop
| C++ | void ImGui_PopTabStop(ImGui_Context* ctx) |
|---|
| EEL | ImGui_PopTabStop(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_PopTabStop", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_PopTabStop(ImGui_Context ctx) |
|---|
| Python | ImGui_PopTabStop(ImGui_Context ctx) |
|---|
See PushTabStop
View source
Function: PushTabStop
| C++ | void ImGui_PushTabStop(ImGui_Context* ctx, bool tab_stop) |
|---|
| EEL | ImGui_PushTabStop(ImGui_Context ctx, bool tab_stop) |
|---|
| Legacy EEL | extension_api("ImGui_PushTabStop", ImGui_Context ctx, bool tab_stop) |
|---|
| Lua | reaper.ImGui_PushTabStop(ImGui_Context ctx, boolean tab_stop) |
|---|
| Python | ImGui_PushTabStop(ImGui_Context ctx, bool tab_stop) |
|---|
Allow focusing using TAB/Shift-TAB, enabled by default but you can disable it
for certain widgets
View source
Function: SetItemDefaultFocus
| C++ | void ImGui_SetItemDefaultFocus(ImGui_Context* ctx) |
|---|
| EEL | ImGui_SetItemDefaultFocus(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_SetItemDefaultFocus", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_SetItemDefaultFocus(ImGui_Context ctx) |
|---|
| Python | ImGui_SetItemDefaultFocus(ImGui_Context ctx) |
|---|
Make last item the default focused item of a window.
View source
Function: SetKeyboardFocusHere
| C++ | void ImGui_SetKeyboardFocusHere(ImGui_Context* ctx, int* offsetInOptional = 0) |
|---|
| EEL | ImGui_SetKeyboardFocusHere(ImGui_Context ctx, int offset = 0) |
|---|
| Legacy EEL | extension_api("ImGui_SetKeyboardFocusHere", ImGui_Context ctx, int offset = 0) |
|---|
| Lua | reaper.ImGui_SetKeyboardFocusHere(ImGui_Context ctx, number offset = 0) |
|---|
| Python | ImGui_SetKeyboardFocusHere(ImGui_Context ctx, int offset = 0) |
|---|
Focus keyboard on the next widget. Use positive 'offset' to access sub
components of a multiple component widget. Use -1 to access previous widget.
View source
Hovered Flags
For IsItemHovered(), IsWindowHovered() etc.
Constant: HoveredFlags_AllowWhenBlockedByActiveItem
| C++ | int ImGui_HoveredFlags_AllowWhenBlockedByActiveItem |
|---|
| EEL | int ImGui_HoveredFlags_AllowWhenBlockedByActiveItem() |
|---|
| Legacy EEL | int extension_api("ImGui_HoveredFlags_AllowWhenBlockedByActiveItem") |
|---|
| Lua | number retval = reaper.ImGui_HoveredFlags_AllowWhenBlockedByActiveItem() |
|---|
| Python | int retval = ImGui_HoveredFlags_AllowWhenBlockedByActiveItem() |
|---|
Return true even if an active item is blocking access to this item/window.
Useful for Drag and Drop patterns.
View source
Constant: HoveredFlags_DelayNormal
| C++ | int ImGui_HoveredFlags_DelayNormal |
|---|
| EEL | int ImGui_HoveredFlags_DelayNormal() |
|---|
| Legacy EEL | int extension_api("ImGui_HoveredFlags_DelayNormal") |
|---|
| Lua | number retval = reaper.ImGui_HoveredFlags_DelayNormal() |
|---|
| Python | int retval = ImGui_HoveredFlags_DelayNormal() |
|---|
Return true after ConfigVar_HoverDelayNormal elapsed (~0.30 sec)
View source
Constant: HoveredFlags_DelayShort
| C++ | int ImGui_HoveredFlags_DelayShort |
|---|
| EEL | int ImGui_HoveredFlags_DelayShort() |
|---|
| Legacy EEL | int extension_api("ImGui_HoveredFlags_DelayShort") |
|---|
| Lua | number retval = reaper.ImGui_HoveredFlags_DelayShort() |
|---|
| Python | int retval = ImGui_HoveredFlags_DelayShort() |
|---|
Return true after ConfigVar_HoverDelayShort elapsed (~0.10 sec)
View source
Constant: HoveredFlags_NoNavOverride
| C++ | int ImGui_HoveredFlags_NoNavOverride |
|---|
| EEL | int ImGui_HoveredFlags_NoNavOverride() |
|---|
| Legacy EEL | int extension_api("ImGui_HoveredFlags_NoNavOverride") |
|---|
| Lua | number retval = reaper.ImGui_HoveredFlags_NoNavOverride() |
|---|
| Python | int retval = ImGui_HoveredFlags_NoNavOverride() |
|---|
Disable using gamepad/keyboard navigation state when active, always query mouse.
View source
Constant: HoveredFlags_NoSharedDelay
| C++ | int ImGui_HoveredFlags_NoSharedDelay |
|---|
| EEL | int ImGui_HoveredFlags_NoSharedDelay() |
|---|
| Legacy EEL | int extension_api("ImGui_HoveredFlags_NoSharedDelay") |
|---|
| Lua | number retval = reaper.ImGui_HoveredFlags_NoSharedDelay() |
|---|
| Python | int retval = ImGui_HoveredFlags_NoSharedDelay() |
|---|
Disable shared delay system where moving from one item to the next keeps
the previous timer for a short time (standard for tooltips with long delays
View source
Constant: HoveredFlags_None
| C++ | int ImGui_HoveredFlags_None |
|---|
| EEL | int ImGui_HoveredFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_HoveredFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_HoveredFlags_None() |
|---|
| Python | int retval = ImGui_HoveredFlags_None() |
|---|
Return true if directly over the item/window, not obstructed by another
window, not obstructed by an active popup or modal blocking inputs under them.
View source
IsItemHovered only
Constant: HoveredFlags_AllowWhenDisabled
| C++ | int ImGui_HoveredFlags_AllowWhenDisabled |
|---|
| EEL | int ImGui_HoveredFlags_AllowWhenDisabled() |
|---|
| Legacy EEL | int extension_api("ImGui_HoveredFlags_AllowWhenDisabled") |
|---|
| Lua | number retval = reaper.ImGui_HoveredFlags_AllowWhenDisabled() |
|---|
| Python | int retval = ImGui_HoveredFlags_AllowWhenDisabled() |
|---|
IsItemHovered only: Return true even if the item is disabled.
View source
Constant: HoveredFlags_AllowWhenOverlapped
| C++ | int ImGui_HoveredFlags_AllowWhenOverlapped |
|---|
| EEL | int ImGui_HoveredFlags_AllowWhenOverlapped() |
|---|
| Legacy EEL | int extension_api("ImGui_HoveredFlags_AllowWhenOverlapped") |
|---|
| Lua | number retval = reaper.ImGui_HoveredFlags_AllowWhenOverlapped() |
|---|
| Python | int retval = ImGui_HoveredFlags_AllowWhenOverlapped() |
|---|
IsItemHovered only: Return true even if the position is obstructed or
overlapped by another window.
View source
Constant: HoveredFlags_RectOnly
| C++ | int ImGui_HoveredFlags_RectOnly |
|---|
| EEL | int ImGui_HoveredFlags_RectOnly() |
|---|
| Legacy EEL | int extension_api("ImGui_HoveredFlags_RectOnly") |
|---|
| Lua | number retval = reaper.ImGui_HoveredFlags_RectOnly() |
|---|
| Python | int retval = ImGui_HoveredFlags_RectOnly() |
|---|
HoveredFlags_AllowWhenBlockedByPopup |
HoveredFlags_AllowWhenBlockedByActiveItem | HoveredFlags_AllowWhenOverlapped
View source
IsWindowHovered only
Constant: HoveredFlags_AnyWindow
| C++ | int ImGui_HoveredFlags_AnyWindow |
|---|
| EEL | int ImGui_HoveredFlags_AnyWindow() |
|---|
| Legacy EEL | int extension_api("ImGui_HoveredFlags_AnyWindow") |
|---|
| Lua | number retval = reaper.ImGui_HoveredFlags_AnyWindow() |
|---|
| Python | int retval = ImGui_HoveredFlags_AnyWindow() |
|---|
IsWindowHovered only: Return true if any window is hovered.
View source
Constant: HoveredFlags_ChildWindows
| C++ | int ImGui_HoveredFlags_ChildWindows |
|---|
| EEL | int ImGui_HoveredFlags_ChildWindows() |
|---|
| Legacy EEL | int extension_api("ImGui_HoveredFlags_ChildWindows") |
|---|
| Lua | number retval = reaper.ImGui_HoveredFlags_ChildWindows() |
|---|
| Python | int retval = ImGui_HoveredFlags_ChildWindows() |
|---|
IsWindowHovered only: Return true if any children of the window is hovered.
View source
Constant: HoveredFlags_DockHierarchy
| C++ | int ImGui_HoveredFlags_DockHierarchy |
|---|
| EEL | int ImGui_HoveredFlags_DockHierarchy() |
|---|
| Legacy EEL | int extension_api("ImGui_HoveredFlags_DockHierarchy") |
|---|
| Lua | number retval = reaper.ImGui_HoveredFlags_DockHierarchy() |
|---|
| Python | int retval = ImGui_HoveredFlags_DockHierarchy() |
|---|
IsWindowHovered only: Consider docking hierarchy (treat dockspace host as
parent of docked window) (when used with _ChildWindows or _RootWindow).
View source
Constant: HoveredFlags_RootAndChildWindows
| C++ | int ImGui_HoveredFlags_RootAndChildWindows |
|---|
| EEL | int ImGui_HoveredFlags_RootAndChildWindows() |
|---|
| Legacy EEL | int extension_api("ImGui_HoveredFlags_RootAndChildWindows") |
|---|
| Lua | number retval = reaper.ImGui_HoveredFlags_RootAndChildWindows() |
|---|
| Python | int retval = ImGui_HoveredFlags_RootAndChildWindows() |
|---|
HoveredFlags_RootWindow | HoveredFlags_ChildWindows
View source
Constant: HoveredFlags_RootWindow
| C++ | int ImGui_HoveredFlags_RootWindow |
|---|
| EEL | int ImGui_HoveredFlags_RootWindow() |
|---|
| Legacy EEL | int extension_api("ImGui_HoveredFlags_RootWindow") |
|---|
| Lua | number retval = reaper.ImGui_HoveredFlags_RootWindow() |
|---|
| Python | int retval = ImGui_HoveredFlags_RootWindow() |
|---|
IsWindowHovered only: Test from root window (top most parent of the current hierarchy).
View source
Most of the functions are referring to the previous Item that has been submitted.
See Demo Window under "Widgets->Querying Item Status" for an interactive
visualization of most of those functions.
Function: IsAnyItemActive
| C++ | bool ImGui_IsAnyItemActive(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_IsAnyItemActive(ImGui_Context ctx) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsAnyItemActive", ImGui_Context ctx) |
|---|
| Lua | boolean retval = reaper.ImGui_IsAnyItemActive(ImGui_Context ctx) |
|---|
| Python | bool retval = ImGui_IsAnyItemActive(ImGui_Context ctx) |
|---|
View source
Function: IsAnyItemFocused
| C++ | bool ImGui_IsAnyItemFocused(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_IsAnyItemFocused(ImGui_Context ctx) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsAnyItemFocused", ImGui_Context ctx) |
|---|
| Lua | boolean retval = reaper.ImGui_IsAnyItemFocused(ImGui_Context ctx) |
|---|
| Python | bool retval = ImGui_IsAnyItemFocused(ImGui_Context ctx) |
|---|
View source
Function: IsAnyItemHovered
| C++ | bool ImGui_IsAnyItemHovered(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_IsAnyItemHovered(ImGui_Context ctx) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsAnyItemHovered", ImGui_Context ctx) |
|---|
| Lua | boolean retval = reaper.ImGui_IsAnyItemHovered(ImGui_Context ctx) |
|---|
| Python | bool retval = ImGui_IsAnyItemHovered(ImGui_Context ctx) |
|---|
View source
Function: IsItemActivated
| C++ | bool ImGui_IsItemActivated(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_IsItemActivated(ImGui_Context ctx) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsItemActivated", ImGui_Context ctx) |
|---|
| Lua | boolean retval = reaper.ImGui_IsItemActivated(ImGui_Context ctx) |
|---|
| Python | bool retval = ImGui_IsItemActivated(ImGui_Context ctx) |
|---|
Was the last item just made active (item was previously inactive).
View source
Function: IsItemActive
| C++ | bool ImGui_IsItemActive(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_IsItemActive(ImGui_Context ctx) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsItemActive", ImGui_Context ctx) |
|---|
| Lua | boolean retval = reaper.ImGui_IsItemActive(ImGui_Context ctx) |
|---|
| Python | bool retval = ImGui_IsItemActive(ImGui_Context ctx) |
|---|
Is the last item active? (e.g. button being held, text field being edited.
This will continuously return true while holding mouse button on an item.
Items that don't interact will always return false.
View source
Function: IsItemClicked
| C++ | bool ImGui_IsItemClicked(ImGui_Context* ctx, int* mouse_buttonInOptional = MouseButton_Left) |
|---|
| EEL | bool ImGui_IsItemClicked(ImGui_Context ctx, int mouse_button = MouseButton_Left) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsItemClicked", ImGui_Context ctx, int mouse_button = MouseButton_Left) |
|---|
| Lua | boolean retval = reaper.ImGui_IsItemClicked(ImGui_Context ctx, number mouse_button = MouseButton_Left) |
|---|
| Python | bool retval = ImGui_IsItemClicked(ImGui_Context ctx, int mouse_button = MouseButton_Left) |
|---|
Is the last item clicked? (e.g. button/node just clicked on)
== IsMouseClicked(mouse_button) && IsItemHovered().
This is NOT equivalent to the behavior of e.g. Button.
Most widgets have specific reactions based on mouse-up/down state, mouse position etc.
View source
Function: IsItemDeactivated
| C++ | bool ImGui_IsItemDeactivated(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_IsItemDeactivated(ImGui_Context ctx) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsItemDeactivated", ImGui_Context ctx) |
|---|
| Lua | boolean retval = reaper.ImGui_IsItemDeactivated(ImGui_Context ctx) |
|---|
| Python | bool retval = ImGui_IsItemDeactivated(ImGui_Context ctx) |
|---|
Was the last item just made inactive (item was previously active).
Useful for Undo/Redo patterns with widgets that require continuous editing.
View source
Function: IsItemDeactivatedAfterEdit
| C++ | bool ImGui_IsItemDeactivatedAfterEdit(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_IsItemDeactivatedAfterEdit(ImGui_Context ctx) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsItemDeactivatedAfterEdit", ImGui_Context ctx) |
|---|
| Lua | boolean retval = reaper.ImGui_IsItemDeactivatedAfterEdit(ImGui_Context ctx) |
|---|
| Python | bool retval = ImGui_IsItemDeactivatedAfterEdit(ImGui_Context ctx) |
|---|
Was the last item just made inactive and made a value change when it was
active? (e.g. Slider/Drag moved).
Useful for Undo/Redo patterns with widgets that require continuous editing. Note
that you may get false positives (some widgets such as Combo/ListBox/Selectable
will return true even when clicking an already selected item).
View source
Function: IsItemEdited
| C++ | bool ImGui_IsItemEdited(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_IsItemEdited(ImGui_Context ctx) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsItemEdited", ImGui_Context ctx) |
|---|
| Lua | boolean retval = reaper.ImGui_IsItemEdited(ImGui_Context ctx) |
|---|
| Python | bool retval = ImGui_IsItemEdited(ImGui_Context ctx) |
|---|
Did the last item modify its underlying value this frame? or was pressed?
This is generally the same as the "bool" return value of many widgets.
View source
Function: IsItemFocused
| C++ | bool ImGui_IsItemFocused(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_IsItemFocused(ImGui_Context ctx) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsItemFocused", ImGui_Context ctx) |
|---|
| Lua | boolean retval = reaper.ImGui_IsItemFocused(ImGui_Context ctx) |
|---|
| Python | bool retval = ImGui_IsItemFocused(ImGui_Context ctx) |
|---|
Is the last item focused for keyboard/gamepad navigation?
View source
Function: IsItemHovered
| C++ | bool ImGui_IsItemHovered(ImGui_Context* ctx, int* flagsInOptional = HoveredFlags_None) |
|---|
| EEL | bool ImGui_IsItemHovered(ImGui_Context ctx, int flags = HoveredFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsItemHovered", ImGui_Context ctx, int flags = HoveredFlags_None) |
|---|
| Lua | boolean retval = reaper.ImGui_IsItemHovered(ImGui_Context ctx, number flags = HoveredFlags_None) |
|---|
| Python | bool retval = ImGui_IsItemHovered(ImGui_Context ctx, int flags = HoveredFlags_None) |
|---|
Is the last item hovered? (and usable, aka not blocked by a popup, etc.).
See HoveredFlags_* for more options.
View source
Function: IsItemVisible
| C++ | bool ImGui_IsItemVisible(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_IsItemVisible(ImGui_Context ctx) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsItemVisible", ImGui_Context ctx) |
|---|
| Lua | boolean retval = reaper.ImGui_IsItemVisible(ImGui_Context ctx) |
|---|
| Python | bool retval = ImGui_IsItemVisible(ImGui_Context ctx) |
|---|
Is the last item visible? (items may be out of sight because of clipping/scrolling)
View source
Keyboard & Mouse
Keyboard
Function: GetInputQueueCharacter
| C++ | bool ImGui_GetInputQueueCharacter(ImGui_Context* ctx, int idx, int* unicode_charOut) |
|---|
| EEL | bool ImGui_GetInputQueueCharacter(ImGui_Context ctx, int idx, int &unicode_char) |
|---|
| Legacy EEL | bool extension_api("ImGui_GetInputQueueCharacter", ImGui_Context ctx, int idx, int &unicode_char) |
|---|
| Lua | boolean retval, number unicode_char = reaper.ImGui_GetInputQueueCharacter(ImGui_Context ctx, number idx) |
|---|
| Python | (bool retval, int unicode_char) = ImGui_GetInputQueueCharacter(ImGui_Context ctx, int idx) |
|---|
Read from ImGui's character input queue.
Call with increasing idx until false is returned.
View source
Function: GetKeyDownDuration
| C++ | double ImGui_GetKeyDownDuration(ImGui_Context* ctx, int key) |
|---|
| EEL | double ImGui_GetKeyDownDuration(ImGui_Context ctx, int key) |
|---|
| Legacy EEL | double extension_api("ImGui_GetKeyDownDuration", ImGui_Context ctx, int key) |
|---|
| Lua | number retval = reaper.ImGui_GetKeyDownDuration(ImGui_Context ctx, number key) |
|---|
| Python | float retval = ImGui_GetKeyDownDuration(ImGui_Context ctx, int key) |
|---|
Duration the keyboard key has been down (0.0 == just pressed)
View source
Function: GetKeyMods
| C++ | int ImGui_GetKeyMods(ImGui_Context* ctx) |
|---|
| EEL | int ImGui_GetKeyMods(ImGui_Context ctx) |
|---|
| Legacy EEL | int extension_api("ImGui_GetKeyMods", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetKeyMods(ImGui_Context ctx) |
|---|
| Python | int retval = ImGui_GetKeyMods(ImGui_Context ctx) |
|---|
Flags for the Ctrl/Shift/Alt/Super keys. Uses Mod_* values.
View source
Function: GetKeyPressedAmount
| C++ | int ImGui_GetKeyPressedAmount(ImGui_Context* ctx, int key, double repeat_delay, double rate) |
|---|
| EEL | int ImGui_GetKeyPressedAmount(ImGui_Context ctx, int key, repeat_delay, rate) |
|---|
| Legacy EEL | int extension_api("ImGui_GetKeyPressedAmount", ImGui_Context ctx, int key, repeat_delay, rate) |
|---|
| Lua | number retval = reaper.ImGui_GetKeyPressedAmount(ImGui_Context ctx, number key, number repeat_delay, number rate) |
|---|
| Python | int retval = ImGui_GetKeyPressedAmount(ImGui_Context ctx, int key, float repeat_delay, float rate) |
|---|
Uses provided repeat rate/delay. Return a count, most often 0 or 1 but might
be >1 if ConfigVar_RepeatRate is small enough that GetDeltaTime > RepeatRate.
View source
Function: IsKeyDown
| C++ | bool ImGui_IsKeyDown(ImGui_Context* ctx, int key) |
|---|
| EEL | bool ImGui_IsKeyDown(ImGui_Context ctx, int key) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsKeyDown", ImGui_Context ctx, int key) |
|---|
| Lua | boolean retval = reaper.ImGui_IsKeyDown(ImGui_Context ctx, number key) |
|---|
| Python | bool retval = ImGui_IsKeyDown(ImGui_Context ctx, int key) |
|---|
Is key being held.
View source
Function: IsKeyPressed
| C++ | bool ImGui_IsKeyPressed(ImGui_Context* ctx, int key, bool* repeatInOptional = true) |
|---|
| EEL | bool ImGui_IsKeyPressed(ImGui_Context ctx, int key, bool repeat = true) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsKeyPressed", ImGui_Context ctx, int key, bool repeat = true) |
|---|
| Lua | boolean retval = reaper.ImGui_IsKeyPressed(ImGui_Context ctx, number key, boolean repeat = true) |
|---|
| Python | bool retval = ImGui_IsKeyPressed(ImGui_Context ctx, int key, bool repeat = true) |
|---|
Was key pressed (went from !Down to Down)?
If repeat=true, uses ConfigVar_KeyRepeatDelay / ConfigVar_KeyRepeatRate.
View source
Function: IsKeyReleased
| C++ | bool ImGui_IsKeyReleased(ImGui_Context* ctx, int key) |
|---|
| EEL | bool ImGui_IsKeyReleased(ImGui_Context ctx, int key) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsKeyReleased", ImGui_Context ctx, int key) |
|---|
| Lua | boolean retval = reaper.ImGui_IsKeyReleased(ImGui_Context ctx, number key) |
|---|
| Python | bool retval = ImGui_IsKeyReleased(ImGui_Context ctx, int key) |
|---|
Was key released (went from Down to !Down)?
View source
Function: SetNextFrameWantCaptureKeyboard
| C++ | void ImGui_SetNextFrameWantCaptureKeyboard(ImGui_Context* ctx, bool want_capture_keyboard) |
|---|
| EEL | ImGui_SetNextFrameWantCaptureKeyboard(ImGui_Context ctx, bool want_capture_keyboard) |
|---|
| Legacy EEL | extension_api("ImGui_SetNextFrameWantCaptureKeyboard", ImGui_Context ctx, bool want_capture_keyboard) |
|---|
| Lua | reaper.ImGui_SetNextFrameWantCaptureKeyboard(ImGui_Context ctx, boolean want_capture_keyboard) |
|---|
| Python | ImGui_SetNextFrameWantCaptureKeyboard(ImGui_Context ctx, bool want_capture_keyboard) |
|---|
Request capture of keyboard shortcuts in REAPER's global scope for the next frame.
View source
Named Keys
Keyboard
Constant: Key_0
| C++ | int ImGui_Key_0 |
|---|
| EEL | int ImGui_Key_0() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_0") |
|---|
| Lua | number retval = reaper.ImGui_Key_0() |
|---|
| Python | int retval = ImGui_Key_0() |
|---|
View source
Constant: Key_1
| C++ | int ImGui_Key_1 |
|---|
| EEL | int ImGui_Key_1() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_1") |
|---|
| Lua | number retval = reaper.ImGui_Key_1() |
|---|
| Python | int retval = ImGui_Key_1() |
|---|
View source
Constant: Key_2
| C++ | int ImGui_Key_2 |
|---|
| EEL | int ImGui_Key_2() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_2") |
|---|
| Lua | number retval = reaper.ImGui_Key_2() |
|---|
| Python | int retval = ImGui_Key_2() |
|---|
View source
Constant: Key_3
| C++ | int ImGui_Key_3 |
|---|
| EEL | int ImGui_Key_3() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_3") |
|---|
| Lua | number retval = reaper.ImGui_Key_3() |
|---|
| Python | int retval = ImGui_Key_3() |
|---|
View source
Constant: Key_4
| C++ | int ImGui_Key_4 |
|---|
| EEL | int ImGui_Key_4() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_4") |
|---|
| Lua | number retval = reaper.ImGui_Key_4() |
|---|
| Python | int retval = ImGui_Key_4() |
|---|
View source
Constant: Key_5
| C++ | int ImGui_Key_5 |
|---|
| EEL | int ImGui_Key_5() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_5") |
|---|
| Lua | number retval = reaper.ImGui_Key_5() |
|---|
| Python | int retval = ImGui_Key_5() |
|---|
View source
Constant: Key_6
| C++ | int ImGui_Key_6 |
|---|
| EEL | int ImGui_Key_6() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_6") |
|---|
| Lua | number retval = reaper.ImGui_Key_6() |
|---|
| Python | int retval = ImGui_Key_6() |
|---|
View source
Constant: Key_7
| C++ | int ImGui_Key_7 |
|---|
| EEL | int ImGui_Key_7() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_7") |
|---|
| Lua | number retval = reaper.ImGui_Key_7() |
|---|
| Python | int retval = ImGui_Key_7() |
|---|
View source
Constant: Key_8
| C++ | int ImGui_Key_8 |
|---|
| EEL | int ImGui_Key_8() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_8") |
|---|
| Lua | number retval = reaper.ImGui_Key_8() |
|---|
| Python | int retval = ImGui_Key_8() |
|---|
View source
Constant: Key_9
| C++ | int ImGui_Key_9 |
|---|
| EEL | int ImGui_Key_9() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_9") |
|---|
| Lua | number retval = reaper.ImGui_Key_9() |
|---|
| Python | int retval = ImGui_Key_9() |
|---|
View source
Constant: Key_A
| C++ | int ImGui_Key_A |
|---|
| EEL | int ImGui_Key_A() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_A") |
|---|
| Lua | number retval = reaper.ImGui_Key_A() |
|---|
| Python | int retval = ImGui_Key_A() |
|---|
View source
Constant: Key_Apostrophe
| C++ | int ImGui_Key_Apostrophe |
|---|
| EEL | int ImGui_Key_Apostrophe() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Apostrophe") |
|---|
| Lua | number retval = reaper.ImGui_Key_Apostrophe() |
|---|
| Python | int retval = ImGui_Key_Apostrophe() |
|---|
'
View source
Constant: Key_B
| C++ | int ImGui_Key_B |
|---|
| EEL | int ImGui_Key_B() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_B") |
|---|
| Lua | number retval = reaper.ImGui_Key_B() |
|---|
| Python | int retval = ImGui_Key_B() |
|---|
View source
Constant: Key_Backslash
| C++ | int ImGui_Key_Backslash |
|---|
| EEL | int ImGui_Key_Backslash() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Backslash") |
|---|
| Lua | number retval = reaper.ImGui_Key_Backslash() |
|---|
| Python | int retval = ImGui_Key_Backslash() |
|---|
\
View source
Constant: Key_Backspace
| C++ | int ImGui_Key_Backspace |
|---|
| EEL | int ImGui_Key_Backspace() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Backspace") |
|---|
| Lua | number retval = reaper.ImGui_Key_Backspace() |
|---|
| Python | int retval = ImGui_Key_Backspace() |
|---|
View source
Constant: Key_C
| C++ | int ImGui_Key_C |
|---|
| EEL | int ImGui_Key_C() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_C") |
|---|
| Lua | number retval = reaper.ImGui_Key_C() |
|---|
| Python | int retval = ImGui_Key_C() |
|---|
View source
Constant: Key_CapsLock
| C++ | int ImGui_Key_CapsLock |
|---|
| EEL | int ImGui_Key_CapsLock() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_CapsLock") |
|---|
| Lua | number retval = reaper.ImGui_Key_CapsLock() |
|---|
| Python | int retval = ImGui_Key_CapsLock() |
|---|
View source
Constant: Key_Comma
| C++ | int ImGui_Key_Comma |
|---|
| EEL | int ImGui_Key_Comma() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Comma") |
|---|
| Lua | number retval = reaper.ImGui_Key_Comma() |
|---|
| Python | int retval = ImGui_Key_Comma() |
|---|
,
View source
Constant: Key_D
| C++ | int ImGui_Key_D |
|---|
| EEL | int ImGui_Key_D() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_D") |
|---|
| Lua | number retval = reaper.ImGui_Key_D() |
|---|
| Python | int retval = ImGui_Key_D() |
|---|
View source
Constant: Key_Delete
| C++ | int ImGui_Key_Delete |
|---|
| EEL | int ImGui_Key_Delete() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Delete") |
|---|
| Lua | number retval = reaper.ImGui_Key_Delete() |
|---|
| Python | int retval = ImGui_Key_Delete() |
|---|
View source
Constant: Key_DownArrow
| C++ | int ImGui_Key_DownArrow |
|---|
| EEL | int ImGui_Key_DownArrow() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_DownArrow") |
|---|
| Lua | number retval = reaper.ImGui_Key_DownArrow() |
|---|
| Python | int retval = ImGui_Key_DownArrow() |
|---|
View source
Constant: Key_E
| C++ | int ImGui_Key_E |
|---|
| EEL | int ImGui_Key_E() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_E") |
|---|
| Lua | number retval = reaper.ImGui_Key_E() |
|---|
| Python | int retval = ImGui_Key_E() |
|---|
View source
Constant: Key_End
| C++ | int ImGui_Key_End |
|---|
| EEL | int ImGui_Key_End() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_End") |
|---|
| Lua | number retval = reaper.ImGui_Key_End() |
|---|
| Python | int retval = ImGui_Key_End() |
|---|
View source
Constant: Key_Enter
| C++ | int ImGui_Key_Enter |
|---|
| EEL | int ImGui_Key_Enter() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Enter") |
|---|
| Lua | number retval = reaper.ImGui_Key_Enter() |
|---|
| Python | int retval = ImGui_Key_Enter() |
|---|
View source
Constant: Key_Equal
| C++ | int ImGui_Key_Equal |
|---|
| EEL | int ImGui_Key_Equal() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Equal") |
|---|
| Lua | number retval = reaper.ImGui_Key_Equal() |
|---|
| Python | int retval = ImGui_Key_Equal() |
|---|
=
View source
Constant: Key_Escape
| C++ | int ImGui_Key_Escape |
|---|
| EEL | int ImGui_Key_Escape() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Escape") |
|---|
| Lua | number retval = reaper.ImGui_Key_Escape() |
|---|
| Python | int retval = ImGui_Key_Escape() |
|---|
View source
Constant: Key_F
| C++ | int ImGui_Key_F |
|---|
| EEL | int ImGui_Key_F() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_F") |
|---|
| Lua | number retval = reaper.ImGui_Key_F() |
|---|
| Python | int retval = ImGui_Key_F() |
|---|
View source
Constant: Key_F1
| C++ | int ImGui_Key_F1 |
|---|
| EEL | int ImGui_Key_F1() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_F1") |
|---|
| Lua | number retval = reaper.ImGui_Key_F1() |
|---|
| Python | int retval = ImGui_Key_F1() |
|---|
View source
Constant: Key_F10
| C++ | int ImGui_Key_F10 |
|---|
| EEL | int ImGui_Key_F10() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_F10") |
|---|
| Lua | number retval = reaper.ImGui_Key_F10() |
|---|
| Python | int retval = ImGui_Key_F10() |
|---|
View source
Constant: Key_F11
| C++ | int ImGui_Key_F11 |
|---|
| EEL | int ImGui_Key_F11() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_F11") |
|---|
| Lua | number retval = reaper.ImGui_Key_F11() |
|---|
| Python | int retval = ImGui_Key_F11() |
|---|
View source
Constant: Key_F12
| C++ | int ImGui_Key_F12 |
|---|
| EEL | int ImGui_Key_F12() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_F12") |
|---|
| Lua | number retval = reaper.ImGui_Key_F12() |
|---|
| Python | int retval = ImGui_Key_F12() |
|---|
View source
Constant: Key_F2
| C++ | int ImGui_Key_F2 |
|---|
| EEL | int ImGui_Key_F2() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_F2") |
|---|
| Lua | number retval = reaper.ImGui_Key_F2() |
|---|
| Python | int retval = ImGui_Key_F2() |
|---|
View source
Constant: Key_F3
| C++ | int ImGui_Key_F3 |
|---|
| EEL | int ImGui_Key_F3() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_F3") |
|---|
| Lua | number retval = reaper.ImGui_Key_F3() |
|---|
| Python | int retval = ImGui_Key_F3() |
|---|
View source
Constant: Key_F4
| C++ | int ImGui_Key_F4 |
|---|
| EEL | int ImGui_Key_F4() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_F4") |
|---|
| Lua | number retval = reaper.ImGui_Key_F4() |
|---|
| Python | int retval = ImGui_Key_F4() |
|---|
View source
Constant: Key_F5
| C++ | int ImGui_Key_F5 |
|---|
| EEL | int ImGui_Key_F5() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_F5") |
|---|
| Lua | number retval = reaper.ImGui_Key_F5() |
|---|
| Python | int retval = ImGui_Key_F5() |
|---|
View source
Constant: Key_F6
| C++ | int ImGui_Key_F6 |
|---|
| EEL | int ImGui_Key_F6() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_F6") |
|---|
| Lua | number retval = reaper.ImGui_Key_F6() |
|---|
| Python | int retval = ImGui_Key_F6() |
|---|
View source
Constant: Key_F7
| C++ | int ImGui_Key_F7 |
|---|
| EEL | int ImGui_Key_F7() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_F7") |
|---|
| Lua | number retval = reaper.ImGui_Key_F7() |
|---|
| Python | int retval = ImGui_Key_F7() |
|---|
View source
Constant: Key_F8
| C++ | int ImGui_Key_F8 |
|---|
| EEL | int ImGui_Key_F8() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_F8") |
|---|
| Lua | number retval = reaper.ImGui_Key_F8() |
|---|
| Python | int retval = ImGui_Key_F8() |
|---|
View source
Constant: Key_F9
| C++ | int ImGui_Key_F9 |
|---|
| EEL | int ImGui_Key_F9() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_F9") |
|---|
| Lua | number retval = reaper.ImGui_Key_F9() |
|---|
| Python | int retval = ImGui_Key_F9() |
|---|
View source
Constant: Key_G
| C++ | int ImGui_Key_G |
|---|
| EEL | int ImGui_Key_G() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_G") |
|---|
| Lua | number retval = reaper.ImGui_Key_G() |
|---|
| Python | int retval = ImGui_Key_G() |
|---|
View source
Constant: Key_GraveAccent
| C++ | int ImGui_Key_GraveAccent |
|---|
| EEL | int ImGui_Key_GraveAccent() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_GraveAccent") |
|---|
| Lua | number retval = reaper.ImGui_Key_GraveAccent() |
|---|
| Python | int retval = ImGui_Key_GraveAccent() |
|---|
`
View source
Constant: Key_H
| C++ | int ImGui_Key_H |
|---|
| EEL | int ImGui_Key_H() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_H") |
|---|
| Lua | number retval = reaper.ImGui_Key_H() |
|---|
| Python | int retval = ImGui_Key_H() |
|---|
View source
Constant: Key_Home
| C++ | int ImGui_Key_Home |
|---|
| EEL | int ImGui_Key_Home() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Home") |
|---|
| Lua | number retval = reaper.ImGui_Key_Home() |
|---|
| Python | int retval = ImGui_Key_Home() |
|---|
View source
Constant: Key_I
| C++ | int ImGui_Key_I |
|---|
| EEL | int ImGui_Key_I() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_I") |
|---|
| Lua | number retval = reaper.ImGui_Key_I() |
|---|
| Python | int retval = ImGui_Key_I() |
|---|
View source
Constant: Key_Insert
| C++ | int ImGui_Key_Insert |
|---|
| EEL | int ImGui_Key_Insert() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Insert") |
|---|
| Lua | number retval = reaper.ImGui_Key_Insert() |
|---|
| Python | int retval = ImGui_Key_Insert() |
|---|
View source
Constant: Key_J
| C++ | int ImGui_Key_J |
|---|
| EEL | int ImGui_Key_J() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_J") |
|---|
| Lua | number retval = reaper.ImGui_Key_J() |
|---|
| Python | int retval = ImGui_Key_J() |
|---|
View source
Constant: Key_K
| C++ | int ImGui_Key_K |
|---|
| EEL | int ImGui_Key_K() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_K") |
|---|
| Lua | number retval = reaper.ImGui_Key_K() |
|---|
| Python | int retval = ImGui_Key_K() |
|---|
View source
Constant: Key_Keypad0
| C++ | int ImGui_Key_Keypad0 |
|---|
| EEL | int ImGui_Key_Keypad0() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Keypad0") |
|---|
| Lua | number retval = reaper.ImGui_Key_Keypad0() |
|---|
| Python | int retval = ImGui_Key_Keypad0() |
|---|
View source
Constant: Key_Keypad1
| C++ | int ImGui_Key_Keypad1 |
|---|
| EEL | int ImGui_Key_Keypad1() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Keypad1") |
|---|
| Lua | number retval = reaper.ImGui_Key_Keypad1() |
|---|
| Python | int retval = ImGui_Key_Keypad1() |
|---|
View source
Constant: Key_Keypad2
| C++ | int ImGui_Key_Keypad2 |
|---|
| EEL | int ImGui_Key_Keypad2() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Keypad2") |
|---|
| Lua | number retval = reaper.ImGui_Key_Keypad2() |
|---|
| Python | int retval = ImGui_Key_Keypad2() |
|---|
View source
Constant: Key_Keypad3
| C++ | int ImGui_Key_Keypad3 |
|---|
| EEL | int ImGui_Key_Keypad3() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Keypad3") |
|---|
| Lua | number retval = reaper.ImGui_Key_Keypad3() |
|---|
| Python | int retval = ImGui_Key_Keypad3() |
|---|
View source
Constant: Key_Keypad4
| C++ | int ImGui_Key_Keypad4 |
|---|
| EEL | int ImGui_Key_Keypad4() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Keypad4") |
|---|
| Lua | number retval = reaper.ImGui_Key_Keypad4() |
|---|
| Python | int retval = ImGui_Key_Keypad4() |
|---|
View source
Constant: Key_Keypad5
| C++ | int ImGui_Key_Keypad5 |
|---|
| EEL | int ImGui_Key_Keypad5() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Keypad5") |
|---|
| Lua | number retval = reaper.ImGui_Key_Keypad5() |
|---|
| Python | int retval = ImGui_Key_Keypad5() |
|---|
View source
Constant: Key_Keypad6
| C++ | int ImGui_Key_Keypad6 |
|---|
| EEL | int ImGui_Key_Keypad6() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Keypad6") |
|---|
| Lua | number retval = reaper.ImGui_Key_Keypad6() |
|---|
| Python | int retval = ImGui_Key_Keypad6() |
|---|
View source
Constant: Key_Keypad7
| C++ | int ImGui_Key_Keypad7 |
|---|
| EEL | int ImGui_Key_Keypad7() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Keypad7") |
|---|
| Lua | number retval = reaper.ImGui_Key_Keypad7() |
|---|
| Python | int retval = ImGui_Key_Keypad7() |
|---|
View source
Constant: Key_Keypad8
| C++ | int ImGui_Key_Keypad8 |
|---|
| EEL | int ImGui_Key_Keypad8() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Keypad8") |
|---|
| Lua | number retval = reaper.ImGui_Key_Keypad8() |
|---|
| Python | int retval = ImGui_Key_Keypad8() |
|---|
View source
Constant: Key_Keypad9
| C++ | int ImGui_Key_Keypad9 |
|---|
| EEL | int ImGui_Key_Keypad9() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Keypad9") |
|---|
| Lua | number retval = reaper.ImGui_Key_Keypad9() |
|---|
| Python | int retval = ImGui_Key_Keypad9() |
|---|
View source
Constant: Key_KeypadAdd
| C++ | int ImGui_Key_KeypadAdd |
|---|
| EEL | int ImGui_Key_KeypadAdd() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_KeypadAdd") |
|---|
| Lua | number retval = reaper.ImGui_Key_KeypadAdd() |
|---|
| Python | int retval = ImGui_Key_KeypadAdd() |
|---|
View source
Constant: Key_KeypadDecimal
| C++ | int ImGui_Key_KeypadDecimal |
|---|
| EEL | int ImGui_Key_KeypadDecimal() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_KeypadDecimal") |
|---|
| Lua | number retval = reaper.ImGui_Key_KeypadDecimal() |
|---|
| Python | int retval = ImGui_Key_KeypadDecimal() |
|---|
View source
Constant: Key_KeypadDivide
| C++ | int ImGui_Key_KeypadDivide |
|---|
| EEL | int ImGui_Key_KeypadDivide() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_KeypadDivide") |
|---|
| Lua | number retval = reaper.ImGui_Key_KeypadDivide() |
|---|
| Python | int retval = ImGui_Key_KeypadDivide() |
|---|
View source
Constant: Key_KeypadEnter
| C++ | int ImGui_Key_KeypadEnter |
|---|
| EEL | int ImGui_Key_KeypadEnter() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_KeypadEnter") |
|---|
| Lua | number retval = reaper.ImGui_Key_KeypadEnter() |
|---|
| Python | int retval = ImGui_Key_KeypadEnter() |
|---|
View source
Constant: Key_KeypadEqual
| C++ | int ImGui_Key_KeypadEqual |
|---|
| EEL | int ImGui_Key_KeypadEqual() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_KeypadEqual") |
|---|
| Lua | number retval = reaper.ImGui_Key_KeypadEqual() |
|---|
| Python | int retval = ImGui_Key_KeypadEqual() |
|---|
View source
Constant: Key_KeypadMultiply
| C++ | int ImGui_Key_KeypadMultiply |
|---|
| EEL | int ImGui_Key_KeypadMultiply() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_KeypadMultiply") |
|---|
| Lua | number retval = reaper.ImGui_Key_KeypadMultiply() |
|---|
| Python | int retval = ImGui_Key_KeypadMultiply() |
|---|
View source
Constant: Key_KeypadSubtract
| C++ | int ImGui_Key_KeypadSubtract |
|---|
| EEL | int ImGui_Key_KeypadSubtract() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_KeypadSubtract") |
|---|
| Lua | number retval = reaper.ImGui_Key_KeypadSubtract() |
|---|
| Python | int retval = ImGui_Key_KeypadSubtract() |
|---|
View source
Constant: Key_L
| C++ | int ImGui_Key_L |
|---|
| EEL | int ImGui_Key_L() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_L") |
|---|
| Lua | number retval = reaper.ImGui_Key_L() |
|---|
| Python | int retval = ImGui_Key_L() |
|---|
View source
Constant: Key_LeftAlt
| C++ | int ImGui_Key_LeftAlt |
|---|
| EEL | int ImGui_Key_LeftAlt() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_LeftAlt") |
|---|
| Lua | number retval = reaper.ImGui_Key_LeftAlt() |
|---|
| Python | int retval = ImGui_Key_LeftAlt() |
|---|
View source
Constant: Key_LeftArrow
| C++ | int ImGui_Key_LeftArrow |
|---|
| EEL | int ImGui_Key_LeftArrow() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_LeftArrow") |
|---|
| Lua | number retval = reaper.ImGui_Key_LeftArrow() |
|---|
| Python | int retval = ImGui_Key_LeftArrow() |
|---|
View source
Constant: Key_LeftBracket
| C++ | int ImGui_Key_LeftBracket |
|---|
| EEL | int ImGui_Key_LeftBracket() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_LeftBracket") |
|---|
| Lua | number retval = reaper.ImGui_Key_LeftBracket() |
|---|
| Python | int retval = ImGui_Key_LeftBracket() |
|---|
[
View source
Constant: Key_LeftCtrl
| C++ | int ImGui_Key_LeftCtrl |
|---|
| EEL | int ImGui_Key_LeftCtrl() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_LeftCtrl") |
|---|
| Lua | number retval = reaper.ImGui_Key_LeftCtrl() |
|---|
| Python | int retval = ImGui_Key_LeftCtrl() |
|---|
View source
Constant: Key_LeftShift
| C++ | int ImGui_Key_LeftShift |
|---|
| EEL | int ImGui_Key_LeftShift() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_LeftShift") |
|---|
| Lua | number retval = reaper.ImGui_Key_LeftShift() |
|---|
| Python | int retval = ImGui_Key_LeftShift() |
|---|
View source
Constant: Key_LeftSuper
| C++ | int ImGui_Key_LeftSuper |
|---|
| EEL | int ImGui_Key_LeftSuper() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_LeftSuper") |
|---|
| Lua | number retval = reaper.ImGui_Key_LeftSuper() |
|---|
| Python | int retval = ImGui_Key_LeftSuper() |
|---|
View source
Constant: Key_M
| C++ | int ImGui_Key_M |
|---|
| EEL | int ImGui_Key_M() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_M") |
|---|
| Lua | number retval = reaper.ImGui_Key_M() |
|---|
| Python | int retval = ImGui_Key_M() |
|---|
View source
Constant: Key_Minus
| C++ | int ImGui_Key_Minus |
|---|
| EEL | int ImGui_Key_Minus() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Minus") |
|---|
| Lua | number retval = reaper.ImGui_Key_Minus() |
|---|
| Python | int retval = ImGui_Key_Minus() |
|---|
View source
Constant: Key_N
| C++ | int ImGui_Key_N |
|---|
| EEL | int ImGui_Key_N() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_N") |
|---|
| Lua | number retval = reaper.ImGui_Key_N() |
|---|
| Python | int retval = ImGui_Key_N() |
|---|
View source
Constant: Key_NumLock
| C++ | int ImGui_Key_NumLock |
|---|
| EEL | int ImGui_Key_NumLock() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_NumLock") |
|---|
| Lua | number retval = reaper.ImGui_Key_NumLock() |
|---|
| Python | int retval = ImGui_Key_NumLock() |
|---|
View source
Constant: Key_O
| C++ | int ImGui_Key_O |
|---|
| EEL | int ImGui_Key_O() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_O") |
|---|
| Lua | number retval = reaper.ImGui_Key_O() |
|---|
| Python | int retval = ImGui_Key_O() |
|---|
View source
Constant: Key_P
| C++ | int ImGui_Key_P |
|---|
| EEL | int ImGui_Key_P() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_P") |
|---|
| Lua | number retval = reaper.ImGui_Key_P() |
|---|
| Python | int retval = ImGui_Key_P() |
|---|
View source
Constant: Key_PageDown
| C++ | int ImGui_Key_PageDown |
|---|
| EEL | int ImGui_Key_PageDown() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_PageDown") |
|---|
| Lua | number retval = reaper.ImGui_Key_PageDown() |
|---|
| Python | int retval = ImGui_Key_PageDown() |
|---|
View source
Constant: Key_PageUp
| C++ | int ImGui_Key_PageUp |
|---|
| EEL | int ImGui_Key_PageUp() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_PageUp") |
|---|
| Lua | number retval = reaper.ImGui_Key_PageUp() |
|---|
| Python | int retval = ImGui_Key_PageUp() |
|---|
View source
Constant: Key_Pause
| C++ | int ImGui_Key_Pause |
|---|
| EEL | int ImGui_Key_Pause() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Pause") |
|---|
| Lua | number retval = reaper.ImGui_Key_Pause() |
|---|
| Python | int retval = ImGui_Key_Pause() |
|---|
View source
Constant: Key_Period
| C++ | int ImGui_Key_Period |
|---|
| EEL | int ImGui_Key_Period() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Period") |
|---|
| Lua | number retval = reaper.ImGui_Key_Period() |
|---|
| Python | int retval = ImGui_Key_Period() |
|---|
.
View source
Constant: Key_PrintScreen
| C++ | int ImGui_Key_PrintScreen |
|---|
| EEL | int ImGui_Key_PrintScreen() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_PrintScreen") |
|---|
| Lua | number retval = reaper.ImGui_Key_PrintScreen() |
|---|
| Python | int retval = ImGui_Key_PrintScreen() |
|---|
View source
Constant: Key_Q
| C++ | int ImGui_Key_Q |
|---|
| EEL | int ImGui_Key_Q() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Q") |
|---|
| Lua | number retval = reaper.ImGui_Key_Q() |
|---|
| Python | int retval = ImGui_Key_Q() |
|---|
View source
Constant: Key_R
| C++ | int ImGui_Key_R |
|---|
| EEL | int ImGui_Key_R() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_R") |
|---|
| Lua | number retval = reaper.ImGui_Key_R() |
|---|
| Python | int retval = ImGui_Key_R() |
|---|
View source
Constant: Key_RightAlt
| C++ | int ImGui_Key_RightAlt |
|---|
| EEL | int ImGui_Key_RightAlt() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_RightAlt") |
|---|
| Lua | number retval = reaper.ImGui_Key_RightAlt() |
|---|
| Python | int retval = ImGui_Key_RightAlt() |
|---|
View source
Constant: Key_RightArrow
| C++ | int ImGui_Key_RightArrow |
|---|
| EEL | int ImGui_Key_RightArrow() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_RightArrow") |
|---|
| Lua | number retval = reaper.ImGui_Key_RightArrow() |
|---|
| Python | int retval = ImGui_Key_RightArrow() |
|---|
View source
Constant: Key_RightBracket
| C++ | int ImGui_Key_RightBracket |
|---|
| EEL | int ImGui_Key_RightBracket() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_RightBracket") |
|---|
| Lua | number retval = reaper.ImGui_Key_RightBracket() |
|---|
| Python | int retval = ImGui_Key_RightBracket() |
|---|
]
View source
Constant: Key_RightCtrl
| C++ | int ImGui_Key_RightCtrl |
|---|
| EEL | int ImGui_Key_RightCtrl() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_RightCtrl") |
|---|
| Lua | number retval = reaper.ImGui_Key_RightCtrl() |
|---|
| Python | int retval = ImGui_Key_RightCtrl() |
|---|
View source
Constant: Key_RightShift
| C++ | int ImGui_Key_RightShift |
|---|
| EEL | int ImGui_Key_RightShift() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_RightShift") |
|---|
| Lua | number retval = reaper.ImGui_Key_RightShift() |
|---|
| Python | int retval = ImGui_Key_RightShift() |
|---|
View source
Constant: Key_RightSuper
| C++ | int ImGui_Key_RightSuper |
|---|
| EEL | int ImGui_Key_RightSuper() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_RightSuper") |
|---|
| Lua | number retval = reaper.ImGui_Key_RightSuper() |
|---|
| Python | int retval = ImGui_Key_RightSuper() |
|---|
View source
Constant: Key_S
| C++ | int ImGui_Key_S |
|---|
| EEL | int ImGui_Key_S() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_S") |
|---|
| Lua | number retval = reaper.ImGui_Key_S() |
|---|
| Python | int retval = ImGui_Key_S() |
|---|
View source
Constant: Key_ScrollLock
| C++ | int ImGui_Key_ScrollLock |
|---|
| EEL | int ImGui_Key_ScrollLock() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_ScrollLock") |
|---|
| Lua | number retval = reaper.ImGui_Key_ScrollLock() |
|---|
| Python | int retval = ImGui_Key_ScrollLock() |
|---|
View source
Constant: Key_Semicolon
| C++ | int ImGui_Key_Semicolon |
|---|
| EEL | int ImGui_Key_Semicolon() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Semicolon") |
|---|
| Lua | number retval = reaper.ImGui_Key_Semicolon() |
|---|
| Python | int retval = ImGui_Key_Semicolon() |
|---|
;
View source
Constant: Key_Slash
| C++ | int ImGui_Key_Slash |
|---|
| EEL | int ImGui_Key_Slash() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Slash") |
|---|
| Lua | number retval = reaper.ImGui_Key_Slash() |
|---|
| Python | int retval = ImGui_Key_Slash() |
|---|
/
View source
Constant: Key_Space
| C++ | int ImGui_Key_Space |
|---|
| EEL | int ImGui_Key_Space() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Space") |
|---|
| Lua | number retval = reaper.ImGui_Key_Space() |
|---|
| Python | int retval = ImGui_Key_Space() |
|---|
View source
Constant: Key_T
| C++ | int ImGui_Key_T |
|---|
| EEL | int ImGui_Key_T() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_T") |
|---|
| Lua | number retval = reaper.ImGui_Key_T() |
|---|
| Python | int retval = ImGui_Key_T() |
|---|
View source
Constant: Key_Tab
| C++ | int ImGui_Key_Tab |
|---|
| EEL | int ImGui_Key_Tab() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Tab") |
|---|
| Lua | number retval = reaper.ImGui_Key_Tab() |
|---|
| Python | int retval = ImGui_Key_Tab() |
|---|
View source
Constant: Key_U
| C++ | int ImGui_Key_U |
|---|
| EEL | int ImGui_Key_U() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_U") |
|---|
| Lua | number retval = reaper.ImGui_Key_U() |
|---|
| Python | int retval = ImGui_Key_U() |
|---|
View source
Constant: Key_UpArrow
| C++ | int ImGui_Key_UpArrow |
|---|
| EEL | int ImGui_Key_UpArrow() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_UpArrow") |
|---|
| Lua | number retval = reaper.ImGui_Key_UpArrow() |
|---|
| Python | int retval = ImGui_Key_UpArrow() |
|---|
View source
Constant: Key_V
| C++ | int ImGui_Key_V |
|---|
| EEL | int ImGui_Key_V() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_V") |
|---|
| Lua | number retval = reaper.ImGui_Key_V() |
|---|
| Python | int retval = ImGui_Key_V() |
|---|
View source
Constant: Key_W
| C++ | int ImGui_Key_W |
|---|
| EEL | int ImGui_Key_W() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_W") |
|---|
| Lua | number retval = reaper.ImGui_Key_W() |
|---|
| Python | int retval = ImGui_Key_W() |
|---|
View source
Constant: Key_X
| C++ | int ImGui_Key_X |
|---|
| EEL | int ImGui_Key_X() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_X") |
|---|
| Lua | number retval = reaper.ImGui_Key_X() |
|---|
| Python | int retval = ImGui_Key_X() |
|---|
View source
Constant: Key_Y
| C++ | int ImGui_Key_Y |
|---|
| EEL | int ImGui_Key_Y() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Y") |
|---|
| Lua | number retval = reaper.ImGui_Key_Y() |
|---|
| Python | int retval = ImGui_Key_Y() |
|---|
View source
Constant: Key_Z
| C++ | int ImGui_Key_Z |
|---|
| EEL | int ImGui_Key_Z() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_Z") |
|---|
| Lua | number retval = reaper.ImGui_Key_Z() |
|---|
| Python | int retval = ImGui_Key_Z() |
|---|
View source
Modifiers
Constant: Mod_Alt
| C++ | int ImGui_Mod_Alt |
|---|
| EEL | int ImGui_Mod_Alt() |
|---|
| Legacy EEL | int extension_api("ImGui_Mod_Alt") |
|---|
| Lua | number retval = reaper.ImGui_Mod_Alt() |
|---|
| Python | int retval = ImGui_Mod_Alt() |
|---|
View source
Constant: Mod_Ctrl
| C++ | int ImGui_Mod_Ctrl |
|---|
| EEL | int ImGui_Mod_Ctrl() |
|---|
| Legacy EEL | int extension_api("ImGui_Mod_Ctrl") |
|---|
| Lua | number retval = reaper.ImGui_Mod_Ctrl() |
|---|
| Python | int retval = ImGui_Mod_Ctrl() |
|---|
View source
Constant: Mod_None
| C++ | int ImGui_Mod_None |
|---|
| EEL | int ImGui_Mod_None() |
|---|
| Legacy EEL | int extension_api("ImGui_Mod_None") |
|---|
| Lua | number retval = reaper.ImGui_Mod_None() |
|---|
| Python | int retval = ImGui_Mod_None() |
|---|
View source
Constant: Mod_Shift
| C++ | int ImGui_Mod_Shift |
|---|
| EEL | int ImGui_Mod_Shift() |
|---|
| Legacy EEL | int extension_api("ImGui_Mod_Shift") |
|---|
| Lua | number retval = reaper.ImGui_Mod_Shift() |
|---|
| Python | int retval = ImGui_Mod_Shift() |
|---|
View source
Constant: Mod_Shortcut
| C++ | int ImGui_Mod_Shortcut |
|---|
| EEL | int ImGui_Mod_Shortcut() |
|---|
| Legacy EEL | int extension_api("ImGui_Mod_Shortcut") |
|---|
| Lua | number retval = reaper.ImGui_Mod_Shortcut() |
|---|
| Python | int retval = ImGui_Mod_Shortcut() |
|---|
Alias for Mod_Ctrl on Linux and Windows and Mod_Super on macOS (Cmd key).
View source
Constant: Mod_Super
| C++ | int ImGui_Mod_Super |
|---|
| EEL | int ImGui_Mod_Super() |
|---|
| Legacy EEL | int extension_api("ImGui_Mod_Super") |
|---|
| Lua | number retval = reaper.ImGui_Mod_Super() |
|---|
| Python | int retval = ImGui_Mod_Super() |
|---|
View source
This is mirroring the data also written accessible via IsMouseDown,
GetMouseWheel etc, in a format allowing them to be accessed via standard key API.
Constant: Key_MouseLeft
| C++ | int ImGui_Key_MouseLeft |
|---|
| EEL | int ImGui_Key_MouseLeft() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_MouseLeft") |
|---|
| Lua | number retval = reaper.ImGui_Key_MouseLeft() |
|---|
| Python | int retval = ImGui_Key_MouseLeft() |
|---|
View source
Constant: Key_MouseMiddle
| C++ | int ImGui_Key_MouseMiddle |
|---|
| EEL | int ImGui_Key_MouseMiddle() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_MouseMiddle") |
|---|
| Lua | number retval = reaper.ImGui_Key_MouseMiddle() |
|---|
| Python | int retval = ImGui_Key_MouseMiddle() |
|---|
View source
Constant: Key_MouseRight
| C++ | int ImGui_Key_MouseRight |
|---|
| EEL | int ImGui_Key_MouseRight() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_MouseRight") |
|---|
| Lua | number retval = reaper.ImGui_Key_MouseRight() |
|---|
| Python | int retval = ImGui_Key_MouseRight() |
|---|
View source
Constant: Key_MouseWheelX
| C++ | int ImGui_Key_MouseWheelX |
|---|
| EEL | int ImGui_Key_MouseWheelX() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_MouseWheelX") |
|---|
| Lua | number retval = reaper.ImGui_Key_MouseWheelX() |
|---|
| Python | int retval = ImGui_Key_MouseWheelX() |
|---|
View source
Constant: Key_MouseWheelY
| C++ | int ImGui_Key_MouseWheelY |
|---|
| EEL | int ImGui_Key_MouseWheelY() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_MouseWheelY") |
|---|
| Lua | number retval = reaper.ImGui_Key_MouseWheelY() |
|---|
| Python | int retval = ImGui_Key_MouseWheelY() |
|---|
View source
Constant: Key_MouseX1
| C++ | int ImGui_Key_MouseX1 |
|---|
| EEL | int ImGui_Key_MouseX1() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_MouseX1") |
|---|
| Lua | number retval = reaper.ImGui_Key_MouseX1() |
|---|
| Python | int retval = ImGui_Key_MouseX1() |
|---|
View source
Constant: Key_MouseX2
| C++ | int ImGui_Key_MouseX2 |
|---|
| EEL | int ImGui_Key_MouseX2() |
|---|
| Legacy EEL | int extension_api("ImGui_Key_MouseX2") |
|---|
| Lua | number retval = reaper.ImGui_Key_MouseX2() |
|---|
| Python | int retval = ImGui_Key_MouseX2() |
|---|
View source
Mouse
To refer to a mouse button, you may use named enums in your code e.g.
MouseButton_Left, MouseButton_Right.
You can also use regular integer: it is forever guaranteed that
0=Left, 1=Right, 2=Middle. Buttons 3 and 4 do not have a named enum.
Dragging operations are only reported after mouse has moved a certain distance
away from the initial clicking position (see 'lock_threshold' parameters and
'ConfigVar_MouseDragThreshold').
Function: GetMouseClickedCount
| C++ | int ImGui_GetMouseClickedCount(ImGui_Context* ctx, int button) |
|---|
| EEL | int ImGui_GetMouseClickedCount(ImGui_Context ctx, int button) |
|---|
| Legacy EEL | int extension_api("ImGui_GetMouseClickedCount", ImGui_Context ctx, int button) |
|---|
| Lua | number retval = reaper.ImGui_GetMouseClickedCount(ImGui_Context ctx, number button) |
|---|
| Python | int retval = ImGui_GetMouseClickedCount(ImGui_Context ctx, int button) |
|---|
Return the number of successive mouse-clicks at the time where a click happen (otherwise 0).
View source
Function: GetMouseClickedPos
| C++ | void ImGui_GetMouseClickedPos(ImGui_Context* ctx, int button, double* xOut, double* yOut) |
|---|
| EEL | ImGui_GetMouseClickedPos(ImGui_Context ctx, int button, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_GetMouseClickedPos", ImGui_Context ctx, int button, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_GetMouseClickedPos(ImGui_Context ctx, number button) |
|---|
| Python | (float x, float y) = ImGui_GetMouseClickedPos(ImGui_Context ctx, int button) |
|---|
View source
Function: GetMouseDelta
| C++ | void ImGui_GetMouseDelta(ImGui_Context* ctx, double* xOut, double* yOut) |
|---|
| EEL | ImGui_GetMouseDelta(ImGui_Context ctx, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_GetMouseDelta", ImGui_Context ctx, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_GetMouseDelta(ImGui_Context ctx) |
|---|
| Python | (float x, float y) = ImGui_GetMouseDelta(ImGui_Context ctx) |
|---|
Mouse delta. Note that this is zero if either current or previous position
are invalid (-FLT_MAX,-FLT_MAX), so a disappearing/reappearing mouse won't have
a huge delta.
View source
Function: GetMouseDownDuration
| C++ | double ImGui_GetMouseDownDuration(ImGui_Context* ctx, int button) |
|---|
| EEL | double ImGui_GetMouseDownDuration(ImGui_Context ctx, int button) |
|---|
| Legacy EEL | double extension_api("ImGui_GetMouseDownDuration", ImGui_Context ctx, int button) |
|---|
| Lua | number retval = reaper.ImGui_GetMouseDownDuration(ImGui_Context ctx, number button) |
|---|
| Python | float retval = ImGui_GetMouseDownDuration(ImGui_Context ctx, int button) |
|---|
Duration the mouse button has been down (0.0 == just clicked)
View source
Function: GetMouseDragDelta
| C++ | void ImGui_GetMouseDragDelta(ImGui_Context* ctx, double* xOut, double* yOut, int* buttonInOptional = MouseButton_Left, double* lock_thresholdInOptional = -1.0) |
|---|
| EEL | ImGui_GetMouseDragDelta(ImGui_Context ctx, &x, &y, int button = MouseButton_Left, lock_threshold = -1.0) |
|---|
| Legacy EEL | extension_api("ImGui_GetMouseDragDelta", ImGui_Context ctx, &x, &y, int button = MouseButton_Left, lock_threshold = -1.0) |
|---|
| Lua | number x, number y = reaper.ImGui_GetMouseDragDelta(ImGui_Context ctx, nil, nil, number button = MouseButton_Left, number lock_threshold = -1.0) |
|---|
| Python | (float x, float y) = ImGui_GetMouseDragDelta(ImGui_Context ctx, int button = MouseButton_Left, float lock_threshold = -1.0) |
|---|
Return the delta from the initial clicking position while the mouse button is
pressed or was just released. This is locked and return 0.0 until the mouse
moves past a distance threshold at least once (if lock_threshold < -1.0, uses
ConfigVar_MouseDragThreshold).
View source
Function: GetMousePos
| C++ | void ImGui_GetMousePos(ImGui_Context* ctx, double* xOut, double* yOut) |
|---|
| EEL | ImGui_GetMousePos(ImGui_Context ctx, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_GetMousePos", ImGui_Context ctx, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_GetMousePos(ImGui_Context ctx) |
|---|
| Python | (float x, float y) = ImGui_GetMousePos(ImGui_Context ctx) |
|---|
View source
Function: GetMouseWheel
| C++ | void ImGui_GetMouseWheel(ImGui_Context* ctx, double* verticalOut, double* horizontalOut) |
|---|
| EEL | ImGui_GetMouseWheel(ImGui_Context ctx, &vertical, &horizontal) |
|---|
| Legacy EEL | extension_api("ImGui_GetMouseWheel", ImGui_Context ctx, &vertical, &horizontal) |
|---|
| Lua | number vertical, number horizontal = reaper.ImGui_GetMouseWheel(ImGui_Context ctx) |
|---|
| Python | (float vertical, float horizontal) = ImGui_GetMouseWheel(ImGui_Context ctx) |
|---|
Vertical: 1 unit scrolls about 5 lines text. >0 scrolls Up, <0 scrolls Down.
Hold SHIFT to turn vertical scroll into horizontal scroll
Horizontal: >0 scrolls Left, <0 scrolls Right.
Most users don't have a mouse with a horizontal wheel.
View source
Function: IsAnyMouseDown
| C++ | bool ImGui_IsAnyMouseDown(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_IsAnyMouseDown(ImGui_Context ctx) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsAnyMouseDown", ImGui_Context ctx) |
|---|
| Lua | boolean retval = reaper.ImGui_IsAnyMouseDown(ImGui_Context ctx) |
|---|
| Python | bool retval = ImGui_IsAnyMouseDown(ImGui_Context ctx) |
|---|
Is any mouse button held?
View source
Function: IsMouseClicked
| C++ | bool ImGui_IsMouseClicked(ImGui_Context* ctx, int button, bool* repeatInOptional = false) |
|---|
| EEL | bool ImGui_IsMouseClicked(ImGui_Context ctx, int button, bool repeat = false) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsMouseClicked", ImGui_Context ctx, int button, bool repeat = false) |
|---|
| Lua | boolean retval = reaper.ImGui_IsMouseClicked(ImGui_Context ctx, number button, boolean repeat = false) |
|---|
| Python | bool retval = ImGui_IsMouseClicked(ImGui_Context ctx, int button, bool repeat = false) |
|---|
Did mouse button clicked? (went from !Down to Down).
Same as GetMouseClickedCount() == 1.
View source
Function: IsMouseDoubleClicked
| C++ | bool ImGui_IsMouseDoubleClicked(ImGui_Context* ctx, int button) |
|---|
| EEL | bool ImGui_IsMouseDoubleClicked(ImGui_Context ctx, int button) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsMouseDoubleClicked", ImGui_Context ctx, int button) |
|---|
| Lua | boolean retval = reaper.ImGui_IsMouseDoubleClicked(ImGui_Context ctx, number button) |
|---|
| Python | bool retval = ImGui_IsMouseDoubleClicked(ImGui_Context ctx, int button) |
|---|
Did mouse button double-clicked? Same as GetMouseClickedCount() == 2.
(Note that a double-click will also report IsMouseClicked() == true)
View source
Function: IsMouseDown
| C++ | bool ImGui_IsMouseDown(ImGui_Context* ctx, int button) |
|---|
| EEL | bool ImGui_IsMouseDown(ImGui_Context ctx, int button) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsMouseDown", ImGui_Context ctx, int button) |
|---|
| Lua | boolean retval = reaper.ImGui_IsMouseDown(ImGui_Context ctx, number button) |
|---|
| Python | bool retval = ImGui_IsMouseDown(ImGui_Context ctx, int button) |
|---|
Is mouse button held?
View source
Function: IsMouseDragging
| C++ | bool ImGui_IsMouseDragging(ImGui_Context* ctx, int button, double* lock_thresholdInOptional = -1.0) |
|---|
| EEL | bool ImGui_IsMouseDragging(ImGui_Context ctx, int button, lock_threshold = -1.0) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsMouseDragging", ImGui_Context ctx, int button, lock_threshold = -1.0) |
|---|
| Lua | boolean retval = reaper.ImGui_IsMouseDragging(ImGui_Context ctx, number button, number lock_threshold = -1.0) |
|---|
| Python | bool retval = ImGui_IsMouseDragging(ImGui_Context ctx, int button, float lock_threshold = -1.0) |
|---|
Is mouse dragging? (if lock_threshold < -1.0, uses ConfigVar_MouseDragThreshold)
View source
Function: IsMouseHoveringRect
| C++ | bool ImGui_IsMouseHoveringRect(ImGui_Context* ctx, double r_min_x, double r_min_y, double r_max_x, double r_max_y, bool* clipInOptional = true) |
|---|
| EEL | bool ImGui_IsMouseHoveringRect(ImGui_Context ctx, r_min_x, r_min_y, r_max_x, r_max_y, bool clip = true) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsMouseHoveringRect", ImGui_Context ctx, r_min_x, r_min_y, r_max_x, r_max_y, bool clip = true) |
|---|
| Lua | boolean retval = reaper.ImGui_IsMouseHoveringRect(ImGui_Context ctx, number r_min_x, number r_min_y, number r_max_x, number r_max_y, boolean clip = true) |
|---|
| Python | bool retval = ImGui_IsMouseHoveringRect(ImGui_Context ctx, float r_min_x, float r_min_y, float r_max_x, float r_max_y, bool clip = true) |
|---|
Is mouse hovering given bounding rect (in screen space).
Clipped by current clipping settings, but disregarding of other consideration
of focus/window ordering/popup-block.
View source
Function: IsMousePosValid
| C++ | bool ImGui_IsMousePosValid(ImGui_Context* ctx, double* mouse_pos_xInOptional = nullptr, double* mouse_pos_yInOptional = nullptr) |
|---|
| EEL | bool ImGui_IsMousePosValid(ImGui_Context ctx, mouse_pos_x = nullptr, mouse_pos_y = nullptr) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsMousePosValid", ImGui_Context ctx, mouse_pos_x = nullptr, mouse_pos_y = nullptr) |
|---|
| Lua | boolean retval = reaper.ImGui_IsMousePosValid(ImGui_Context ctx, number mouse_pos_x = nullptr, number mouse_pos_y = nullptr) |
|---|
| Python | bool retval = ImGui_IsMousePosValid(ImGui_Context ctx, float mouse_pos_x = nullptr, float mouse_pos_y = nullptr) |
|---|
View source
Function: IsMouseReleased
| C++ | bool ImGui_IsMouseReleased(ImGui_Context* ctx, int button) |
|---|
| EEL | bool ImGui_IsMouseReleased(ImGui_Context ctx, int button) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsMouseReleased", ImGui_Context ctx, int button) |
|---|
| Lua | boolean retval = reaper.ImGui_IsMouseReleased(ImGui_Context ctx, number button) |
|---|
| Python | bool retval = ImGui_IsMouseReleased(ImGui_Context ctx, int button) |
|---|
Did mouse button released? (went from Down to !Down)
View source
Constant: MouseButton_Left
| C++ | int ImGui_MouseButton_Left |
|---|
| EEL | int ImGui_MouseButton_Left() |
|---|
| Legacy EEL | int extension_api("ImGui_MouseButton_Left") |
|---|
| Lua | number retval = reaper.ImGui_MouseButton_Left() |
|---|
| Python | int retval = ImGui_MouseButton_Left() |
|---|
View source
Constant: MouseButton_Middle
| C++ | int ImGui_MouseButton_Middle |
|---|
| EEL | int ImGui_MouseButton_Middle() |
|---|
| Legacy EEL | int extension_api("ImGui_MouseButton_Middle") |
|---|
| Lua | number retval = reaper.ImGui_MouseButton_Middle() |
|---|
| Python | int retval = ImGui_MouseButton_Middle() |
|---|
View source
Constant: MouseButton_Right
| C++ | int ImGui_MouseButton_Right |
|---|
| EEL | int ImGui_MouseButton_Right() |
|---|
| Legacy EEL | int extension_api("ImGui_MouseButton_Right") |
|---|
| Lua | number retval = reaper.ImGui_MouseButton_Right() |
|---|
| Python | int retval = ImGui_MouseButton_Right() |
|---|
View source
Function: ResetMouseDragDelta
| C++ | void ImGui_ResetMouseDragDelta(ImGui_Context* ctx, int* buttonInOptional = MouseButton_Left) |
|---|
| EEL | ImGui_ResetMouseDragDelta(ImGui_Context ctx, int button = MouseButton_Left) |
|---|
| Legacy EEL | extension_api("ImGui_ResetMouseDragDelta", ImGui_Context ctx, int button = MouseButton_Left) |
|---|
| Lua | reaper.ImGui_ResetMouseDragDelta(ImGui_Context ctx, number button = MouseButton_Left) |
|---|
| Python | ImGui_ResetMouseDragDelta(ImGui_Context ctx, int button = MouseButton_Left) |
|---|
View source
Mouse Cursor
Function: GetMouseCursor
| C++ | int ImGui_GetMouseCursor(ImGui_Context* ctx) |
|---|
| EEL | int ImGui_GetMouseCursor(ImGui_Context ctx) |
|---|
| Legacy EEL | int extension_api("ImGui_GetMouseCursor", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetMouseCursor(ImGui_Context ctx) |
|---|
| Python | int retval = ImGui_GetMouseCursor(ImGui_Context ctx) |
|---|
Get desired mouse cursor shape, reset every frame. This is updated during the frame.
View source
Constant: MouseCursor_Arrow
| C++ | int ImGui_MouseCursor_Arrow |
|---|
| EEL | int ImGui_MouseCursor_Arrow() |
|---|
| Legacy EEL | int extension_api("ImGui_MouseCursor_Arrow") |
|---|
| Lua | number retval = reaper.ImGui_MouseCursor_Arrow() |
|---|
| Python | int retval = ImGui_MouseCursor_Arrow() |
|---|
View source
Constant: MouseCursor_Hand
| C++ | int ImGui_MouseCursor_Hand |
|---|
| EEL | int ImGui_MouseCursor_Hand() |
|---|
| Legacy EEL | int extension_api("ImGui_MouseCursor_Hand") |
|---|
| Lua | number retval = reaper.ImGui_MouseCursor_Hand() |
|---|
| Python | int retval = ImGui_MouseCursor_Hand() |
|---|
(Unused by Dear ImGui functions. Use for e.g. hyperlinks)
View source
Constant: MouseCursor_None
| C++ | int ImGui_MouseCursor_None |
|---|
| EEL | int ImGui_MouseCursor_None() |
|---|
| Legacy EEL | int extension_api("ImGui_MouseCursor_None") |
|---|
| Lua | number retval = reaper.ImGui_MouseCursor_None() |
|---|
| Python | int retval = ImGui_MouseCursor_None() |
|---|
View source
Constant: MouseCursor_NotAllowed
| C++ | int ImGui_MouseCursor_NotAllowed |
|---|
| EEL | int ImGui_MouseCursor_NotAllowed() |
|---|
| Legacy EEL | int extension_api("ImGui_MouseCursor_NotAllowed") |
|---|
| Lua | number retval = reaper.ImGui_MouseCursor_NotAllowed() |
|---|
| Python | int retval = ImGui_MouseCursor_NotAllowed() |
|---|
When hovering something with disallowed interaction. Usually a crossed circle.
View source
Constant: MouseCursor_ResizeAll
| C++ | int ImGui_MouseCursor_ResizeAll |
|---|
| EEL | int ImGui_MouseCursor_ResizeAll() |
|---|
| Legacy EEL | int extension_api("ImGui_MouseCursor_ResizeAll") |
|---|
| Lua | number retval = reaper.ImGui_MouseCursor_ResizeAll() |
|---|
| Python | int retval = ImGui_MouseCursor_ResizeAll() |
|---|
(Unused by Dear ImGui functions)
View source
Constant: MouseCursor_ResizeEW
| C++ | int ImGui_MouseCursor_ResizeEW |
|---|
| EEL | int ImGui_MouseCursor_ResizeEW() |
|---|
| Legacy EEL | int extension_api("ImGui_MouseCursor_ResizeEW") |
|---|
| Lua | number retval = reaper.ImGui_MouseCursor_ResizeEW() |
|---|
| Python | int retval = ImGui_MouseCursor_ResizeEW() |
|---|
When hovering over a vertical border or a column.
View source
Constant: MouseCursor_ResizeNESW
| C++ | int ImGui_MouseCursor_ResizeNESW |
|---|
| EEL | int ImGui_MouseCursor_ResizeNESW() |
|---|
| Legacy EEL | int extension_api("ImGui_MouseCursor_ResizeNESW") |
|---|
| Lua | number retval = reaper.ImGui_MouseCursor_ResizeNESW() |
|---|
| Python | int retval = ImGui_MouseCursor_ResizeNESW() |
|---|
When hovering over the bottom-left corner of a window.
View source
Constant: MouseCursor_ResizeNS
| C++ | int ImGui_MouseCursor_ResizeNS |
|---|
| EEL | int ImGui_MouseCursor_ResizeNS() |
|---|
| Legacy EEL | int extension_api("ImGui_MouseCursor_ResizeNS") |
|---|
| Lua | number retval = reaper.ImGui_MouseCursor_ResizeNS() |
|---|
| Python | int retval = ImGui_MouseCursor_ResizeNS() |
|---|
When hovering over a horizontal border.
View source
Constant: MouseCursor_ResizeNWSE
| C++ | int ImGui_MouseCursor_ResizeNWSE |
|---|
| EEL | int ImGui_MouseCursor_ResizeNWSE() |
|---|
| Legacy EEL | int extension_api("ImGui_MouseCursor_ResizeNWSE") |
|---|
| Lua | number retval = reaper.ImGui_MouseCursor_ResizeNWSE() |
|---|
| Python | int retval = ImGui_MouseCursor_ResizeNWSE() |
|---|
When hovering over the bottom-right corner of a window.
View source
Constant: MouseCursor_TextInput
| C++ | int ImGui_MouseCursor_TextInput |
|---|
| EEL | int ImGui_MouseCursor_TextInput() |
|---|
| Legacy EEL | int extension_api("ImGui_MouseCursor_TextInput") |
|---|
| Lua | number retval = reaper.ImGui_MouseCursor_TextInput() |
|---|
| Python | int retval = ImGui_MouseCursor_TextInput() |
|---|
When hovering over InputText, etc.
View source
Function: SetMouseCursor
| C++ | void ImGui_SetMouseCursor(ImGui_Context* ctx, int cursor_type) |
|---|
| EEL | ImGui_SetMouseCursor(ImGui_Context ctx, int cursor_type) |
|---|
| Legacy EEL | extension_api("ImGui_SetMouseCursor", ImGui_Context ctx, int cursor_type) |
|---|
| Lua | reaper.ImGui_SetMouseCursor(ImGui_Context ctx, number cursor_type) |
|---|
| Python | ImGui_SetMouseCursor(ImGui_Context ctx, int cursor_type) |
|---|
Set desired mouse cursor shape. See MouseCursor_* for possible values.
View source
Layout
Function: Separator
| C++ | void ImGui_Separator(ImGui_Context* ctx) |
|---|
| EEL | ImGui_Separator(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_Separator", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_Separator(ImGui_Context ctx) |
|---|
| Python | ImGui_Separator(ImGui_Context ctx) |
|---|
Separator, generally horizontal. inside a menu bar or in horizontal layout
mode, this becomes a vertical separator.
View source
Function: SeparatorText
| C++ | void ImGui_SeparatorText(ImGui_Context* ctx, const char* label) |
|---|
| EEL | ImGui_SeparatorText(ImGui_Context ctx, "label") |
|---|
| Legacy EEL | extension_api("ImGui_SeparatorText", ImGui_Context ctx, "label") |
|---|
| Lua | reaper.ImGui_SeparatorText(ImGui_Context ctx, string label) |
|---|
| Python | ImGui_SeparatorText(ImGui_Context ctx, str label) |
|---|
Text formatted with an horizontal line
View source
Clipping
Mouse hovering is affected by PushClipRect() calls, unlike direct calls to
DrawList_PushClipRect() which are render only. Coordinates are in screen space.
Function: IsRectVisible
| C++ | bool ImGui_IsRectVisible(ImGui_Context* ctx, double size_w, double size_h) |
|---|
| EEL | bool ImGui_IsRectVisible(ImGui_Context ctx, size_w, size_h) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsRectVisible", ImGui_Context ctx, size_w, size_h) |
|---|
| Lua | boolean retval = reaper.ImGui_IsRectVisible(ImGui_Context ctx, number size_w, number size_h) |
|---|
| Python | bool retval = ImGui_IsRectVisible(ImGui_Context ctx, float size_w, float size_h) |
|---|
Test if rectangle (of given size, starting from cursor position) is
visible / not clipped.
View source
Function: IsRectVisibleEx
| C++ | bool ImGui_IsRectVisibleEx(ImGui_Context* ctx, double rect_min_x, double rect_min_y, double rect_max_x, double rect_max_y) |
|---|
| EEL | bool ImGui_IsRectVisibleEx(ImGui_Context ctx, rect_min_x, rect_min_y, rect_max_x, rect_max_y) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsRectVisibleEx", ImGui_Context ctx, rect_min_x, rect_min_y, rect_max_x, rect_max_y) |
|---|
| Lua | boolean retval = reaper.ImGui_IsRectVisibleEx(ImGui_Context ctx, number rect_min_x, number rect_min_y, number rect_max_x, number rect_max_y) |
|---|
| Python | bool retval = ImGui_IsRectVisibleEx(ImGui_Context ctx, float rect_min_x, float rect_min_y, float rect_max_x, float rect_max_y) |
|---|
Test if rectangle (in screen space) is visible / not clipped. to perform
coarse clipping on user's side.
View source
Function: PopClipRect
| C++ | void ImGui_PopClipRect(ImGui_Context* ctx) |
|---|
| EEL | ImGui_PopClipRect(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_PopClipRect", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_PopClipRect(ImGui_Context ctx) |
|---|
| Python | ImGui_PopClipRect(ImGui_Context ctx) |
|---|
See PushClipRect
View source
Function: PushClipRect
| C++ | void ImGui_PushClipRect(ImGui_Context* ctx, double clip_rect_min_x, double clip_rect_min_y, double clip_rect_max_x, double clip_rect_max_y, bool intersect_with_current_clip_rect) |
|---|
| EEL | ImGui_PushClipRect(ImGui_Context ctx, clip_rect_min_x, clip_rect_min_y, clip_rect_max_x, clip_rect_max_y, bool intersect_with_current_clip_rect) |
|---|
| Legacy EEL | extension_api("ImGui_PushClipRect", ImGui_Context ctx, clip_rect_min_x, clip_rect_min_y, clip_rect_max_x, clip_rect_max_y, bool intersect_with_current_clip_rect) |
|---|
| Lua | reaper.ImGui_PushClipRect(ImGui_Context ctx, number clip_rect_min_x, number clip_rect_min_y, number clip_rect_max_x, number clip_rect_max_y, boolean intersect_with_current_clip_rect) |
|---|
| Python | ImGui_PushClipRect(ImGui_Context ctx, float clip_rect_min_x, float clip_rect_min_y, float clip_rect_max_x, float clip_rect_max_y, bool intersect_with_current_clip_rect) |
|---|
View source
Cursor
By "cursor" we mean the current output position.
The typical widget behavior is to output themselves at the current cursor
position, then move the cursor one line down.
You can call SameLine() between widgets to undo the last carriage return and
output at the right of the preceding widget.
Function: BeginGroup
| C++ | void ImGui_BeginGroup(ImGui_Context* ctx) |
|---|
| EEL | ImGui_BeginGroup(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_BeginGroup", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_BeginGroup(ImGui_Context ctx) |
|---|
| Python | ImGui_BeginGroup(ImGui_Context ctx) |
|---|
Lock horizontal starting position. See EndGroup.
View source
Function: Dummy
| C++ | void ImGui_Dummy(ImGui_Context* ctx, double size_w, double size_h) |
|---|
| EEL | ImGui_Dummy(ImGui_Context ctx, size_w, size_h) |
|---|
| Legacy EEL | extension_api("ImGui_Dummy", ImGui_Context ctx, size_w, size_h) |
|---|
| Lua | reaper.ImGui_Dummy(ImGui_Context ctx, number size_w, number size_h) |
|---|
| Python | ImGui_Dummy(ImGui_Context ctx, float size_w, float size_h) |
|---|
Add a dummy item of given size. unlike InvisibleButton, Dummy() won't take the
mouse click or be navigable into.
View source
Function: EndGroup
| C++ | void ImGui_EndGroup(ImGui_Context* ctx) |
|---|
| EEL | ImGui_EndGroup(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_EndGroup", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_EndGroup(ImGui_Context ctx) |
|---|
| Python | ImGui_EndGroup(ImGui_Context ctx) |
|---|
Unlock horizontal starting position + capture the whole group bounding box
into one "item" (so you can use IsItemHovered or layout primitives such as
SameLine on whole group, etc.).
See BeginGroup.
View source
Function: GetCursorPos
| C++ | void ImGui_GetCursorPos(ImGui_Context* ctx, double* xOut, double* yOut) |
|---|
| EEL | ImGui_GetCursorPos(ImGui_Context ctx, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_GetCursorPos", ImGui_Context ctx, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_GetCursorPos(ImGui_Context ctx) |
|---|
| Python | (float x, float y) = ImGui_GetCursorPos(ImGui_Context ctx) |
|---|
Cursor position in window
View source
Function: GetCursorPosX
| C++ | double ImGui_GetCursorPosX(ImGui_Context* ctx) |
|---|
| EEL | double ImGui_GetCursorPosX(ImGui_Context ctx) |
|---|
| Legacy EEL | double extension_api("ImGui_GetCursorPosX", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetCursorPosX(ImGui_Context ctx) |
|---|
| Python | float retval = ImGui_GetCursorPosX(ImGui_Context ctx) |
|---|
Cursor X position in window
View source
Function: GetCursorPosY
| C++ | double ImGui_GetCursorPosY(ImGui_Context* ctx) |
|---|
| EEL | double ImGui_GetCursorPosY(ImGui_Context ctx) |
|---|
| Legacy EEL | double extension_api("ImGui_GetCursorPosY", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetCursorPosY(ImGui_Context ctx) |
|---|
| Python | float retval = ImGui_GetCursorPosY(ImGui_Context ctx) |
|---|
Cursor Y position in window
View source
Function: GetCursorScreenPos
| C++ | void ImGui_GetCursorScreenPos(ImGui_Context* ctx, double* xOut, double* yOut) |
|---|
| EEL | ImGui_GetCursorScreenPos(ImGui_Context ctx, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_GetCursorScreenPos", ImGui_Context ctx, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_GetCursorScreenPos(ImGui_Context ctx) |
|---|
| Python | (float x, float y) = ImGui_GetCursorScreenPos(ImGui_Context ctx) |
|---|
Cursor position in absolute screen coordinates (useful to work with the DrawList API).
View source
Function: GetCursorStartPos
| C++ | void ImGui_GetCursorStartPos(ImGui_Context* ctx, double* xOut, double* yOut) |
|---|
| EEL | ImGui_GetCursorStartPos(ImGui_Context ctx, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_GetCursorStartPos", ImGui_Context ctx, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_GetCursorStartPos(ImGui_Context ctx) |
|---|
| Python | (float x, float y) = ImGui_GetCursorStartPos(ImGui_Context ctx) |
|---|
Initial cursor position in window coordinates.
View source
Function: Indent
| C++ | void ImGui_Indent(ImGui_Context* ctx, double* indent_wInOptional = 0.0) |
|---|
| EEL | ImGui_Indent(ImGui_Context ctx, indent_w = 0.0) |
|---|
| Legacy EEL | extension_api("ImGui_Indent", ImGui_Context ctx, indent_w = 0.0) |
|---|
| Lua | reaper.ImGui_Indent(ImGui_Context ctx, number indent_w = 0.0) |
|---|
| Python | ImGui_Indent(ImGui_Context ctx, float indent_w = 0.0) |
|---|
Move content position toward the right, by 'indent_w', or
StyleVar_IndentSpacing if 'indent_w' <= 0. See Unindent.
View source
Function: NewLine
| C++ | void ImGui_NewLine(ImGui_Context* ctx) |
|---|
| EEL | ImGui_NewLine(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_NewLine", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_NewLine(ImGui_Context ctx) |
|---|
| Python | ImGui_NewLine(ImGui_Context ctx) |
|---|
Undo a SameLine() or force a new line when in a horizontal-layout context.
View source
Function: SameLine
| C++ | void ImGui_SameLine(ImGui_Context* ctx, double* offset_from_start_xInOptional = 0.0, double* spacingInOptional = -1.0) |
|---|
| EEL | ImGui_SameLine(ImGui_Context ctx, offset_from_start_x = 0.0, spacing = -1.0) |
|---|
| Legacy EEL | extension_api("ImGui_SameLine", ImGui_Context ctx, offset_from_start_x = 0.0, spacing = -1.0) |
|---|
| Lua | reaper.ImGui_SameLine(ImGui_Context ctx, number offset_from_start_x = 0.0, number spacing = -1.0) |
|---|
| Python | ImGui_SameLine(ImGui_Context ctx, float offset_from_start_x = 0.0, float spacing = -1.0) |
|---|
Call between widgets or groups to layout them horizontally.
X position given in window coordinates.
View source
Function: SetCursorPos
| C++ | void ImGui_SetCursorPos(ImGui_Context* ctx, double local_pos_x, double local_pos_y) |
|---|
| EEL | ImGui_SetCursorPos(ImGui_Context ctx, local_pos_x, local_pos_y) |
|---|
| Legacy EEL | extension_api("ImGui_SetCursorPos", ImGui_Context ctx, local_pos_x, local_pos_y) |
|---|
| Lua | reaper.ImGui_SetCursorPos(ImGui_Context ctx, number local_pos_x, number local_pos_y) |
|---|
| Python | ImGui_SetCursorPos(ImGui_Context ctx, float local_pos_x, float local_pos_y) |
|---|
Cursor position in window
View source
Function: SetCursorPosX
| C++ | void ImGui_SetCursorPosX(ImGui_Context* ctx, double local_x) |
|---|
| EEL | ImGui_SetCursorPosX(ImGui_Context ctx, local_x) |
|---|
| Legacy EEL | extension_api("ImGui_SetCursorPosX", ImGui_Context ctx, local_x) |
|---|
| Lua | reaper.ImGui_SetCursorPosX(ImGui_Context ctx, number local_x) |
|---|
| Python | ImGui_SetCursorPosX(ImGui_Context ctx, float local_x) |
|---|
Cursor X position in window
View source
Function: SetCursorPosY
| C++ | void ImGui_SetCursorPosY(ImGui_Context* ctx, double local_y) |
|---|
| EEL | ImGui_SetCursorPosY(ImGui_Context ctx, local_y) |
|---|
| Legacy EEL | extension_api("ImGui_SetCursorPosY", ImGui_Context ctx, local_y) |
|---|
| Lua | reaper.ImGui_SetCursorPosY(ImGui_Context ctx, number local_y) |
|---|
| Python | ImGui_SetCursorPosY(ImGui_Context ctx, float local_y) |
|---|
Cursor Y position in window
View source
Function: SetCursorScreenPos
| C++ | void ImGui_SetCursorScreenPos(ImGui_Context* ctx, double pos_x, double pos_y) |
|---|
| EEL | ImGui_SetCursorScreenPos(ImGui_Context ctx, pos_x, pos_y) |
|---|
| Legacy EEL | extension_api("ImGui_SetCursorScreenPos", ImGui_Context ctx, pos_x, pos_y) |
|---|
| Lua | reaper.ImGui_SetCursorScreenPos(ImGui_Context ctx, number pos_x, number pos_y) |
|---|
| Python | ImGui_SetCursorScreenPos(ImGui_Context ctx, float pos_x, float pos_y) |
|---|
Cursor position in absolute screen coordinates.
View source
Function: Spacing
| C++ | void ImGui_Spacing(ImGui_Context* ctx) |
|---|
| EEL | ImGui_Spacing(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_Spacing", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_Spacing(ImGui_Context ctx) |
|---|
| Python | ImGui_Spacing(ImGui_Context ctx) |
|---|
Add vertical spacing.
View source
Function: Unindent
| C++ | void ImGui_Unindent(ImGui_Context* ctx, double* indent_wInOptional = 0.0) |
|---|
| EEL | ImGui_Unindent(ImGui_Context ctx, indent_w = 0.0) |
|---|
| Legacy EEL | extension_api("ImGui_Unindent", ImGui_Context ctx, indent_w = 0.0) |
|---|
| Lua | reaper.ImGui_Unindent(ImGui_Context ctx, number indent_w = 0.0) |
|---|
| Python | ImGui_Unindent(ImGui_Context ctx, float indent_w = 0.0) |
|---|
Move content position back to the left, by 'indent_w', or
StyleVar_IndentSpacing if 'indent_w' <= 0
View source
List Clipper
Helper to manually clip large list of items.
If you have lots evenly spaced items and you have random access to the list,
you can perform coarse clipping based on visibility to only submit items that
are in view.
The clipper calculates the range of visible items and advance the cursor to
compensate for the non-visible items we have skipped.
(Dear ImGui already clip items based on their bounds but: it needs to first
layout the item to do so, and generally fetching/submitting your own data incurs
additional cost. Coarse clipping using ImGui_ListClipper allows you to easily
scale using lists with tens of thousands of items without a problem.)
Usage:
if not reaper.ImGui_ValidatePtr(clipper, 'ImGui_ListClipper*') then
clipper = reaper.ImGui_CreateListClipper(ctx)
end
reaper.ImGui_ListClipper_Begin(clipper, 1000) -- We have 1000 elements, evenly spaced
while reaper.ImGui_ListClipper_Step(clipper) do
local display_start, display_end = reaper.ImGui_ListClipper_GetDisplayRange(clipper)
for row = display_start, display_end - 1 do
reaper.ImGui_Text(ctx, ("line number %d"):format(i))
end
end
Generally what happens is:
- Clipper lets you process the first element (DisplayStart = 0, DisplayEnd = 1)
regardless of it being visible or not.
- User code submit that one element.
- Clipper can measure the height of the first element
- Clipper calculate the actual range of elements to display based on the current
clipping rectangle, position the cursor before the first visible element.
- User code submit visible elements.
- The clipper also handles various subtleties related to keyboard/gamepad
navigation, wrapping etc.
Function: CreateListClipper
| C++ | ImGui_ListClipper* ImGui_CreateListClipper(ImGui_Context* ctx) |
|---|
| EEL | ImGui_ListClipper* ImGui_CreateListClipper(ImGui_Context ctx) |
|---|
| Legacy EEL | ImGui_ListClipper* extension_api("ImGui_CreateListClipper", ImGui_Context ctx) |
|---|
| Lua | ImGui_ListClipper retval = reaper.ImGui_CreateListClipper(ImGui_Context ctx) |
|---|
| Python | ImGui_ListClipper retval = ImGui_CreateListClipper(ImGui_Context ctx) |
|---|
The returned clipper object is only valid for the given context and is valid
as long as it is used in each defer cycle unless attached (see Attach).
View source
Function: ListClipper_Begin
| C++ | void ImGui_ListClipper_Begin(ImGui_ListClipper* clipper, int items_count, double* items_heightInOptional = -1.0) |
|---|
| EEL | ImGui_ListClipper_Begin(ImGui_ListClipper clipper, int items_count, items_height = -1.0) |
|---|
| Legacy EEL | extension_api("ImGui_ListClipper_Begin", ImGui_ListClipper clipper, int items_count, items_height = -1.0) |
|---|
| Lua | reaper.ImGui_ListClipper_Begin(ImGui_ListClipper clipper, number items_count, number items_height = -1.0) |
|---|
| Python | ImGui_ListClipper_Begin(ImGui_ListClipper clipper, int items_count, float items_height = -1.0) |
|---|
- items_count: Use INT_MAX if you don't know how many items you have
(in which case the cursor won't be advanced in the final step)
- items_height: Use -1.0 to be calculated automatically on first step.
Otherwise pass in the distance between your items, typically
GetTextLineHeightWithSpacing or GetFrameHeightWithSpacing.
View source
Function: ListClipper_End
| C++ | void ImGui_ListClipper_End(ImGui_ListClipper* clipper) |
|---|
| EEL | ImGui_ListClipper_End(ImGui_ListClipper clipper) |
|---|
| Legacy EEL | extension_api("ImGui_ListClipper_End", ImGui_ListClipper clipper) |
|---|
| Lua | reaper.ImGui_ListClipper_End(ImGui_ListClipper clipper) |
|---|
| Python | ImGui_ListClipper_End(ImGui_ListClipper clipper) |
|---|
Automatically called on the last call of ListClipper_Step that returns false.
View source
Function: ListClipper_ForceDisplayRangeByIndices
| C++ | void ImGui_ListClipper_ForceDisplayRangeByIndices(ImGui_ListClipper* clipper, int item_min, int item_max) |
|---|
| EEL | ImGui_ListClipper_ForceDisplayRangeByIndices(ImGui_ListClipper clipper, int item_min, int item_max) |
|---|
| Legacy EEL | extension_api("ImGui_ListClipper_ForceDisplayRangeByIndices", ImGui_ListClipper clipper, int item_min, int item_max) |
|---|
| Lua | reaper.ImGui_ListClipper_ForceDisplayRangeByIndices(ImGui_ListClipper clipper, number item_min, number item_max) |
|---|
| Python | ImGui_ListClipper_ForceDisplayRangeByIndices(ImGui_ListClipper clipper, int item_min, int item_max) |
|---|
Call ListClipper_ForceDisplayRangeByIndices before first call to
ListClipper_Step if you need a range of items to be displayed regardless of
visibility.
item_max is exclusive e.g. use (42, 42+1) to make item 42 always visible BUT due
to alignment/padding of certain items it is likely that an extra item may be
included on either end of the display range.
View source
Function: ListClipper_GetDisplayRange
| C++ | void ImGui_ListClipper_GetDisplayRange(ImGui_ListClipper* clipper, int* display_startOut, int* display_endOut) |
|---|
| EEL | ImGui_ListClipper_GetDisplayRange(ImGui_ListClipper clipper, int &display_start, int &display_end) |
|---|
| Legacy EEL | extension_api("ImGui_ListClipper_GetDisplayRange", ImGui_ListClipper clipper, int &display_start, int &display_end) |
|---|
| Lua | number display_start, number display_end = reaper.ImGui_ListClipper_GetDisplayRange(ImGui_ListClipper clipper) |
|---|
| Python | (int display_start, int display_end) = ImGui_ListClipper_GetDisplayRange(ImGui_ListClipper clipper) |
|---|
View source
Function: ListClipper_Step
| C++ | bool ImGui_ListClipper_Step(ImGui_ListClipper* clipper) |
|---|
| EEL | bool ImGui_ListClipper_Step(ImGui_ListClipper clipper) |
|---|
| Legacy EEL | bool extension_api("ImGui_ListClipper_Step", ImGui_ListClipper clipper) |
|---|
| Lua | boolean retval = reaper.ImGui_ListClipper_Step(ImGui_ListClipper clipper) |
|---|
| Python | bool retval = ImGui_ListClipper_Step(ImGui_ListClipper clipper) |
|---|
Call until it returns false. The display_start/display_end fields from
ListClipper_GetDisplayRange will be set and you can process/draw those items.
View source
Plot
Simple data plotting using reaper_array as data source.
Function: PlotHistogram
| C++ | void ImGui_PlotHistogram(ImGui_Context* ctx, const char* label, reaper_array* values, int* values_offsetInOptional = 0, const char* overlay_textInOptional = nullptr, double* scale_minInOptional = 3.4028234663852886e+38F, double* scale_maxInOptional = 3.4028234663852886e+38F, double* graph_size_wInOptional = 0.0, double* graph_size_hInOptional = 0.0) |
|---|
| EEL | ImGui_PlotHistogram(ImGui_Context ctx, "label", reaper_array values, int values_offset = 0, "overlay_text" = nullptr, scale_min = 3.4028234663852886e+38F, scale_max = 3.4028234663852886e+38F, graph_size_w = 0.0, graph_size_h = 0.0) |
|---|
| Legacy EEL | extension_api("ImGui_PlotHistogram", ImGui_Context ctx, "label", reaper_array values, int values_offset = 0, "overlay_text" = nullptr, scale_min = 3.4028234663852886e+38F, scale_max = 3.4028234663852886e+38F, graph_size_w = 0.0, graph_size_h = 0.0) |
|---|
| Lua | reaper.ImGui_PlotHistogram(ImGui_Context ctx, string label, reaper_array values, number values_offset = 0, string overlay_text = nullptr, number scale_min = 3.4028234663852886e+38F, number scale_max = 3.4028234663852886e+38F, number graph_size_w = 0.0, number graph_size_h = 0.0) |
|---|
| Python | ImGui_PlotHistogram(ImGui_Context ctx, str label, reaper_array values, int values_offset = 0, str overlay_text = nullptr, float scale_min = 3.4028234663852886e+38F, float scale_max = 3.4028234663852886e+38F, float graph_size_w = 0.0, float graph_size_h = 0.0) |
|---|
View source
Function: PlotLines
| C++ | void ImGui_PlotLines(ImGui_Context* ctx, const char* label, reaper_array* values, int* values_offsetInOptional = 0, const char* overlay_textInOptional = nullptr, double* scale_minInOptional = 3.4028234663852886e+38F, double* scale_maxInOptional = 3.4028234663852886e+38F, double* graph_size_wInOptional = 0.0, double* graph_size_hInOptional = 0.0) |
|---|
| EEL | ImGui_PlotLines(ImGui_Context ctx, "label", reaper_array values, int values_offset = 0, "overlay_text" = nullptr, scale_min = 3.4028234663852886e+38F, scale_max = 3.4028234663852886e+38F, graph_size_w = 0.0, graph_size_h = 0.0) |
|---|
| Legacy EEL | extension_api("ImGui_PlotLines", ImGui_Context ctx, "label", reaper_array values, int values_offset = 0, "overlay_text" = nullptr, scale_min = 3.4028234663852886e+38F, scale_max = 3.4028234663852886e+38F, graph_size_w = 0.0, graph_size_h = 0.0) |
|---|
| Lua | reaper.ImGui_PlotLines(ImGui_Context ctx, string label, reaper_array values, number values_offset = 0, string overlay_text = nullptr, number scale_min = 3.4028234663852886e+38F, number scale_max = 3.4028234663852886e+38F, number graph_size_w = 0.0, number graph_size_h = 0.0) |
|---|
| Python | ImGui_PlotLines(ImGui_Context ctx, str label, reaper_array values, int values_offset = 0, str overlay_text = nullptr, float scale_min = 3.4028234663852886e+38F, float scale_max = 3.4028234663852886e+38F, float graph_size_w = 0.0, float graph_size_h = 0.0) |
|---|
View source
- They block normal mouse hovering detection (and therefore most mouse
interactions) behind them.
- If not modal: they can be closed by clicking anywhere outside them, or by
pressing ESCAPE.
- Their visibility state (~bool) is held internally instead of being held by the
programmer as we are used to with regular Begin*() calls.
The 3 properties above are related: we need to retain popup visibility state in
the library because popups may be closed as any time.
You can bypass the hovering restriction by using
HoveredFlags_AllowWhenBlockedByPopup when calling IsItemHovered or IsWindowHovered.
IMPORTANT: Popup identifiers are relative to the current ID stack, so OpenPopup
and BeginPopup generally needs to be at the same level of the stack.
For OpenPopup*(), BeginPopupContext*() and IsPopupOpen.
Helpers to do OpenPopup+BeginPopup where the Open action is triggered by e.g.
hovering an item and right-clicking. They are convenient to easily create
context menus, hence the name.
Notice that BeginPopupContext* takes PopupFlags_* just like OpenPopup and
unlike BeginPopup.
We exceptionally default their flags to 1 (== PopupFlags_MouseButtonRight) for
backward compatibility with older API taking 'int mouse_button = 1' parameter,
so if you add other flags remember to re-add the PopupFlags_MouseButtonRight.
Tooltip are windows following the mouse. They do not take focus away.
Function: BeginTooltip
| C++ | bool ImGui_BeginTooltip(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_BeginTooltip(ImGui_Context ctx) |
|---|
| Legacy EEL | bool extension_api("ImGui_BeginTooltip", ImGui_Context ctx) |
|---|
| Lua | boolean retval = reaper.ImGui_BeginTooltip(ImGui_Context ctx) |
|---|
| Python | bool retval = ImGui_BeginTooltip(ImGui_Context ctx) |
|---|
Begin/append a tooltip window.
To create full-featured tooltip (with any kind of items).
View source
Function: EndTooltip
| C++ | void ImGui_EndTooltip(ImGui_Context* ctx) |
|---|
| EEL | ImGui_EndTooltip(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_EndTooltip", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_EndTooltip(ImGui_Context ctx) |
|---|
| Python | ImGui_EndTooltip(ImGui_Context ctx) |
|---|
Only call EndTooltip() if BeginTooltip() returns true.
View source
Function: SetTooltip
| C++ | void ImGui_SetTooltip(ImGui_Context* ctx, const char* text) |
|---|
| EEL | ImGui_SetTooltip(ImGui_Context ctx, "text") |
|---|
| Legacy EEL | extension_api("ImGui_SetTooltip", ImGui_Context ctx, "text") |
|---|
| Lua | reaper.ImGui_SetTooltip(ImGui_Context ctx, string text) |
|---|
| Python | ImGui_SetTooltip(ImGui_Context ctx, str text) |
|---|
Set a text-only tooltip, typically use with IsItemHovered. override any
previous call to SetTooltip.
View source
Style
Colors
Constant: Col_Border
| C++ | int ImGui_Col_Border |
|---|
| EEL | int ImGui_Col_Border() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_Border") |
|---|
| Lua | number retval = reaper.ImGui_Col_Border() |
|---|
| Python | int retval = ImGui_Col_Border() |
|---|
View source
Constant: Col_BorderShadow
| C++ | int ImGui_Col_BorderShadow |
|---|
| EEL | int ImGui_Col_BorderShadow() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_BorderShadow") |
|---|
| Lua | number retval = reaper.ImGui_Col_BorderShadow() |
|---|
| Python | int retval = ImGui_Col_BorderShadow() |
|---|
View source
Constant: Col_Button
| C++ | int ImGui_Col_Button |
|---|
| EEL | int ImGui_Col_Button() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_Button") |
|---|
| Lua | number retval = reaper.ImGui_Col_Button() |
|---|
| Python | int retval = ImGui_Col_Button() |
|---|
View source
Constant: Col_ButtonActive
| C++ | int ImGui_Col_ButtonActive |
|---|
| EEL | int ImGui_Col_ButtonActive() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_ButtonActive") |
|---|
| Lua | number retval = reaper.ImGui_Col_ButtonActive() |
|---|
| Python | int retval = ImGui_Col_ButtonActive() |
|---|
View source
Constant: Col_ButtonHovered
| C++ | int ImGui_Col_ButtonHovered |
|---|
| EEL | int ImGui_Col_ButtonHovered() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_ButtonHovered") |
|---|
| Lua | number retval = reaper.ImGui_Col_ButtonHovered() |
|---|
| Python | int retval = ImGui_Col_ButtonHovered() |
|---|
View source
Constant: Col_CheckMark
| C++ | int ImGui_Col_CheckMark |
|---|
| EEL | int ImGui_Col_CheckMark() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_CheckMark") |
|---|
| Lua | number retval = reaper.ImGui_Col_CheckMark() |
|---|
| Python | int retval = ImGui_Col_CheckMark() |
|---|
View source
Constant: Col_ChildBg
| C++ | int ImGui_Col_ChildBg |
|---|
| EEL | int ImGui_Col_ChildBg() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_ChildBg") |
|---|
| Lua | number retval = reaper.ImGui_Col_ChildBg() |
|---|
| Python | int retval = ImGui_Col_ChildBg() |
|---|
Background of child windows.
View source
Constant: Col_DockingEmptyBg
| C++ | int ImGui_Col_DockingEmptyBg |
|---|
| EEL | int ImGui_Col_DockingEmptyBg() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_DockingEmptyBg") |
|---|
| Lua | number retval = reaper.ImGui_Col_DockingEmptyBg() |
|---|
| Python | int retval = ImGui_Col_DockingEmptyBg() |
|---|
Background color for empty node (e.g. CentralNode with no window docked into it).
View source
Constant: Col_DockingPreview
| C++ | int ImGui_Col_DockingPreview |
|---|
| EEL | int ImGui_Col_DockingPreview() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_DockingPreview") |
|---|
| Lua | number retval = reaper.ImGui_Col_DockingPreview() |
|---|
| Python | int retval = ImGui_Col_DockingPreview() |
|---|
Preview overlay color when about to docking something.
View source
Constant: Col_DragDropTarget
| C++ | int ImGui_Col_DragDropTarget |
|---|
| EEL | int ImGui_Col_DragDropTarget() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_DragDropTarget") |
|---|
| Lua | number retval = reaper.ImGui_Col_DragDropTarget() |
|---|
| Python | int retval = ImGui_Col_DragDropTarget() |
|---|
Rectangle highlighting a drop target
View source
Constant: Col_FrameBg
| C++ | int ImGui_Col_FrameBg |
|---|
| EEL | int ImGui_Col_FrameBg() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_FrameBg") |
|---|
| Lua | number retval = reaper.ImGui_Col_FrameBg() |
|---|
| Python | int retval = ImGui_Col_FrameBg() |
|---|
Background of checkbox, radio button, plot, slider, text input.
View source
Constant: Col_FrameBgActive
| C++ | int ImGui_Col_FrameBgActive |
|---|
| EEL | int ImGui_Col_FrameBgActive() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_FrameBgActive") |
|---|
| Lua | number retval = reaper.ImGui_Col_FrameBgActive() |
|---|
| Python | int retval = ImGui_Col_FrameBgActive() |
|---|
View source
Constant: Col_FrameBgHovered
| C++ | int ImGui_Col_FrameBgHovered |
|---|
| EEL | int ImGui_Col_FrameBgHovered() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_FrameBgHovered") |
|---|
| Lua | number retval = reaper.ImGui_Col_FrameBgHovered() |
|---|
| Python | int retval = ImGui_Col_FrameBgHovered() |
|---|
View source
Constant: Col_ModalWindowDimBg
| C++ | int ImGui_Col_ModalWindowDimBg |
|---|
| EEL | int ImGui_Col_ModalWindowDimBg() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_ModalWindowDimBg") |
|---|
| Lua | number retval = reaper.ImGui_Col_ModalWindowDimBg() |
|---|
| Python | int retval = ImGui_Col_ModalWindowDimBg() |
|---|
Darken/colorize entire screen behind a modal window, when one is active.
View source
Constant: Col_NavHighlight
| C++ | int ImGui_Col_NavHighlight |
|---|
| EEL | int ImGui_Col_NavHighlight() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_NavHighlight") |
|---|
| Lua | number retval = reaper.ImGui_Col_NavHighlight() |
|---|
| Python | int retval = ImGui_Col_NavHighlight() |
|---|
Gamepad/keyboard: current highlighted item.
View source
Constant: Col_NavWindowingDimBg
| C++ | int ImGui_Col_NavWindowingDimBg |
|---|
| EEL | int ImGui_Col_NavWindowingDimBg() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_NavWindowingDimBg") |
|---|
| Lua | number retval = reaper.ImGui_Col_NavWindowingDimBg() |
|---|
| Python | int retval = ImGui_Col_NavWindowingDimBg() |
|---|
Darken/colorize entire screen behind the CTRL+TAB window list, when active.
View source
Constant: Col_NavWindowingHighlight
| C++ | int ImGui_Col_NavWindowingHighlight |
|---|
| EEL | int ImGui_Col_NavWindowingHighlight() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_NavWindowingHighlight") |
|---|
| Lua | number retval = reaper.ImGui_Col_NavWindowingHighlight() |
|---|
| Python | int retval = ImGui_Col_NavWindowingHighlight() |
|---|
Highlight window when using CTRL+TAB.
View source
Constant: Col_PlotHistogram
| C++ | int ImGui_Col_PlotHistogram |
|---|
| EEL | int ImGui_Col_PlotHistogram() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_PlotHistogram") |
|---|
| Lua | number retval = reaper.ImGui_Col_PlotHistogram() |
|---|
| Python | int retval = ImGui_Col_PlotHistogram() |
|---|
View source
Constant: Col_PlotHistogramHovered
| C++ | int ImGui_Col_PlotHistogramHovered |
|---|
| EEL | int ImGui_Col_PlotHistogramHovered() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_PlotHistogramHovered") |
|---|
| Lua | number retval = reaper.ImGui_Col_PlotHistogramHovered() |
|---|
| Python | int retval = ImGui_Col_PlotHistogramHovered() |
|---|
View source
Constant: Col_PlotLines
| C++ | int ImGui_Col_PlotLines |
|---|
| EEL | int ImGui_Col_PlotLines() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_PlotLines") |
|---|
| Lua | number retval = reaper.ImGui_Col_PlotLines() |
|---|
| Python | int retval = ImGui_Col_PlotLines() |
|---|
View source
Constant: Col_PlotLinesHovered
| C++ | int ImGui_Col_PlotLinesHovered |
|---|
| EEL | int ImGui_Col_PlotLinesHovered() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_PlotLinesHovered") |
|---|
| Lua | number retval = reaper.ImGui_Col_PlotLinesHovered() |
|---|
| Python | int retval = ImGui_Col_PlotLinesHovered() |
|---|
View source
Constant: Col_ResizeGrip
| C++ | int ImGui_Col_ResizeGrip |
|---|
| EEL | int ImGui_Col_ResizeGrip() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_ResizeGrip") |
|---|
| Lua | number retval = reaper.ImGui_Col_ResizeGrip() |
|---|
| Python | int retval = ImGui_Col_ResizeGrip() |
|---|
Resize grip in lower-right and lower-left corners of windows.
View source
Constant: Col_ResizeGripActive
| C++ | int ImGui_Col_ResizeGripActive |
|---|
| EEL | int ImGui_Col_ResizeGripActive() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_ResizeGripActive") |
|---|
| Lua | number retval = reaper.ImGui_Col_ResizeGripActive() |
|---|
| Python | int retval = ImGui_Col_ResizeGripActive() |
|---|
View source
Constant: Col_ResizeGripHovered
| C++ | int ImGui_Col_ResizeGripHovered |
|---|
| EEL | int ImGui_Col_ResizeGripHovered() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_ResizeGripHovered") |
|---|
| Lua | number retval = reaper.ImGui_Col_ResizeGripHovered() |
|---|
| Python | int retval = ImGui_Col_ResizeGripHovered() |
|---|
View source
Constant: Col_ScrollbarBg
| C++ | int ImGui_Col_ScrollbarBg |
|---|
| EEL | int ImGui_Col_ScrollbarBg() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_ScrollbarBg") |
|---|
| Lua | number retval = reaper.ImGui_Col_ScrollbarBg() |
|---|
| Python | int retval = ImGui_Col_ScrollbarBg() |
|---|
View source
Constant: Col_ScrollbarGrab
| C++ | int ImGui_Col_ScrollbarGrab |
|---|
| EEL | int ImGui_Col_ScrollbarGrab() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_ScrollbarGrab") |
|---|
| Lua | number retval = reaper.ImGui_Col_ScrollbarGrab() |
|---|
| Python | int retval = ImGui_Col_ScrollbarGrab() |
|---|
View source
Constant: Col_ScrollbarGrabActive
| C++ | int ImGui_Col_ScrollbarGrabActive |
|---|
| EEL | int ImGui_Col_ScrollbarGrabActive() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_ScrollbarGrabActive") |
|---|
| Lua | number retval = reaper.ImGui_Col_ScrollbarGrabActive() |
|---|
| Python | int retval = ImGui_Col_ScrollbarGrabActive() |
|---|
View source
Constant: Col_ScrollbarGrabHovered
| C++ | int ImGui_Col_ScrollbarGrabHovered |
|---|
| EEL | int ImGui_Col_ScrollbarGrabHovered() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_ScrollbarGrabHovered") |
|---|
| Lua | number retval = reaper.ImGui_Col_ScrollbarGrabHovered() |
|---|
| Python | int retval = ImGui_Col_ScrollbarGrabHovered() |
|---|
View source
Constant: Col_Separator
| C++ | int ImGui_Col_Separator |
|---|
| EEL | int ImGui_Col_Separator() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_Separator") |
|---|
| Lua | number retval = reaper.ImGui_Col_Separator() |
|---|
| Python | int retval = ImGui_Col_Separator() |
|---|
View source
Constant: Col_SeparatorActive
| C++ | int ImGui_Col_SeparatorActive |
|---|
| EEL | int ImGui_Col_SeparatorActive() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_SeparatorActive") |
|---|
| Lua | number retval = reaper.ImGui_Col_SeparatorActive() |
|---|
| Python | int retval = ImGui_Col_SeparatorActive() |
|---|
View source
Constant: Col_SeparatorHovered
| C++ | int ImGui_Col_SeparatorHovered |
|---|
| EEL | int ImGui_Col_SeparatorHovered() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_SeparatorHovered") |
|---|
| Lua | number retval = reaper.ImGui_Col_SeparatorHovered() |
|---|
| Python | int retval = ImGui_Col_SeparatorHovered() |
|---|
View source
Constant: Col_SliderGrab
| C++ | int ImGui_Col_SliderGrab |
|---|
| EEL | int ImGui_Col_SliderGrab() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_SliderGrab") |
|---|
| Lua | number retval = reaper.ImGui_Col_SliderGrab() |
|---|
| Python | int retval = ImGui_Col_SliderGrab() |
|---|
View source
Constant: Col_SliderGrabActive
| C++ | int ImGui_Col_SliderGrabActive |
|---|
| EEL | int ImGui_Col_SliderGrabActive() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_SliderGrabActive") |
|---|
| Lua | number retval = reaper.ImGui_Col_SliderGrabActive() |
|---|
| Python | int retval = ImGui_Col_SliderGrabActive() |
|---|
View source
Constant: Col_Tab
| C++ | int ImGui_Col_Tab |
|---|
| EEL | int ImGui_Col_Tab() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_Tab") |
|---|
| Lua | number retval = reaper.ImGui_Col_Tab() |
|---|
| Python | int retval = ImGui_Col_Tab() |
|---|
TabItem in a TabBar
View source
Constant: Col_TabActive
| C++ | int ImGui_Col_TabActive |
|---|
| EEL | int ImGui_Col_TabActive() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_TabActive") |
|---|
| Lua | number retval = reaper.ImGui_Col_TabActive() |
|---|
| Python | int retval = ImGui_Col_TabActive() |
|---|
View source
Constant: Col_TabHovered
| C++ | int ImGui_Col_TabHovered |
|---|
| EEL | int ImGui_Col_TabHovered() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_TabHovered") |
|---|
| Lua | number retval = reaper.ImGui_Col_TabHovered() |
|---|
| Python | int retval = ImGui_Col_TabHovered() |
|---|
View source
Constant: Col_TabUnfocused
| C++ | int ImGui_Col_TabUnfocused |
|---|
| EEL | int ImGui_Col_TabUnfocused() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_TabUnfocused") |
|---|
| Lua | number retval = reaper.ImGui_Col_TabUnfocused() |
|---|
| Python | int retval = ImGui_Col_TabUnfocused() |
|---|
View source
Constant: Col_TabUnfocusedActive
| C++ | int ImGui_Col_TabUnfocusedActive |
|---|
| EEL | int ImGui_Col_TabUnfocusedActive() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_TabUnfocusedActive") |
|---|
| Lua | number retval = reaper.ImGui_Col_TabUnfocusedActive() |
|---|
| Python | int retval = ImGui_Col_TabUnfocusedActive() |
|---|
View source
Constant: Col_TableBorderLight
| C++ | int ImGui_Col_TableBorderLight |
|---|
| EEL | int ImGui_Col_TableBorderLight() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_TableBorderLight") |
|---|
| Lua | number retval = reaper.ImGui_Col_TableBorderLight() |
|---|
| Python | int retval = ImGui_Col_TableBorderLight() |
|---|
Table inner borders (prefer using Alpha=1.0 here).
View source
Constant: Col_TableBorderStrong
| C++ | int ImGui_Col_TableBorderStrong |
|---|
| EEL | int ImGui_Col_TableBorderStrong() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_TableBorderStrong") |
|---|
| Lua | number retval = reaper.ImGui_Col_TableBorderStrong() |
|---|
| Python | int retval = ImGui_Col_TableBorderStrong() |
|---|
Table outer and header borders (prefer using Alpha=1.0 here).
View source
Constant: Col_TableRowBg
| C++ | int ImGui_Col_TableRowBg |
|---|
| EEL | int ImGui_Col_TableRowBg() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_TableRowBg") |
|---|
| Lua | number retval = reaper.ImGui_Col_TableRowBg() |
|---|
| Python | int retval = ImGui_Col_TableRowBg() |
|---|
Table row background (even rows).
View source
Constant: Col_TableRowBgAlt
| C++ | int ImGui_Col_TableRowBgAlt |
|---|
| EEL | int ImGui_Col_TableRowBgAlt() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_TableRowBgAlt") |
|---|
| Lua | number retval = reaper.ImGui_Col_TableRowBgAlt() |
|---|
| Python | int retval = ImGui_Col_TableRowBgAlt() |
|---|
Table row background (odd rows).
View source
Constant: Col_Text
| C++ | int ImGui_Col_Text |
|---|
| EEL | int ImGui_Col_Text() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_Text") |
|---|
| Lua | number retval = reaper.ImGui_Col_Text() |
|---|
| Python | int retval = ImGui_Col_Text() |
|---|
View source
Constant: Col_TextDisabled
| C++ | int ImGui_Col_TextDisabled |
|---|
| EEL | int ImGui_Col_TextDisabled() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_TextDisabled") |
|---|
| Lua | number retval = reaper.ImGui_Col_TextDisabled() |
|---|
| Python | int retval = ImGui_Col_TextDisabled() |
|---|
View source
Constant: Col_TextSelectedBg
| C++ | int ImGui_Col_TextSelectedBg |
|---|
| EEL | int ImGui_Col_TextSelectedBg() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_TextSelectedBg") |
|---|
| Lua | number retval = reaper.ImGui_Col_TextSelectedBg() |
|---|
| Python | int retval = ImGui_Col_TextSelectedBg() |
|---|
View source
Constant: Col_TitleBg
| C++ | int ImGui_Col_TitleBg |
|---|
| EEL | int ImGui_Col_TitleBg() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_TitleBg") |
|---|
| Lua | number retval = reaper.ImGui_Col_TitleBg() |
|---|
| Python | int retval = ImGui_Col_TitleBg() |
|---|
View source
Constant: Col_TitleBgActive
| C++ | int ImGui_Col_TitleBgActive |
|---|
| EEL | int ImGui_Col_TitleBgActive() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_TitleBgActive") |
|---|
| Lua | number retval = reaper.ImGui_Col_TitleBgActive() |
|---|
| Python | int retval = ImGui_Col_TitleBgActive() |
|---|
View source
Constant: Col_TitleBgCollapsed
| C++ | int ImGui_Col_TitleBgCollapsed |
|---|
| EEL | int ImGui_Col_TitleBgCollapsed() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_TitleBgCollapsed") |
|---|
| Lua | number retval = reaper.ImGui_Col_TitleBgCollapsed() |
|---|
| Python | int retval = ImGui_Col_TitleBgCollapsed() |
|---|
View source
Constant: Col_WindowBg
| C++ | int ImGui_Col_WindowBg |
|---|
| EEL | int ImGui_Col_WindowBg() |
|---|
| Legacy EEL | int extension_api("ImGui_Col_WindowBg") |
|---|
| Lua | number retval = reaper.ImGui_Col_WindowBg() |
|---|
| Python | int retval = ImGui_Col_WindowBg() |
|---|
Background of normal windows. See also WindowFlags_NoBackground.
View source
Function: GetColor
| C++ | int ImGui_GetColor(ImGui_Context* ctx, int idx, double* alpha_mulInOptional = 1.0) |
|---|
| EEL | int ImGui_GetColor(ImGui_Context ctx, int idx, alpha_mul = 1.0) |
|---|
| Legacy EEL | int extension_api("ImGui_GetColor", ImGui_Context ctx, int idx, alpha_mul = 1.0) |
|---|
| Lua | number retval = reaper.ImGui_GetColor(ImGui_Context ctx, number idx, number alpha_mul = 1.0) |
|---|
| Python | int retval = ImGui_GetColor(ImGui_Context ctx, int idx, float alpha_mul = 1.0) |
|---|
Retrieve given style color with style alpha applied and optional extra alpha
multiplier, packed as a 32-bit value (RGBA). See Col_* for available style colors.
View source
Function: GetColorEx
| C++ | int ImGui_GetColorEx(ImGui_Context* ctx, int col_rgba) |
|---|
| EEL | int ImGui_GetColorEx(ImGui_Context ctx, int col_rgba) |
|---|
| Legacy EEL | int extension_api("ImGui_GetColorEx", ImGui_Context ctx, int col_rgba) |
|---|
| Lua | number retval = reaper.ImGui_GetColorEx(ImGui_Context ctx, number col_rgba) |
|---|
| Python | int retval = ImGui_GetColorEx(ImGui_Context ctx, int col_rgba) |
|---|
Retrieve given color with style alpha applied, packed as a 32-bit value (RGBA).
View source
Function: GetStyleColor
| C++ | int ImGui_GetStyleColor(ImGui_Context* ctx, int idx) |
|---|
| EEL | int ImGui_GetStyleColor(ImGui_Context ctx, int idx) |
|---|
| Legacy EEL | int extension_api("ImGui_GetStyleColor", ImGui_Context ctx, int idx) |
|---|
| Lua | number retval = reaper.ImGui_GetStyleColor(ImGui_Context ctx, number idx) |
|---|
| Python | int retval = ImGui_GetStyleColor(ImGui_Context ctx, int idx) |
|---|
Retrieve style color as stored in ImGuiStyle structure.
Use to feed back into PushStyleColor, Otherwise use GetColor to get style color
with style alpha baked in. See Col_* for available style colors.
View source
Function: PopStyleColor
| C++ | void ImGui_PopStyleColor(ImGui_Context* ctx, int* countInOptional = 1) |
|---|
| EEL | ImGui_PopStyleColor(ImGui_Context ctx, int count = 1) |
|---|
| Legacy EEL | extension_api("ImGui_PopStyleColor", ImGui_Context ctx, int count = 1) |
|---|
| Lua | reaper.ImGui_PopStyleColor(ImGui_Context ctx, number count = 1) |
|---|
| Python | ImGui_PopStyleColor(ImGui_Context ctx, int count = 1) |
|---|
View source
Function: PushStyleColor
| C++ | void ImGui_PushStyleColor(ImGui_Context* ctx, int idx, int col_rgba) |
|---|
| EEL | ImGui_PushStyleColor(ImGui_Context ctx, int idx, int col_rgba) |
|---|
| Legacy EEL | extension_api("ImGui_PushStyleColor", ImGui_Context ctx, int idx, int col_rgba) |
|---|
| Lua | reaper.ImGui_PushStyleColor(ImGui_Context ctx, number idx, number col_rgba) |
|---|
| Python | ImGui_PushStyleColor(ImGui_Context ctx, int idx, int col_rgba) |
|---|
Temporarily modify a style color.
Call PopStyleColor to undo after use (before the end of the frame).
See Col_* for available style colors.
View source
Variables
Function: GetStyleVar
| C++ | void ImGui_GetStyleVar(ImGui_Context* ctx, int var_idx, double* val1Out, double* val2Out) |
|---|
| EEL | ImGui_GetStyleVar(ImGui_Context ctx, int var_idx, &val1, &val2) |
|---|
| Legacy EEL | extension_api("ImGui_GetStyleVar", ImGui_Context ctx, int var_idx, &val1, &val2) |
|---|
| Lua | number val1, number val2 = reaper.ImGui_GetStyleVar(ImGui_Context ctx, number var_idx) |
|---|
| Python | (float val1, float val2) = ImGui_GetStyleVar(ImGui_Context ctx, int var_idx) |
|---|
View source
Function: PopStyleVar
| C++ | void ImGui_PopStyleVar(ImGui_Context* ctx, int* countInOptional = 1) |
|---|
| EEL | ImGui_PopStyleVar(ImGui_Context ctx, int count = 1) |
|---|
| Legacy EEL | extension_api("ImGui_PopStyleVar", ImGui_Context ctx, int count = 1) |
|---|
| Lua | reaper.ImGui_PopStyleVar(ImGui_Context ctx, number count = 1) |
|---|
| Python | ImGui_PopStyleVar(ImGui_Context ctx, int count = 1) |
|---|
Reset a style variable.
View source
Function: PushStyleVar
| C++ | void ImGui_PushStyleVar(ImGui_Context* ctx, int var_idx, double val1, double* val2InOptional = nullptr) |
|---|
| EEL | ImGui_PushStyleVar(ImGui_Context ctx, int var_idx, val1, val2 = nullptr) |
|---|
| Legacy EEL | extension_api("ImGui_PushStyleVar", ImGui_Context ctx, int var_idx, val1, val2 = nullptr) |
|---|
| Lua | reaper.ImGui_PushStyleVar(ImGui_Context ctx, number var_idx, number val1, number val2 = nullptr) |
|---|
| Python | ImGui_PushStyleVar(ImGui_Context ctx, int var_idx, float val1, float val2 = nullptr) |
|---|
Temporarily modify a style variable.
Call PopStyleVar to undo after use (before the end of the frame).
See StyleVar_* for possible values of 'var_idx'.
View source
Constant: StyleVar_Alpha
| C++ | int ImGui_StyleVar_Alpha |
|---|
| EEL | int ImGui_StyleVar_Alpha() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_Alpha") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_Alpha() |
|---|
| Python | int retval = ImGui_StyleVar_Alpha() |
|---|
Global alpha applies to everything in Dear ImGui.
View source
Constant: StyleVar_ButtonTextAlign
| C++ | int ImGui_StyleVar_ButtonTextAlign |
|---|
| EEL | int ImGui_StyleVar_ButtonTextAlign() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_ButtonTextAlign") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_ButtonTextAlign() |
|---|
| Python | int retval = ImGui_StyleVar_ButtonTextAlign() |
|---|
Alignment of button text when button is larger than text.
Defaults to (0.5, 0.5) (centered).
View source
Constant: StyleVar_CellPadding
| C++ | int ImGui_StyleVar_CellPadding |
|---|
| EEL | int ImGui_StyleVar_CellPadding() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_CellPadding") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_CellPadding() |
|---|
| Python | int retval = ImGui_StyleVar_CellPadding() |
|---|
Padding within a table cell.
View source
Constant: StyleVar_ChildBorderSize
| C++ | int ImGui_StyleVar_ChildBorderSize |
|---|
| EEL | int ImGui_StyleVar_ChildBorderSize() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_ChildBorderSize") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_ChildBorderSize() |
|---|
| Python | int retval = ImGui_StyleVar_ChildBorderSize() |
|---|
Thickness of border around child windows. Generally set to 0.0 or 1.0.
(Other values are not well tested and more CPU/GPU costly).
View source
Constant: StyleVar_ChildRounding
| C++ | int ImGui_StyleVar_ChildRounding |
|---|
| EEL | int ImGui_StyleVar_ChildRounding() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_ChildRounding") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_ChildRounding() |
|---|
| Python | int retval = ImGui_StyleVar_ChildRounding() |
|---|
Radius of child window corners rounding. Set to 0.0 to have rectangular windows.
View source
Constant: StyleVar_DisabledAlpha
| C++ | int ImGui_StyleVar_DisabledAlpha |
|---|
| EEL | int ImGui_StyleVar_DisabledAlpha() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_DisabledAlpha") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_DisabledAlpha() |
|---|
| Python | int retval = ImGui_StyleVar_DisabledAlpha() |
|---|
Additional alpha multiplier applied by BeginDisabled.
Multiply over current value of Alpha.
View source
Constant: StyleVar_FrameBorderSize
| C++ | int ImGui_StyleVar_FrameBorderSize |
|---|
| EEL | int ImGui_StyleVar_FrameBorderSize() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_FrameBorderSize") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_FrameBorderSize() |
|---|
| Python | int retval = ImGui_StyleVar_FrameBorderSize() |
|---|
Thickness of border around frames. Generally set to 0.0 or 1.0.
(Other values are not well tested and more CPU/GPU costly).
View source
Constant: StyleVar_FramePadding
| C++ | int ImGui_StyleVar_FramePadding |
|---|
| EEL | int ImGui_StyleVar_FramePadding() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_FramePadding") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_FramePadding() |
|---|
| Python | int retval = ImGui_StyleVar_FramePadding() |
|---|
Padding within a framed rectangle (used by most widgets).
View source
Constant: StyleVar_FrameRounding
| C++ | int ImGui_StyleVar_FrameRounding |
|---|
| EEL | int ImGui_StyleVar_FrameRounding() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_FrameRounding") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_FrameRounding() |
|---|
| Python | int retval = ImGui_StyleVar_FrameRounding() |
|---|
Radius of frame corners rounding.
Set to 0.0 to have rectangular frame (used by most widgets).
View source
Constant: StyleVar_GrabMinSize
| C++ | int ImGui_StyleVar_GrabMinSize |
|---|
| EEL | int ImGui_StyleVar_GrabMinSize() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_GrabMinSize") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_GrabMinSize() |
|---|
| Python | int retval = ImGui_StyleVar_GrabMinSize() |
|---|
Minimum width/height of a grab box for slider/scrollbar.
View source
Constant: StyleVar_GrabRounding
| C++ | int ImGui_StyleVar_GrabRounding |
|---|
| EEL | int ImGui_StyleVar_GrabRounding() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_GrabRounding") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_GrabRounding() |
|---|
| Python | int retval = ImGui_StyleVar_GrabRounding() |
|---|
Radius of grabs corners rounding. Set to 0.0 to have rectangular slider grabs.
View source
Constant: StyleVar_IndentSpacing
| C++ | int ImGui_StyleVar_IndentSpacing |
|---|
| EEL | int ImGui_StyleVar_IndentSpacing() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_IndentSpacing") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_IndentSpacing() |
|---|
| Python | int retval = ImGui_StyleVar_IndentSpacing() |
|---|
Horizontal indentation when e.g. entering a tree node.
Generally == (GetFontSize + StyleVar_FramePadding.x*2).
View source
Constant: StyleVar_ItemInnerSpacing
| C++ | int ImGui_StyleVar_ItemInnerSpacing |
|---|
| EEL | int ImGui_StyleVar_ItemInnerSpacing() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_ItemInnerSpacing") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_ItemInnerSpacing() |
|---|
| Python | int retval = ImGui_StyleVar_ItemInnerSpacing() |
|---|
Horizontal and vertical spacing between within elements of a composed widget
(e.g. a slider and its label).
View source
Constant: StyleVar_ItemSpacing
| C++ | int ImGui_StyleVar_ItemSpacing |
|---|
| EEL | int ImGui_StyleVar_ItemSpacing() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_ItemSpacing") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_ItemSpacing() |
|---|
| Python | int retval = ImGui_StyleVar_ItemSpacing() |
|---|
Horizontal and vertical spacing between widgets/lines.
View source
Constant: StyleVar_ScrollbarRounding
| C++ | int ImGui_StyleVar_ScrollbarRounding |
|---|
| EEL | int ImGui_StyleVar_ScrollbarRounding() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_ScrollbarRounding") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_ScrollbarRounding() |
|---|
| Python | int retval = ImGui_StyleVar_ScrollbarRounding() |
|---|
Radius of grab corners for scrollbar.
View source
Constant: StyleVar_ScrollbarSize
| C++ | int ImGui_StyleVar_ScrollbarSize |
|---|
| EEL | int ImGui_StyleVar_ScrollbarSize() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_ScrollbarSize") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_ScrollbarSize() |
|---|
| Python | int retval = ImGui_StyleVar_ScrollbarSize() |
|---|
Width of the vertical scrollbar, Height of the horizontal scrollbar.
View source
Constant: StyleVar_SelectableTextAlign
| C++ | int ImGui_StyleVar_SelectableTextAlign |
|---|
| EEL | int ImGui_StyleVar_SelectableTextAlign() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_SelectableTextAlign") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_SelectableTextAlign() |
|---|
| Python | int retval = ImGui_StyleVar_SelectableTextAlign() |
|---|
Alignment of selectable text. Defaults to (0.0, 0.0) (top-left aligned).
It's generally important to keep this left-aligned if you want to lay
multiple items on a same line.
View source
Constant: StyleVar_SeparatorTextAlign
| C++ | int ImGui_StyleVar_SeparatorTextAlign |
|---|
| EEL | int ImGui_StyleVar_SeparatorTextAlign() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_SeparatorTextAlign") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_SeparatorTextAlign() |
|---|
| Python | int retval = ImGui_StyleVar_SeparatorTextAlign() |
|---|
Alignment of text within the separator.
Defaults to (0.0, 0.5) (left aligned, center).
View source
Constant: StyleVar_SeparatorTextBorderSize
| C++ | int ImGui_StyleVar_SeparatorTextBorderSize |
|---|
| EEL | int ImGui_StyleVar_SeparatorTextBorderSize() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_SeparatorTextBorderSize") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_SeparatorTextBorderSize() |
|---|
| Python | int retval = ImGui_StyleVar_SeparatorTextBorderSize() |
|---|
Thickness of border in SeparatorText()
View source
Constant: StyleVar_SeparatorTextPadding
| C++ | int ImGui_StyleVar_SeparatorTextPadding |
|---|
| EEL | int ImGui_StyleVar_SeparatorTextPadding() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_SeparatorTextPadding") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_SeparatorTextPadding() |
|---|
| Python | int retval = ImGui_StyleVar_SeparatorTextPadding() |
|---|
Horizontal offset of text from each edge of the separator + spacing on other
axis. Generally small values. .y is recommended to be == StyleVar_FramePadding.y.
View source
Constant: StyleVar_TabRounding
| C++ | int ImGui_StyleVar_TabRounding |
|---|
| EEL | int ImGui_StyleVar_TabRounding() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_TabRounding") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_TabRounding() |
|---|
| Python | int retval = ImGui_StyleVar_TabRounding() |
|---|
Radius of upper corners of a tab. Set to 0.0 to have rectangular tabs.
View source
Constant: StyleVar_WindowBorderSize
| C++ | int ImGui_StyleVar_WindowBorderSize |
|---|
| EEL | int ImGui_StyleVar_WindowBorderSize() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_WindowBorderSize") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_WindowBorderSize() |
|---|
| Python | int retval = ImGui_StyleVar_WindowBorderSize() |
|---|
Thickness of border around windows. Generally set to 0.0 or 1.0.
(Other values are not well tested and more CPU/GPU costly).
View source
Constant: StyleVar_WindowMinSize
| C++ | int ImGui_StyleVar_WindowMinSize |
|---|
| EEL | int ImGui_StyleVar_WindowMinSize() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_WindowMinSize") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_WindowMinSize() |
|---|
| Python | int retval = ImGui_StyleVar_WindowMinSize() |
|---|
Minimum window size. This is a global setting.
If you want to constrain individual windows, use SetNextWindowSizeConstraints.
View source
Constant: StyleVar_WindowPadding
| C++ | int ImGui_StyleVar_WindowPadding |
|---|
| EEL | int ImGui_StyleVar_WindowPadding() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_WindowPadding") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_WindowPadding() |
|---|
| Python | int retval = ImGui_StyleVar_WindowPadding() |
|---|
Padding within a window.
View source
Constant: StyleVar_WindowRounding
| C++ | int ImGui_StyleVar_WindowRounding |
|---|
| EEL | int ImGui_StyleVar_WindowRounding() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_WindowRounding") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_WindowRounding() |
|---|
| Python | int retval = ImGui_StyleVar_WindowRounding() |
|---|
Radius of window corners rounding. Set to 0.0 to have rectangular windows.
Large values tend to lead to variety of artifacts and are not recommended.
View source
Constant: StyleVar_WindowTitleAlign
| C++ | int ImGui_StyleVar_WindowTitleAlign |
|---|
| EEL | int ImGui_StyleVar_WindowTitleAlign() |
|---|
| Legacy EEL | int extension_api("ImGui_StyleVar_WindowTitleAlign") |
|---|
| Lua | number retval = reaper.ImGui_StyleVar_WindowTitleAlign() |
|---|
| Python | int retval = ImGui_StyleVar_WindowTitleAlign() |
|---|
Alignment for title bar text.
Defaults to (0.0,0.5) for left-aligned,vertically centered.
View source
Tab Bar
Function: BeginTabBar
| C++ | bool ImGui_BeginTabBar(ImGui_Context* ctx, const char* str_id, int* flagsInOptional = TabBarFlags_None) |
|---|
| EEL | bool ImGui_BeginTabBar(ImGui_Context ctx, "str_id", int flags = TabBarFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_BeginTabBar", ImGui_Context ctx, "str_id", int flags = TabBarFlags_None) |
|---|
| Lua | boolean retval = reaper.ImGui_BeginTabBar(ImGui_Context ctx, string str_id, number flags = TabBarFlags_None) |
|---|
| Python | bool retval = ImGui_BeginTabBar(ImGui_Context ctx, str str_id, int flags = TabBarFlags_None) |
|---|
Create and append into a TabBar.
View source
Function: EndTabBar
| C++ | void ImGui_EndTabBar(ImGui_Context* ctx) |
|---|
| EEL | ImGui_EndTabBar(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_EndTabBar", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_EndTabBar(ImGui_Context ctx) |
|---|
| Python | ImGui_EndTabBar(ImGui_Context ctx) |
|---|
Only call EndTabBar() if BeginTabBar() returns true!
View source
Constant: TabBarFlags_AutoSelectNewTabs
| C++ | int ImGui_TabBarFlags_AutoSelectNewTabs |
|---|
| EEL | int ImGui_TabBarFlags_AutoSelectNewTabs() |
|---|
| Legacy EEL | int extension_api("ImGui_TabBarFlags_AutoSelectNewTabs") |
|---|
| Lua | number retval = reaper.ImGui_TabBarFlags_AutoSelectNewTabs() |
|---|
| Python | int retval = ImGui_TabBarFlags_AutoSelectNewTabs() |
|---|
Automatically select new tabs when they appear.
View source
Constant: TabBarFlags_FittingPolicyResizeDown
| C++ | int ImGui_TabBarFlags_FittingPolicyResizeDown |
|---|
| EEL | int ImGui_TabBarFlags_FittingPolicyResizeDown() |
|---|
| Legacy EEL | int extension_api("ImGui_TabBarFlags_FittingPolicyResizeDown") |
|---|
| Lua | number retval = reaper.ImGui_TabBarFlags_FittingPolicyResizeDown() |
|---|
| Python | int retval = ImGui_TabBarFlags_FittingPolicyResizeDown() |
|---|
Resize tabs when they don't fit.
View source
Constant: TabBarFlags_FittingPolicyScroll
| C++ | int ImGui_TabBarFlags_FittingPolicyScroll |
|---|
| EEL | int ImGui_TabBarFlags_FittingPolicyScroll() |
|---|
| Legacy EEL | int extension_api("ImGui_TabBarFlags_FittingPolicyScroll") |
|---|
| Lua | number retval = reaper.ImGui_TabBarFlags_FittingPolicyScroll() |
|---|
| Python | int retval = ImGui_TabBarFlags_FittingPolicyScroll() |
|---|
Add scroll buttons when tabs don't fit.
View source
Constant: TabBarFlags_NoCloseWithMiddleMouseButton
| C++ | int ImGui_TabBarFlags_NoCloseWithMiddleMouseButton |
|---|
| EEL | int ImGui_TabBarFlags_NoCloseWithMiddleMouseButton() |
|---|
| Legacy EEL | int extension_api("ImGui_TabBarFlags_NoCloseWithMiddleMouseButton") |
|---|
| Lua | number retval = reaper.ImGui_TabBarFlags_NoCloseWithMiddleMouseButton() |
|---|
| Python | int retval = ImGui_TabBarFlags_NoCloseWithMiddleMouseButton() |
|---|
Disable behavior of closing tabs (that are submitted with p_open != nil)
with middle mouse button. You can still repro this behavior on user's side
with if(IsItemHovered() && IsMouseClicked(2)) p_open = false.
View source
Constant: TabBarFlags_NoTabListScrollingButtons
| C++ | int ImGui_TabBarFlags_NoTabListScrollingButtons |
|---|
| EEL | int ImGui_TabBarFlags_NoTabListScrollingButtons() |
|---|
| Legacy EEL | int extension_api("ImGui_TabBarFlags_NoTabListScrollingButtons") |
|---|
| Lua | number retval = reaper.ImGui_TabBarFlags_NoTabListScrollingButtons() |
|---|
| Python | int retval = ImGui_TabBarFlags_NoTabListScrollingButtons() |
|---|
Disable scrolling buttons (apply when fitting policy is
TabBarFlags_FittingPolicyScroll).
View source
Constant: TabBarFlags_NoTooltip
| C++ | int ImGui_TabBarFlags_NoTooltip |
|---|
| EEL | int ImGui_TabBarFlags_NoTooltip() |
|---|
| Legacy EEL | int extension_api("ImGui_TabBarFlags_NoTooltip") |
|---|
| Lua | number retval = reaper.ImGui_TabBarFlags_NoTooltip() |
|---|
| Python | int retval = ImGui_TabBarFlags_NoTooltip() |
|---|
Disable tooltips when hovering a tab.
View source
Constant: TabBarFlags_None
| C++ | int ImGui_TabBarFlags_None |
|---|
| EEL | int ImGui_TabBarFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_TabBarFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_TabBarFlags_None() |
|---|
| Python | int retval = ImGui_TabBarFlags_None() |
|---|
View source
Constant: TabBarFlags_Reorderable
| C++ | int ImGui_TabBarFlags_Reorderable |
|---|
| EEL | int ImGui_TabBarFlags_Reorderable() |
|---|
| Legacy EEL | int extension_api("ImGui_TabBarFlags_Reorderable") |
|---|
| Lua | number retval = reaper.ImGui_TabBarFlags_Reorderable() |
|---|
| Python | int retval = ImGui_TabBarFlags_Reorderable() |
|---|
Allow manually dragging tabs to re-order them + New tabs are appended at
the end of list.
View source
Tab Item
Function: BeginTabItem
| C++ | bool ImGui_BeginTabItem(ImGui_Context* ctx, const char* label, bool* p_openInOutOptional = nullptr, int* flagsInOptional = TabItemFlags_None) |
|---|
| EEL | bool ImGui_BeginTabItem(ImGui_Context ctx, "label", bool &p_open = nullptr, int flags = TabItemFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_BeginTabItem", ImGui_Context ctx, "label", bool &p_open = nullptr, int flags = TabItemFlags_None) |
|---|
| Lua | boolean retval, boolean p_open = reaper.ImGui_BeginTabItem(ImGui_Context ctx, string label, boolean p_open = nullptr, number flags = TabItemFlags_None) |
|---|
| Python | (bool retval, bool p_open) = ImGui_BeginTabItem(ImGui_Context ctx, str label, bool p_open = nullptr, int flags = TabItemFlags_None) |
|---|
Create a Tab. Returns true if the Tab is selected.
Set 'p_open' to true to enable the close button.
View source
Function: EndTabItem
| C++ | void ImGui_EndTabItem(ImGui_Context* ctx) |
|---|
| EEL | ImGui_EndTabItem(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_EndTabItem", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_EndTabItem(ImGui_Context ctx) |
|---|
| Python | ImGui_EndTabItem(ImGui_Context ctx) |
|---|
Only call EndTabItem() if BeginTabItem() returns true!
View source
Function: SetTabItemClosed
| C++ | void ImGui_SetTabItemClosed(ImGui_Context* ctx, const char* tab_or_docked_window_label) |
|---|
| EEL | ImGui_SetTabItemClosed(ImGui_Context ctx, "tab_or_docked_window_label") |
|---|
| Legacy EEL | extension_api("ImGui_SetTabItemClosed", ImGui_Context ctx, "tab_or_docked_window_label") |
|---|
| Lua | reaper.ImGui_SetTabItemClosed(ImGui_Context ctx, string tab_or_docked_window_label) |
|---|
| Python | ImGui_SetTabItemClosed(ImGui_Context ctx, str tab_or_docked_window_label) |
|---|
Notify TabBar or Docking system of a closed tab/window ahead
(useful to reduce visual flicker on reorderable tab bars).
For tab-bar: call after BeginTabBar and before Tab submissions.
Otherwise call with a window name.
View source
Function: TabItemButton
| C++ | bool ImGui_TabItemButton(ImGui_Context* ctx, const char* label, int* flagsInOptional = TabItemFlags_None) |
|---|
| EEL | bool ImGui_TabItemButton(ImGui_Context ctx, "label", int flags = TabItemFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_TabItemButton", ImGui_Context ctx, "label", int flags = TabItemFlags_None) |
|---|
| Lua | boolean retval = reaper.ImGui_TabItemButton(ImGui_Context ctx, string label, number flags = TabItemFlags_None) |
|---|
| Python | bool retval = ImGui_TabItemButton(ImGui_Context ctx, str label, int flags = TabItemFlags_None) |
|---|
Create a Tab behaving like a button. Return true when clicked.
Cannot be selected in the tab bar.
View source
Constant: TabItemFlags_Leading
| C++ | int ImGui_TabItemFlags_Leading |
|---|
| EEL | int ImGui_TabItemFlags_Leading() |
|---|
| Legacy EEL | int extension_api("ImGui_TabItemFlags_Leading") |
|---|
| Lua | number retval = reaper.ImGui_TabItemFlags_Leading() |
|---|
| Python | int retval = ImGui_TabItemFlags_Leading() |
|---|
Enforce the tab position to the left of the tab bar (after the tab list popup button).
View source
Constant: TabItemFlags_NoCloseWithMiddleMouseButton
| C++ | int ImGui_TabItemFlags_NoCloseWithMiddleMouseButton |
|---|
| EEL | int ImGui_TabItemFlags_NoCloseWithMiddleMouseButton() |
|---|
| Legacy EEL | int extension_api("ImGui_TabItemFlags_NoCloseWithMiddleMouseButton") |
|---|
| Lua | number retval = reaper.ImGui_TabItemFlags_NoCloseWithMiddleMouseButton() |
|---|
| Python | int retval = ImGui_TabItemFlags_NoCloseWithMiddleMouseButton() |
|---|
Disable behavior of closing tabs (that are submitted with p_open != nil) with
middle mouse button. You can still repro this behavior on user's side with
if(IsItemHovered() && IsMouseClicked(2)) p_open = false.
View source
Constant: TabItemFlags_NoPushId
| C++ | int ImGui_TabItemFlags_NoPushId |
|---|
| EEL | int ImGui_TabItemFlags_NoPushId() |
|---|
| Legacy EEL | int extension_api("ImGui_TabItemFlags_NoPushId") |
|---|
| Lua | number retval = reaper.ImGui_TabItemFlags_NoPushId() |
|---|
| Python | int retval = ImGui_TabItemFlags_NoPushId() |
|---|
Don't call PushID(tab->ID)/PopID() on BeginTabItem/EndTabItem.
View source
Constant: TabItemFlags_NoReorder
| C++ | int ImGui_TabItemFlags_NoReorder |
|---|
| EEL | int ImGui_TabItemFlags_NoReorder() |
|---|
| Legacy EEL | int extension_api("ImGui_TabItemFlags_NoReorder") |
|---|
| Lua | number retval = reaper.ImGui_TabItemFlags_NoReorder() |
|---|
| Python | int retval = ImGui_TabItemFlags_NoReorder() |
|---|
Disable reordering this tab or having another tab cross over this tab.
View source
Constant: TabItemFlags_NoTooltip
| C++ | int ImGui_TabItemFlags_NoTooltip |
|---|
| EEL | int ImGui_TabItemFlags_NoTooltip() |
|---|
| Legacy EEL | int extension_api("ImGui_TabItemFlags_NoTooltip") |
|---|
| Lua | number retval = reaper.ImGui_TabItemFlags_NoTooltip() |
|---|
| Python | int retval = ImGui_TabItemFlags_NoTooltip() |
|---|
Disable tooltip for the given tab.
View source
Constant: TabItemFlags_None
| C++ | int ImGui_TabItemFlags_None |
|---|
| EEL | int ImGui_TabItemFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_TabItemFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_TabItemFlags_None() |
|---|
| Python | int retval = ImGui_TabItemFlags_None() |
|---|
View source
Constant: TabItemFlags_SetSelected
| C++ | int ImGui_TabItemFlags_SetSelected |
|---|
| EEL | int ImGui_TabItemFlags_SetSelected() |
|---|
| Legacy EEL | int extension_api("ImGui_TabItemFlags_SetSelected") |
|---|
| Lua | number retval = reaper.ImGui_TabItemFlags_SetSelected() |
|---|
| Python | int retval = ImGui_TabItemFlags_SetSelected() |
|---|
Trigger flag to programmatically make the tab selected when calling BeginTabItem.
View source
Constant: TabItemFlags_Trailing
| C++ | int ImGui_TabItemFlags_Trailing |
|---|
| EEL | int ImGui_TabItemFlags_Trailing() |
|---|
| Legacy EEL | int extension_api("ImGui_TabItemFlags_Trailing") |
|---|
| Lua | number retval = reaper.ImGui_TabItemFlags_Trailing() |
|---|
| Python | int retval = ImGui_TabItemFlags_Trailing() |
|---|
Enforce the tab position to the right of the tab bar (before the scrolling buttons).
View source
Constant: TabItemFlags_UnsavedDocument
| C++ | int ImGui_TabItemFlags_UnsavedDocument |
|---|
| EEL | int ImGui_TabItemFlags_UnsavedDocument() |
|---|
| Legacy EEL | int extension_api("ImGui_TabItemFlags_UnsavedDocument") |
|---|
| Lua | number retval = reaper.ImGui_TabItemFlags_UnsavedDocument() |
|---|
| Python | int retval = ImGui_TabItemFlags_UnsavedDocument() |
|---|
Append '*' to title without affecting the ID, as a convenience to avoid using
the ### operator. Also: tab is selected on closure and closure is deferred by
one frame to allow code to undo it without flicker.
View source
Table
See top of imgui_tables.cpp
for general commentary.
See TableFlags* and TableColumnFlags* enums for a description of available flags.
The typical call flow is:
- Call BeginTable.
- Optionally call TableSetupColumn to submit column name/flags/defaults.
- Optionally call TableSetupScrollFreeze to request scroll freezing of columns/rows.
- Optionally call TableHeadersRow to submit a header row. Names are pulled from
TableSetupColumn data.
- Populate contents:
- Call EndTable.
Function: BeginTable
| C++ | bool ImGui_BeginTable(ImGui_Context* ctx, const char* str_id, int column, int* flagsInOptional = TableFlags_None, double* outer_size_wInOptional = 0.0, double* outer_size_hInOptional = 0.0, double* inner_widthInOptional = 0.0) |
|---|
| EEL | bool ImGui_BeginTable(ImGui_Context ctx, "str_id", int column, int flags = TableFlags_None, outer_size_w = 0.0, outer_size_h = 0.0, inner_width = 0.0) |
|---|
| Legacy EEL | bool extension_api("ImGui_BeginTable", ImGui_Context ctx, "str_id", int column, int flags = TableFlags_None, outer_size_w = 0.0, outer_size_h = 0.0, inner_width = 0.0) |
|---|
| Lua | boolean retval = reaper.ImGui_BeginTable(ImGui_Context ctx, string str_id, number column, number flags = TableFlags_None, number outer_size_w = 0.0, number outer_size_h = 0.0, number inner_width = 0.0) |
|---|
| Python | bool retval = ImGui_BeginTable(ImGui_Context ctx, str str_id, int column, int flags = TableFlags_None, float outer_size_w = 0.0, float outer_size_h = 0.0, float inner_width = 0.0) |
|---|
View source
Function: EndTable
| C++ | void ImGui_EndTable(ImGui_Context* ctx) |
|---|
| EEL | ImGui_EndTable(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_EndTable", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_EndTable(ImGui_Context ctx) |
|---|
| Python | ImGui_EndTable(ImGui_Context ctx) |
|---|
Only call EndTable() if BeginTable() returns true!
View source
Function: TableGetColumnCount
| C++ | int ImGui_TableGetColumnCount(ImGui_Context* ctx) |
|---|
| EEL | int ImGui_TableGetColumnCount(ImGui_Context ctx) |
|---|
| Legacy EEL | int extension_api("ImGui_TableGetColumnCount", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_TableGetColumnCount(ImGui_Context ctx) |
|---|
| Python | int retval = ImGui_TableGetColumnCount(ImGui_Context ctx) |
|---|
Return number of columns (value passed to BeginTable).
View source
Function: TableGetColumnIndex
| C++ | int ImGui_TableGetColumnIndex(ImGui_Context* ctx) |
|---|
| EEL | int ImGui_TableGetColumnIndex(ImGui_Context ctx) |
|---|
| Legacy EEL | int extension_api("ImGui_TableGetColumnIndex", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_TableGetColumnIndex(ImGui_Context ctx) |
|---|
| Python | int retval = ImGui_TableGetColumnIndex(ImGui_Context ctx) |
|---|
Return current column index.
View source
Function: TableGetRowIndex
| C++ | int ImGui_TableGetRowIndex(ImGui_Context* ctx) |
|---|
| EEL | int ImGui_TableGetRowIndex(ImGui_Context ctx) |
|---|
| Legacy EEL | int extension_api("ImGui_TableGetRowIndex", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_TableGetRowIndex(ImGui_Context ctx) |
|---|
| Python | int retval = ImGui_TableGetRowIndex(ImGui_Context ctx) |
|---|
Return current row index.
View source
Function: TableNextColumn
| C++ | bool ImGui_TableNextColumn(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_TableNextColumn(ImGui_Context ctx) |
|---|
| Legacy EEL | bool extension_api("ImGui_TableNextColumn", ImGui_Context ctx) |
|---|
| Lua | boolean retval = reaper.ImGui_TableNextColumn(ImGui_Context ctx) |
|---|
| Python | bool retval = ImGui_TableNextColumn(ImGui_Context ctx) |
|---|
Append into the next column (or first column of next row if currently in
last column). Return true when column is visible.
View source
Function: TableNextRow
| C++ | void ImGui_TableNextRow(ImGui_Context* ctx, int* row_flagsInOptional = TableRowFlags_None, double* min_row_heightInOptional = 0.0) |
|---|
| EEL | ImGui_TableNextRow(ImGui_Context ctx, int row_flags = TableRowFlags_None, min_row_height = 0.0) |
|---|
| Legacy EEL | extension_api("ImGui_TableNextRow", ImGui_Context ctx, int row_flags = TableRowFlags_None, min_row_height = 0.0) |
|---|
| Lua | reaper.ImGui_TableNextRow(ImGui_Context ctx, number row_flags = TableRowFlags_None, number min_row_height = 0.0) |
|---|
| Python | ImGui_TableNextRow(ImGui_Context ctx, int row_flags = TableRowFlags_None, float min_row_height = 0.0) |
|---|
Append into the first cell of a new row.
View source
Constant: TableRowFlags_None
| C++ | int ImGui_TableRowFlags_None |
|---|
| EEL | int ImGui_TableRowFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_TableRowFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_TableRowFlags_None() |
|---|
| Python | int retval = ImGui_TableRowFlags_None() |
|---|
For TableNextRow.
View source
Function: TableSetColumnIndex
| C++ | bool ImGui_TableSetColumnIndex(ImGui_Context* ctx, int column_n) |
|---|
| EEL | bool ImGui_TableSetColumnIndex(ImGui_Context ctx, int column_n) |
|---|
| Legacy EEL | bool extension_api("ImGui_TableSetColumnIndex", ImGui_Context ctx, int column_n) |
|---|
| Lua | boolean retval = reaper.ImGui_TableSetColumnIndex(ImGui_Context ctx, number column_n) |
|---|
| Python | bool retval = ImGui_TableSetColumnIndex(ImGui_Context ctx, int column_n) |
|---|
Append into the specified column. Return true when column is visible.
View source
Background
Background colors are rendering in 3 layers:
- Layer 0: draw with RowBg0 color if set, otherwise draw with ColumnBg0 if set.
- Layer 1: draw with RowBg1 color if set, otherwise draw with ColumnBg1 if set.
- Layer 2: draw with CellBg color if set.
The purpose of the two row/columns layers is to let you decide if a background
color change should override or blend with the existing color.
When using TableFlags_RowBg on the table, each row has the RowBg0 color
automatically set for odd/even rows.
If you set the color of RowBg0 target, your color will override the existing
RowBg0 color.
If you set the color of RowBg1 or ColumnBg1 target, your color will blend over
the RowBg0 color.
Constant: TableBgTarget_CellBg
| C++ | int ImGui_TableBgTarget_CellBg |
|---|
| EEL | int ImGui_TableBgTarget_CellBg() |
|---|
| Legacy EEL | int extension_api("ImGui_TableBgTarget_CellBg") |
|---|
| Lua | number retval = reaper.ImGui_TableBgTarget_CellBg() |
|---|
| Python | int retval = ImGui_TableBgTarget_CellBg() |
|---|
Set cell background color (top-most color).
View source
Constant: TableBgTarget_None
| C++ | int ImGui_TableBgTarget_None |
|---|
| EEL | int ImGui_TableBgTarget_None() |
|---|
| Legacy EEL | int extension_api("ImGui_TableBgTarget_None") |
|---|
| Lua | number retval = reaper.ImGui_TableBgTarget_None() |
|---|
| Python | int retval = ImGui_TableBgTarget_None() |
|---|
View source
Constant: TableBgTarget_RowBg0
| C++ | int ImGui_TableBgTarget_RowBg0 |
|---|
| EEL | int ImGui_TableBgTarget_RowBg0() |
|---|
| Legacy EEL | int extension_api("ImGui_TableBgTarget_RowBg0") |
|---|
| Lua | number retval = reaper.ImGui_TableBgTarget_RowBg0() |
|---|
| Python | int retval = ImGui_TableBgTarget_RowBg0() |
|---|
Set row background color 0 (generally used for background,
automatically set when TableFlags_RowBg is used).
View source
Constant: TableBgTarget_RowBg1
| C++ | int ImGui_TableBgTarget_RowBg1 |
|---|
| EEL | int ImGui_TableBgTarget_RowBg1() |
|---|
| Legacy EEL | int extension_api("ImGui_TableBgTarget_RowBg1") |
|---|
| Lua | number retval = reaper.ImGui_TableBgTarget_RowBg1() |
|---|
| Python | int retval = ImGui_TableBgTarget_RowBg1() |
|---|
Set row background color 1 (generally used for selection marking).
View source
Function: TableSetBgColor
| C++ | void ImGui_TableSetBgColor(ImGui_Context* ctx, int target, int color_rgba, int* column_nInOptional = -1) |
|---|
| EEL | ImGui_TableSetBgColor(ImGui_Context ctx, int target, int color_rgba, int column_n = -1) |
|---|
| Legacy EEL | extension_api("ImGui_TableSetBgColor", ImGui_Context ctx, int target, int color_rgba, int column_n = -1) |
|---|
| Lua | reaper.ImGui_TableSetBgColor(ImGui_Context ctx, number target, number color_rgba, number column_n = -1) |
|---|
| Python | ImGui_TableSetBgColor(ImGui_Context ctx, int target, int color_rgba, int column_n = -1) |
|---|
Change the color of a cell, row, or column.
See TableBgTarget_* flags for details.
View source
Header & Columns
Use TableSetupColumn() to specify label, resizing policy, default
width/weight, id, various other flags etc.
Use TableHeadersRow() to create a header row and automatically submit a
TableHeader() for each column. Headers are required to perform: reordering,
sorting, and opening the context menu. The context menu can also be made
available in columns body using ImGuiTableFlags_ContextMenuInBody.
You may manually submit headers using TableNextRow() + TableHeader() calls, but
this is only useful in some advanced use cases (e.g. adding custom widgets in
header row).
Use TableSetupScrollFreeze() to lock columns/rows so they stay visible when
scrolled.
Function: TableGetColumnFlags
| C++ | int ImGui_TableGetColumnFlags(ImGui_Context* ctx, int* column_nInOptional = -1) |
|---|
| EEL | int ImGui_TableGetColumnFlags(ImGui_Context ctx, int column_n = -1) |
|---|
| Legacy EEL | int extension_api("ImGui_TableGetColumnFlags", ImGui_Context ctx, int column_n = -1) |
|---|
| Lua | number retval = reaper.ImGui_TableGetColumnFlags(ImGui_Context ctx, number column_n = -1) |
|---|
| Python | int retval = ImGui_TableGetColumnFlags(ImGui_Context ctx, int column_n = -1) |
|---|
Return column flags so you can query their Enabled/Visible/Sorted/Hovered
status flags. Pass -1 to use current column.
View source
Function: TableGetColumnName
| C++ | const char* ImGui_TableGetColumnName(ImGui_Context* ctx, int* column_nInOptional = -1) |
|---|
| EEL | const char* ImGui_TableGetColumnName(ImGui_Context ctx, int column_n = -1) |
|---|
| Legacy EEL | const char* extension_api("ImGui_TableGetColumnName", ImGui_Context ctx, int column_n = -1) |
|---|
| Lua | string retval = reaper.ImGui_TableGetColumnName(ImGui_Context ctx, number column_n = -1) |
|---|
| Python | str retval = ImGui_TableGetColumnName(ImGui_Context ctx, int column_n = -1) |
|---|
Return "" if column didn't have a name declared by TableSetupColumn.
Pass -1 to use current column.
View source
Function: TableSetColumnEnabled
| C++ | void ImGui_TableSetColumnEnabled(ImGui_Context* ctx, int column_n, bool v) |
|---|
| EEL | ImGui_TableSetColumnEnabled(ImGui_Context ctx, int column_n, bool v) |
|---|
| Legacy EEL | extension_api("ImGui_TableSetColumnEnabled", ImGui_Context ctx, int column_n, bool v) |
|---|
| Lua | reaper.ImGui_TableSetColumnEnabled(ImGui_Context ctx, number column_n, boolean v) |
|---|
| Python | ImGui_TableSetColumnEnabled(ImGui_Context ctx, int column_n, bool v) |
|---|
Change user-accessible enabled/disabled state of a column, set to false to
hide the column. Note that end-user can use the context menu to change this
themselves (right-click in headers, or right-click in columns body with
TableFlags_ContextMenuInBody).
View source
Function: TableSetupColumn
| C++ | void ImGui_TableSetupColumn(ImGui_Context* ctx, const char* label, int* flagsInOptional = TableColumnFlags_None, double* init_width_or_weightInOptional = 0.0, int* user_idInOptional = 0) |
|---|
| EEL | ImGui_TableSetupColumn(ImGui_Context ctx, "label", int flags = TableColumnFlags_None, init_width_or_weight = 0.0, int user_id = 0) |
|---|
| Legacy EEL | extension_api("ImGui_TableSetupColumn", ImGui_Context ctx, "label", int flags = TableColumnFlags_None, init_width_or_weight = 0.0, int user_id = 0) |
|---|
| Lua | reaper.ImGui_TableSetupColumn(ImGui_Context ctx, string label, number flags = TableColumnFlags_None, number init_width_or_weight = 0.0, number user_id = 0) |
|---|
| Python | ImGui_TableSetupColumn(ImGui_Context ctx, str label, int flags = TableColumnFlags_None, float init_width_or_weight = 0.0, int user_id = 0) |
|---|
Use to specify label, resizing policy, default width/weight, id,
various other flags etc.
View source
Function: TableSetupScrollFreeze
| C++ | void ImGui_TableSetupScrollFreeze(ImGui_Context* ctx, int cols, int rows) |
|---|
| EEL | ImGui_TableSetupScrollFreeze(ImGui_Context ctx, int cols, int rows) |
|---|
| Legacy EEL | extension_api("ImGui_TableSetupScrollFreeze", ImGui_Context ctx, int cols, int rows) |
|---|
| Lua | reaper.ImGui_TableSetupScrollFreeze(ImGui_Context ctx, number cols, number rows) |
|---|
| Python | ImGui_TableSetupScrollFreeze(ImGui_Context ctx, int cols, int rows) |
|---|
Lock columns/rows so they stay visible when scrolled.
View source
Column Flags
For TableSetupColumn.
Constant: TableColumnFlags_None
| C++ | int ImGui_TableColumnFlags_None |
|---|
| EEL | int ImGui_TableColumnFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_None() |
|---|
| Python | int retval = ImGui_TableColumnFlags_None() |
|---|
View source
Constant: TableColumnFlags_DefaultHide
| C++ | int ImGui_TableColumnFlags_DefaultHide |
|---|
| EEL | int ImGui_TableColumnFlags_DefaultHide() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_DefaultHide") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_DefaultHide() |
|---|
| Python | int retval = ImGui_TableColumnFlags_DefaultHide() |
|---|
Default as a hidden/disabled column.
View source
Constant: TableColumnFlags_DefaultSort
| C++ | int ImGui_TableColumnFlags_DefaultSort |
|---|
| EEL | int ImGui_TableColumnFlags_DefaultSort() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_DefaultSort") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_DefaultSort() |
|---|
| Python | int retval = ImGui_TableColumnFlags_DefaultSort() |
|---|
Default as a sorting column.
View source
Constant: TableColumnFlags_Disabled
| C++ | int ImGui_TableColumnFlags_Disabled |
|---|
| EEL | int ImGui_TableColumnFlags_Disabled() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_Disabled") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_Disabled() |
|---|
| Python | int retval = ImGui_TableColumnFlags_Disabled() |
|---|
Overriding/master disable flag: hide column, won't show in context menu
(unlike calling TableSetColumnEnabled which manipulates the user accessible state).
View source
Constant: TableColumnFlags_IndentDisable
| C++ | int ImGui_TableColumnFlags_IndentDisable |
|---|
| EEL | int ImGui_TableColumnFlags_IndentDisable() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_IndentDisable") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_IndentDisable() |
|---|
| Python | int retval = ImGui_TableColumnFlags_IndentDisable() |
|---|
Ignore current Indent value when entering cell (default for columns > 0).
Indentation changes within the cell will still be honored.
View source
Constant: TableColumnFlags_IndentEnable
| C++ | int ImGui_TableColumnFlags_IndentEnable |
|---|
| EEL | int ImGui_TableColumnFlags_IndentEnable() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_IndentEnable") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_IndentEnable() |
|---|
| Python | int retval = ImGui_TableColumnFlags_IndentEnable() |
|---|
Use current Indent value when entering cell (default for column 0).
View source
Constant: TableColumnFlags_NoClip
| C++ | int ImGui_TableColumnFlags_NoClip |
|---|
| EEL | int ImGui_TableColumnFlags_NoClip() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_NoClip") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_NoClip() |
|---|
| Python | int retval = ImGui_TableColumnFlags_NoClip() |
|---|
Disable clipping for this column
(all NoClip columns will render in a same draw command).
View source
Constant: TableColumnFlags_NoHeaderLabel
| C++ | int ImGui_TableColumnFlags_NoHeaderLabel |
|---|
| EEL | int ImGui_TableColumnFlags_NoHeaderLabel() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_NoHeaderLabel") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_NoHeaderLabel() |
|---|
| Python | int retval = ImGui_TableColumnFlags_NoHeaderLabel() |
|---|
TableHeadersRow will not submit label for this column.
Convenient for some small columns. Name will still appear in context menu.
View source
Constant: TableColumnFlags_NoHeaderWidth
| C++ | int ImGui_TableColumnFlags_NoHeaderWidth |
|---|
| EEL | int ImGui_TableColumnFlags_NoHeaderWidth() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_NoHeaderWidth") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_NoHeaderWidth() |
|---|
| Python | int retval = ImGui_TableColumnFlags_NoHeaderWidth() |
|---|
Disable header text width contribution to automatic column width.
View source
Constant: TableColumnFlags_NoHide
| C++ | int ImGui_TableColumnFlags_NoHide |
|---|
| EEL | int ImGui_TableColumnFlags_NoHide() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_NoHide") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_NoHide() |
|---|
| Python | int retval = ImGui_TableColumnFlags_NoHide() |
|---|
Disable ability to hide/disable this column.
View source
Constant: TableColumnFlags_NoReorder
| C++ | int ImGui_TableColumnFlags_NoReorder |
|---|
| EEL | int ImGui_TableColumnFlags_NoReorder() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_NoReorder") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_NoReorder() |
|---|
| Python | int retval = ImGui_TableColumnFlags_NoReorder() |
|---|
Disable manual reordering this column, this will also prevent other columns
from crossing over this column.
View source
Constant: TableColumnFlags_NoResize
| C++ | int ImGui_TableColumnFlags_NoResize |
|---|
| EEL | int ImGui_TableColumnFlags_NoResize() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_NoResize") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_NoResize() |
|---|
| Python | int retval = ImGui_TableColumnFlags_NoResize() |
|---|
Disable manual resizing.
View source
Constant: TableColumnFlags_NoSort
| C++ | int ImGui_TableColumnFlags_NoSort |
|---|
| EEL | int ImGui_TableColumnFlags_NoSort() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_NoSort") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_NoSort() |
|---|
| Python | int retval = ImGui_TableColumnFlags_NoSort() |
|---|
Disable ability to sort on this field
(even if TableFlags_Sortable is set on the table).
View source
Constant: TableColumnFlags_NoSortAscending
| C++ | int ImGui_TableColumnFlags_NoSortAscending |
|---|
| EEL | int ImGui_TableColumnFlags_NoSortAscending() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_NoSortAscending") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_NoSortAscending() |
|---|
| Python | int retval = ImGui_TableColumnFlags_NoSortAscending() |
|---|
Disable ability to sort in the ascending direction.
View source
Constant: TableColumnFlags_NoSortDescending
| C++ | int ImGui_TableColumnFlags_NoSortDescending |
|---|
| EEL | int ImGui_TableColumnFlags_NoSortDescending() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_NoSortDescending") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_NoSortDescending() |
|---|
| Python | int retval = ImGui_TableColumnFlags_NoSortDescending() |
|---|
Disable ability to sort in the descending direction.
View source
Constant: TableColumnFlags_PreferSortAscending
| C++ | int ImGui_TableColumnFlags_PreferSortAscending |
|---|
| EEL | int ImGui_TableColumnFlags_PreferSortAscending() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_PreferSortAscending") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_PreferSortAscending() |
|---|
| Python | int retval = ImGui_TableColumnFlags_PreferSortAscending() |
|---|
Make the initial sort direction Ascending when first sorting on this column (default).
View source
Constant: TableColumnFlags_PreferSortDescending
| C++ | int ImGui_TableColumnFlags_PreferSortDescending |
|---|
| EEL | int ImGui_TableColumnFlags_PreferSortDescending() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_PreferSortDescending") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_PreferSortDescending() |
|---|
| Python | int retval = ImGui_TableColumnFlags_PreferSortDescending() |
|---|
Make the initial sort direction Descending when first sorting on this column.
View source
Constant: TableColumnFlags_WidthFixed
| C++ | int ImGui_TableColumnFlags_WidthFixed |
|---|
| EEL | int ImGui_TableColumnFlags_WidthFixed() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_WidthFixed") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_WidthFixed() |
|---|
| Python | int retval = ImGui_TableColumnFlags_WidthFixed() |
|---|
Column will not stretch. Preferable with horizontal scrolling enabled
(default if table sizing policy is _SizingFixedFit and table is resizable).
View source
Constant: TableColumnFlags_WidthStretch
| C++ | int ImGui_TableColumnFlags_WidthStretch |
|---|
| EEL | int ImGui_TableColumnFlags_WidthStretch() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_WidthStretch") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_WidthStretch() |
|---|
| Python | int retval = ImGui_TableColumnFlags_WidthStretch() |
|---|
Column will stretch. Preferable with horizontal scrolling disabled
(default if table sizing policy is _SizingStretchSame or _SizingStretchProp).
View source
Output status
Read-only via TableGetColumnFlags
Constant: TableColumnFlags_IsEnabled
| C++ | int ImGui_TableColumnFlags_IsEnabled |
|---|
| EEL | int ImGui_TableColumnFlags_IsEnabled() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_IsEnabled") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_IsEnabled() |
|---|
| Python | int retval = ImGui_TableColumnFlags_IsEnabled() |
|---|
Status: is enabled == not hidden by user/api (referred to as "Hide" in
_DefaultHide and _NoHide) flags.
View source
Constant: TableColumnFlags_IsHovered
| C++ | int ImGui_TableColumnFlags_IsHovered |
|---|
| EEL | int ImGui_TableColumnFlags_IsHovered() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_IsHovered") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_IsHovered() |
|---|
| Python | int retval = ImGui_TableColumnFlags_IsHovered() |
|---|
Status: is hovered by mouse.
View source
Constant: TableColumnFlags_IsSorted
| C++ | int ImGui_TableColumnFlags_IsSorted |
|---|
| EEL | int ImGui_TableColumnFlags_IsSorted() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_IsSorted") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_IsSorted() |
|---|
| Python | int retval = ImGui_TableColumnFlags_IsSorted() |
|---|
Status: is currently part of the sort specs.
View source
Constant: TableColumnFlags_IsVisible
| C++ | int ImGui_TableColumnFlags_IsVisible |
|---|
| EEL | int ImGui_TableColumnFlags_IsVisible() |
|---|
| Legacy EEL | int extension_api("ImGui_TableColumnFlags_IsVisible") |
|---|
| Lua | number retval = reaper.ImGui_TableColumnFlags_IsVisible() |
|---|
| Python | int retval = ImGui_TableColumnFlags_IsVisible() |
|---|
Status: is visible == is enabled AND not clipped by scrolling.
View source
Sorting
Constant: SortDirection_Ascending
| C++ | int ImGui_SortDirection_Ascending |
|---|
| EEL | int ImGui_SortDirection_Ascending() |
|---|
| Legacy EEL | int extension_api("ImGui_SortDirection_Ascending") |
|---|
| Lua | number retval = reaper.ImGui_SortDirection_Ascending() |
|---|
| Python | int retval = ImGui_SortDirection_Ascending() |
|---|
Ascending = 0->9, A->Z etc.
View source
Constant: SortDirection_Descending
| C++ | int ImGui_SortDirection_Descending |
|---|
| EEL | int ImGui_SortDirection_Descending() |
|---|
| Legacy EEL | int extension_api("ImGui_SortDirection_Descending") |
|---|
| Lua | number retval = reaper.ImGui_SortDirection_Descending() |
|---|
| Python | int retval = ImGui_SortDirection_Descending() |
|---|
Descending = 9->0, Z->A etc.
View source
Constant: SortDirection_None
| C++ | int ImGui_SortDirection_None |
|---|
| EEL | int ImGui_SortDirection_None() |
|---|
| Legacy EEL | int extension_api("ImGui_SortDirection_None") |
|---|
| Lua | number retval = reaper.ImGui_SortDirection_None() |
|---|
| Python | int retval = ImGui_SortDirection_None() |
|---|
View source
Function: TableGetColumnSortSpecs
| C++ | bool ImGui_TableGetColumnSortSpecs(ImGui_Context* ctx, int id, int* column_user_idOut, int* column_indexOut, int* sort_orderOut, int* sort_directionOut) |
|---|
| EEL | bool ImGui_TableGetColumnSortSpecs(ImGui_Context ctx, int id, int &column_user_id, int &column_index, int &sort_order, int &sort_direction) |
|---|
| Legacy EEL | bool extension_api("ImGui_TableGetColumnSortSpecs", ImGui_Context ctx, int id, int &column_user_id, int &column_index, int &sort_order, int &sort_direction) |
|---|
| Lua | boolean retval, number column_user_id, number column_index, number sort_order, number sort_direction = reaper.ImGui_TableGetColumnSortSpecs(ImGui_Context ctx, number id) |
|---|
| Python | (bool retval, int column_user_id, int column_index, int sort_order, int sort_direction) = ImGui_TableGetColumnSortSpecs(ImGui_Context ctx, int id) |
|---|
Sorting specification for one column of a table.
Call while incrementing 'id' from 0 until false is returned.
- ColumnUserID: User id of the column (if specified by a TableSetupColumn call)
- ColumnIndex: Index of the column
- SortOrder: Index within parent SortSpecs (always stored in order starting
from 0, tables sorted on a single criteria will always have a 0 here)
- SortDirection: SortDirection_Ascending or SortDirection_Descending
(you can use this or SortSign, whichever is more convenient for your sort
function)
See TableNeedSort.
View source
Function: TableNeedSort
| C++ | bool ImGui_TableNeedSort(ImGui_Context* ctx, bool* has_specsOut) |
|---|
| EEL | bool ImGui_TableNeedSort(ImGui_Context ctx, bool &has_specs) |
|---|
| Legacy EEL | bool extension_api("ImGui_TableNeedSort", ImGui_Context ctx, bool &has_specs) |
|---|
| Lua | boolean retval, boolean has_specs = reaper.ImGui_TableNeedSort(ImGui_Context ctx) |
|---|
| Python | (bool retval, bool has_specs) = ImGui_TableNeedSort(ImGui_Context ctx) |
|---|
Return true once when sorting specs have changed since last call,
or the first time. 'has_specs' is false when not sorting.
See TableGetColumnSortSpecs.
View source
Table Flags
For BeginTable.
- Important! Sizing policies have complex and subtle side effects,
more so than you would expect. Read comments/demos carefully +
experiment with live demos to get acquainted with them.
- The DEFAULT sizing policies are:
- When ScrollX is off:
- Table defaults to TableFlags_SizingStretchSame ->
all Columns defaults to TableColumnFlags_WidthStretch with same weight.
- Columns sizing policy allowed: Stretch (default), Fixed/Auto.
- Fixed Columns will generally obtain their requested width
(unless the table cannot fit them all).
- Stretch Columns will share the remaining width.
- Mixed Fixed/Stretch columns is possible but has various side-effects on
resizing behaviors.
The typical use of mixing sizing policies is: any number of LEADING Fixed
columns, followed by one or two TRAILING Stretch columns.
(this is because the visible order of columns have subtle but necessary
effects on how they react to manual resizing).
- When ScrollX is on:
- Table defaults to TableFlags_SizingFixedFit ->
all Columns defaults to TableColumnFlags_WidthFixed
- Columns sizing policy allowed: Fixed/Auto mostly.
- Fixed Columns can be enlarged as needed.
Table will show a horizontal scrollbar if needed.
- When using auto-resizing (non-resizable) fixed columns,
querying the content width to use item right-alignment e.g.
SetNextItemWidth(-FLT_MIN) doesn't make sense, would create a feedback loop.
- Using Stretch columns OFTEN DOES NOT MAKE SENSE if ScrollX is on,
UNLESS you have specified a value for 'inner_width' in BeginTable().
If you specify a value for 'inner_width' then effectively the scrolling
space is known and Stretch or mixed Fixed/Stretch columns become meaningful
again.
- Read on documentation at the top of imgui_tables.cpp for details.
Constant: TableFlags_None
| C++ | int ImGui_TableFlags_None |
|---|
| EEL | int ImGui_TableFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_None() |
|---|
| Python | int retval = ImGui_TableFlags_None() |
|---|
View source
Clipping
Constant: TableFlags_NoClip
| C++ | int ImGui_TableFlags_NoClip |
|---|
| EEL | int ImGui_TableFlags_NoClip() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_NoClip") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_NoClip() |
|---|
| Python | int retval = ImGui_TableFlags_NoClip() |
|---|
Disable clipping rectangle for every individual columns
(reduce draw command count, items will be able to overflow into other columns).
Generally incompatible with TableSetupScrollFreeze.
View source
Decorations
Constant: TableFlags_Borders
| C++ | int ImGui_TableFlags_Borders |
|---|
| EEL | int ImGui_TableFlags_Borders() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_Borders") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_Borders() |
|---|
| Python | int retval = ImGui_TableFlags_Borders() |
|---|
Draw all borders.
View source
Constant: TableFlags_BordersH
| C++ | int ImGui_TableFlags_BordersH |
|---|
| EEL | int ImGui_TableFlags_BordersH() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_BordersH") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_BordersH() |
|---|
| Python | int retval = ImGui_TableFlags_BordersH() |
|---|
Draw horizontal borders.
View source
Constant: TableFlags_BordersInner
| C++ | int ImGui_TableFlags_BordersInner |
|---|
| EEL | int ImGui_TableFlags_BordersInner() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_BordersInner") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_BordersInner() |
|---|
| Python | int retval = ImGui_TableFlags_BordersInner() |
|---|
Draw inner borders.
View source
Constant: TableFlags_BordersInnerH
| C++ | int ImGui_TableFlags_BordersInnerH |
|---|
| EEL | int ImGui_TableFlags_BordersInnerH() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_BordersInnerH") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_BordersInnerH() |
|---|
| Python | int retval = ImGui_TableFlags_BordersInnerH() |
|---|
Draw horizontal borders between rows.
View source
Constant: TableFlags_BordersInnerV
| C++ | int ImGui_TableFlags_BordersInnerV |
|---|
| EEL | int ImGui_TableFlags_BordersInnerV() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_BordersInnerV") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_BordersInnerV() |
|---|
| Python | int retval = ImGui_TableFlags_BordersInnerV() |
|---|
Draw vertical borders between columns.
View source
Constant: TableFlags_BordersOuter
| C++ | int ImGui_TableFlags_BordersOuter |
|---|
| EEL | int ImGui_TableFlags_BordersOuter() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_BordersOuter") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_BordersOuter() |
|---|
| Python | int retval = ImGui_TableFlags_BordersOuter() |
|---|
Draw outer borders.
View source
Constant: TableFlags_BordersOuterH
| C++ | int ImGui_TableFlags_BordersOuterH |
|---|
| EEL | int ImGui_TableFlags_BordersOuterH() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_BordersOuterH") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_BordersOuterH() |
|---|
| Python | int retval = ImGui_TableFlags_BordersOuterH() |
|---|
Draw horizontal borders at the top and bottom.
View source
Constant: TableFlags_BordersOuterV
| C++ | int ImGui_TableFlags_BordersOuterV |
|---|
| EEL | int ImGui_TableFlags_BordersOuterV() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_BordersOuterV") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_BordersOuterV() |
|---|
| Python | int retval = ImGui_TableFlags_BordersOuterV() |
|---|
Draw vertical borders on the left and right sides.
View source
Constant: TableFlags_BordersV
| C++ | int ImGui_TableFlags_BordersV |
|---|
| EEL | int ImGui_TableFlags_BordersV() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_BordersV") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_BordersV() |
|---|
| Python | int retval = ImGui_TableFlags_BordersV() |
|---|
Draw vertical borders.
View source
Constant: TableFlags_RowBg
| C++ | int ImGui_TableFlags_RowBg |
|---|
| EEL | int ImGui_TableFlags_RowBg() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_RowBg") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_RowBg() |
|---|
| Python | int retval = ImGui_TableFlags_RowBg() |
|---|
Set each RowBg color with Col_TableRowBg or Col_TableRowBgAlt (equivalent of
calling TableSetBgColor with TableBgTarget_RowBg0 on each row manually).
View source
Features
Constant: TableFlags_ContextMenuInBody
| C++ | int ImGui_TableFlags_ContextMenuInBody |
|---|
| EEL | int ImGui_TableFlags_ContextMenuInBody() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_ContextMenuInBody") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_ContextMenuInBody() |
|---|
| Python | int retval = ImGui_TableFlags_ContextMenuInBody() |
|---|
Right-click on columns body/contents will display table context menu.
By default it is available in TableHeadersRow.
View source
Constant: TableFlags_Hideable
| C++ | int ImGui_TableFlags_Hideable |
|---|
| EEL | int ImGui_TableFlags_Hideable() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_Hideable") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_Hideable() |
|---|
| Python | int retval = ImGui_TableFlags_Hideable() |
|---|
Enable hiding/disabling columns in context menu.
View source
Constant: TableFlags_NoSavedSettings
| C++ | int ImGui_TableFlags_NoSavedSettings |
|---|
| EEL | int ImGui_TableFlags_NoSavedSettings() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_NoSavedSettings") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_NoSavedSettings() |
|---|
| Python | int retval = ImGui_TableFlags_NoSavedSettings() |
|---|
Disable persisting columns order, width and sort settings in the .ini file.
View source
Constant: TableFlags_Reorderable
| C++ | int ImGui_TableFlags_Reorderable |
|---|
| EEL | int ImGui_TableFlags_Reorderable() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_Reorderable") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_Reorderable() |
|---|
| Python | int retval = ImGui_TableFlags_Reorderable() |
|---|
Enable reordering columns in header row
(need calling TableSetupColumn + TableHeadersRow to display headers).
View source
Constant: TableFlags_Resizable
| C++ | int ImGui_TableFlags_Resizable |
|---|
| EEL | int ImGui_TableFlags_Resizable() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_Resizable") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_Resizable() |
|---|
| Python | int retval = ImGui_TableFlags_Resizable() |
|---|
Enable resizing columns.
View source
Constant: TableFlags_Sortable
| C++ | int ImGui_TableFlags_Sortable |
|---|
| EEL | int ImGui_TableFlags_Sortable() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_Sortable") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_Sortable() |
|---|
| Python | int retval = ImGui_TableFlags_Sortable() |
|---|
Enable sorting. Call TableNeedSort/TableGetColumnSortSpecs to obtain sort specs.
Also see TableFlags_SortMulti and TableFlags_SortTristate.
View source
Padding
Constant: TableFlags_NoPadInnerX
| C++ | int ImGui_TableFlags_NoPadInnerX |
|---|
| EEL | int ImGui_TableFlags_NoPadInnerX() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_NoPadInnerX") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_NoPadInnerX() |
|---|
| Python | int retval = ImGui_TableFlags_NoPadInnerX() |
|---|
Disable inner padding between columns (double inner padding if
TableFlags_BordersOuterV is on, single inner padding if BordersOuterV is off).
View source
Constant: TableFlags_NoPadOuterX
| C++ | int ImGui_TableFlags_NoPadOuterX |
|---|
| EEL | int ImGui_TableFlags_NoPadOuterX() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_NoPadOuterX") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_NoPadOuterX() |
|---|
| Python | int retval = ImGui_TableFlags_NoPadOuterX() |
|---|
Default if TableFlags_BordersOuterV is off. Disable outermost padding.
View source
Constant: TableFlags_PadOuterX
| C++ | int ImGui_TableFlags_PadOuterX |
|---|
| EEL | int ImGui_TableFlags_PadOuterX() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_PadOuterX") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_PadOuterX() |
|---|
| Python | int retval = ImGui_TableFlags_PadOuterX() |
|---|
Default if TableFlags_BordersOuterV is on. Enable outermost padding.
Generally desirable if you have headers.
View source
Constant: TableFlags_ScrollX
| C++ | int ImGui_TableFlags_ScrollX |
|---|
| EEL | int ImGui_TableFlags_ScrollX() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_ScrollX") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_ScrollX() |
|---|
| Python | int retval = ImGui_TableFlags_ScrollX() |
|---|
Enable horizontal scrolling. Require 'outer_size' parameter of BeginTable to
specify the container size. Changes default sizing policy.
Because this creates a child window, ScrollY is currently generally
recommended when using ScrollX.
View source
Constant: TableFlags_ScrollY
| C++ | int ImGui_TableFlags_ScrollY |
|---|
| EEL | int ImGui_TableFlags_ScrollY() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_ScrollY") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_ScrollY() |
|---|
| Python | int retval = ImGui_TableFlags_ScrollY() |
|---|
Enable vertical scrolling.
Require 'outer_size' parameter of BeginTable to specify the container size.
View source
Constant: TableFlags_NoHostExtendX
| C++ | int ImGui_TableFlags_NoHostExtendX |
|---|
| EEL | int ImGui_TableFlags_NoHostExtendX() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_NoHostExtendX") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_NoHostExtendX() |
|---|
| Python | int retval = ImGui_TableFlags_NoHostExtendX() |
|---|
Make outer width auto-fit to columns, overriding outer_size.x value. Only
available when ScrollX/ScrollY are disabled and Stretch columns are not used.
View source
Constant: TableFlags_NoHostExtendY
| C++ | int ImGui_TableFlags_NoHostExtendY |
|---|
| EEL | int ImGui_TableFlags_NoHostExtendY() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_NoHostExtendY") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_NoHostExtendY() |
|---|
| Python | int retval = ImGui_TableFlags_NoHostExtendY() |
|---|
Make outer height stop exactly at outer_size.y (prevent auto-extending table
past the limit). Only available when ScrollX/ScrollY are disabled.
Data below the limit will be clipped and not visible.
View source
Constant: TableFlags_NoKeepColumnsVisible
| C++ | int ImGui_TableFlags_NoKeepColumnsVisible |
|---|
| EEL | int ImGui_TableFlags_NoKeepColumnsVisible() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_NoKeepColumnsVisible") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_NoKeepColumnsVisible() |
|---|
| Python | int retval = ImGui_TableFlags_NoKeepColumnsVisible() |
|---|
Disable keeping column always minimally visible when ScrollX is off and table
gets too small. Not recommended if columns are resizable.
View source
Constant: TableFlags_PreciseWidths
| C++ | int ImGui_TableFlags_PreciseWidths |
|---|
| EEL | int ImGui_TableFlags_PreciseWidths() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_PreciseWidths") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_PreciseWidths() |
|---|
| Python | int retval = ImGui_TableFlags_PreciseWidths() |
|---|
Disable distributing remainder width to stretched columns (width allocation
on a 100-wide table with 3 columns: Without this flag: 33,33,34. With this
flag: 33,33,33).
With larger number of columns, resizing will appear to be less smooth.
View source
Sizing Policy
(read above for defaults)
Constant: TableFlags_SizingFixedFit
| C++ | int ImGui_TableFlags_SizingFixedFit |
|---|
| EEL | int ImGui_TableFlags_SizingFixedFit() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_SizingFixedFit") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_SizingFixedFit() |
|---|
| Python | int retval = ImGui_TableFlags_SizingFixedFit() |
|---|
Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable),
matching contents width.
View source
Constant: TableFlags_SizingFixedSame
| C++ | int ImGui_TableFlags_SizingFixedSame |
|---|
| EEL | int ImGui_TableFlags_SizingFixedSame() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_SizingFixedSame") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_SizingFixedSame() |
|---|
| Python | int retval = ImGui_TableFlags_SizingFixedSame() |
|---|
Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable),
matching the maximum contents width of all columns.
Implicitly enable TableFlags_NoKeepColumnsVisible.
View source
Constant: TableFlags_SizingStretchProp
| C++ | int ImGui_TableFlags_SizingStretchProp |
|---|
| EEL | int ImGui_TableFlags_SizingStretchProp() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_SizingStretchProp") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_SizingStretchProp() |
|---|
| Python | int retval = ImGui_TableFlags_SizingStretchProp() |
|---|
Columns default to _WidthStretch with default weights proportional to each
columns contents widths.
View source
Constant: TableFlags_SizingStretchSame
| C++ | int ImGui_TableFlags_SizingStretchSame |
|---|
| EEL | int ImGui_TableFlags_SizingStretchSame() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_SizingStretchSame") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_SizingStretchSame() |
|---|
| Python | int retval = ImGui_TableFlags_SizingStretchSame() |
|---|
Columns default to _WidthStretch with default weights all equal,
unless overriden by TableSetupColumn.
View source
Sorting
Constant: TableFlags_SortMulti
| C++ | int ImGui_TableFlags_SortMulti |
|---|
| EEL | int ImGui_TableFlags_SortMulti() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_SortMulti") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_SortMulti() |
|---|
| Python | int retval = ImGui_TableFlags_SortMulti() |
|---|
Hold shift when clicking headers to sort on multiple column.
TableGetGetSortSpecs may return specs where (SpecsCount > 1).
View source
Constant: TableFlags_SortTristate
| C++ | int ImGui_TableFlags_SortTristate |
|---|
| EEL | int ImGui_TableFlags_SortTristate() |
|---|
| Legacy EEL | int extension_api("ImGui_TableFlags_SortTristate") |
|---|
| Lua | number retval = reaper.ImGui_TableFlags_SortTristate() |
|---|
| Python | int retval = ImGui_TableFlags_SortTristate() |
|---|
Allow no sorting, disable default sorting.
TableGetColumnSortSpecs may return specs where (SpecsCount == 0).
View source
Text
Function: AlignTextToFramePadding
| C++ | void ImGui_AlignTextToFramePadding(ImGui_Context* ctx) |
|---|
| EEL | ImGui_AlignTextToFramePadding(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_AlignTextToFramePadding", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_AlignTextToFramePadding(ImGui_Context ctx) |
|---|
| Python | ImGui_AlignTextToFramePadding(ImGui_Context ctx) |
|---|
Vertically align upcoming text baseline to StyleVar_FramePadding.y so that it
will align properly to regularly framed items (call if you have text on a line
before a framed item).
View source
Function: Bullet
| C++ | void ImGui_Bullet(ImGui_Context* ctx) |
|---|
| EEL | ImGui_Bullet(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_Bullet", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_Bullet(ImGui_Context ctx) |
|---|
| Python | ImGui_Bullet(ImGui_Context ctx) |
|---|
Draw a small circle + keep the cursor on the same line.
Advance cursor x position by GetTreeNodeToLabelSpacing,
same distance that TreeNode uses.
View source
Function: BulletText
| C++ | void ImGui_BulletText(ImGui_Context* ctx, const char* text) |
|---|
| EEL | ImGui_BulletText(ImGui_Context ctx, "text") |
|---|
| Legacy EEL | extension_api("ImGui_BulletText", ImGui_Context ctx, "text") |
|---|
| Lua | reaper.ImGui_BulletText(ImGui_Context ctx, string text) |
|---|
| Python | ImGui_BulletText(ImGui_Context ctx, str text) |
|---|
Shortcut for Bullet + Text.
View source
Function: CalcTextSize
| C++ | void ImGui_CalcTextSize(ImGui_Context* ctx, const char* text, double* wOut, double* hOut, bool* hide_text_after_double_hashInOptional = false, double* wrap_widthInOptional = -1.0) |
|---|
| EEL | ImGui_CalcTextSize(ImGui_Context ctx, "text", &w, &h, bool hide_text_after_double_hash = false, wrap_width = -1.0) |
|---|
| Legacy EEL | extension_api("ImGui_CalcTextSize", ImGui_Context ctx, "text", &w, &h, bool hide_text_after_double_hash = false, wrap_width = -1.0) |
|---|
| Lua | number w, number h = reaper.ImGui_CalcTextSize(ImGui_Context ctx, string text, nil, nil, boolean hide_text_after_double_hash = false, number wrap_width = -1.0) |
|---|
| Python | (float w, float h) = ImGui_CalcTextSize(ImGui_Context ctx, str text, bool hide_text_after_double_hash = false, float wrap_width = -1.0) |
|---|
View source
Function: DebugTextEncoding
| C++ | void ImGui_DebugTextEncoding(ImGui_Context* ctx, const char* text) |
|---|
| EEL | ImGui_DebugTextEncoding(ImGui_Context ctx, "text") |
|---|
| Legacy EEL | extension_api("ImGui_DebugTextEncoding", ImGui_Context ctx, "text") |
|---|
| Lua | reaper.ImGui_DebugTextEncoding(ImGui_Context ctx, string text) |
|---|
| Python | ImGui_DebugTextEncoding(ImGui_Context ctx, str text) |
|---|
Helper tool to diagnose between text encoding issues and font loading issues.
Pass your UTF-8 string and verify that there are correct.
View source
Function: GetFrameHeight
| C++ | double ImGui_GetFrameHeight(ImGui_Context* ctx) |
|---|
| EEL | double ImGui_GetFrameHeight(ImGui_Context ctx) |
|---|
| Legacy EEL | double extension_api("ImGui_GetFrameHeight", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetFrameHeight(ImGui_Context ctx) |
|---|
| Python | float retval = ImGui_GetFrameHeight(ImGui_Context ctx) |
|---|
GetFontSize + StyleVar_FramePadding.y * 2
View source
Function: GetFrameHeightWithSpacing
| C++ | double ImGui_GetFrameHeightWithSpacing(ImGui_Context* ctx) |
|---|
| EEL | double ImGui_GetFrameHeightWithSpacing(ImGui_Context ctx) |
|---|
| Legacy EEL | double extension_api("ImGui_GetFrameHeightWithSpacing", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetFrameHeightWithSpacing(ImGui_Context ctx) |
|---|
| Python | float retval = ImGui_GetFrameHeightWithSpacing(ImGui_Context ctx) |
|---|
GetFontSize + StyleVar_FramePadding.y * 2 + StyleVar_ItemSpacing.y
(distance in pixels between 2 consecutive lines of framed widgets).
View source
Function: GetTextLineHeight
| C++ | double ImGui_GetTextLineHeight(ImGui_Context* ctx) |
|---|
| EEL | double ImGui_GetTextLineHeight(ImGui_Context ctx) |
|---|
| Legacy EEL | double extension_api("ImGui_GetTextLineHeight", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetTextLineHeight(ImGui_Context ctx) |
|---|
| Python | float retval = ImGui_GetTextLineHeight(ImGui_Context ctx) |
|---|
Same as GetFontSize
View source
Function: GetTextLineHeightWithSpacing
| C++ | double ImGui_GetTextLineHeightWithSpacing(ImGui_Context* ctx) |
|---|
| EEL | double ImGui_GetTextLineHeightWithSpacing(ImGui_Context ctx) |
|---|
| Legacy EEL | double extension_api("ImGui_GetTextLineHeightWithSpacing", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetTextLineHeightWithSpacing(ImGui_Context ctx) |
|---|
| Python | float retval = ImGui_GetTextLineHeightWithSpacing(ImGui_Context ctx) |
|---|
GetFontSize + StyleVar_ItemSpacing.y
(distance in pixels between 2 consecutive lines of text).
View source
Function: LabelText
| C++ | void ImGui_LabelText(ImGui_Context* ctx, const char* label, const char* text) |
|---|
| EEL | ImGui_LabelText(ImGui_Context ctx, "label", "text") |
|---|
| Legacy EEL | extension_api("ImGui_LabelText", ImGui_Context ctx, "label", "text") |
|---|
| Lua | reaper.ImGui_LabelText(ImGui_Context ctx, string label, string text) |
|---|
| Python | ImGui_LabelText(ImGui_Context ctx, str label, str text) |
|---|
Display text+label aligned the same way as value+label widgets
View source
Function: PopTextWrapPos
| C++ | void ImGui_PopTextWrapPos(ImGui_Context* ctx) |
|---|
| EEL | ImGui_PopTextWrapPos(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_PopTextWrapPos", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_PopTextWrapPos(ImGui_Context ctx) |
|---|
| Python | ImGui_PopTextWrapPos(ImGui_Context ctx) |
|---|
View source
Function: PushTextWrapPos
| C++ | void ImGui_PushTextWrapPos(ImGui_Context* ctx, double* wrap_local_pos_xInOptional = 0.0) |
|---|
| EEL | ImGui_PushTextWrapPos(ImGui_Context ctx, wrap_local_pos_x = 0.0) |
|---|
| Legacy EEL | extension_api("ImGui_PushTextWrapPos", ImGui_Context ctx, wrap_local_pos_x = 0.0) |
|---|
| Lua | reaper.ImGui_PushTextWrapPos(ImGui_Context ctx, number wrap_local_pos_x = 0.0) |
|---|
| Python | ImGui_PushTextWrapPos(ImGui_Context ctx, float wrap_local_pos_x = 0.0) |
|---|
Push word-wrapping position for Text*() commands.
- < 0.0: no wrapping
- = 0.0: wrap to end of window (or column)
- > 0.0: wrap at 'wrap_pos_x' position in window local space.
View source
Function: Text
| C++ | void ImGui_Text(ImGui_Context* ctx, const char* text) |
|---|
| EEL | ImGui_Text(ImGui_Context ctx, "text") |
|---|
| Legacy EEL | extension_api("ImGui_Text", ImGui_Context ctx, "text") |
|---|
| Lua | reaper.ImGui_Text(ImGui_Context ctx, string text) |
|---|
| Python | ImGui_Text(ImGui_Context ctx, str text) |
|---|
View source
Function: TextColored
| C++ | void ImGui_TextColored(ImGui_Context* ctx, int col_rgba, const char* text) |
|---|
| EEL | ImGui_TextColored(ImGui_Context ctx, int col_rgba, "text") |
|---|
| Legacy EEL | extension_api("ImGui_TextColored", ImGui_Context ctx, int col_rgba, "text") |
|---|
| Lua | reaper.ImGui_TextColored(ImGui_Context ctx, number col_rgba, string text) |
|---|
| Python | ImGui_TextColored(ImGui_Context ctx, int col_rgba, str text) |
|---|
Shortcut for PushStyleColor(Col_Text, color); Text(text); PopStyleColor();
View source
Function: TextDisabled
| C++ | void ImGui_TextDisabled(ImGui_Context* ctx, const char* text) |
|---|
| EEL | ImGui_TextDisabled(ImGui_Context ctx, "text") |
|---|
| Legacy EEL | extension_api("ImGui_TextDisabled", ImGui_Context ctx, "text") |
|---|
| Lua | reaper.ImGui_TextDisabled(ImGui_Context ctx, string text) |
|---|
| Python | ImGui_TextDisabled(ImGui_Context ctx, str text) |
|---|
View source
Function: TextWrapped
| C++ | void ImGui_TextWrapped(ImGui_Context* ctx, const char* text) |
|---|
| EEL | ImGui_TextWrapped(ImGui_Context ctx, "text") |
|---|
| Legacy EEL | extension_api("ImGui_TextWrapped", ImGui_Context ctx, "text") |
|---|
| Lua | reaper.ImGui_TextWrapped(ImGui_Context ctx, string text) |
|---|
| Python | ImGui_TextWrapped(ImGui_Context ctx, str text) |
|---|
Shortcut for PushTextWrapPos(0.0); Text(text); PopTextWrapPos();.
Note that this won't work on an auto-resizing window if there's no other
widgets to extend the window width, yoy may need to set a size using
SetNextWindowSize.
View source
Text & Scalar Input
Function: InputDouble
| C++ | bool ImGui_InputDouble(ImGui_Context* ctx, const char* label, double* vInOut, double* stepInOptional = 0.0, double* step_fastInOptional = 0.0, const char* formatInOptional = "%.3f", int* flagsInOptional = InputTextFlags_None) |
|---|
| EEL | bool ImGui_InputDouble(ImGui_Context ctx, "label", &v, step = 0.0, step_fast = 0.0, "format" = "%.3f", int flags = InputTextFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_InputDouble", ImGui_Context ctx, "label", &v, step = 0.0, step_fast = 0.0, "format" = "%.3f", int flags = InputTextFlags_None) |
|---|
| Lua | boolean retval, number v = reaper.ImGui_InputDouble(ImGui_Context ctx, string label, number v, number step = 0.0, number step_fast = 0.0, string format = "%.3f", number flags = InputTextFlags_None) |
|---|
| Python | (bool retval, float v) = ImGui_InputDouble(ImGui_Context ctx, str label, float v, float step = 0.0, float step_fast = 0.0, str format = "%.3f", int flags = InputTextFlags_None) |
|---|
View source
Function: InputDouble2
| C++ | bool ImGui_InputDouble2(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, const char* formatInOptional = "%.3f", int* flagsInOptional = InputTextFlags_None) |
|---|
| EEL | bool ImGui_InputDouble2(ImGui_Context ctx, "label", &v1, &v2, "format" = "%.3f", int flags = InputTextFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_InputDouble2", ImGui_Context ctx, "label", &v1, &v2, "format" = "%.3f", int flags = InputTextFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2 = reaper.ImGui_InputDouble2(ImGui_Context ctx, string label, number v1, number v2, string format = "%.3f", number flags = InputTextFlags_None) |
|---|
| Python | (bool retval, float v1, float v2) = ImGui_InputDouble2(ImGui_Context ctx, str label, float v1, float v2, str format = "%.3f", int flags = InputTextFlags_None) |
|---|
View source
Function: InputDouble3
| C++ | bool ImGui_InputDouble3(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, const char* formatInOptional = "%.3f", int* flagsInOptional = InputTextFlags_None) |
|---|
| EEL | bool ImGui_InputDouble3(ImGui_Context ctx, "label", &v1, &v2, &v3, "format" = "%.3f", int flags = InputTextFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_InputDouble3", ImGui_Context ctx, "label", &v1, &v2, &v3, "format" = "%.3f", int flags = InputTextFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2, number v3 = reaper.ImGui_InputDouble3(ImGui_Context ctx, string label, number v1, number v2, number v3, string format = "%.3f", number flags = InputTextFlags_None) |
|---|
| Python | (bool retval, float v1, float v2, float v3) = ImGui_InputDouble3(ImGui_Context ctx, str label, float v1, float v2, float v3, str format = "%.3f", int flags = InputTextFlags_None) |
|---|
View source
Function: InputDouble4
| C++ | bool ImGui_InputDouble4(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, double* v4InOut, const char* formatInOptional = "%.3f", int* flagsInOptional = InputTextFlags_None) |
|---|
| EEL | bool ImGui_InputDouble4(ImGui_Context ctx, "label", &v1, &v2, &v3, &v4, "format" = "%.3f", int flags = InputTextFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_InputDouble4", ImGui_Context ctx, "label", &v1, &v2, &v3, &v4, "format" = "%.3f", int flags = InputTextFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2, number v3, number v4 = reaper.ImGui_InputDouble4(ImGui_Context ctx, string label, number v1, number v2, number v3, number v4, string format = "%.3f", number flags = InputTextFlags_None) |
|---|
| Python | (bool retval, float v1, float v2, float v3, float v4) = ImGui_InputDouble4(ImGui_Context ctx, str label, float v1, float v2, float v3, float v4, str format = "%.3f", int flags = InputTextFlags_None) |
|---|
View source
Function: InputDoubleN
| C++ | bool ImGui_InputDoubleN(ImGui_Context* ctx, const char* label, reaper_array* values, double* stepInOptional = nullptr, double* step_fastInOptional = nullptr, const char* formatInOptional = "%.3f", int* flagsInOptional = InputTextFlags_None) |
|---|
| EEL | bool ImGui_InputDoubleN(ImGui_Context ctx, "label", reaper_array values, step = nullptr, step_fast = nullptr, "format" = "%.3f", int flags = InputTextFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_InputDoubleN", ImGui_Context ctx, "label", reaper_array values, step = nullptr, step_fast = nullptr, "format" = "%.3f", int flags = InputTextFlags_None) |
|---|
| Lua | boolean retval = reaper.ImGui_InputDoubleN(ImGui_Context ctx, string label, reaper_array values, number step = nullptr, number step_fast = nullptr, string format = "%.3f", number flags = InputTextFlags_None) |
|---|
| Python | bool retval = ImGui_InputDoubleN(ImGui_Context ctx, str label, reaper_array values, float step = nullptr, float step_fast = nullptr, str format = "%.3f", int flags = InputTextFlags_None) |
|---|
View source
Function: InputInt
| C++ | bool ImGui_InputInt(ImGui_Context* ctx, const char* label, int* vInOut, int* stepInOptional = 1, int* step_fastInOptional = 100, int* flagsInOptional = InputTextFlags_None) |
|---|
| EEL | bool ImGui_InputInt(ImGui_Context ctx, "label", int &v, int step = 1, int step_fast = 100, int flags = InputTextFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_InputInt", ImGui_Context ctx, "label", int &v, int step = 1, int step_fast = 100, int flags = InputTextFlags_None) |
|---|
| Lua | boolean retval, number v = reaper.ImGui_InputInt(ImGui_Context ctx, string label, number v, number step = 1, number step_fast = 100, number flags = InputTextFlags_None) |
|---|
| Python | (bool retval, int v) = ImGui_InputInt(ImGui_Context ctx, str label, int v, int step = 1, int step_fast = 100, int flags = InputTextFlags_None) |
|---|
View source
Function: InputInt2
| C++ | bool ImGui_InputInt2(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* flagsInOptional = InputTextFlags_None) |
|---|
| EEL | bool ImGui_InputInt2(ImGui_Context ctx, "label", int &v1, int &v2, int flags = InputTextFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_InputInt2", ImGui_Context ctx, "label", int &v1, int &v2, int flags = InputTextFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2 = reaper.ImGui_InputInt2(ImGui_Context ctx, string label, number v1, number v2, number flags = InputTextFlags_None) |
|---|
| Python | (bool retval, int v1, int v2) = ImGui_InputInt2(ImGui_Context ctx, str label, int v1, int v2, int flags = InputTextFlags_None) |
|---|
View source
Function: InputInt3
| C++ | bool ImGui_InputInt3(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, int* flagsInOptional = InputTextFlags_None) |
|---|
| EEL | bool ImGui_InputInt3(ImGui_Context ctx, "label", int &v1, int &v2, int &v3, int flags = InputTextFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_InputInt3", ImGui_Context ctx, "label", int &v1, int &v2, int &v3, int flags = InputTextFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2, number v3 = reaper.ImGui_InputInt3(ImGui_Context ctx, string label, number v1, number v2, number v3, number flags = InputTextFlags_None) |
|---|
| Python | (bool retval, int v1, int v2, int v3) = ImGui_InputInt3(ImGui_Context ctx, str label, int v1, int v2, int v3, int flags = InputTextFlags_None) |
|---|
View source
Function: InputInt4
| C++ | bool ImGui_InputInt4(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, int* v4InOut, int* flagsInOptional = InputTextFlags_None) |
|---|
| EEL | bool ImGui_InputInt4(ImGui_Context ctx, "label", int &v1, int &v2, int &v3, int &v4, int flags = InputTextFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_InputInt4", ImGui_Context ctx, "label", int &v1, int &v2, int &v3, int &v4, int flags = InputTextFlags_None) |
|---|
| Lua | boolean retval, number v1, number v2, number v3, number v4 = reaper.ImGui_InputInt4(ImGui_Context ctx, string label, number v1, number v2, number v3, number v4, number flags = InputTextFlags_None) |
|---|
| Python | (bool retval, int v1, int v2, int v3, int v4) = ImGui_InputInt4(ImGui_Context ctx, str label, int v1, int v2, int v3, int v4, int flags = InputTextFlags_None) |
|---|
View source
Function: InputText
| C++ | bool ImGui_InputText(ImGui_Context* ctx, const char* label, char* bufInOutNeedBig, int bufInOutNeedBig_sz, int* flagsInOptional = InputTextFlags_None, ImGui_Function* callbackInOptional = nullptr) |
|---|
| EEL | bool ImGui_InputText(ImGui_Context ctx, "label", #buf, int flags = InputTextFlags_None, ImGui_Function callback = nullptr) |
|---|
| Legacy EEL | bool extension_api("ImGui_InputText", ImGui_Context ctx, "label", #buf, int flags = InputTextFlags_None, ImGui_Function callback = nullptr) |
|---|
| Lua | boolean retval, string buf = reaper.ImGui_InputText(ImGui_Context ctx, string label, string buf, number flags = InputTextFlags_None, ImGui_Function callback = nullptr) |
|---|
| Python | (bool retval, str buf) = ImGui_InputText(ImGui_Context ctx, str label, str buf, int flags = InputTextFlags_None, ImGui_Function callback = nullptr) |
|---|
View source
Function: InputTextMultiline
| C++ | bool ImGui_InputTextMultiline(ImGui_Context* ctx, const char* label, char* bufInOutNeedBig, int bufInOutNeedBig_sz, double* size_wInOptional = 0.0, double* size_hInOptional = 0.0, int* flagsInOptional = InputTextFlags_None, ImGui_Function* callbackInOptional = nullptr) |
|---|
| EEL | bool ImGui_InputTextMultiline(ImGui_Context ctx, "label", #buf, size_w = 0.0, size_h = 0.0, int flags = InputTextFlags_None, ImGui_Function callback = nullptr) |
|---|
| Legacy EEL | bool extension_api("ImGui_InputTextMultiline", ImGui_Context ctx, "label", #buf, size_w = 0.0, size_h = 0.0, int flags = InputTextFlags_None, ImGui_Function callback = nullptr) |
|---|
| Lua | boolean retval, string buf = reaper.ImGui_InputTextMultiline(ImGui_Context ctx, string label, string buf, number size_w = 0.0, number size_h = 0.0, number flags = InputTextFlags_None, ImGui_Function callback = nullptr) |
|---|
| Python | (bool retval, str buf) = ImGui_InputTextMultiline(ImGui_Context ctx, str label, str buf, float size_w = 0.0, float size_h = 0.0, int flags = InputTextFlags_None, ImGui_Function callback = nullptr) |
|---|
View source
Function: InputTextWithHint
| C++ | bool ImGui_InputTextWithHint(ImGui_Context* ctx, const char* label, const char* hint, char* bufInOutNeedBig, int bufInOutNeedBig_sz, int* flagsInOptional = InputTextFlags_None, ImGui_Function* callbackInOptional = nullptr) |
|---|
| EEL | bool ImGui_InputTextWithHint(ImGui_Context ctx, "label", "hint", #buf, int flags = InputTextFlags_None, ImGui_Function callback = nullptr) |
|---|
| Legacy EEL | bool extension_api("ImGui_InputTextWithHint", ImGui_Context ctx, "label", "hint", #buf, int flags = InputTextFlags_None, ImGui_Function callback = nullptr) |
|---|
| Lua | boolean retval, string buf = reaper.ImGui_InputTextWithHint(ImGui_Context ctx, string label, string hint, string buf, number flags = InputTextFlags_None, ImGui_Function callback = nullptr) |
|---|
| Python | (bool retval, str buf) = ImGui_InputTextWithHint(ImGui_Context ctx, str label, str hint, str buf, int flags = InputTextFlags_None, ImGui_Function callback = nullptr) |
|---|
View source
Flags
Most of these are only useful for InputText*() and not for InputDoubleX,
InputIntX etc.
(Those are per-item flags. There are shared flags in SetConfigVar:
ConfigVar_InputTextCursorBlink and ConfigVar_InputTextEnterKeepActive.)
Constant: InputTextFlags_AllowTabInput
| C++ | int ImGui_InputTextFlags_AllowTabInput |
|---|
| EEL | int ImGui_InputTextFlags_AllowTabInput() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_AllowTabInput") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_AllowTabInput() |
|---|
| Python | int retval = ImGui_InputTextFlags_AllowTabInput() |
|---|
Pressing TAB input a '\t' character into the text field.
View source
Constant: InputTextFlags_AlwaysOverwrite
| C++ | int ImGui_InputTextFlags_AlwaysOverwrite |
|---|
| EEL | int ImGui_InputTextFlags_AlwaysOverwrite() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_AlwaysOverwrite") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_AlwaysOverwrite() |
|---|
| Python | int retval = ImGui_InputTextFlags_AlwaysOverwrite() |
|---|
Overwrite mode.
View source
Constant: InputTextFlags_AutoSelectAll
| C++ | int ImGui_InputTextFlags_AutoSelectAll |
|---|
| EEL | int ImGui_InputTextFlags_AutoSelectAll() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_AutoSelectAll") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_AutoSelectAll() |
|---|
| Python | int retval = ImGui_InputTextFlags_AutoSelectAll() |
|---|
Select entire text when first taking mouse focus.
View source
Constant: InputTextFlags_CallbackAlways
| C++ | int ImGui_InputTextFlags_CallbackAlways |
|---|
| EEL | int ImGui_InputTextFlags_CallbackAlways() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_CallbackAlways") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_CallbackAlways() |
|---|
| Python | int retval = ImGui_InputTextFlags_CallbackAlways() |
|---|
Callback on each iteration. User code may query cursor position, modify text buffer.
View source
Constant: InputTextFlags_CallbackCharFilter
| C++ | int ImGui_InputTextFlags_CallbackCharFilter |
|---|
| EEL | int ImGui_InputTextFlags_CallbackCharFilter() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_CallbackCharFilter") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_CallbackCharFilter() |
|---|
| Python | int retval = ImGui_InputTextFlags_CallbackCharFilter() |
|---|
Callback on character inputs to replace or discard them.
Modify 'EventChar' to replace or 'EventChar = 0' to discard.
View source
Constant: InputTextFlags_CallbackCompletion
| C++ | int ImGui_InputTextFlags_CallbackCompletion |
|---|
| EEL | int ImGui_InputTextFlags_CallbackCompletion() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_CallbackCompletion") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_CallbackCompletion() |
|---|
| Python | int retval = ImGui_InputTextFlags_CallbackCompletion() |
|---|
Callback on pressing TAB (for completion handling).
View source
Constant: InputTextFlags_CallbackEdit
| C++ | int ImGui_InputTextFlags_CallbackEdit |
|---|
| EEL | int ImGui_InputTextFlags_CallbackEdit() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_CallbackEdit") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_CallbackEdit() |
|---|
| Python | int retval = ImGui_InputTextFlags_CallbackEdit() |
|---|
Callback on any edit (note that InputText() already returns true on edit,
the callback is useful mainly to manipulate the underlying buffer while
focus is active).
View source
Constant: InputTextFlags_CallbackHistory
| C++ | int ImGui_InputTextFlags_CallbackHistory |
|---|
| EEL | int ImGui_InputTextFlags_CallbackHistory() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_CallbackHistory") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_CallbackHistory() |
|---|
| Python | int retval = ImGui_InputTextFlags_CallbackHistory() |
|---|
Callback on pressing Up/Down arrows (for history handling).
View source
Constant: InputTextFlags_CharsDecimal
| C++ | int ImGui_InputTextFlags_CharsDecimal |
|---|
| EEL | int ImGui_InputTextFlags_CharsDecimal() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_CharsDecimal") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_CharsDecimal() |
|---|
| Python | int retval = ImGui_InputTextFlags_CharsDecimal() |
|---|
Allow 0123456789.+-*/.
View source
Constant: InputTextFlags_CharsHexadecimal
| C++ | int ImGui_InputTextFlags_CharsHexadecimal |
|---|
| EEL | int ImGui_InputTextFlags_CharsHexadecimal() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_CharsHexadecimal") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_CharsHexadecimal() |
|---|
| Python | int retval = ImGui_InputTextFlags_CharsHexadecimal() |
|---|
Allow 0123456789ABCDEFabcdef.
View source
Constant: InputTextFlags_CharsNoBlank
| C++ | int ImGui_InputTextFlags_CharsNoBlank |
|---|
| EEL | int ImGui_InputTextFlags_CharsNoBlank() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_CharsNoBlank") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_CharsNoBlank() |
|---|
| Python | int retval = ImGui_InputTextFlags_CharsNoBlank() |
|---|
Filter out spaces, tabs.
View source
Constant: InputTextFlags_CharsUppercase
| C++ | int ImGui_InputTextFlags_CharsUppercase |
|---|
| EEL | int ImGui_InputTextFlags_CharsUppercase() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_CharsUppercase") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_CharsUppercase() |
|---|
| Python | int retval = ImGui_InputTextFlags_CharsUppercase() |
|---|
Turn a..z into A..Z.
View source
Constant: InputTextFlags_CtrlEnterForNewLine
| C++ | int ImGui_InputTextFlags_CtrlEnterForNewLine |
|---|
| EEL | int ImGui_InputTextFlags_CtrlEnterForNewLine() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_CtrlEnterForNewLine") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_CtrlEnterForNewLine() |
|---|
| Python | int retval = ImGui_InputTextFlags_CtrlEnterForNewLine() |
|---|
In multi-line mode, unfocus with Enter, add new line with Ctrl+Enter
(default is opposite: unfocus with Ctrl+Enter, add line with Enter).
View source
Constant: InputTextFlags_EnterReturnsTrue
| C++ | int ImGui_InputTextFlags_EnterReturnsTrue |
|---|
| EEL | int ImGui_InputTextFlags_EnterReturnsTrue() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_EnterReturnsTrue") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_EnterReturnsTrue() |
|---|
| Python | int retval = ImGui_InputTextFlags_EnterReturnsTrue() |
|---|
Return 'true' when Enter is pressed (as opposed to every time the value was
modified). Consider looking at the IsItemDeactivatedAfterEdit function.
View source
Constant: InputTextFlags_EscapeClearsAll
| C++ | int ImGui_InputTextFlags_EscapeClearsAll |
|---|
| EEL | int ImGui_InputTextFlags_EscapeClearsAll() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_EscapeClearsAll") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_EscapeClearsAll() |
|---|
| Python | int retval = ImGui_InputTextFlags_EscapeClearsAll() |
|---|
Escape key clears content if not empty, and deactivate otherwise
(constrast to default behavior of Escape to revert).
View source
Constant: InputTextFlags_NoHorizontalScroll
| C++ | int ImGui_InputTextFlags_NoHorizontalScroll |
|---|
| EEL | int ImGui_InputTextFlags_NoHorizontalScroll() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_NoHorizontalScroll") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_NoHorizontalScroll() |
|---|
| Python | int retval = ImGui_InputTextFlags_NoHorizontalScroll() |
|---|
Disable following the cursor horizontally.
View source
Constant: InputTextFlags_NoUndoRedo
| C++ | int ImGui_InputTextFlags_NoUndoRedo |
|---|
| EEL | int ImGui_InputTextFlags_NoUndoRedo() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_NoUndoRedo") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_NoUndoRedo() |
|---|
| Python | int retval = ImGui_InputTextFlags_NoUndoRedo() |
|---|
Disable undo/redo. Note that input text owns the text data while active.
View source
Constant: InputTextFlags_None
| C++ | int ImGui_InputTextFlags_None |
|---|
| EEL | int ImGui_InputTextFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_None() |
|---|
| Python | int retval = ImGui_InputTextFlags_None() |
|---|
View source
Constant: InputTextFlags_Password
| C++ | int ImGui_InputTextFlags_Password |
|---|
| EEL | int ImGui_InputTextFlags_Password() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_Password") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_Password() |
|---|
| Python | int retval = ImGui_InputTextFlags_Password() |
|---|
Password mode, display all characters as '*'.
View source
Constant: InputTextFlags_ReadOnly
| C++ | int ImGui_InputTextFlags_ReadOnly |
|---|
| EEL | int ImGui_InputTextFlags_ReadOnly() |
|---|
| Legacy EEL | int extension_api("ImGui_InputTextFlags_ReadOnly") |
|---|
| Lua | number retval = reaper.ImGui_InputTextFlags_ReadOnly() |
|---|
| Python | int retval = ImGui_InputTextFlags_ReadOnly() |
|---|
Read-only mode.
View source
InputText Callback
The functions and variables documented in this section are only available
within the callbacks given to the InputText* functions.
See CreateFunctionFromEEL.
local reverseAlphabet = reaper.ImGui_CreateFunctionFromEEL([[
EventChar >= 'a' && EventChar <= 'z' ? EventChar = 'z' - (EventChar - 'a');
]])
local function frame()
rv, text = reaper.ImGui_InputText(ctx, 'No lowercase', text,
reaper.ImGui_InputTextFlags_CallbackCharFilter(), reverseAlphabet)
end
Variable access table (R = updated for reading,
W = writes are applied,
- = unmodified):
The InputTextCallback_* functions should only be used when EventFlag is one of
InputTextFlags_CallbackAlways/Completion/Edit/History.
Variable: Buf
Current value being edited.
View source
Variable: CursorPos
View source
Variable: EventChar
Character input. Replace character with another one, or set to zero to drop.
View source
Variable: EventFlag
One of InputTextFlags_Callback*
View source
Variable: EventKey
Key_UpArrow/DownArrow/Tab. Compare against these constants instead of
a hard-coded numerical value.
View source
Variable: Flags
What was passed to InputText()
View source
Function: InputTextCallback_ClearSelection
| EEL | InputTextCallback_ClearSelection() |
|---|
View source
Function: InputTextCallback_DeleteChars
| EEL | InputTextCallback_DeleteChars(int pos, int bytes_count) |
|---|
View source
Function: InputTextCallback_HasSelection
| EEL | bool InputTextCallback_HasSelection() |
|---|
View source
Function: InputTextCallback_InsertChars
| EEL | InputTextCallback_InsertChars(int pos, "new_text") |
|---|
View source
Function: InputTextCallback_SelectAll
| EEL | InputTextCallback_SelectAll() |
|---|
View source
Variable: SelectionEnd
View source
Variable: SelectionStart
Equal to SelectionEnd when no selection.
View source
Text Filter
Helper to perform simple filtering on text strings.
In format "aaaaa[,bbbb][,ccccc]".
Filter usage:
- "" display all lines
- "xxx" display lines containing "xxx"
- "xxx,yyy" display lines containing "xxx" or "yyy"
- "-xxx" hide lines containing "xxx"
Function: CreateTextFilter
| C++ | ImGui_TextFilter* ImGui_CreateTextFilter(const char* default_filterInOptional = "") |
|---|
| EEL | ImGui_TextFilter* ImGui_CreateTextFilter("default_filter" = "") |
|---|
| Legacy EEL | ImGui_TextFilter* extension_api("ImGui_CreateTextFilter", "default_filter" = "") |
|---|
| Lua | ImGui_TextFilter retval = reaper.ImGui_CreateTextFilter(string default_filter = "") |
|---|
| Python | ImGui_TextFilter retval = ImGui_CreateTextFilter(str default_filter = "") |
|---|
Valid while used every frame unless attached to a context (see Attach).
View source
Function: TextFilter_Clear
| C++ | void ImGui_TextFilter_Clear(ImGui_TextFilter* filter) |
|---|
| EEL | ImGui_TextFilter_Clear(ImGui_TextFilter filter) |
|---|
| Legacy EEL | extension_api("ImGui_TextFilter_Clear", ImGui_TextFilter filter) |
|---|
| Lua | reaper.ImGui_TextFilter_Clear(ImGui_TextFilter filter) |
|---|
| Python | ImGui_TextFilter_Clear(ImGui_TextFilter filter) |
|---|
View source
Function: TextFilter_Draw
| C++ | bool ImGui_TextFilter_Draw(ImGui_TextFilter* filter, ImGui_Context* ctx, const char* labelInOptional = "Filter (inc,-exc)", double* widthInOptional = 0.0) |
|---|
| EEL | bool ImGui_TextFilter_Draw(ImGui_TextFilter filter, ImGui_Context ctx, "label" = "Filter (inc,-exc)", width = 0.0) |
|---|
| Legacy EEL | bool extension_api("ImGui_TextFilter_Draw", ImGui_TextFilter filter, ImGui_Context ctx, "label" = "Filter (inc,-exc)", width = 0.0) |
|---|
| Lua | boolean retval = reaper.ImGui_TextFilter_Draw(ImGui_TextFilter filter, ImGui_Context ctx, string label = "Filter (inc,-exc)", number width = 0.0) |
|---|
| Python | bool retval = ImGui_TextFilter_Draw(ImGui_TextFilter filter, ImGui_Context ctx, str label = "Filter (inc,-exc)", float width = 0.0) |
|---|
Helper calling InputText+TextFilter_Set
View source
Function: TextFilter_Get
| C++ | const char* ImGui_TextFilter_Get(ImGui_TextFilter* filter) |
|---|
| EEL | const char* ImGui_TextFilter_Get(ImGui_TextFilter filter) |
|---|
| Legacy EEL | const char* extension_api("ImGui_TextFilter_Get", ImGui_TextFilter filter) |
|---|
| Lua | string retval = reaper.ImGui_TextFilter_Get(ImGui_TextFilter filter) |
|---|
| Python | str retval = ImGui_TextFilter_Get(ImGui_TextFilter filter) |
|---|
View source
Function: TextFilter_IsActive
| C++ | bool ImGui_TextFilter_IsActive(ImGui_TextFilter* filter) |
|---|
| EEL | bool ImGui_TextFilter_IsActive(ImGui_TextFilter filter) |
|---|
| Legacy EEL | bool extension_api("ImGui_TextFilter_IsActive", ImGui_TextFilter filter) |
|---|
| Lua | boolean retval = reaper.ImGui_TextFilter_IsActive(ImGui_TextFilter filter) |
|---|
| Python | bool retval = ImGui_TextFilter_IsActive(ImGui_TextFilter filter) |
|---|
View source
Function: TextFilter_PassFilter
| C++ | bool ImGui_TextFilter_PassFilter(ImGui_TextFilter* filter, const char* text) |
|---|
| EEL | bool ImGui_TextFilter_PassFilter(ImGui_TextFilter filter, "text") |
|---|
| Legacy EEL | bool extension_api("ImGui_TextFilter_PassFilter", ImGui_TextFilter filter, "text") |
|---|
| Lua | boolean retval = reaper.ImGui_TextFilter_PassFilter(ImGui_TextFilter filter, string text) |
|---|
| Python | bool retval = ImGui_TextFilter_PassFilter(ImGui_TextFilter filter, str text) |
|---|
View source
Function: TextFilter_Set
| C++ | void ImGui_TextFilter_Set(ImGui_TextFilter* filter, const char* filter_text) |
|---|
| EEL | ImGui_TextFilter_Set(ImGui_TextFilter filter, "filter_text") |
|---|
| Legacy EEL | extension_api("ImGui_TextFilter_Set", ImGui_TextFilter filter, "filter_text") |
|---|
| Lua | reaper.ImGui_TextFilter_Set(ImGui_TextFilter filter, string filter_text) |
|---|
| Python | ImGui_TextFilter_Set(ImGui_TextFilter filter, str filter_text) |
|---|
View source
Tree Node
Function: GetTreeNodeToLabelSpacing
| C++ | double ImGui_GetTreeNodeToLabelSpacing(ImGui_Context* ctx) |
|---|
| EEL | double ImGui_GetTreeNodeToLabelSpacing(ImGui_Context ctx) |
|---|
| Legacy EEL | double extension_api("ImGui_GetTreeNodeToLabelSpacing", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetTreeNodeToLabelSpacing(ImGui_Context ctx) |
|---|
| Python | float retval = ImGui_GetTreeNodeToLabelSpacing(ImGui_Context ctx) |
|---|
Horizontal distance preceding label when using TreeNode*() or Bullet()
== (GetFontSize + StyleVar_FramePadding.x*2) for a regular unframed TreeNode.
View source
Function: IsItemToggledOpen
| C++ | bool ImGui_IsItemToggledOpen(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_IsItemToggledOpen(ImGui_Context ctx) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsItemToggledOpen", ImGui_Context ctx) |
|---|
| Lua | boolean retval = reaper.ImGui_IsItemToggledOpen(ImGui_Context ctx) |
|---|
| Python | bool retval = ImGui_IsItemToggledOpen(ImGui_Context ctx) |
|---|
Was the last item open state toggled? Set by TreeNode.
View source
Function: SetNextItemOpen
| C++ | void ImGui_SetNextItemOpen(ImGui_Context* ctx, bool is_open, int* condInOptional = Cond_Always) |
|---|
| EEL | ImGui_SetNextItemOpen(ImGui_Context ctx, bool is_open, int cond = Cond_Always) |
|---|
| Legacy EEL | extension_api("ImGui_SetNextItemOpen", ImGui_Context ctx, bool is_open, int cond = Cond_Always) |
|---|
| Lua | reaper.ImGui_SetNextItemOpen(ImGui_Context ctx, boolean is_open, number cond = Cond_Always) |
|---|
| Python | ImGui_SetNextItemOpen(ImGui_Context ctx, bool is_open, int cond = Cond_Always) |
|---|
Set next TreeNode/CollapsingHeader open state.
Can also be done with the TreeNodeFlags_DefaultOpen flag.
View source
Function: TreeNode
| C++ | bool ImGui_TreeNode(ImGui_Context* ctx, const char* label, int* flagsInOptional = TreeNodeFlags_None) |
|---|
| EEL | bool ImGui_TreeNode(ImGui_Context ctx, "label", int flags = TreeNodeFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_TreeNode", ImGui_Context ctx, "label", int flags = TreeNodeFlags_None) |
|---|
| Lua | boolean retval = reaper.ImGui_TreeNode(ImGui_Context ctx, string label, number flags = TreeNodeFlags_None) |
|---|
| Python | bool retval = ImGui_TreeNode(ImGui_Context ctx, str label, int flags = TreeNodeFlags_None) |
|---|
TreeNode functions return true when the node is open, in which case you need
to also call TreePop when you are finished displaying the tree node contents.
View source
Function: TreeNodeEx
| C++ | bool ImGui_TreeNodeEx(ImGui_Context* ctx, const char* str_id, const char* label, int* flagsInOptional = TreeNodeFlags_None) |
|---|
| EEL | bool ImGui_TreeNodeEx(ImGui_Context ctx, "str_id", "label", int flags = TreeNodeFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_TreeNodeEx", ImGui_Context ctx, "str_id", "label", int flags = TreeNodeFlags_None) |
|---|
| Lua | boolean retval = reaper.ImGui_TreeNodeEx(ImGui_Context ctx, string str_id, string label, number flags = TreeNodeFlags_None) |
|---|
| Python | bool retval = ImGui_TreeNodeEx(ImGui_Context ctx, str str_id, str label, int flags = TreeNodeFlags_None) |
|---|
Helper variation to easily decorelate the id from the displayed string.
Read the FAQ about why and how to use ID.
To align arbitrary text at the same level as a TreeNode you can use Bullet.
View source
Function: TreePop
| C++ | void ImGui_TreePop(ImGui_Context* ctx) |
|---|
| EEL | ImGui_TreePop(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_TreePop", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_TreePop(ImGui_Context ctx) |
|---|
| Python | ImGui_TreePop(ImGui_Context ctx) |
|---|
Unindent()+PopID()
View source
Function: TreePush
| C++ | void ImGui_TreePush(ImGui_Context* ctx, const char* str_id) |
|---|
| EEL | ImGui_TreePush(ImGui_Context ctx, "str_id") |
|---|
| Legacy EEL | extension_api("ImGui_TreePush", ImGui_Context ctx, "str_id") |
|---|
| Lua | reaper.ImGui_TreePush(ImGui_Context ctx, string str_id) |
|---|
| Python | ImGui_TreePush(ImGui_Context ctx, str str_id) |
|---|
Indent()+PushID(). Already called by TreeNode when returning true,
but you can call TreePush/TreePop yourself if desired.
View source
Flags
For TreeNode, TreeNodeEx and CollapsingHeader.
Constant: TreeNodeFlags_AllowItemOverlap
| C++ | int ImGui_TreeNodeFlags_AllowItemOverlap |
|---|
| EEL | int ImGui_TreeNodeFlags_AllowItemOverlap() |
|---|
| Legacy EEL | int extension_api("ImGui_TreeNodeFlags_AllowItemOverlap") |
|---|
| Lua | number retval = reaper.ImGui_TreeNodeFlags_AllowItemOverlap() |
|---|
| Python | int retval = ImGui_TreeNodeFlags_AllowItemOverlap() |
|---|
Hit testing to allow subsequent widgets to overlap this one.
View source
Constant: TreeNodeFlags_Bullet
| C++ | int ImGui_TreeNodeFlags_Bullet |
|---|
| EEL | int ImGui_TreeNodeFlags_Bullet() |
|---|
| Legacy EEL | int extension_api("ImGui_TreeNodeFlags_Bullet") |
|---|
| Lua | number retval = reaper.ImGui_TreeNodeFlags_Bullet() |
|---|
| Python | int retval = ImGui_TreeNodeFlags_Bullet() |
|---|
Display a bullet instead of arrow.
View source
Constant: TreeNodeFlags_DefaultOpen
| C++ | int ImGui_TreeNodeFlags_DefaultOpen |
|---|
| EEL | int ImGui_TreeNodeFlags_DefaultOpen() |
|---|
| Legacy EEL | int extension_api("ImGui_TreeNodeFlags_DefaultOpen") |
|---|
| Lua | number retval = reaper.ImGui_TreeNodeFlags_DefaultOpen() |
|---|
| Python | int retval = ImGui_TreeNodeFlags_DefaultOpen() |
|---|
Default node to be open.
View source
Constant: TreeNodeFlags_FramePadding
| C++ | int ImGui_TreeNodeFlags_FramePadding |
|---|
| EEL | int ImGui_TreeNodeFlags_FramePadding() |
|---|
| Legacy EEL | int extension_api("ImGui_TreeNodeFlags_FramePadding") |
|---|
| Lua | number retval = reaper.ImGui_TreeNodeFlags_FramePadding() |
|---|
| Python | int retval = ImGui_TreeNodeFlags_FramePadding() |
|---|
Use FramePadding (even for an unframed text node) to vertically align text
baseline to regular widget height.
Equivalent to calling AlignTextToFramePadding.
View source
Constant: TreeNodeFlags_Framed
| C++ | int ImGui_TreeNodeFlags_Framed |
|---|
| EEL | int ImGui_TreeNodeFlags_Framed() |
|---|
| Legacy EEL | int extension_api("ImGui_TreeNodeFlags_Framed") |
|---|
| Lua | number retval = reaper.ImGui_TreeNodeFlags_Framed() |
|---|
| Python | int retval = ImGui_TreeNodeFlags_Framed() |
|---|
Draw frame with background (e.g. for CollapsingHeader).
View source
Constant: TreeNodeFlags_Leaf
| C++ | int ImGui_TreeNodeFlags_Leaf |
|---|
| EEL | int ImGui_TreeNodeFlags_Leaf() |
|---|
| Legacy EEL | int extension_api("ImGui_TreeNodeFlags_Leaf") |
|---|
| Lua | number retval = reaper.ImGui_TreeNodeFlags_Leaf() |
|---|
| Python | int retval = ImGui_TreeNodeFlags_Leaf() |
|---|
No collapsing, no arrow (use as a convenience for leaf nodes).
View source
Constant: TreeNodeFlags_NoAutoOpenOnLog
| C++ | int ImGui_TreeNodeFlags_NoAutoOpenOnLog |
|---|
| EEL | int ImGui_TreeNodeFlags_NoAutoOpenOnLog() |
|---|
| Legacy EEL | int extension_api("ImGui_TreeNodeFlags_NoAutoOpenOnLog") |
|---|
| Lua | number retval = reaper.ImGui_TreeNodeFlags_NoAutoOpenOnLog() |
|---|
| Python | int retval = ImGui_TreeNodeFlags_NoAutoOpenOnLog() |
|---|
Don't automatically and temporarily open node when Logging is active
(by default logging will automatically open tree nodes).
View source
Constant: TreeNodeFlags_NoTreePushOnOpen
| C++ | int ImGui_TreeNodeFlags_NoTreePushOnOpen |
|---|
| EEL | int ImGui_TreeNodeFlags_NoTreePushOnOpen() |
|---|
| Legacy EEL | int extension_api("ImGui_TreeNodeFlags_NoTreePushOnOpen") |
|---|
| Lua | number retval = reaper.ImGui_TreeNodeFlags_NoTreePushOnOpen() |
|---|
| Python | int retval = ImGui_TreeNodeFlags_NoTreePushOnOpen() |
|---|
Don't do a TreePush when open (e.g. for CollapsingHeader)
= no extra indent nor pushing on ID stack.
View source
Constant: TreeNodeFlags_None
| C++ | int ImGui_TreeNodeFlags_None |
|---|
| EEL | int ImGui_TreeNodeFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_TreeNodeFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_TreeNodeFlags_None() |
|---|
| Python | int retval = ImGui_TreeNodeFlags_None() |
|---|
View source
Constant: TreeNodeFlags_OpenOnArrow
| C++ | int ImGui_TreeNodeFlags_OpenOnArrow |
|---|
| EEL | int ImGui_TreeNodeFlags_OpenOnArrow() |
|---|
| Legacy EEL | int extension_api("ImGui_TreeNodeFlags_OpenOnArrow") |
|---|
| Lua | number retval = reaper.ImGui_TreeNodeFlags_OpenOnArrow() |
|---|
| Python | int retval = ImGui_TreeNodeFlags_OpenOnArrow() |
|---|
Only open when clicking on the arrow part.
If TreeNodeFlags_OpenOnDoubleClick is also set, single-click arrow or
double-click all box to open.
View source
Constant: TreeNodeFlags_OpenOnDoubleClick
| C++ | int ImGui_TreeNodeFlags_OpenOnDoubleClick |
|---|
| EEL | int ImGui_TreeNodeFlags_OpenOnDoubleClick() |
|---|
| Legacy EEL | int extension_api("ImGui_TreeNodeFlags_OpenOnDoubleClick") |
|---|
| Lua | number retval = reaper.ImGui_TreeNodeFlags_OpenOnDoubleClick() |
|---|
| Python | int retval = ImGui_TreeNodeFlags_OpenOnDoubleClick() |
|---|
Need double-click to open node.
View source
Constant: TreeNodeFlags_Selected
| C++ | int ImGui_TreeNodeFlags_Selected |
|---|
| EEL | int ImGui_TreeNodeFlags_Selected() |
|---|
| Legacy EEL | int extension_api("ImGui_TreeNodeFlags_Selected") |
|---|
| Lua | number retval = reaper.ImGui_TreeNodeFlags_Selected() |
|---|
| Python | int retval = ImGui_TreeNodeFlags_Selected() |
|---|
Draw as selected.
View source
Constant: TreeNodeFlags_SpanAvailWidth
| C++ | int ImGui_TreeNodeFlags_SpanAvailWidth |
|---|
| EEL | int ImGui_TreeNodeFlags_SpanAvailWidth() |
|---|
| Legacy EEL | int extension_api("ImGui_TreeNodeFlags_SpanAvailWidth") |
|---|
| Lua | number retval = reaper.ImGui_TreeNodeFlags_SpanAvailWidth() |
|---|
| Python | int retval = ImGui_TreeNodeFlags_SpanAvailWidth() |
|---|
Extend hit box to the right-most edge, even if not framed.
This is not the default in order to allow adding other items on the same line.
In the future we may refactor the hit system to be front-to-back,
allowing natural overlaps and then this can become the default.
View source
Constant: TreeNodeFlags_SpanFullWidth
| C++ | int ImGui_TreeNodeFlags_SpanFullWidth |
|---|
| EEL | int ImGui_TreeNodeFlags_SpanFullWidth() |
|---|
| Legacy EEL | int extension_api("ImGui_TreeNodeFlags_SpanFullWidth") |
|---|
| Lua | number retval = reaper.ImGui_TreeNodeFlags_SpanFullWidth() |
|---|
| Python | int retval = ImGui_TreeNodeFlags_SpanFullWidth() |
|---|
Extend hit box to the left-most and right-most edges (bypass the indented area).
View source
Utility
Function: GetVersion
| C++ | void ImGui_GetVersion(char* imgui_versionOut, int imgui_versionOut_sz, int* imgui_version_numOut, char* reaimgui_versionOut, int reaimgui_versionOut_sz) |
|---|
| EEL | ImGui_GetVersion(#imgui_version, int &imgui_version_num, #reaimgui_version) |
|---|
| Legacy EEL | extension_api("ImGui_GetVersion", #imgui_version, int &imgui_version_num, #reaimgui_version) |
|---|
| Lua | string imgui_version, number imgui_version_num, string reaimgui_version = reaper.ImGui_GetVersion() |
|---|
| Python | (str imgui_version, int imgui_version_num, str reaimgui_version) = ImGui_GetVersion() |
|---|
View source
Function: NumericLimits_Double
| C++ | void ImGui_NumericLimits_Double(double* minOut, double* maxOut) |
|---|
| EEL | ImGui_NumericLimits_Double(&min, &max) |
|---|
| Legacy EEL | extension_api("ImGui_NumericLimits_Double", &min, &max) |
|---|
| Lua | number min, number max = reaper.ImGui_NumericLimits_Double() |
|---|
| Python | (float min, float max) = ImGui_NumericLimits_Double() |
|---|
Returns DBL_MIN and DBL_MAX for this system.
View source
Function: NumericLimits_Float
| C++ | void ImGui_NumericLimits_Float(double* minOut, double* maxOut) |
|---|
| EEL | ImGui_NumericLimits_Float(&min, &max) |
|---|
| Legacy EEL | extension_api("ImGui_NumericLimits_Float", &min, &max) |
|---|
| Lua | number min, number max = reaper.ImGui_NumericLimits_Float() |
|---|
| Python | (float min, float max) = ImGui_NumericLimits_Float() |
|---|
Returns FLT_MIN and FLT_MAX for this system.
View source
Function: NumericLimits_Int
| C++ | void ImGui_NumericLimits_Int(int* minOut, int* maxOut) |
|---|
| EEL | ImGui_NumericLimits_Int(int &min, int &max) |
|---|
| Legacy EEL | extension_api("ImGui_NumericLimits_Int", int &min, int &max) |
|---|
| Lua | number min, number max = reaper.ImGui_NumericLimits_Int() |
|---|
| Python | (int min, int max) = ImGui_NumericLimits_Int() |
|---|
Returns INT_MIN and INT_MAX for this system.
View source
Function: PointConvertNative
| C++ | void ImGui_PointConvertNative(ImGui_Context* ctx, double* xInOut, double* yInOut, bool* to_nativeInOptional = false) |
|---|
| EEL | ImGui_PointConvertNative(ImGui_Context ctx, &x, &y, bool to_native = false) |
|---|
| Legacy EEL | extension_api("ImGui_PointConvertNative", ImGui_Context ctx, &x, &y, bool to_native = false) |
|---|
| Lua | number x, number y = reaper.ImGui_PointConvertNative(ImGui_Context ctx, number x, number y, boolean to_native = false) |
|---|
| Python | (float x, float y) = ImGui_PointConvertNative(ImGui_Context ctx, float x, float y, bool to_native = false) |
|---|
Convert a position from the current platform's native coordinate position
system to ReaImGui global coordinates (or vice versa).
This effectively flips the Y coordinate on macOS and applies HiDPI scaling on
Windows and Linux.
View source
Function: ProgressBar
| C++ | void ImGui_ProgressBar(ImGui_Context* ctx, double fraction, double* size_arg_wInOptional = -1.1754943508222875e-38F, double* size_arg_hInOptional = 0.0, const char* overlayInOptional = nullptr) |
|---|
| EEL | ImGui_ProgressBar(ImGui_Context ctx, fraction, size_arg_w = -1.1754943508222875e-38F, size_arg_h = 0.0, "overlay" = nullptr) |
|---|
| Legacy EEL | extension_api("ImGui_ProgressBar", ImGui_Context ctx, fraction, size_arg_w = -1.1754943508222875e-38F, size_arg_h = 0.0, "overlay" = nullptr) |
|---|
| Lua | reaper.ImGui_ProgressBar(ImGui_Context ctx, number fraction, number size_arg_w = -1.1754943508222875e-38F, number size_arg_h = 0.0, string overlay = nullptr) |
|---|
| Python | ImGui_ProgressBar(ImGui_Context ctx, float fraction, float size_arg_w = -1.1754943508222875e-38F, float size_arg_h = 0.0, str overlay = nullptr) |
|---|
View source
Function: ValidatePtr
| C++ | bool ImGui_ValidatePtr(void* pointer, const char* type) |
|---|
| EEL | bool ImGui_ValidatePtr(void pointer, "type") |
|---|
| Legacy EEL | bool extension_api("ImGui_ValidatePtr", void pointer, "type") |
|---|
| Lua | boolean retval = reaper.ImGui_ValidatePtr(void pointer, string type) |
|---|
| Python | bool retval = ImGui_ValidatePtr(void pointer, str type) |
|---|
Return whether the pointer of the specified type is valid.
Supported types are:
View source
Clipboard
Function: GetClipboardText
| C++ | const char* ImGui_GetClipboardText(ImGui_Context* ctx) |
|---|
| EEL | const char* ImGui_GetClipboardText(ImGui_Context ctx) |
|---|
| Legacy EEL | const char* extension_api("ImGui_GetClipboardText", ImGui_Context ctx) |
|---|
| Lua | string retval = reaper.ImGui_GetClipboardText(ImGui_Context ctx) |
|---|
| Python | str retval = ImGui_GetClipboardText(ImGui_Context ctx) |
|---|
View source
Function: SetClipboardText
| C++ | void ImGui_SetClipboardText(ImGui_Context* ctx, const char* text) |
|---|
| EEL | ImGui_SetClipboardText(ImGui_Context ctx, "text") |
|---|
| Legacy EEL | extension_api("ImGui_SetClipboardText", ImGui_Context ctx, "text") |
|---|
| Lua | reaper.ImGui_SetClipboardText(ImGui_Context ctx, string text) |
|---|
| Python | ImGui_SetClipboardText(ImGui_Context ctx, str text) |
|---|
See also the LogToClipboard function to capture GUI into clipboard,
or easily output text data to the clipboard.
View source
Color Conversion
Function: ColorConvertDouble4ToU32
| C++ | int ImGui_ColorConvertDouble4ToU32(double r, double g, double b, double a) |
|---|
| EEL | int ImGui_ColorConvertDouble4ToU32(r, g, b, a) |
|---|
| Legacy EEL | int extension_api("ImGui_ColorConvertDouble4ToU32", r, g, b, a) |
|---|
| Lua | number retval = reaper.ImGui_ColorConvertDouble4ToU32(number r, number g, number b, number a) |
|---|
| Python | int retval = ImGui_ColorConvertDouble4ToU32(float r, float g, float b, float a) |
|---|
Pack 0..1 RGBA values into a 32-bit integer (0xRRGGBBAA).
View source
Function: ColorConvertHSVtoRGB
| C++ | void ImGui_ColorConvertHSVtoRGB(double h, double s, double v, double* rOut, double* gOut, double* bOut) |
|---|
| EEL | ImGui_ColorConvertHSVtoRGB(h, s, v, &r, &g, &b) |
|---|
| Legacy EEL | extension_api("ImGui_ColorConvertHSVtoRGB", h, s, v, &r, &g, &b) |
|---|
| Lua | number r, number g, number b = reaper.ImGui_ColorConvertHSVtoRGB(number h, number s, number v) |
|---|
| Python | (float r, float g, float b) = ImGui_ColorConvertHSVtoRGB(float h, float s, float v) |
|---|
Convert HSV values (0..1) into RGB (0..1).
View source
Function: ColorConvertNative
| C++ | int ImGui_ColorConvertNative(int rgb) |
|---|
| EEL | int ImGui_ColorConvertNative(int rgb) |
|---|
| Legacy EEL | int extension_api("ImGui_ColorConvertNative", int rgb) |
|---|
| Lua | number retval = reaper.ImGui_ColorConvertNative(number rgb) |
|---|
| Python | int retval = ImGui_ColorConvertNative(int rgb) |
|---|
Convert a native color coming from REAPER or 0xRRGGBB to native.
This swaps the red and blue channels on Windows.
View source
Function: ColorConvertRGBtoHSV
| C++ | void ImGui_ColorConvertRGBtoHSV(double r, double g, double b, double* hOut, double* sOut, double* vOut) |
|---|
| EEL | ImGui_ColorConvertRGBtoHSV(r, g, b, &h, &s, &v) |
|---|
| Legacy EEL | extension_api("ImGui_ColorConvertRGBtoHSV", r, g, b, &h, &s, &v) |
|---|
| Lua | number h, number s, number v = reaper.ImGui_ColorConvertRGBtoHSV(number r, number g, number b) |
|---|
| Python | (float h, float s, float v) = ImGui_ColorConvertRGBtoHSV(float r, float g, float b) |
|---|
Convert RGB values (0..1) into HSV (0..1).
View source
Function: ColorConvertU32ToDouble4
| C++ | void ImGui_ColorConvertU32ToDouble4(int rgba, double* rOut, double* gOut, double* bOut, double* aOut) |
|---|
| EEL | ImGui_ColorConvertU32ToDouble4(int rgba, &r, &g, &b, &a) |
|---|
| Legacy EEL | extension_api("ImGui_ColorConvertU32ToDouble4", int rgba, &r, &g, &b, &a) |
|---|
| Lua | number r, number g, number b, number a = reaper.ImGui_ColorConvertU32ToDouble4(number rgba) |
|---|
| Python | (float r, float g, float b, float a) = ImGui_ColorConvertU32ToDouble4(int rgba) |
|---|
Unpack a 32-bit integer (0xRRGGBBAA) into separate RGBA values (0..1).
View source
Conditions
Used for many SetNextWindow*() and SetWindow*() functions.
Constant: Cond_Always
| C++ | int ImGui_Cond_Always |
|---|
| EEL | int ImGui_Cond_Always() |
|---|
| Legacy EEL | int extension_api("ImGui_Cond_Always") |
|---|
| Lua | number retval = reaper.ImGui_Cond_Always() |
|---|
| Python | int retval = ImGui_Cond_Always() |
|---|
No condition (always set the variable).
View source
Constant: Cond_Appearing
| C++ | int ImGui_Cond_Appearing |
|---|
| EEL | int ImGui_Cond_Appearing() |
|---|
| Legacy EEL | int extension_api("ImGui_Cond_Appearing") |
|---|
| Lua | number retval = reaper.ImGui_Cond_Appearing() |
|---|
| Python | int retval = ImGui_Cond_Appearing() |
|---|
Set the variable if the object/window is appearing after being
hidden/inactive (or the first time).
View source
Constant: Cond_FirstUseEver
| C++ | int ImGui_Cond_FirstUseEver |
|---|
| EEL | int ImGui_Cond_FirstUseEver() |
|---|
| Legacy EEL | int extension_api("ImGui_Cond_FirstUseEver") |
|---|
| Lua | number retval = reaper.ImGui_Cond_FirstUseEver() |
|---|
| Python | int retval = ImGui_Cond_FirstUseEver() |
|---|
Set the variable if the object/window has no persistently saved data
(no entry in .ini file).
View source
Constant: Cond_Once
| C++ | int ImGui_Cond_Once |
|---|
| EEL | int ImGui_Cond_Once() |
|---|
| Legacy EEL | int extension_api("ImGui_Cond_Once") |
|---|
| Lua | number retval = reaper.ImGui_Cond_Once() |
|---|
| Python | int retval = ImGui_Cond_Once() |
|---|
Set the variable once per runtime session (only the first call will succeed).
View source
ID stack/scope
Read the FAQ for more details about how IDs are
handled in dear imgui.
- Those questions are answered and impacted by understanding of the ID stack system:
- "Q: Why is my widget not reacting when I click on it?"
- "Q: How can I have widgets with an empty label?"
- "Q: How can I have multiple widgets with the same label?"
- Short version: ID are hashes of the entire ID stack. If you are creating widgets
in a loop you most likely want to push a unique identifier (e.g. object pointer,
loop index) to uniquely differentiate them.
- You can also use the "Label##foobar" syntax within widget label to distinguish
them from each others.
- We use the "label"/"name" terminology to denote a string that will be
displayed + used as an ID, whereas "str_id" denote a string that is only used
as an ID and not normally displayed.
Function: PopID
| C++ | void ImGui_PopID(ImGui_Context* ctx) |
|---|
| EEL | ImGui_PopID(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_PopID", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_PopID(ImGui_Context ctx) |
|---|
| Python | ImGui_PopID(ImGui_Context ctx) |
|---|
Pop from the ID stack.
View source
Function: PushID
| C++ | void ImGui_PushID(ImGui_Context* ctx, const char* str_id) |
|---|
| EEL | ImGui_PushID(ImGui_Context ctx, "str_id") |
|---|
| Legacy EEL | extension_api("ImGui_PushID", ImGui_Context ctx, "str_id") |
|---|
| Lua | reaper.ImGui_PushID(ImGui_Context ctx, string str_id) |
|---|
| Python | ImGui_PushID(ImGui_Context ctx, str str_id) |
|---|
Push string into the ID stack.
View source
Logging/Capture
All text output from the interface can be captured into tty/file/clipboard.
By default, tree nodes are automatically opened during logging.
Function: LogFinish
| C++ | void ImGui_LogFinish(ImGui_Context* ctx) |
|---|
| EEL | ImGui_LogFinish(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_LogFinish", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_LogFinish(ImGui_Context ctx) |
|---|
| Python | ImGui_LogFinish(ImGui_Context ctx) |
|---|
Stop logging (close file, etc.)
View source
Function: LogText
| C++ | void ImGui_LogText(ImGui_Context* ctx, const char* text) |
|---|
| EEL | ImGui_LogText(ImGui_Context ctx, "text") |
|---|
| Legacy EEL | extension_api("ImGui_LogText", ImGui_Context ctx, "text") |
|---|
| Lua | reaper.ImGui_LogText(ImGui_Context ctx, string text) |
|---|
| Python | ImGui_LogText(ImGui_Context ctx, str text) |
|---|
Pass text data straight to log (without being displayed)
View source
Function: LogToClipboard
| C++ | void ImGui_LogToClipboard(ImGui_Context* ctx, int* auto_open_depthInOptional = -1) |
|---|
| EEL | ImGui_LogToClipboard(ImGui_Context ctx, int auto_open_depth = -1) |
|---|
| Legacy EEL | extension_api("ImGui_LogToClipboard", ImGui_Context ctx, int auto_open_depth = -1) |
|---|
| Lua | reaper.ImGui_LogToClipboard(ImGui_Context ctx, number auto_open_depth = -1) |
|---|
| Python | ImGui_LogToClipboard(ImGui_Context ctx, int auto_open_depth = -1) |
|---|
Start logging all text output from the interface to the OS clipboard.
See also SetClipboardText.
View source
Function: LogToFile
| C++ | void ImGui_LogToFile(ImGui_Context* ctx, int* auto_open_depthInOptional = -1, const char* filenameInOptional = nullptr) |
|---|
| EEL | ImGui_LogToFile(ImGui_Context ctx, int auto_open_depth = -1, "filename" = nullptr) |
|---|
| Legacy EEL | extension_api("ImGui_LogToFile", ImGui_Context ctx, int auto_open_depth = -1, "filename" = nullptr) |
|---|
| Lua | reaper.ImGui_LogToFile(ImGui_Context ctx, number auto_open_depth = -1, string filename = nullptr) |
|---|
| Python | ImGui_LogToFile(ImGui_Context ctx, int auto_open_depth = -1, str filename = nullptr) |
|---|
Start logging all text output from the interface to a file.
The data is saved to $resource_path/imgui_log.txt if filename is nil.
View source
Function: LogToTTY
| C++ | void ImGui_LogToTTY(ImGui_Context* ctx, int* auto_open_depthInOptional = -1) |
|---|
| EEL | ImGui_LogToTTY(ImGui_Context ctx, int auto_open_depth = -1) |
|---|
| Legacy EEL | extension_api("ImGui_LogToTTY", ImGui_Context ctx, int auto_open_depth = -1) |
|---|
| Lua | reaper.ImGui_LogToTTY(ImGui_Context ctx, number auto_open_depth = -1) |
|---|
| Python | ImGui_LogToTTY(ImGui_Context ctx, int auto_open_depth = -1) |
|---|
Start logging all text output from the interface to the TTY (stdout).
View source
Viewport
Function: GetMainViewport
| C++ | ImGui_Viewport* ImGui_GetMainViewport(ImGui_Context* ctx) |
|---|
| EEL | ImGui_Viewport* ImGui_GetMainViewport(ImGui_Context ctx) |
|---|
| Legacy EEL | ImGui_Viewport* extension_api("ImGui_GetMainViewport", ImGui_Context ctx) |
|---|
| Lua | ImGui_Viewport retval = reaper.ImGui_GetMainViewport(ImGui_Context ctx) |
|---|
| Python | ImGui_Viewport retval = ImGui_GetMainViewport(ImGui_Context ctx) |
|---|
Currently represents REAPER's main window (arrange view).
WARNING: This may change or be removed in the future.
View source
Function: GetWindowViewport
| C++ | ImGui_Viewport* ImGui_GetWindowViewport(ImGui_Context* ctx) |
|---|
| EEL | ImGui_Viewport* ImGui_GetWindowViewport(ImGui_Context ctx) |
|---|
| Legacy EEL | ImGui_Viewport* extension_api("ImGui_GetWindowViewport", ImGui_Context ctx) |
|---|
| Lua | ImGui_Viewport retval = reaper.ImGui_GetWindowViewport(ImGui_Context ctx) |
|---|
| Python | ImGui_Viewport retval = ImGui_GetWindowViewport(ImGui_Context ctx) |
|---|
Get viewport currently associated to the current window.
View source
Function: Viewport_GetCenter
| C++ | void ImGui_Viewport_GetCenter(ImGui_Viewport* viewport, double* xOut, double* yOut) |
|---|
| EEL | ImGui_Viewport_GetCenter(ImGui_Viewport viewport, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_Viewport_GetCenter", ImGui_Viewport viewport, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_Viewport_GetCenter(ImGui_Viewport viewport) |
|---|
| Python | (float x, float y) = ImGui_Viewport_GetCenter(ImGui_Viewport viewport) |
|---|
Center of the viewport.
View source
Function: Viewport_GetPos
| C++ | void ImGui_Viewport_GetPos(ImGui_Viewport* viewport, double* xOut, double* yOut) |
|---|
| EEL | ImGui_Viewport_GetPos(ImGui_Viewport viewport, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_Viewport_GetPos", ImGui_Viewport viewport, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_Viewport_GetPos(ImGui_Viewport viewport) |
|---|
| Python | (float x, float y) = ImGui_Viewport_GetPos(ImGui_Viewport viewport) |
|---|
Main Area: Position of the viewport
View source
Function: Viewport_GetSize
| C++ | void ImGui_Viewport_GetSize(ImGui_Viewport* viewport, double* wOut, double* hOut) |
|---|
| EEL | ImGui_Viewport_GetSize(ImGui_Viewport viewport, &w, &h) |
|---|
| Legacy EEL | extension_api("ImGui_Viewport_GetSize", ImGui_Viewport viewport, &w, &h) |
|---|
| Lua | number w, number h = reaper.ImGui_Viewport_GetSize(ImGui_Viewport viewport) |
|---|
| Python | (float w, float h) = ImGui_Viewport_GetSize(ImGui_Viewport viewport) |
|---|
Main Area: Size of the viewport.
View source
Work Area
Viewport minus task bars, menu bars, status bars
Function: Viewport_GetWorkCenter
| C++ | void ImGui_Viewport_GetWorkCenter(ImGui_Viewport* viewport, double* xOut, double* yOut) |
|---|
| EEL | ImGui_Viewport_GetWorkCenter(ImGui_Viewport viewport, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_Viewport_GetWorkCenter", ImGui_Viewport viewport, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_Viewport_GetWorkCenter(ImGui_Viewport viewport) |
|---|
| Python | (float x, float y) = ImGui_Viewport_GetWorkCenter(ImGui_Viewport viewport) |
|---|
Center of the viewport's work area.
View source
Function: Viewport_GetWorkPos
| C++ | void ImGui_Viewport_GetWorkPos(ImGui_Viewport* viewport, double* xOut, double* yOut) |
|---|
| EEL | ImGui_Viewport_GetWorkPos(ImGui_Viewport viewport, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_Viewport_GetWorkPos", ImGui_Viewport viewport, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_Viewport_GetWorkPos(ImGui_Viewport viewport) |
|---|
| Python | (float x, float y) = ImGui_Viewport_GetWorkPos(ImGui_Viewport viewport) |
|---|
= Viewport_GetPos
View source
Function: Viewport_GetWorkSize
| C++ | void ImGui_Viewport_GetWorkSize(ImGui_Viewport* viewport, double* wOut, double* hOut) |
|---|
| EEL | ImGui_Viewport_GetWorkSize(ImGui_Viewport viewport, &w, &h) |
|---|
| Legacy EEL | extension_api("ImGui_Viewport_GetWorkSize", ImGui_Viewport viewport, &w, &h) |
|---|
| Lua | number w, number h = reaper.ImGui_Viewport_GetWorkSize(ImGui_Viewport viewport) |
|---|
| Python | (float w, float h) = ImGui_Viewport_GetWorkSize(ImGui_Viewport viewport) |
|---|
<= Viewport_GetSize
View source
Window
Functions for creating and manipulating windows.
Note that the bottom of the window stack always contains a window called "Debug".
Function: Begin
| C++ | bool ImGui_Begin(ImGui_Context* ctx, const char* name, bool* p_openInOutOptional = nullptr, int* flagsInOptional = WindowFlags_None) |
|---|
| EEL | bool ImGui_Begin(ImGui_Context ctx, "name", bool &p_open = nullptr, int flags = WindowFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_Begin", ImGui_Context ctx, "name", bool &p_open = nullptr, int flags = WindowFlags_None) |
|---|
| Lua | boolean retval, boolean p_open = reaper.ImGui_Begin(ImGui_Context ctx, string name, boolean p_open = nullptr, number flags = WindowFlags_None) |
|---|
| Python | (bool retval, bool p_open) = ImGui_Begin(ImGui_Context ctx, str name, bool p_open = nullptr, int flags = WindowFlags_None) |
|---|
Push window to the stack and start appending to it.
- Passing true to 'p_open' shows a window-closing widget in the upper-right
corner of the window, which clicking will set the boolean to false when returned.
- You may append multiple times to the same window during the same frame by
calling Begin()/End() pairs multiple times. Some information such as 'flags'
or 'p_open' will only be considered by the first call to Begin().
- Begin() return false to indicate the window is collapsed or fully clipped,
so you may early out and omit submitting anything to the window.
View source
Function: End
| C++ | void ImGui_End(ImGui_Context* ctx) |
|---|
| EEL | ImGui_End(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_End", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_End(ImGui_Context ctx) |
|---|
| Python | ImGui_End(ImGui_Context ctx) |
|---|
Pop window from the stack. See Begin.
View source
Child Windows
Use child windows to begin into a self-contained independent
scrolling/clipping regions within a host window.
Child windows can embed their own child.
Function: BeginChild
| C++ | bool ImGui_BeginChild(ImGui_Context* ctx, const char* str_id, double* size_wInOptional = 0.0, double* size_hInOptional = 0.0, bool* borderInOptional = false, int* flagsInOptional = WindowFlags_None) |
|---|
| EEL | bool ImGui_BeginChild(ImGui_Context ctx, "str_id", size_w = 0.0, size_h = 0.0, bool border = false, int flags = WindowFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_BeginChild", ImGui_Context ctx, "str_id", size_w = 0.0, size_h = 0.0, bool border = false, int flags = WindowFlags_None) |
|---|
| Lua | boolean retval = reaper.ImGui_BeginChild(ImGui_Context ctx, string str_id, number size_w = 0.0, number size_h = 0.0, boolean border = false, number flags = WindowFlags_None) |
|---|
| Python | bool retval = ImGui_BeginChild(ImGui_Context ctx, str str_id, float size_w = 0.0, float size_h = 0.0, bool border = false, int flags = WindowFlags_None) |
|---|
For each independent axis of 'size':
- > 0.0: fixed size
- = 0.0: use remaining host window size
- < 0.0: use remaining window size minus abs(size)
(Each axis can use a different mode, e.g. size = 0x400.)
Returns false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting anything to the window.
View source
Function: BeginChildFrame
| C++ | bool ImGui_BeginChildFrame(ImGui_Context* ctx, const char* str_id, double size_w, double size_h, int* flagsInOptional = WindowFlags_None) |
|---|
| EEL | bool ImGui_BeginChildFrame(ImGui_Context ctx, "str_id", size_w, size_h, int flags = WindowFlags_None) |
|---|
| Legacy EEL | bool extension_api("ImGui_BeginChildFrame", ImGui_Context ctx, "str_id", size_w, size_h, int flags = WindowFlags_None) |
|---|
| Lua | boolean retval = reaper.ImGui_BeginChildFrame(ImGui_Context ctx, string str_id, number size_w, number size_h, number flags = WindowFlags_None) |
|---|
| Python | bool retval = ImGui_BeginChildFrame(ImGui_Context ctx, str str_id, float size_w, float size_h, int flags = WindowFlags_None) |
|---|
Helper to create a child window / scrolling region that looks like a normal
widget frame. See BeginChild.
View source
Function: EndChild
| C++ | void ImGui_EndChild(ImGui_Context* ctx) |
|---|
| EEL | ImGui_EndChild(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_EndChild", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_EndChild(ImGui_Context ctx) |
|---|
| Python | ImGui_EndChild(ImGui_Context ctx) |
|---|
See BeginChild.
View source
Function: EndChildFrame
| C++ | void ImGui_EndChildFrame(ImGui_Context* ctx) |
|---|
| EEL | ImGui_EndChildFrame(ImGui_Context ctx) |
|---|
| Legacy EEL | extension_api("ImGui_EndChildFrame", ImGui_Context ctx) |
|---|
| Lua | reaper.ImGui_EndChildFrame(ImGui_Context ctx) |
|---|
| Python | ImGui_EndChildFrame(ImGui_Context ctx) |
|---|
See BeginChildFrame.
View source
Content Region
Retrieve available space from a given point.
GetContentRegionAvail() is frequently useful.
Function: GetContentRegionAvail
| C++ | void ImGui_GetContentRegionAvail(ImGui_Context* ctx, double* xOut, double* yOut) |
|---|
| EEL | ImGui_GetContentRegionAvail(ImGui_Context ctx, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_GetContentRegionAvail", ImGui_Context ctx, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_GetContentRegionAvail(ImGui_Context ctx) |
|---|
| Python | (float x, float y) = ImGui_GetContentRegionAvail(ImGui_Context ctx) |
|---|
== GetContentRegionMax() - GetCursorPos()
View source
Function: GetContentRegionMax
| C++ | void ImGui_GetContentRegionMax(ImGui_Context* ctx, double* xOut, double* yOut) |
|---|
| EEL | ImGui_GetContentRegionMax(ImGui_Context ctx, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_GetContentRegionMax", ImGui_Context ctx, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_GetContentRegionMax(ImGui_Context ctx) |
|---|
| Python | (float x, float y) = ImGui_GetContentRegionMax(ImGui_Context ctx) |
|---|
Current content boundaries (typically window boundaries including scrolling,
or current column boundaries), in windows coordinates.
View source
Function: GetWindowContentRegionMax
| C++ | void ImGui_GetWindowContentRegionMax(ImGui_Context* ctx, double* xOut, double* yOut) |
|---|
| EEL | ImGui_GetWindowContentRegionMax(ImGui_Context ctx, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_GetWindowContentRegionMax", ImGui_Context ctx, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_GetWindowContentRegionMax(ImGui_Context ctx) |
|---|
| Python | (float x, float y) = ImGui_GetWindowContentRegionMax(ImGui_Context ctx) |
|---|
Content boundaries max (roughly (0,0)+Size-Scroll) where Size can be
overridden with SetNextWindowContentSize, in window coordinates.
View source
Function: GetWindowContentRegionMin
| C++ | void ImGui_GetWindowContentRegionMin(ImGui_Context* ctx, double* xOut, double* yOut) |
|---|
| EEL | ImGui_GetWindowContentRegionMin(ImGui_Context ctx, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_GetWindowContentRegionMin", ImGui_Context ctx, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_GetWindowContentRegionMin(ImGui_Context ctx) |
|---|
| Python | (float x, float y) = ImGui_GetWindowContentRegionMin(ImGui_Context ctx) |
|---|
Content boundaries min (roughly (0,0)-Scroll), in window coordinates.
View source
Debug Windows
Function: ShowAboutWindow
| C++ | void ImGui_ShowAboutWindow(ImGui_Context* ctx, bool* p_openInOutOptional = nullptr) |
|---|
| EEL | ImGui_ShowAboutWindow(ImGui_Context ctx, bool &p_open = nullptr) |
|---|
| Legacy EEL | extension_api("ImGui_ShowAboutWindow", ImGui_Context ctx, bool &p_open = nullptr) |
|---|
| Lua | boolean p_open = reaper.ImGui_ShowAboutWindow(ImGui_Context ctx, boolean p_open = nullptr) |
|---|
| Python | (bool p_open) = ImGui_ShowAboutWindow(ImGui_Context ctx, bool p_open = nullptr) |
|---|
Create About window.
Display ReaImGui version, Dear ImGui version, credits and build/system information.
View source
Function: ShowDebugLogWindow
| C++ | void ImGui_ShowDebugLogWindow(ImGui_Context* ctx, bool* p_openInOutOptional = nullptr) |
|---|
| EEL | ImGui_ShowDebugLogWindow(ImGui_Context ctx, bool &p_open = nullptr) |
|---|
| Legacy EEL | extension_api("ImGui_ShowDebugLogWindow", ImGui_Context ctx, bool &p_open = nullptr) |
|---|
| Lua | boolean p_open = reaper.ImGui_ShowDebugLogWindow(ImGui_Context ctx, boolean p_open = nullptr) |
|---|
| Python | (bool p_open) = ImGui_ShowDebugLogWindow(ImGui_Context ctx, bool p_open = nullptr) |
|---|
Create Debug Log window. display a simplified log of important dear imgui events.
View source
Function: ShowMetricsWindow
| C++ | void ImGui_ShowMetricsWindow(ImGui_Context* ctx, bool* p_openInOutOptional = nullptr) |
|---|
| EEL | ImGui_ShowMetricsWindow(ImGui_Context ctx, bool &p_open = nullptr) |
|---|
| Legacy EEL | extension_api("ImGui_ShowMetricsWindow", ImGui_Context ctx, bool &p_open = nullptr) |
|---|
| Lua | boolean p_open = reaper.ImGui_ShowMetricsWindow(ImGui_Context ctx, boolean p_open = nullptr) |
|---|
| Python | (bool p_open) = ImGui_ShowMetricsWindow(ImGui_Context ctx, bool p_open = nullptr) |
|---|
Create Metrics/Debugger window.
Display Dear ImGui internals: windows, draw commands, various internal state, etc.
View source
Function: ShowStackToolWindow
| C++ | void ImGui_ShowStackToolWindow(ImGui_Context* ctx, bool* p_openInOutOptional = nullptr) |
|---|
| EEL | ImGui_ShowStackToolWindow(ImGui_Context ctx, bool &p_open = nullptr) |
|---|
| Legacy EEL | extension_api("ImGui_ShowStackToolWindow", ImGui_Context ctx, bool &p_open = nullptr) |
|---|
| Lua | boolean p_open = reaper.ImGui_ShowStackToolWindow(ImGui_Context ctx, boolean p_open = nullptr) |
|---|
| Python | (bool p_open) = ImGui_ShowStackToolWindow(ImGui_Context ctx, bool p_open = nullptr) |
|---|
Create Stack Tool window. Hover items with mouse to query information about
the source of their unique ID.
View source
Docking
Dock windows into other windows or in REAPER dockers.
Dock IDs are:
- 0 = undocked
- -1 to -16 = REAPER docker index
- > 0 = Dear ImGui dockspace ID (when the user docked the window into another one).
Set ConfigFlags_DockingEnable when creating your context or with
SetConfigVar(ConfigVar_Flags) to enable docking (disabled by default).
Function: GetWindowDockID
| C++ | int ImGui_GetWindowDockID(ImGui_Context* ctx) |
|---|
| EEL | int ImGui_GetWindowDockID(ImGui_Context ctx) |
|---|
| Legacy EEL | int extension_api("ImGui_GetWindowDockID", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetWindowDockID(ImGui_Context ctx) |
|---|
| Python | int retval = ImGui_GetWindowDockID(ImGui_Context ctx) |
|---|
View source
Function: IsWindowDocked
| C++ | bool ImGui_IsWindowDocked(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_IsWindowDocked(ImGui_Context ctx) |
|---|
| Legacy EEL | bool extension_api("ImGui_IsWindowDocked", ImGui_Context ctx) |
|---|
| Lua | boolean retval = reaper.ImGui_IsWindowDocked(ImGui_Context ctx) |
|---|
| Python | bool retval = ImGui_IsWindowDocked(ImGui_Context ctx) |
|---|
Is current window docked into another window or a REAPER docker?
View source
Function: SetNextWindowDockID
| C++ | void ImGui_SetNextWindowDockID(ImGui_Context* ctx, int dock_id, int* condInOptional = Cond_Always) |
|---|
| EEL | ImGui_SetNextWindowDockID(ImGui_Context ctx, int dock_id, int cond = Cond_Always) |
|---|
| Legacy EEL | extension_api("ImGui_SetNextWindowDockID", ImGui_Context ctx, int dock_id, int cond = Cond_Always) |
|---|
| Lua | reaper.ImGui_SetNextWindowDockID(ImGui_Context ctx, number dock_id, number cond = Cond_Always) |
|---|
| Python | ImGui_SetNextWindowDockID(ImGui_Context ctx, int dock_id, int cond = Cond_Always) |
|---|
View source
Flags
For Begin and BeginChild.
(Those are per-window flags. There are shared flags in SetConfigVar:
ConfigVar_WindowsResizeFromEdges and ConfigVar_WindowsMoveFromTitleBarOnly)
Constant: WindowFlags_AlwaysAutoResize
| C++ | int ImGui_WindowFlags_AlwaysAutoResize |
|---|
| EEL | int ImGui_WindowFlags_AlwaysAutoResize() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_AlwaysAutoResize") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_AlwaysAutoResize() |
|---|
| Python | int retval = ImGui_WindowFlags_AlwaysAutoResize() |
|---|
Resize every window to its content every frame.
View source
Constant: WindowFlags_AlwaysHorizontalScrollbar
| C++ | int ImGui_WindowFlags_AlwaysHorizontalScrollbar |
|---|
| EEL | int ImGui_WindowFlags_AlwaysHorizontalScrollbar() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_AlwaysHorizontalScrollbar") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_AlwaysHorizontalScrollbar() |
|---|
| Python | int retval = ImGui_WindowFlags_AlwaysHorizontalScrollbar() |
|---|
Always show horizontal scrollbar (even if ContentSize.x < Size.x).
View source
Constant: WindowFlags_AlwaysUseWindowPadding
| C++ | int ImGui_WindowFlags_AlwaysUseWindowPadding |
|---|
| EEL | int ImGui_WindowFlags_AlwaysUseWindowPadding() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_AlwaysUseWindowPadding") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_AlwaysUseWindowPadding() |
|---|
| Python | int retval = ImGui_WindowFlags_AlwaysUseWindowPadding() |
|---|
Ensure child windows without border uses StyleVar_WindowPadding
(ignored by default for non-bordered child windows, because more convenient).
View source
Constant: WindowFlags_AlwaysVerticalScrollbar
| C++ | int ImGui_WindowFlags_AlwaysVerticalScrollbar |
|---|
| EEL | int ImGui_WindowFlags_AlwaysVerticalScrollbar() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_AlwaysVerticalScrollbar") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_AlwaysVerticalScrollbar() |
|---|
| Python | int retval = ImGui_WindowFlags_AlwaysVerticalScrollbar() |
|---|
Always show vertical scrollbar (even if ContentSize.y < Size.y).
View source
Constant: WindowFlags_HorizontalScrollbar
| C++ | int ImGui_WindowFlags_HorizontalScrollbar |
|---|
| EEL | int ImGui_WindowFlags_HorizontalScrollbar() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_HorizontalScrollbar") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_HorizontalScrollbar() |
|---|
| Python | int retval = ImGui_WindowFlags_HorizontalScrollbar() |
|---|
Allow horizontal scrollbar to appear (off by default).
You may use SetNextWindowContentSize(width, 0.0) prior to calling Begin() to
specify width. Read code in the demo's "Horizontal Scrolling" section.
View source
Constant: WindowFlags_NoBackground
| C++ | int ImGui_WindowFlags_NoBackground |
|---|
| EEL | int ImGui_WindowFlags_NoBackground() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_NoBackground") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_NoBackground() |
|---|
| Python | int retval = ImGui_WindowFlags_NoBackground() |
|---|
Disable drawing background color (WindowBg, etc.) and outside border.
Similar as using SetNextWindowBgAlpha(0.0).
View source
Constant: WindowFlags_NoCollapse
| C++ | int ImGui_WindowFlags_NoCollapse |
|---|
| EEL | int ImGui_WindowFlags_NoCollapse() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_NoCollapse") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_NoCollapse() |
|---|
| Python | int retval = ImGui_WindowFlags_NoCollapse() |
|---|
Disable user collapsing window by double-clicking on it.
Also referred to as Window Menu Button (e.g. within a docking node).
View source
Constant: WindowFlags_NoDecoration
| C++ | int ImGui_WindowFlags_NoDecoration |
|---|
| EEL | int ImGui_WindowFlags_NoDecoration() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_NoDecoration") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_NoDecoration() |
|---|
| Python | int retval = ImGui_WindowFlags_NoDecoration() |
|---|
WindowFlags_NoTitleBar | WindowFlags_NoResize | WindowFlags_NoScrollbar |
WindowFlags_NoCollapse
View source
Constant: WindowFlags_NoDocking
| C++ | int ImGui_WindowFlags_NoDocking |
|---|
| EEL | int ImGui_WindowFlags_NoDocking() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_NoDocking") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_NoDocking() |
|---|
| Python | int retval = ImGui_WindowFlags_NoDocking() |
|---|
Disable docking of this window.
View source
Constant: WindowFlags_NoFocusOnAppearing
| C++ | int ImGui_WindowFlags_NoFocusOnAppearing |
|---|
| EEL | int ImGui_WindowFlags_NoFocusOnAppearing() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_NoFocusOnAppearing") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_NoFocusOnAppearing() |
|---|
| Python | int retval = ImGui_WindowFlags_NoFocusOnAppearing() |
|---|
Disable taking focus when transitioning from hidden to visible state.
View source
Constant: WindowFlags_NoInputs
| C++ | int ImGui_WindowFlags_NoInputs |
|---|
| EEL | int ImGui_WindowFlags_NoInputs() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_NoInputs") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_NoInputs() |
|---|
| Python | int retval = ImGui_WindowFlags_NoInputs() |
|---|
WindowFlags_NoMouseInputs | WindowFlags_NoNavInputs | WindowFlags_NoNavFocus
View source
Constant: WindowFlags_NoMouseInputs
| C++ | int ImGui_WindowFlags_NoMouseInputs |
|---|
| EEL | int ImGui_WindowFlags_NoMouseInputs() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_NoMouseInputs") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_NoMouseInputs() |
|---|
| Python | int retval = ImGui_WindowFlags_NoMouseInputs() |
|---|
Disable catching mouse, hovering test with pass through.
View source
Constant: WindowFlags_NoMove
| C++ | int ImGui_WindowFlags_NoMove |
|---|
| EEL | int ImGui_WindowFlags_NoMove() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_NoMove") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_NoMove() |
|---|
| Python | int retval = ImGui_WindowFlags_NoMove() |
|---|
Disable user moving the window.
View source
Constant: WindowFlags_NoNav
| C++ | int ImGui_WindowFlags_NoNav |
|---|
| EEL | int ImGui_WindowFlags_NoNav() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_NoNav") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_NoNav() |
|---|
| Python | int retval = ImGui_WindowFlags_NoNav() |
|---|
WindowFlags_NoNavInputs | WindowFlags_NoNavFocus
View source
Constant: WindowFlags_NoNavFocus
| C++ | int ImGui_WindowFlags_NoNavFocus |
|---|
| EEL | int ImGui_WindowFlags_NoNavFocus() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_NoNavFocus") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_NoNavFocus() |
|---|
| Python | int retval = ImGui_WindowFlags_NoNavFocus() |
|---|
No focusing toward this window with gamepad/keyboard navigation
(e.g. skipped by CTRL+TAB).
View source
Constant: WindowFlags_NoNavInputs
| C++ | int ImGui_WindowFlags_NoNavInputs |
|---|
| EEL | int ImGui_WindowFlags_NoNavInputs() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_NoNavInputs") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_NoNavInputs() |
|---|
| Python | int retval = ImGui_WindowFlags_NoNavInputs() |
|---|
No gamepad/keyboard navigation within the window.
View source
Constant: WindowFlags_NoResize
| C++ | int ImGui_WindowFlags_NoResize |
|---|
| EEL | int ImGui_WindowFlags_NoResize() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_NoResize") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_NoResize() |
|---|
| Python | int retval = ImGui_WindowFlags_NoResize() |
|---|
Disable user resizing with the lower-right grip.
View source
Constant: WindowFlags_NoSavedSettings
| C++ | int ImGui_WindowFlags_NoSavedSettings |
|---|
| EEL | int ImGui_WindowFlags_NoSavedSettings() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_NoSavedSettings") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_NoSavedSettings() |
|---|
| Python | int retval = ImGui_WindowFlags_NoSavedSettings() |
|---|
Never load/save settings in .ini file.
View source
Constant: WindowFlags_NoScrollWithMouse
| C++ | int ImGui_WindowFlags_NoScrollWithMouse |
|---|
| EEL | int ImGui_WindowFlags_NoScrollWithMouse() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_NoScrollWithMouse") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_NoScrollWithMouse() |
|---|
| Python | int retval = ImGui_WindowFlags_NoScrollWithMouse() |
|---|
Disable user vertically scrolling with mouse wheel.
On child window, mouse wheel will be forwarded to the parent unless
NoScrollbar is also set.
View source
Constant: WindowFlags_NoScrollbar
| C++ | int ImGui_WindowFlags_NoScrollbar |
|---|
| EEL | int ImGui_WindowFlags_NoScrollbar() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_NoScrollbar") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_NoScrollbar() |
|---|
| Python | int retval = ImGui_WindowFlags_NoScrollbar() |
|---|
Disable scrollbars (window can still scroll with mouse or programmatically).
View source
Constant: WindowFlags_NoTitleBar
| C++ | int ImGui_WindowFlags_NoTitleBar |
|---|
| EEL | int ImGui_WindowFlags_NoTitleBar() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_NoTitleBar") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_NoTitleBar() |
|---|
| Python | int retval = ImGui_WindowFlags_NoTitleBar() |
|---|
Disable title-bar.
View source
Constant: WindowFlags_None
| C++ | int ImGui_WindowFlags_None |
|---|
| EEL | int ImGui_WindowFlags_None() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_None") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_None() |
|---|
| Python | int retval = ImGui_WindowFlags_None() |
|---|
Default flag.
View source
Constant: WindowFlags_TopMost
| C++ | int ImGui_WindowFlags_TopMost |
|---|
| EEL | int ImGui_WindowFlags_TopMost() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_TopMost") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_TopMost() |
|---|
| Python | int retval = ImGui_WindowFlags_TopMost() |
|---|
Show the window above all non-topmost windows.
View source
Constant: WindowFlags_UnsavedDocument
| C++ | int ImGui_WindowFlags_UnsavedDocument |
|---|
| EEL | int ImGui_WindowFlags_UnsavedDocument() |
|---|
| Legacy EEL | int extension_api("ImGui_WindowFlags_UnsavedDocument") |
|---|
| Lua | number retval = reaper.ImGui_WindowFlags_UnsavedDocument() |
|---|
| Python | int retval = ImGui_WindowFlags_UnsavedDocument() |
|---|
Display a dot next to the title. When used in a tab/docking context,
tab is selected when clicking the X + closure is not assumed
(will wait for user to stop submitting the tab).
Otherwise closure is assumed when pressing the X,
so if you keep submitting the tab may reappear at end of tab bar.
View source
Properties
Prefer using SetNextWindow* functions (before Begin) rather that SetWindow* functions
(after Begin).
'Current window' = the window we are appending into while inside a Begin()/End()
block. 'Next window' = next window we will Begin() into.
Function: GetWindowDpiScale
| C++ | double ImGui_GetWindowDpiScale(ImGui_Context* ctx) |
|---|
| EEL | double ImGui_GetWindowDpiScale(ImGui_Context ctx) |
|---|
| Legacy EEL | double extension_api("ImGui_GetWindowDpiScale", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetWindowDpiScale(ImGui_Context ctx) |
|---|
| Python | float retval = ImGui_GetWindowDpiScale(ImGui_Context ctx) |
|---|
Get DPI scale currently associated to the current window's viewport
(1.0 = 96 DPI).
View source
Function: GetWindowHeight
| C++ | double ImGui_GetWindowHeight(ImGui_Context* ctx) |
|---|
| EEL | double ImGui_GetWindowHeight(ImGui_Context ctx) |
|---|
| Legacy EEL | double extension_api("ImGui_GetWindowHeight", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetWindowHeight(ImGui_Context ctx) |
|---|
| Python | float retval = ImGui_GetWindowHeight(ImGui_Context ctx) |
|---|
Get current window height (shortcut for (select(2, GetWindowSize())).
View source
Function: GetWindowPos
| C++ | void ImGui_GetWindowPos(ImGui_Context* ctx, double* xOut, double* yOut) |
|---|
| EEL | ImGui_GetWindowPos(ImGui_Context ctx, &x, &y) |
|---|
| Legacy EEL | extension_api("ImGui_GetWindowPos", ImGui_Context ctx, &x, &y) |
|---|
| Lua | number x, number y = reaper.ImGui_GetWindowPos(ImGui_Context ctx) |
|---|
| Python | (float x, float y) = ImGui_GetWindowPos(ImGui_Context ctx) |
|---|
Get current window position in screen space (useful if you want to do your own
drawing via the DrawList API).
View source
Function: GetWindowSize
| C++ | void ImGui_GetWindowSize(ImGui_Context* ctx, double* wOut, double* hOut) |
|---|
| EEL | ImGui_GetWindowSize(ImGui_Context ctx, &w, &h) |
|---|
| Legacy EEL | extension_api("ImGui_GetWindowSize", ImGui_Context ctx, &w, &h) |
|---|
| Lua | number w, number h = reaper.ImGui_GetWindowSize(ImGui_Context ctx) |
|---|
| Python | (float w, float h) = ImGui_GetWindowSize(ImGui_Context ctx) |
|---|
Get current window size
View source
Function: GetWindowWidth
| C++ | double ImGui_GetWindowWidth(ImGui_Context* ctx) |
|---|
| EEL | double ImGui_GetWindowWidth(ImGui_Context ctx) |
|---|
| Legacy EEL | double extension_api("ImGui_GetWindowWidth", ImGui_Context ctx) |
|---|
| Lua | number retval = reaper.ImGui_GetWindowWidth(ImGui_Context ctx) |
|---|
| Python | float retval = ImGui_GetWindowWidth(ImGui_Context ctx) |
|---|
Get current window width (shortcut for (select(1, GetWindowSize())).
View source
Function: IsWindowAppearing
| C++ | bool ImGui_IsWindowAppearing(ImGui_Context* ctx) |
|---|
| EEL | bool ImGui_IsWindowAppearing(ImGui_Context ctx) |
|---|
| Legacy EEL | |
|---|