/cvui

A (very) simple UI lib built on top of OpenCV drawing primitives

Primary LanguageC++MIT LicenseMIT

cvui

A (very) simple UI lib built on top of OpenCV drawing primitives. Other UI libs, such as imgui, require a graphical backend (e.g. OpenGL) to work, so if you want to use imgui in a OpenCV app, you must make it OpenGL enabled, for instance. It is not the case with cvui, which uses only OpenCV drawing primitives to do all the rendering (no OpenGL or Qt required).

image

Features

  • Lightweight and simple to use user interface.
  • Header-only with no external dependencies (except OpenCV).
  • Based on OpenCV drawing primitives only (OpenGL or Qt are not required).
  • Friendly and C-like API (no classes/objects, etc).
  • Easily render components without worrying about their position (using rows/columns).
  • MIT licensed.

Build

The only dependency is OpenCV (version 2.x or 3.x), which you are probably already using. Just add cvui.h to your project and you are ready to go.

Usage

Check the examples folder for some code, but the general idea is the following:

#include <iostream>

#include "opencv2/core/core.hpp"
#include "opencv2/highgui/highgui.hpp"

#define WINDOW_NAME		"CVUI Test"

int main(int argc, const char *argv[])
{
	cv::Mat frame = cv::Mat(250, 600, CV_8UC3);
	bool checked = false;
	int count = 0;

	cv::namedWindow(WINDOW_NAME);
	cvui::init(WINDOW_NAME);

	while (true) {
		frame = cv::Scalar(49, 52, 49);

		cvui::text(frame, 50, 30, "Hey there!");
		cvui::text(frame, 200, 30, "Use hex 0xRRGGBB colors easily", 0.4, 0xff0000);

		if (cvui::button(frame, 50, 50, "Button")) {
			std::cout << "Button clicked!" << std::endl;
		}

		cvui::window(frame, 50, 100, 120, 100, "Window");
		cvui::counter(frame, 200, 100, &count);
		cvui::checkbox(frame, 200, 150, "Checkbox", &checked);

		cvui::update();

		cv::imshow(WINDOW_NAME, frame);
        cv::waitKey(30);
	}

	return 0;
}

License

Copyright (c) 2016 Fernando Bevilacqua. Licensed under the MIT license.

Change log

See all changes in the CHANGELOG file.