Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.55 KB

README.md

File metadata and controls

39 lines (27 loc) · 1.55 KB
Raw

ImGui Knobs

This is a port/adaptation of imgui-rs-knobs, for C++.

image

Usage

Add imgui-knobs.cpp and imgui-knobs.h to your project and include imgui-knobs.h in some source file.

static float value = 0;

if (ImGuiKnobs::Knob("Volume", &value, -6.0f, 6.0f, 0.1f, "%.1fdB", ImGuiKnobVariant_Tick)) {
    // value was changed
}

Draw knobs using either Knob or KnobInt. The API is:

bool ImGuiKnobs::Knob(label, *value, min, max, [speed, format, variant, size, flags, steps])
bool ImGuiKnobs::KnobInt(label, *value, min, max, [speed, format, variant, size, flags, steps])

Variants

variant determines the visual look of the knob. Available variants are: ImGuiKnobVariant_Tick, ImGuiKnobVariant_Dot, ImGuiKnobVariant_Wiper, ImGuiKnobVariant_WiperOnly, ImGuiKnobVariant_WiperDot, ImGuiKnobVariant_Stepped, ImGuiKnobVariant_Space.

Flags

  • ImGuiKnobFlags_NoTitle: Hide the top title.
  • ImGuiKnobFlags_NoInput: Hide the bottom drag input.
  • ImGuiKnobFlags_ValueTooltip: Show a tooltip with the current value on hover.
  • ImGuiKnobFlags_DragHorizontal: Use horizontal dragging (default is vertical).

Size

You can specify a size given as the width of the knob (will be scaled according to ImGui's FontGlobalScale). Default (0) will use 4x line height.

Steps

Steps determines the number of steps draw, it is only used for the ImGuiKnobVariant_Stepped variant.