Skip to content

Latest commit

 

History

History
119 lines (77 loc) · 4.74 KB

README.md

File metadata and controls

119 lines (77 loc) · 4.74 KB
Raw

DPF Widgets

Official and Community made reusable GUI widgets for DPF

This is a repository for shared GUI widgets targetting DPF.

Since DPF allows multiple backends (cairo, opengl or vulkan), we need to split them as such. Each folder provides widgets for its dedicated backend type. It is not mandatory that a widget is usable for more than 1 backend. Generic widgets (those based on DPF core classes like Color, Rectangle, etc) are placed under the "generic" directory.

Status

generic / ResizeHandle

Resize handle for DPF windows, will sit on bottom-right.

Works in both Cairo and OpenGL modes (classic/legacy OpenGL only, does not support OpenGL3 mode).

Used very often and in many plugins.

generic / LVGL

screenshot

Exposes the LVGL drawing API inside a DGL Widget. This class will take care of setting up LVGL for drawing, and also user input, resizes and everything in between.

See lvgl-template-plugin for a CMake-based template plugin project around LVGL.

opengl / Blendish

screenshot

oui-blendish widgets for DPF. Work in progress, usable in very select cases.

Used in:

opengl / DearImGui

screenshot

Exposes the Dear ImGui drawing API inside a DGL Widget. The drawing function onDisplay() is implemented internally but a new onImGuiDisplay() needs to be overridden instead. This class will take care of setting up ImGui for drawing, and also also user input, resizes and everything in between.

Used in:

See imgui-template-plugin for a CMake-based template plugin project around ImGui. See imgui-template-app for a standalone application template.

opengl / DearImGuiColorTextEditor

screenshot

Text Editor Widget class, based on ImGuiColorTextEdit.

Used in:

opengl / Quantum

screenshot

Quanta-inspired widgets for DPF.

Used in:

Rules and Layout

Each widget MUST follow these rules:

  1. contain exactly 1 header file, with hpp extension
  2. must subclass SubWidget (for cairo use CairoSubWidget, nanovg should use NanoSubWidget) or TopLevelWidget
  3. widget name must match filename
  4. must have DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(ClassName) at the end of its class definition
  5. filenames must avoid generic terms such as widget
  6. contain 0 or 1 implementation files, with cpp extension and same basename as the matching hpp file
  7. optionally contain extra files, directly included from the cpp file
  8. place any extra files under a directory with the same basename as the cpp file, minus the file extension
  9. try to be self-contained, not needing externally installed dependencies (besides the locally available extra files defined in the previous point)
  10. be contained within DGL_NAMESPACE
  11. have clear documentation specifying its use
  12. be cross-platform (win32 and posix)
  13. be liberally licensed (the same way as DPF or with a compatible license allowing commercial use)

Coding style rules yet to be defined.