docs.rs failed to build dear-implot3d-0.3.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

Visit the last successful build: dear-implot3d-0.8.0

dear-implot3d

High-level Rust bindings for ImPlot3D, integrating with dear-imgui-rs.

This crate sits on top of dear-implot3d-sys (FFI to cimplot3d) and mirrors the ergonomics of dear-implot.

Compatibility

Item	Version
Crate	0.3.x
dear-imgui-rs	0.3.x
dear-implot3d-sys	0.3.x

See also: docs/COMPATIBILITY.md in the workspace for the full matrix.

Features

Safe, idiomatic Rust API - Type-safe wrappers over the C API
Builder pattern - Fluent API for configuring plots
RAII tokens - Automatic cleanup with Plot3DToken
Type-safe flags - Using bitflags! for compile-time safety
Modular plot types - Separate modules for each plot type
f32/f64 support - Separate functions for different numeric types
Optional mint support - Interoperability with math libraries (glam, nalgebra, cgmath, etc.)
Predefined meshes - Cube, sphere meshes included
Comprehensive API - Line, scatter, surface, triangle, quad, mesh, image, and text plots

Quick Start

use dear_imgui_rs::*;
use dear_implot3d::*;

let mut imgui_ctx = Context::create();
let plot3d_ctx = Plot3DContext::create(&imgui_ctx);

// In your main loop:
let ui = imgui_ctx.frame();
let plot_ui = plot3d_ctx.get_plot_ui(&ui);

if let Some(_token) = plot_ui.begin_plot("3D Demo")
    .size([600.0, 400.0])
    .build()
{
    plot_ui.setup_axes("X", "Y", "Z",
        Axis3DFlags::NONE,
        Axis3DFlags::NONE,
        Axis3DFlags::NONE);

    let xs = [0.0, 1.0, 2.0];
    let ys = [0.0, 1.0, 0.0];
    let zs = [0.0, 0.5, 1.0];
    plot_ui.plot_line_f32("Line", &xs, &ys, &zs, Line3DFlags::NONE);
}

Examples

See examples/implot3d_basic.rs for a comprehensive demo that replicates the official ImPlot3D C++ demo.

Run with:

cargo run -p dear-imgui-examples --bin implot3d_basic --features "dear-implot3d, dear-app/implot3d"

Predefined Meshes

The meshes module provides ready-to-use mesh data:

use dear_implot3d::meshes::*;

// Cube (8 vertices, 36 indices)
plot_ui.mesh("Cube", CUBE_VERTICES, CUBE_INDICES).plot();

// Sphere (162 vertices, 960 indices)
plot_ui.mesh("Sphere", SPHERE_VERTICES, SPHERE_INDICES).plot();

Mint Support

When the mint feature is enabled, you can use mint::Point3<f32> types:

use mint::Point3;

let points = vec![
    Point3 { x: 0.0, y: 0.0, z: 0.0 },
    Point3 { x: 1.0, y: 1.0, z: 1.0 },
];

plot_ui.plot_line_mint("Line", &points, Line3DFlags::NONE);

Notes

The underlying C API comes from cimplot3d which depends on implot3d. Ensure git submodules are initialized with --recursive.

License

See workspace root.

dear-implot3d 0.3.0