Docs: Improve documentation #154
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 tasks
github-actions
bot
added
status:review
Copilot finished reviewing on behalf of
brenocq
November 17, 2025 19:11
There was a problem hiding this comment.
Pull Request Overview
This PR significantly improves ImPlot3D's documentation and functionality by adding 8 new demos, introducing utility API functions, fixing critical bugs, and standardizing file headers with MIT license text.
- Adds comprehensive demos for offset/stride, colored scatter, equal axes, auto-fitting, mouse picking, and custom overlays
- Introduces
PlotDummy(),ShowStyleSelector(),ShowColormapSelector(), andShowAboutWindow()APIs - Fixes negative offset handling bug using proper modulo arithmetic and corrects ray direction for pixel-to-plot conversion
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| implot3d_meshes.cpp | Adds MIT license header |
| implot3d_items.cpp | Adds MIT license header, fixes negative offset handling with ImPosMod, implements PlotDummy |
| implot3d_internal.h | Adds MIT license header, introduces ImPosMod utility function for proper modulo |
| implot3d_demo.cpp | Adds MIT license, 8 new demos (offset/stride, legend options, equal axes, auto-fitting, mouse picking, custom overlay, per-point style, config tab), MetricFormatter, ShowAboutWindow |
| implot3d.h | Adds MIT license, extensive API documentation improvements, new API functions, deprecation section for renamed functions |
| implot3d.cpp | Adds MIT license, API breaking changes log, implements new selector functions, ray direction fix, obsolete API wrappers |
| example/main.cpp | Adds MIT license header |
| example/CMakeLists.txt | Updates ImPlot dependency to newer commit |
…tSize Rename GetPlotPos() -> GetPlotRectPos() and GetPlotSize() -> GetPlotRectSize() for better clarity in 3D context. The "Rect" suffix makes it explicit these functions return the 2D screen rectangle, not 3D plot space coordinates. Old functions are marked as deprecated using IMPLOT3D_DEPRECATED and will be removed in v1.0. Add IMPLOT3D_DISABLE_OBSOLETE_FUNCTIONS to stay ahead of removals, or IMPLOT3D_DISABLE_OBSOLETE_WARNINGS to suppress deprecation warnings. BREAKING CHANGE: GetPlotPos/GetPlotSize are deprecated (still work with warnings). Update code to use GetPlotRectPos/GetPlotRectSize.
- Add MetricFormatter helper for metric prefixes (G/M/k/m/u/n) - Demonstrate custom axis formatter callbacks - Show Y-axis as Hz and Z-axis as m with proper unit formatting
- Add ShowStyleSelector() and ShowColormapSelector() API functions - Create Config demo tab with font, style, and colormap selectors - Remove duplicate ShowStyleSelector from demo file
- Add "Custom Per-Point Style" demo with colored toruses - Add PlotDummy() API function for legend customization
brenocq
force-pushed
the
docs/improve-documentation
branch
from
d90194c to
0be6212
Compare
brenocq
force-pushed
the
docs/improve-documentation
branch
from
0be6212 to
862b128
Compare
github-actions
bot
added
status:done
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #99
This PR improves the documentation of the public and internal APIs, adds license information to all files, and implements many new demos. Below are the list of changes.
9 New Demos:
- Offset and Stride
- Legend Options
- Equal Axes
- Auto-Fitting Data
- Mouse Picking
- Custom Overlay (tooltips, gizmo, overlays)
- Colored Scatter (per-point coloring with toruses)
- Config Tab
- About Window
New API Functions:
-
PlotDummy()- Demoed to modify item color in legend-
ShowStyleSelector()/ShowColormapSelector()- Style/colormap-
ShowAboutWindow()- About dialogBug Fixes:
- Wrong negative offset handling
- Wrong ray direction for
PixelsToPlotRayBreaking Changes:
-
GetPlotPos()→GetPlotRectPos()-
GetPlotSize()→GetPlotRectSize()