Skip to content

DaltonLens/DaltonLens

Repository files navigation

CMake Build and Test Xcode - Build

DaltonLens

DaltonLens is a utility to help colorblind people by providing color filters and highlighting tools. It is especially useful to read color-coded charts and plots. Here are the main features:

  • Runs as a tray program and always instantly available via the CMD/Win + Alt + Ctrl + Space global shortchut.

  • Can show an overlay over your screen to get information about the color under the mouse pointer, including its name.

  • Grab a screen region and apply color filters on top of it. The current filters include the daltonize algorithm to transfer the color differences into color channels that are easier to distinguish.

  • Click on a pixel and highlight similar colors in the image. This is especially useful for charts and plots, and it uses adaptive filters to better handle anti-aliased line plots.

  • Simulate color vision deficiencies

It is designed to be lightweight and very reactive by relying mostly on GPU processing.

It is part of the daltonlens.org project.

Getting started

Then you will see a menu tray icon showing that the program is running.

  • You can select the Grab Screen Region menu item there, but the recommend way is to use the global shortcut Ctrl+Alt+Cmd/Win+Space to activate it and get an overlay showing color information about the pixel under the mouse pointer.
  • Then q or escape to exit the pointer overlay, or click and drag over a region to select it. You can also hit Space to automatically select the window under the cursor.
  • Once in the image viewer window you can click on a pixel to highlight similar colors in the image.
  • Use the controls window to switch the filter / configure the options
  • The help menu item gives all the shortcuts. Shift is particularly useful to show the original image regardless of what mode you are currently in.

Demo video & screenshots

DaltonLens_Highlighting_1920x1080.mp4

Highlight Similar Pixels

Apply Color Filters

Help Window

Supported platforms

  • macOS: Mojave (10.14) and newer are supported (including Apple Silicon)
  • Windows: only tested on Windows 10, but anything more recent than Windows 8.1 should work
  • Linux: only tested on Ubuntu 20.04, but should work on any distribution that has gtk3 and libappindicator3.

Building the source code

Building on macOS

Open DaltonLens/macOS/DaltonLens.xcodeproj in Xcode. There are precompiled binaries for the dependencies, so it should just build.

To rebuild the dependencies (glfw and clip, even though only glfw is actually used), run the deps/update_dependencies_prebuilt_binaries.sh script. You will need cmake and the Xcode command line tools installed.

Building on Linux

Just run cmake after installing the required dependencies. Mostly X11, but unfortunately also GTK via libappindicator to get the system tray icon. Hope to get rid of that dependency one day!

Here the apt-get command line tested with Kubuntu 20.04:

sudo apt-get install libx11-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libgl-dev libappindicator3-dev libxcb1-dev

Building on Windows

Run cmake with the Visual Studio Express or Ninja generator.

Dependencies

All the dependencies are embedded in the repository to avoid version hell, so you don't need to install anything. Still listing the dependencies here for awareness:

Donate

I use DaltonLens daily myself, so this donate button is mostly here to give you a chance to say thanks and make me enjoy the special taste of a free coffee :-) If it ever becomes significant I will use it to cover some hardware cost for deep learning as I'm planning to develop smarter color analysis algorithms for chart analysis.

paypal

License: BSD (with 2 clauses)