implot-rs/README.md

implot-rs

Rust bindings for ImPlot, built by running bindgen on cimplot.

Requirements

imgui-rs requires minimum Rust version 1.40, so this project does as well by extension. Currently the master branch of imgui-rs is used as a dependency until https://github.com/Gekkio/imgui-rs/pull/339 makes it into a release.

The sys crate compiles implot, so a C++ compiler will also be required.

Examples

Examples are being built in the implot-examples crate in this repo. To try them out, clone the repo, change into the implot-examples directory and try for example

  cargo run --example line_plots

Documentation

Since the crate is not released yet, the documentation is not hosted yet either. You can build it yourself however by cloning this repo and then doing

  cargo doc --open

An effort is made to document everything as it is being added. Feel free to open an issue if documentation is unclear or lacking.

Design approach

This repo tries to follow the approaches and style used in imgui-rs somewhat closely, because implot is to be used within imgui programs, and hence keeping the interfaces and design philosophies close should make it easier to do that.

If you spot any design inconsistencies or papercuts, feel free to open an issue.

Status

Currently a work in progress. The author is open to collaboration, if you'd like to help, feel free to reach out via a Github issue.

Note that the API is not stabilized yet and expected to change as development progresses. Once there are actual releases on crates.io, semantic versioning will be followed.

At this point, raw bindings are working in implot-sys, and more idiomatic interfaces for plot creation as well a subset of the functionality for plots are implemented. See below for an overview of the progress.

• "BeginPlot"
  • Basic hello world
  • Plot flags
• Plotting functionality
  • Line plot
  • Text plot
  • Scatter plot
  • Bar plot
    • Vertical
    • Horizontal
  • Error bar plot
    • Vertical
    • Horizontal
  • Heatmap
  • Pie chart
  • Digital data
• Plot customization
  • Axis flags
  • Styling colors
  • Styling variables
  • Colormaps
• Plot querying
  • is hovered
  • mouse position in plot
  • plot limits
  • is queried
  • get plot query
  • Choice of y axis
• Utils
  • Plot limit setting
  • imgui-rs style safe push/pop stacks
  • Plot tick setting
  • Set Y axis setting for subsequent elements
  • Plot position and size reading
  • Pixel to plot position
  • Plot to pixel position
  • Push/pop plotclip rect (?)