Struct PlotContext 

pub struct PlotContext { /* private fields */ }

ImPlot context that manages the plotting state

This context is separate from the Dear ImGui context but works alongside it. You need both contexts to create plots.

Implementations

impl PlotContext

pub fn try_create(imgui_ctx: &ImGuiContext) -> ImGuiResult<Self>

Try to create a new ImPlot context

This should be called after creating the Dear ImGui context. The ImPlot context will use the same Dear ImGui context internally.

pub fn create(imgui_ctx: &ImGuiContext) -> Self

Create a new ImPlot context (panics on error)

pub fn get_plot_ui<'ui>(&'ui self, ui: &'ui Ui) -> PlotUi<'ui>

Get a PlotUi for creating plots

This borrows both the ImPlot context and the Dear ImGui Ui, ensuring that plots can only be created when both are available.

pub unsafe fn raw(&self) -> *mut ImPlotContext

Get the raw ImPlot context pointer

Safety

The caller must ensure the pointer is used safely and not stored beyond the lifetime of this context.

impl PlotContext

pub fn add_colormap( &self, name: &str, colors: &[[f32; 4]], qualitative: bool, ) -> ColormapIndex

Add a custom colormap from colors. The colors are copied by ImPlot.

pub fn colormap_count(&self) -> usize

Return the number of available colormaps.

pub fn colormap_name(&self, index: impl Into<ColormapIndex>) -> String

Return a colormap name, or an empty string if the index is invalid for this context.

pub fn colormap_index_by_name(&self, name: &str) -> Option<ColormapIndex>

Look up a colormap index by its name.

pub fn colormap_size(&self, index: impl Into<ColormapIndex>) -> usize

Return the number of color entries in a colormap.

pub fn style_colormap_index(&self) -> Option<ColormapIndex>

Return the default colormap stored in this ImPlot context’s style.

pub fn style_colormap_name(&self) -> Option<String>

Return this context’s default colormap name.

pub fn set_style_colormap(&self, index: impl Into<ColormapIndex>)

Permanently set the default colormap used by this ImPlot context.

pub fn set_style_colormap_by_name(&self, name: &str)

Permanently set the default colormap by name. Invalid names are ignored.

pub fn colormap_color(&self, index: ColormapColorIndex) -> [f32; 4]

Return a color from this context’s active colormap.

pub fn colormap_color_from( &self, index: ColormapColorIndex, cmap: impl Into<ColormapIndex>, ) -> [f32; 4]

Return a color from a selected colormap.

pub fn sample_colormap(&self, t: f32) -> [f32; 4]

Sample this context’s active colormap at t in [0, 1].

pub fn sample_colormap_from( &self, t: f32, cmap: impl Into<ColormapSelection>, ) -> [f32; 4]

Sample a selected colormap at t in [0, 1].

pub fn next_colormap_color(&self) -> [f32; 4]

Return the next color from this context’s current colormap and advance its color cursor.

pub fn map_input_default(&self)

Map this context’s input scheme to ImPlot defaults.

pub fn map_input_reverse(&self)

Map this context’s input scheme to ImPlot’s reversed scheme.

Trait Implementations

impl Drop for PlotContext

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.