Skip to content

figure_implot ​

figure_implot, ImPlot plots with Fortran arrays.

Every drawing procedure of this module refuses a call from a task (FIG_ERR_STATE): see processes.md; and a call with no frame open, a usage error (FIG_ERR_STATE, <procedure>: no frame open). Every begin/end and push/pop pair registers in the scope record of the frame, which checks each end before Dear ImGui sees it: a wrong end is refused and reported by app%next_frame (app%set_checks; errors.md, "Pairing and frames").

ip_begin_plot returns true when the plot is visible: then declare its axes and items and close it with ip_end_plot (only in that case). Items (ip_line, ip_scatter, ip_bars, ip_shaded, ip_error_bars) take real(real32) or real(real64) arrays of any stride (a matrix row y(i,:), y(::2), a component of an array of derived types runs%cl), read in place during the call: they go to ImPlot's float* or double* items with ImPlot's byte stride (ImPlotSpec::Stride). ImPlot has one stride for all the arrays of an item: an array whose stride differs from the ordinates' is copied, laid out at their stride. Abscissae may be integer(int32) or integer(int64) (iteration counters): ImPlot reads x and y of one type, so they are converted into a temporary. The items' array dummies are ASYNCHRONOUS: nvfortran then passes strided sections in place instead of copying them before the call (what each compiler passes: plots.md, "Data in place"). The stride helpers' dummies are too: without it nvfortran copies at the inner call, and the address given to ImPlot is that of a freed temporary.

Every item takes an optional spec, built by ip_spec from ImPlot's defaults (automatic colours, no markers):

fortran
 call ip_line('residual', it, res, spec=ip_spec(line_color=[1.0_real64, 0.0_real64, 0.0_real64, 1.0_real64], &
                                               line_weight=2.0_real64, marker=ImPlotMarker_Circle))

Source: src/lib/figure_implot.F90

Dependencies

Re-exports ​

NameKindModuleDescription
ImPlotMarker_Noneparameterfigure_cimplot_enums
ImPlotMarker_Autoparameterfigure_cimplot_enums
ImPlotMarker_Circleparameterfigure_cimplot_enums
ImPlotMarker_Squareparameterfigure_cimplot_enums
ImPlotMarker_Diamondparameterfigure_cimplot_enums
ImPlotMarker_Upparameterfigure_cimplot_enums
ImPlotMarker_Downparameterfigure_cimplot_enums
ImPlotMarker_Leftparameterfigure_cimplot_enums
ImPlotMarker_Rightparameterfigure_cimplot_enums
ImPlotMarker_Crossparameterfigure_cimplot_enums
ImPlotMarker_Plusparameterfigure_cimplot_enums
ImPlotMarker_Asteriskparameterfigure_cimplot_enums
ImPlotMarker_Verticalparameterfigure_cimplot_enums
ImPlotMarker_Horizontalparameterfigure_cimplot_enums
ImPlotItemFlags_Noneparameterfigure_cimplot_enums
ImPlotItemFlags_NoLegendparameterfigure_cimplot_enums
ImPlotItemFlags_NoFitparameterfigure_cimplot_enums
ImPlotLineFlags_Segmentsparameterfigure_cimplot_enums
ImPlotLineFlags_Loopparameterfigure_cimplot_enums
ImPlotLineFlags_SkipNaNparameterfigure_cimplot_enums
ImPlotLineFlags_NoClipparameterfigure_cimplot_enums
ImPlotLineFlags_Shadedparameterfigure_cimplot_enums
ImPlotScatterFlags_NoClipparameterfigure_cimplot_enums
ImPlotBarsFlags_Horizontalparameterfigure_cimplot_enums
ImPlotStairsFlags_PreStepparameterfigure_cimplot_enums
ImPlotStairsFlags_Shadedparameterfigure_cimplot_enums
ImPlotStemsFlags_Horizontalparameterfigure_cimplot_enums
ImPlotInfLinesFlags_Horizontalparameterfigure_cimplot_enums
ImPlotHistogramFlags_Horizontalparameterfigure_cimplot_enums
ImPlotHistogramFlags_Cumulativeparameterfigure_cimplot_enums
ImPlotHistogramFlags_Densityparameterfigure_cimplot_enums
ImPlotHistogramFlags_NoOutliersparameterfigure_cimplot_enums
ImPlotBin_Sqrtparameterfigure_cimplot_enums
ImPlotBin_Sturgesparameterfigure_cimplot_enums
ImPlotBin_Riceparameterfigure_cimplot_enums
ImPlotBin_Scottparameterfigure_cimplot_enums
ImPlotColormap_Deepparameterfigure_cimplot_enums
ImPlotColormap_Darkparameterfigure_cimplot_enums
ImPlotColormap_Pastelparameterfigure_cimplot_enums
ImPlotColormap_Pairedparameterfigure_cimplot_enums
ImPlotColormap_Viridisparameterfigure_cimplot_enums
ImPlotColormap_Plasmaparameterfigure_cimplot_enums
ImPlotColormap_Hotparameterfigure_cimplot_enums
ImPlotColormap_Coolparameterfigure_cimplot_enums
ImPlotColormap_Pinkparameterfigure_cimplot_enums
ImPlotColormap_Jetparameterfigure_cimplot_enums
ImPlotColormap_Twilightparameterfigure_cimplot_enums
ImPlotColormap_RdBuparameterfigure_cimplot_enums
ImPlotColormap_BrBGparameterfigure_cimplot_enums
ImPlotColormap_PiYGparameterfigure_cimplot_enums
ImPlotColormap_Spectralparameterfigure_cimplot_enums
ImPlotColormap_Greysparameterfigure_cimplot_enums

Contents ​

Variables ​

NameTypeAttributesDescription
subplots_seencharacter(len=128)allocatableTitles of the subplot figures drawn so far.
fits_pendinginteger(kind=int32)Plots of a new subplot figure still to fit to their data.
plot_copiesinteger(kind=int64)Arrays the items copied because ImPlot could not read them in place (strides, integer abscissae): test_plot_copies.
plot_strideinteger(kind=int64)Byte stride given to ImPlot for the last item: test_plot_stride.
scratch_r32type(buffer_r32)targetSingle precision.
scratch_r64type(buffer_r64)targetDouble precision.
scratch_frameinteger(kind=int32)Dear ImGui frame of the last copy into the scratch; -1: none kept.

Derived Types ​

plot_spec_object ​

Style of a plot item: colours, line weight, markers, flags. Build it with ip_spec.

The C struct is private so that a spec always starts from ImPlot's defaults: a zeroed one would draw nothing (line weight 0, marker size 0).

Components

NameTypeAttributesDescription
ctype(im_plot_spec)ImPlotSpec, as passed to ImPlot.

buffer_r32 ​

A scratch array of the items (single precision): the temporary of an array ImPlot cannot read in place.

Components

NameTypeAttributesDescription
vreal(kind=real32)allocatableValues, at the item's stride.

buffer_r64 ​

A scratch array of the items (double precision): the temporary of an array ImPlot cannot read in place.

Components

NameTypeAttributesDescription
vreal(kind=real64)allocatableValues, at the item's stride.

series_r32 ​

Where ImPlot reads the arrays of one item (single precision): one address per array and the byte stride they share (ImPlot applies one stride to all the arrays of an item); an array copied is read from its slot's scratch.

Components

NameTypeAttributesDescription
ptype(c_ptr)Addresses: 1 x, 2 y (sets the stride), 3-4 the other ordinates.
strideinteger(kind=int64)Stride of every array [bytes].

series_r64 ​

Where ImPlot reads the arrays of one item (double precision): one address per array and the byte stride they share (ImPlot applies one stride to all the arrays of an item); an array copied is read from its slot's scratch.

Components

NameTypeAttributesDescription
ptype(c_ptr)Addresses: 1 x, 2 y (sets the stride), 3-4 the other ordinates.
strideinteger(kind=int64)Stride of every array [bytes].

Interfaces ​

ip_line ​

Line through the points (x(i), y(i)); or through y(i) at uniformly spaced x, from a vector or from a row of a matrix. Arrays of any stride are read in place (plots.md, "Data in place"); x may be int32 or int64.

Module procedures: ip_line_r32, ip_line_r64, ip_line_values_r32, ip_line_values_r64, ip_line_row_r32, ip_line_row_r64, ip_line_i32_r32, ip_line_i64_r32, ip_line_i32_r64, ip_line_i64_r64

ip_scatter ​

Markers at the points (x(i), y(i)).

Module procedures: ip_scatter_r32, ip_scatter_r64, ip_scatter_i32_r32, ip_scatter_i64_r32, ip_scatter_i32_r64, ip_scatter_i64_r64

ip_digital ​

A digital signal: y(i) at x(i), drawn as bars of the signal's height in a band at the bottom of the plot.

Module procedures: ip_digital_r32, ip_digital_r64

ip_bar_groups ​

Items in groups of bars: values(g, i), item i in group g.

Module procedures: ip_bar_groups_r32, ip_bar_groups_r64

ip_bars ​

Bars of height y(i) centred at x(i).

Module procedures: ip_bars_r32, ip_bars_r64, ip_bars_i32_r32, ip_bars_i64_r32, ip_bars_i32_r64, ip_bars_i64_r64

ip_field_image ​

A field through a colormap, kept as a texture: real32 or real64.

Module procedures: ip_field_image_r32, ip_field_image_r64

ip_heatmap ​

A 2D field f(i, j) as coloured cells: i along x, j along y, j = 1 at the bottom.

Module procedures: ip_heatmap_r32, ip_heatmap_r64

ip_bubbles ​

Circles at the points (x(i), y(i)) of radius radii(i), in plot units along both axes (PlotBubbles).

Module procedures: ip_bubbles_r32, ip_bubbles_r64

ip_pie_chart ​

A pie chart: one slice per value, labelled in the legend, centred at (x, y) with a radius in plot units.

Module procedures: ip_pie_chart_r32, ip_pie_chart_r64

ip_error_bars ​

Error bars at the points (x(i), y(i)): from y(i) - err(i) to y(i) + err(i), or to y(i) + err_high(i); along x with horizontal=.true..

Module procedures: ip_error_bars_r32, ip_error_bars_r64, ip_error_bars_i32_r32, ip_error_bars_i64_r32, ip_error_bars_i32_r64, ip_error_bars_i64_r64

ip_contour ​

Contour lines of a 2D field f(i, j), sampled at uniformly spaced points, i along x, j along y.

Module procedures: ip_contour_r32, ip_contour_r64

ip_contour_lines ​

The segments of the contour lines of a 2D field (marching squares), without drawing them.

Module procedures: ip_contour_lines_r32, ip_contour_lines_r64

ip_contour_levels ​

Contour levels at round numbers ("nice" steps: 1, 2, 2.5 or 5 times a power of ten) inside a field's range.

Module procedures: ip_contour_levels_r32, ip_contour_levels_r64

ip_shaded ​

Area between two curves y1(x) and y2(x), or between a curve y(x) and the line y = yref.

Module procedures: ip_shaded_r32, ip_shaded_r64, ip_shaded_ref_r32, ip_shaded_ref_r64, ip_shaded_i32_r32, ip_shaded_i64_r32, ip_shaded_i32_r64, ip_shaded_i64_r64, ip_shaded_ref_i32_r32, ip_shaded_ref_i64_r32, ip_shaded_ref_i32_r64, ip_shaded_ref_i64_r64

ip_stairs ​

A staircase through the points (x(i), y(i)): y(i) held until x(i+1). Arrays read in place (plots.md, "Data in place"); x may be int32 or int64.

Module procedures: ip_stairs_r32, ip_stairs_r64, ip_stairs_i32_r32, ip_stairs_i64_r32, ip_stairs_i32_r64, ip_stairs_i64_r64

ip_stems ​

Stems from y = ref to the points (x(i), y(i)), each with a marker.

Module procedures: ip_stems_r32, ip_stems_r64, ip_stems_i32_r32, ip_stems_i64_r32, ip_stems_i32_r64, ip_stems_i64_r64

ip_inf_lines ​

Lines across the whole plot at given x (or y) values: real32, real64, int32 or int64 positions.

Module procedures: ip_inf_lines_r32, ip_inf_lines_r64, ip_inf_lines_i32, ip_inf_lines_i64

ip_histogram ​

A histogram of values: bars as high as the values in each bin.

Module procedures: ip_histogram_r32, ip_histogram_r64

ip_histogram2d ​

A 2-D histogram of points: cells coloured by how many points fall in each.

Module procedures: ip_histogram2d_r32, ip_histogram2d_r64

in_line ​

Whether an array's elements are adjacent in memory.

Module procedures: in_line_r32, in_line_r64

series_lead ​

Place the array that sets an item's stride.

Module procedures: lead_r32, lead_r64

series_put ​

Place another array of an item, at its stride.

Module procedures: put_r32, put_r64, put_i32_r32, put_i64_r32, put_i32_r64, put_i64_r64

series_spec ​

The C spec of an item with its stride.

Module procedures: spec_stride_r32, spec_stride_r64

series_gap ​

Bytes from one address to the next one: the stride of an array, from the addresses of two consecutive elements.

Module procedures: gap

series_scratch ​

The scratch of a slot, at least n elements long, for an array an item lays out itself (a grid, a field).

Module procedures: scratch_slot_r32, scratch_slot_r64

scratch_copy ​

Copy an item's array into its slot's scratch at the item's stride (integer abscissae converted).

Module procedures: copy_r32, copy_r64, copy_i32_r32, copy_i64_r32, copy_i32_r64, copy_i64_r64

Subroutines ​

ip_end_subplots ​

End the grid of plots (only after ip_begin_subplots returned true).

Attributes: recursive

fortran
subroutine ip_end_subplots()

Call graph

ip_end_plot ​

End the plot (only after ip_begin_plot returned true).

Attributes: recursive

fortran
subroutine ip_end_plot()

Call graph

ip_setup_axes ​

Labels of the axes X1 and Y1 (call right after ip_begin_plot, before any item); with auto_fit=.true. both axes fit the data every frame (data that grows while the user watches), instead of once on first use. xscale/yscale: 'linear' (default), 'log' (base 10: values <= 0 are not shown), 'symlog' (symmetric log: linear within [-1, 1], logarithmic beyond, both signs) or 'time' (x only: UNIX seconds, labelled as dates and times). xlog/ylog (deprecated, kept from v0.3): .true. is 'log'. xformat/yformat: a C printf format of the tick labels ('%.6f', '%.2e', '%g s'), checked: one conversion f, e, g or a, with optional flags, width and precision, and any %%. Statuses: FIG_ERR_ARGUMENT for any other format, an unknown scale, 'time' on y, or xlog and xscale that disagree (nothing is set up); FIG_ERR_STATE outside a plot, after its setup is over (an item, ip_set_axes, ip_plot_limits), or from a task; stat absent: error stop with the message (a usage error: as app%set_checks says).

Attributes: recursive

fortran
subroutine ip_setup_axes(xlabel, ylabel, auto_fit, xlog, ylog, xformat, yformat, xscale, yscale, stat)

Arguments

NameTypeIntentAttributesDescription
xlabelcharacter(len=*)inX label.
ylabelcharacter(len=*)inY label.
auto_fitlogicalinoptionalFit the axes to the data every frame (default: first use only).
xloglogicalinoptionalLogarithmic x axis (deprecated: xscale='log').
yloglogicalinoptionalLogarithmic y axis (deprecated: yscale='log').
xformatcharacter(len=*)inoptionalprintf format of the x tick labels (one real).
yformatcharacter(len=*)inoptionalprintf format of the y tick labels (one real).
xscalecharacter(len=*)inoptionalScale of x: 'linear', 'log', 'symlog', 'time'.
yscalecharacter(len=*)inoptionalScale of y: 'linear', 'log', 'symlog'.
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_setup_axes_limits ​

Initial ranges of the axes X1 and Y1 (call right after ip_begin_plot): applied on first use only, so the user can pan and zoom afterwards, or every frame with always=.true.. Statuses: FIG_ERR_STATE outside a plot, after its setup is over, or from a task.

Attributes: recursive

fortran
subroutine ip_setup_axes_limits(xmin, xmax, ymin, ymax, always, stat)

Arguments

NameTypeIntentAttributesDescription
xminreal(kind=real64)inLeft end of the x axis.
xmaxreal(kind=real64)inRight end of the x axis.
yminreal(kind=real64)inBottom end of the y axis.
ymaxreal(kind=real64)inTop end of the y axis.
alwayslogicalinoptionalEnforce every frame (default: first use only).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_setup_axis ​

Set up one axis of the plot being declared (SetupAxis): axis is 'x1', 'x2', 'x3', 'y1', 'y2' or 'y3'. X1 and Y1 always exist; X2, X3, Y2 and Y3 exist on the frames this is called for them. Call it right after ip_begin_plot, before any item, every frame. scale: 'linear' (default), 'log', 'symlog', 'time' (x axes only). The secondary axes (2 and 3) are drawn on the opposite side (top, right) without grid lines unless opposite/no_grid say otherwise. lock: the user cannot pan or zoom it. Statuses: FIG_ERR_ARGUMENT for an unknown axis or scale, 'time' on a y axis, a bad format (nothing set up); FIG_ERR_STATE outside a plot, after its setup is over, or from a task.

Attributes: recursive

fortran
subroutine ip_setup_axis(axis, label, scale, auto_fit, format, opposite, invert, lock, no_grid, stat)

Arguments

NameTypeIntentAttributesDescription
axischaracter(len=*)in'x1', 'x2', 'x3', 'y1', 'y2', 'y3'.
labelcharacter(len=*)inoptionalLabel (default: none).
scalecharacter(len=*)inoptional'linear' (default), 'log', 'symlog', 'time'.
auto_fitlogicalinoptionalFit the data every frame (default: first use only).
formatcharacter(len=*)inoptionalprintf format of the tick labels (one real).
oppositelogicalinoptionalTicks and label on the opposite side (default: axes 2, 3).
invertlogicalinoptionalValues grow leftwards (x) or downwards (y).
locklogicalinoptionalNo pan or zoom by the user.
no_gridlogicalinoptionalNo grid lines (default: axes 2, 3).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_set_axes ​

The axes the next items of the plot being declared use (SetAxes), until the next call or the plot's end (each plot starts on X1 and Y1): x one of 'x1', 'x2', 'x3', y one of 'y1', 'y2', 'y3', each set up (ip_setup_axis) on this frame. It ends the setup: call every ip_setup_* first. Statuses: FIG_ERR_ARGUMENT for a name that is not an axis of its direction; FIG_ERR_STATE outside a plot, for an axis not set up, from a task.

Attributes: recursive

fortran
subroutine ip_set_axes(x, y, stat)

Arguments

NameTypeIntentAttributesDescription
xcharacter(len=*)in'x1', 'x2' or 'x3'.
ycharacter(len=*)in'y1', 'y2' or 'y3'.
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_setup_axis_limits ​

Initial range of one axis (SetupAxisLimits), applied on first use only (the user pans and zooms afterwards), or every frame with always=.true.. After ip_setup_axis for that axis, before any item. Statuses: FIG_ERR_ARGUMENT for an unknown axis, a NaN end, vmin >= vmax; FIG_ERR_STATE outside a plot, after its setup is over, for an axis not set up, from a task.

Attributes: recursive

fortran
subroutine ip_setup_axis_limits(axis, vmin, vmax, always, stat)

Arguments

NameTypeIntentAttributesDescription
axischaracter(len=*)in'x1', 'x2', 'x3', 'y1', 'y2', 'y3'.
vminreal(kind=real64)inLower end [axis units].
vmaxreal(kind=real64)inUpper end [axis units].
alwayslogicalinoptionalEnforce every frame (default: first use only).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_setup_axis_ticks ​

Ticks of one axis at the given values instead of the automatic ones (SetupAxisTicks), labelled labels (as given, trailing blanks dropped) or, without them, by the axis's format. After ip_setup_axis (and its format) for that axis, before any item. Statuses: FIG_ERR_ARGUMENT for an unknown axis, a NaN or infinite value, labels not one per value, more values than a C int counts; FIG_ERR_STATE outside a plot, after its setup is over, for an axis not set up, from a task.

Attributes: recursive

fortran
subroutine ip_setup_axis_ticks(axis, values, labels, stat)

Arguments

NameTypeIntentAttributesDescription
axischaracter(len=*)in'x1', 'x2', 'x3', 'y1', 'y2', 'y3'.
valuesreal(kind=real64)inPositions [axis units].
labelscharacter(len=*)inoptionalOne label per value.
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_setup_axis_constraints ​

Bounds the user cannot pan or zoom one axis past (SetupAxisLimitsConstraints, SetupAxisZoomConstraints): the range stays within [vmin, vmax], its width within [zoom_min, zoom_max]; an end not given keeps its bound (none, or the scale's: a log axis stays above 0). After ip_setup_axis (and its scale) for that axis, before any item, every frame. Statuses: FIG_ERR_ARGUMENT for an unknown axis, a NaN, vmin >= vmax, zoom_min > zoom_max, a negative zoom width, vmin <= 0 on a log axis; FIG_ERR_STATE outside a plot, after its setup is over, for an axis not set up, from a task.

Attributes: recursive

fortran
subroutine ip_setup_axis_constraints(axis, vmin, vmax, zoom_min, zoom_max, stat)

Arguments

NameTypeIntentAttributesDescription
axischaracter(len=*)in'x1', 'x2', 'x3', 'y1', 'y2', 'y3'.
vminreal(kind=real64)inoptionalLowest value shown [axis units].
vmaxreal(kind=real64)inoptionalHighest value shown [axis units].
zoom_minreal(kind=real64)inoptionalNarrowest range [axis units].
zoom_maxreal(kind=real64)inoptionalWidest range [axis units].
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_setup_legend ​

Where the plot's legend goes (SetupLegend): location a compass point, 'n', 'ne', 'e', 'se', 's', 'sw', 'w', 'nw' (default, ImPlot's) or 'c' (centre); outside=.true. puts it outside the plot area, on that side, and the plot area shrinks to make room; horizontal=.true. lays the entries out in a row. Right after ip_begin_plot, before any item. Statuses: FIG_ERR_ARGUMENT for an unknown location; FIG_ERR_STATE outside a plot, after its setup is over, from a task.

Attributes: recursive

fortran
subroutine ip_setup_legend(location, outside, horizontal, stat)

Arguments

NameTypeIntentAttributesDescription
locationcharacter(len=*)inoptionalCompass point: 'n', 'ne', 'e', 'se', 's', 'sw', 'w', 'nw', 'c' (default 'nw').
outsidelogicalinoptionalOutside the plot area (default: inside).
horizontallogicalinoptionalEntries in a row (default: a column).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_plot_limits ​

Axis ranges of the current plot, as the user has panned and zoomed them (between ip_begin_plot and ip_end_plot; ends the setup phase: call ip_setup_* before): of the axes the items use now (X1 and Y1, or those of the last ip_set_axes), or of xaxis ('x1', 'x2', 'x3') and yaxis ('y1', 'y2', 'y3'). Statuses: FIG_ERR_ARGUMENT for a name that is not an axis of its direction; FIG_ERR_STATE outside a plot, for an axis not set up, from a task (the limits are then 0).

Attributes: recursive

fortran
subroutine ip_plot_limits(xmin, xmax, ymin, ymax, xaxis, yaxis, stat)

Arguments

NameTypeIntentAttributesDescription
xminreal(kind=real64)outLeft end of the x axis.
xmaxreal(kind=real64)outRight end of the x axis.
yminreal(kind=real64)outBottom end of the y axis.
ymaxreal(kind=real64)outTop end of the y axis.
xaxischaracter(len=*)inoptional'x1', 'x2' or 'x3' (default: the current one).
yaxischaracter(len=*)inoptional'y1', 'y2' or 'y3' (default: the current one).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_plot_size ​

Size of the current plot's data area [pixels] (between ip_begin_plot and ip_end_plot).

Attributes: recursive

fortran
subroutine ip_plot_size(width, height)

Arguments

NameTypeIntentAttributesDescription
widthreal(kind=real64)outWidth [pixels].
heightreal(kind=real64)outHeight [pixels].

Call graph

ip_line_r32 ​

Line through the points (x(i), y(i)), single precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_line_r32(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real32)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_line_i32_r32 ​

Line through the points (x(i), y(i)), single precision, abscissae integer(int32): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_line_i32_r32(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int32)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_line_i64_r32 ​

Line through the points (x(i), y(i)), single precision, abscissae integer(int64): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_line_i64_r32(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int64)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_scatter_r32 ​

Markers at the points (x(i), y(i)), single precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_scatter_r32(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real32)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_scatter_i32_r32 ​

Markers at the points (x(i), y(i)), single precision, abscissae integer(int32): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_scatter_i32_r32(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int32)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_scatter_i64_r32 ​

Markers at the points (x(i), y(i)), single precision, abscissae integer(int64): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_scatter_i64_r32(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int64)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_bars_r32 ​

Bars of height y(i) centred at x(i), bar_size wide (in x units), single precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_bars_r32(label, x, y, bar_size, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real32)intarget, asynchronousBar positions.
yreal(kind=real32)intarget, asynchronousBar heights.
bar_sizereal(kind=real64)inBar width [x units].
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_bars_i32_r32 ​

Bars of height y(i) centred at x(i), bar_size wide (in x units), single precision, abscissae integer(int32): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_bars_i32_r32(label, x, y, bar_size, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int32)intarget, asynchronousBar positions.
yreal(kind=real32)intarget, asynchronousBar heights.
bar_sizereal(kind=real64)inBar width [x units].
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_bars_i64_r32 ​

Bars of height y(i) centred at x(i), bar_size wide (in x units), single precision, abscissae integer(int64): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_bars_i64_r32(label, x, y, bar_size, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int64)intarget, asynchronousBar positions.
yreal(kind=real32)intarget, asynchronousBar heights.
bar_sizereal(kind=real64)inBar width [x units].
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_shaded_r32 ​

Area between the curves y1(x) and y2(x), single precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_shaded_r32(label, x, y1, y2, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real32)intarget, asynchronousAbscissae.
y1real(kind=real32)intarget, asynchronousFirst curve.
y2real(kind=real32)intarget, asynchronousSecond curve.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_shaded_i32_r32 ​

Area between the curves y1(x) and y2(x), single precision, abscissae integer(int32): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_shaded_i32_r32(label, x, y1, y2, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int32)intarget, asynchronousAbscissae.
y1real(kind=real32)intarget, asynchronousFirst curve.
y2real(kind=real32)intarget, asynchronousSecond curve.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_shaded_i64_r32 ​

Area between the curves y1(x) and y2(x), single precision, abscissae integer(int64): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_shaded_i64_r32(label, x, y1, y2, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int64)intarget, asynchronousAbscissae.
y1real(kind=real32)intarget, asynchronousFirst curve.
y2real(kind=real32)intarget, asynchronousSecond curve.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_shaded_ref_r32 ​

Area between the curve y(x) and the line y = yref, single precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_shaded_ref_r32(label, x, y, yref, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real32)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousCurve.
yrefreal(kind=real64)inReference line (-huge/+huge: to the plot edge).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_shaded_ref_i32_r32 ​

Area between the curve y(x) and the line y = yref, single precision, abscissae integer(int32): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_shaded_ref_i32_r32(label, x, y, yref, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int32)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousCurve.
yrefreal(kind=real64)inReference line (-huge/+huge: to the plot edge).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_shaded_ref_i64_r32 ​

Area between the curve y(x) and the line y = yref, single precision, abscissae integer(int64): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_shaded_ref_i64_r32(label, x, y, yref, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int64)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousCurve.
yrefreal(kind=real64)inReference line (-huge/+huge: to the plot edge).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_error_bars_r32 ​

Error bars at the points (x(i), y(i)), from y(i) - err(i) to y(i) + err(i); with err_high, to y(i) + err_high(i); with horizontal=.true., along x instead, from x(i) - err(i), single precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_error_bars_r32(label, x, y, err, err_high, spec, horizontal, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real32)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
errreal(kind=real32)intarget, asynchronousError below (and above) [y units, or x].
err_highreal(kind=real32)intarget, asynchronous, optionalError above [y units, or x].
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
horizontallogicalinoptionalBars along x (err in x units).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_error_bars_i32_r32 ​

Error bars at the points (x(i), y(i)), from y(i) - err(i) to y(i) + err(i); with err_high, to y(i) + err_high(i); with horizontal=.true., along x instead, from x(i) - err(i), single precision, abscissae integer(int32): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_error_bars_i32_r32(label, x, y, err, err_high, spec, horizontal, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int32)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
errreal(kind=real32)intarget, asynchronousError below (and above) [y units, or x].
err_highreal(kind=real32)intarget, asynchronous, optionalError above [y units, or x].
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
horizontallogicalinoptionalBars along x (err in x units).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_error_bars_i64_r32 ​

Error bars at the points (x(i), y(i)), from y(i) - err(i) to y(i) + err(i); with err_high, to y(i) + err_high(i); with horizontal=.true., along x instead, from x(i) - err(i), single precision, abscissae integer(int64): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_error_bars_i64_r32(label, x, y, err, err_high, spec, horizontal, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int64)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
errreal(kind=real32)intarget, asynchronousError below (and above) [y units, or x].
err_highreal(kind=real32)intarget, asynchronous, optionalError above [y units, or x].
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
horizontallogicalinoptionalBars along x (err in x units).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_line_r64 ​

Line through the points (x(i), y(i)), double precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_line_r64(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real64)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_line_i32_r64 ​

Line through the points (x(i), y(i)), double precision, abscissae integer(int32): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_line_i32_r64(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int32)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_line_i64_r64 ​

Line through the points (x(i), y(i)), double precision, abscissae integer(int64): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_line_i64_r64(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int64)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_scatter_r64 ​

Markers at the points (x(i), y(i)), double precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_scatter_r64(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real64)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_scatter_i32_r64 ​

Markers at the points (x(i), y(i)), double precision, abscissae integer(int32): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_scatter_i32_r64(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int32)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_scatter_i64_r64 ​

Markers at the points (x(i), y(i)), double precision, abscissae integer(int64): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_scatter_i64_r64(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int64)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_bubbles_r32 ​

Circles at the points (x(i), y(i)) of radius radii(i) (PlotBubbles), single precision: the radius is in plot units along both axes (a circle on equal axes; an ellipse where their scales differ), filled with the item's fill colour (ip_spec(fill_color=..., fill_alpha=...)) and outlined with its line colour. Read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_bubbles_r32(label, x, y, radii, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real32)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
radiireal(kind=real32)intarget, asynchronousRadii [plot units].
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_pie_chart_r32 ​

A pie chart (PlotPieChart), single precision: one slice per value, its label in the legend, centred at (x, y) with radius, all in plot units (equal axes keep it round: ip_begin_plot(..., equal=.true.)). The slices start at angle0 degrees (default 90, the top) and go clockwise. Each slice shows its value with label_format, a C printf format of one real (default '%.1f'; '' shows none). Values summing to 1 or more make a full circle; below 1, the slices are fractions of one and the circle is partial, unless normalize=.true., which always makes a full circle. The slices' colours are the colormap's, in order: the plot's, or colormap (ip_colormap); a spec's colours do not apply to them. Statuses: FIG_ERR_ARGUMENT for labels not one per value, a radius not above 0, a value below 0 or not finite, a format refused, a colormap not registered; FIG_ERR_STATE from a task.

Attributes: recursive

fortran
subroutine ip_pie_chart_r32(labels, values, x, y, radius, label_format, angle0, normalize, colormap, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelscharacter(len=*)inOne label per slice (trailing blanks are not shown).
valuesreal(kind=real32)inSlice values (0 or more).
xreal(kind=real64)inCentre's abscissa [plot units].
yreal(kind=real64)inCentre's ordinate [plot units].
radiusreal(kind=real64)inRadius [plot units].
label_formatcharacter(len=*)inoptionalprintf format of a slice's value (default '%.1f').
angle0real(kind=real64)inoptionalWhere the first slice starts [degrees].
normalizelogicalinoptionalAlways a full circle (default .false.).
colormapinteger(kind=int32)inoptionalThe slices' colours (default: the plot's colormap).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_bubbles_r64 ​

Circles at the points (x(i), y(i)) of radius radii(i) (PlotBubbles), double precision: the radius is in plot units along both axes (a circle on equal axes; an ellipse where their scales differ), filled with the item's fill colour (ip_spec(fill_color=..., fill_alpha=...)) and outlined with its line colour. Read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_bubbles_r64(label, x, y, radii, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real64)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
radiireal(kind=real64)intarget, asynchronousRadii [plot units].
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_pie_chart_r64 ​

A pie chart (PlotPieChart), double precision: one slice per value, its label in the legend, centred at (x, y) with radius, all in plot units (equal axes keep it round: ip_begin_plot(..., equal=.true.)). The slices start at angle0 degrees (default 90, the top) and go clockwise. Each slice shows its value with label_format, a C printf format of one real (default '%.1f'; '' shows none). Values summing to 1 or more make a full circle; below 1, the slices are fractions of one and the circle is partial, unless normalize=.true., which always makes a full circle. The slices' colours are the colormap's, in order: the plot's, or colormap (ip_colormap); a spec's colours do not apply to them. Statuses: FIG_ERR_ARGUMENT for labels not one per value, a radius not above 0, a value below 0 or not finite, a format refused, a colormap not registered; FIG_ERR_STATE from a task.

Attributes: recursive

fortran
subroutine ip_pie_chart_r64(labels, values, x, y, radius, label_format, angle0, normalize, colormap, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelscharacter(len=*)inOne label per slice (trailing blanks are not shown).
valuesreal(kind=real64)inSlice values (0 or more).
xreal(kind=real64)inCentre's abscissa [plot units].
yreal(kind=real64)inCentre's ordinate [plot units].
radiusreal(kind=real64)inRadius [plot units].
label_formatcharacter(len=*)inoptionalprintf format of a slice's value (default '%.1f').
angle0real(kind=real64)inoptionalWhere the first slice starts [degrees].
normalizelogicalinoptionalAlways a full circle (default .false.).
colormapinteger(kind=int32)inoptionalThe slices' colours (default: the plot's colormap).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_bars_r64 ​

Bars of height y(i) centred at x(i), bar_size wide (in x units), double precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_bars_r64(label, x, y, bar_size, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real64)intarget, asynchronousBar positions.
yreal(kind=real64)intarget, asynchronousBar heights.
bar_sizereal(kind=real64)inBar width [x units].
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_bars_i32_r64 ​

Bars of height y(i) centred at x(i), bar_size wide (in x units), double precision, abscissae integer(int32): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_bars_i32_r64(label, x, y, bar_size, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int32)intarget, asynchronousBar positions.
yreal(kind=real64)intarget, asynchronousBar heights.
bar_sizereal(kind=real64)inBar width [x units].
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_bars_i64_r64 ​

Bars of height y(i) centred at x(i), bar_size wide (in x units), double precision, abscissae integer(int64): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_bars_i64_r64(label, x, y, bar_size, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int64)intarget, asynchronousBar positions.
yreal(kind=real64)intarget, asynchronousBar heights.
bar_sizereal(kind=real64)inBar width [x units].
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_shaded_r64 ​

Area between the curves y1(x) and y2(x), double precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_shaded_r64(label, x, y1, y2, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real64)intarget, asynchronousAbscissae.
y1real(kind=real64)intarget, asynchronousFirst curve.
y2real(kind=real64)intarget, asynchronousSecond curve.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_shaded_i32_r64 ​

Area between the curves y1(x) and y2(x), double precision, abscissae integer(int32): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_shaded_i32_r64(label, x, y1, y2, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int32)intarget, asynchronousAbscissae.
y1real(kind=real64)intarget, asynchronousFirst curve.
y2real(kind=real64)intarget, asynchronousSecond curve.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_shaded_i64_r64 ​

Area between the curves y1(x) and y2(x), double precision, abscissae integer(int64): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_shaded_i64_r64(label, x, y1, y2, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int64)intarget, asynchronousAbscissae.
y1real(kind=real64)intarget, asynchronousFirst curve.
y2real(kind=real64)intarget, asynchronousSecond curve.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_shaded_ref_r64 ​

Area between the curve y(x) and the line y = yref, double precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_shaded_ref_r64(label, x, y, yref, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real64)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousCurve.
yrefreal(kind=real64)inReference line (-huge/+huge: to the plot edge).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_shaded_ref_i32_r64 ​

Area between the curve y(x) and the line y = yref, double precision, abscissae integer(int32): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_shaded_ref_i32_r64(label, x, y, yref, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int32)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousCurve.
yrefreal(kind=real64)inReference line (-huge/+huge: to the plot edge).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_shaded_ref_i64_r64 ​

Area between the curve y(x) and the line y = yref, double precision, abscissae integer(int64): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_shaded_ref_i64_r64(label, x, y, yref, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int64)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousCurve.
yrefreal(kind=real64)inReference line (-huge/+huge: to the plot edge).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_error_bars_r64 ​

Error bars at the points (x(i), y(i)), from y(i) - err(i) to y(i) + err(i); with err_high, to y(i) + err_high(i); with horizontal=.true., along x instead, from x(i) - err(i), double precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_error_bars_r64(label, x, y, err, err_high, spec, horizontal, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real64)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
errreal(kind=real64)intarget, asynchronousError below (and above) [y units, or x].
err_highreal(kind=real64)intarget, asynchronous, optionalError above [y units, or x].
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
horizontallogicalinoptionalBars along x (err in x units).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_error_bars_i32_r64 ​

Error bars at the points (x(i), y(i)), from y(i) - err(i) to y(i) + err(i); with err_high, to y(i) + err_high(i); with horizontal=.true., along x instead, from x(i) - err(i), double precision, abscissae integer(int32): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_error_bars_i32_r64(label, x, y, err, err_high, spec, horizontal, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int32)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
errreal(kind=real64)intarget, asynchronousError below (and above) [y units, or x].
err_highreal(kind=real64)intarget, asynchronous, optionalError above [y units, or x].
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
horizontallogicalinoptionalBars along x (err in x units).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_error_bars_i64_r64 ​

Error bars at the points (x(i), y(i)), from y(i) - err(i) to y(i) + err(i); with err_high, to y(i) + err_high(i); with horizontal=.true., along x instead, from x(i) - err(i), double precision, abscissae integer(int64): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_error_bars_i64_r64(label, x, y, err, err_high, spec, horizontal, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int64)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
errreal(kind=real64)intarget, asynchronousError below (and above) [y units, or x].
err_highreal(kind=real64)intarget, asynchronous, optionalError above [y units, or x].
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
horizontallogicalinoptionalBars along x (err in x units).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_line_values_r32 ​

Line through y(i) at x = xstart + (i - 1) xscale, single precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_line_values_r32(label, y, xscale, xstart, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
yreal(kind=real32)intarget, asynchronousOrdinates.
xscalereal(kind=real64)inoptionalSpacing of the abscissae (default 1).
xstartreal(kind=real64)inoptionalFirst abscissa (default 0).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_line_row_r32 ​

Line through the row row of y, y(row, j) at x = xstart + (j - 1) xscale, read in place (no copy), single precision.

Attributes: recursive

fortran
subroutine ip_line_row_r32(label, y, row, xscale, xstart, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
yreal(kind=real32)incontiguous, targetMatrix; its row row is plotted.
rowinteger(kind=int32)inRow to plot, in 1..size(y, 1).
xscalereal(kind=real64)inoptionalSpacing of the abscissae (default 1).
xstartreal(kind=real64)inoptionalFirst abscissa (default 0).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_heatmap_r32 ​

The field f(i, j) as coloured cells over [xmin, xmax] x [ymin, ymax], read in place (no copy, no transpose): cell (i, j) spans the i-th of size(f, 1) columns along x and the j-th of size(f, 2) rows along y, j = 1 at the bottom. Single precision.

Attributes: recursive

fortran
subroutine ip_heatmap_r32(label, f, xmin, xmax, ymin, ymax, scale_min, scale_max, label_format, colormap, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
freal(kind=real32)incontiguous, targetField: f(i, j), i along x, j along y.
xminreal(kind=real64)inLeft edge of the first column.
xmaxreal(kind=real64)inRight edge of the last column.
yminreal(kind=real64)inBottom edge of row 1.
ymaxreal(kind=real64)inTop edge of the last row.
scale_minreal(kind=real64)inoptionalValue at the bottom of the colormap.
scale_maxreal(kind=real64)inoptionalValue at the top (both or none; none: data).
label_formatcharacter(len=*)inoptionalprintf format of one real, printing each value in its cell (checked: FIG_ERR_ARGUMENT).
colormapinteger(kind=int32)inoptionalColormap (ip_colormap; default: Viridis).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_line_values_r64 ​

Line through y(i) at x = xstart + (i - 1) xscale, double precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_line_values_r64(label, y, xscale, xstart, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
yreal(kind=real64)intarget, asynchronousOrdinates.
xscalereal(kind=real64)inoptionalSpacing of the abscissae (default 1).
xstartreal(kind=real64)inoptionalFirst abscissa (default 0).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_line_row_r64 ​

Line through the row row of y, y(row, j) at x = xstart + (j - 1) xscale, read in place (no copy), double precision.

Attributes: recursive

fortran
subroutine ip_line_row_r64(label, y, row, xscale, xstart, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
yreal(kind=real64)incontiguous, targetMatrix; its row row is plotted.
rowinteger(kind=int32)inRow to plot, in 1..size(y, 1).
xscalereal(kind=real64)inoptionalSpacing of the abscissae (default 1).
xstartreal(kind=real64)inoptionalFirst abscissa (default 0).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_heatmap_r64 ​

The field f(i, j) as coloured cells over [xmin, xmax] x [ymin, ymax], read in place (no copy, no transpose): cell (i, j) spans the i-th of size(f, 1) columns along x and the j-th of size(f, 2) rows along y, j = 1 at the bottom. Double precision.

Attributes: recursive

fortran
subroutine ip_heatmap_r64(label, f, xmin, xmax, ymin, ymax, scale_min, scale_max, label_format, colormap, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
freal(kind=real64)incontiguous, targetField: f(i, j), i along x, j along y.
xminreal(kind=real64)inLeft edge of the first column.
xmaxreal(kind=real64)inRight edge of the last column.
yminreal(kind=real64)inBottom edge of row 1.
ymaxreal(kind=real64)inTop edge of the last row.
scale_minreal(kind=real64)inoptionalValue at the bottom of the colormap.
scale_maxreal(kind=real64)inoptionalValue at the top (both or none; none: data).
label_formatcharacter(len=*)inoptionalprintf format of one real, printing each value in its cell (checked: FIG_ERR_ARGUMENT).
colormapinteger(kind=int32)inoptionalColormap (ip_colormap; default: Viridis).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_image ​

A texture over [xmin, xmax] x [ymin, ymax], pixel row 1 at ymin (plot convention: y up).

Attributes: recursive

fortran
subroutine ip_image(label, tex, xmin, xmax, ymin, ymax, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
textype(texture_object)inTexture.
xminreal(kind=real64)inLeft edge.
xmaxreal(kind=real64)inRight edge.
yminreal(kind=real64)inBottom edge (pixel row 1).
ymaxreal(kind=real64)inTop edge (last pixel row).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_colormap_scale ​

A colour bar for [scale_min, scale_max], next to a heatmap (outside ip_begin_plot/ip_end_plot). Statuses: FIG_ERR_ARGUMENT for a colormap id that is not registered, or a label_format that is not a printf format of one real.

Attributes: recursive

fortran
subroutine ip_colormap_scale(label, scale_min, scale_max, width, height, label_format, colormap, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLabel (also the widget id).
scale_minreal(kind=real64)inValue at the bottom.
scale_maxreal(kind=real64)inValue at the top.
widthreal(kind=real64)inoptionalWidth [pixels] (default: ImPlot's).
heightreal(kind=real64)inoptionalHeight [pixels] (default: ImPlot's).
label_formatcharacter(len=*)inoptionalprintf format of one real, the tick labels (default '%g').
colormapinteger(kind=int32)inoptionalColormap (ip_colormap; default: Viridis).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_colormap_legend ​

A colour-scale legend: a bar coloured by colormap from vmin to vmax (bottom to top, or left to right with horizontal=.true.), with ticks and their values on its right (or below). An item of the current window, outside a plot: beside any plot (ig_same_line), above or below it, or in any window. With levels: that many bands of equal width, each the map's colour at its centre (as ip_colormap(name, levels) colours a field), the ticks at the bands' edges, labelled with the digits they need to show the edge (label_format's precision raised, up to 6 decimals for %f or 7 significant digits for %e and %g: 87.5 with '%.0f', as ip_contour labels it); without: a continuous bar, ticks at round values (a step of 1, 2, 2.5 or 5 times a power of ten) about every 40 pixels (100 horizontal), labelled with label_format as it is. scale ('linear', 'log', 'symlog') puts the ticks where ip_field_image with that scale puts the values' colours: decades on 'log', 0 and the signed decades on 'symlog' (thinned to the room their labels need), band edges equally spaced in the scale. vmin > vmax turns the scale over. Sizes [pixels]: positive given, negative the space left in the window, absent the default (vertical: 300 long, as wide as the bar and the labels; horizontal: the space left, as tall as the bar and a line of labels). The user cannot change the range: ip_colormap_legend_edit is the same legend, dragged and scrolled. Statuses: FIG_ERR_ARGUMENT for a colormap that is not registered, equal or non-finite vmin/vmax, ends not above 0 on 'log', an unknown scale, levels outside [2, 256], a label_format with a conversion that is not one of a real (a format without conversion is text, printed as it is; '' is the default); FIG_ERR_STATE outside a window and from a task. The same in every mode.

Attributes: recursive

fortran
subroutine ip_colormap_legend(id, colormap, vmin, vmax, levels, horizontal, width, height, label_format, scale, stat)

Arguments

NameTypeIntentAttributesDescription
idcharacter(len=*)inWidget id, unique in the window (not shown).
colormapinteger(kind=int32)inColormap (ip_colormap).
vminreal(kind=real64)inValue at the bottom (left).
vmaxreal(kind=real64)inValue at the top (right).
levelsinteger(kind=int32)inoptionalDiscrete bands, in [2, 256] (default: continuous).
horizontallogicalinoptionalHorizontal bar (default: vertical).
widthreal(kind=real64)inoptionalWidth [pixels].
heightreal(kind=real64)inoptionalHeight [pixels].
label_formatcharacter(len=*)inoptionalprintf format of one real, the values, or text (default, and '': '%g').
scalecharacter(len=*)inoptional'linear' (default), 'log', 'symlog'.
statinteger(kind=int32)outoptionalStatus.

Call graph

legend ​

The legend of ip_colormap_legend and ip_colormap_legend_edit: arguments checked, then drawn natively.

Attributes: recursive

fortran
subroutine legend(caller, id, colormap, vmin, vmax, levels, horizontal, width, height, label_format, scale, interactive, range, changed, stat)

Arguments

NameTypeIntentAttributesDescription
callercharacter(len=*)inThe procedure, for the messages.
idcharacter(len=*)inWidget id.
colormapinteger(kind=int32)inColormap.
vminreal(kind=real64)inValue at the bottom (left).
vmaxreal(kind=real64)inValue at the top (right).
levelsinteger(kind=int32)inoptionalBands.
horizontallogicalinoptionalHorizontal bar.
widthreal(kind=real64)inoptionalWidth [pixels].
heightreal(kind=real64)inoptionalHeight [pixels].
label_formatcharacter(len=*)inoptionalprintf format, or text.
scalecharacter(len=*)inoptionalScale name.
interactivelogicalinDragged and scrolled by the user.
rangereal(kind=real64)outThe range after this frame's input.
changedlogicaloutThe user changed it.
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_field_image_r32 ​

The field f(i, j) through a colormap, as one image over [x0, x1] x [y0, y1] of the current plot: value (i, j) is the pixel in the i-th of size(f, 1) columns along x and the j-th of size(f, 2) rows along y, j = 1 at y0 (read in place, column-major as Fortran stores it). Coloured into a texture kept between frames (cached by the label's id) and coloured again only when changed is true or the array (address, shape), vmin, vmax, colormap, scale or nan_color differ from the last colouring; a texture not drawn for 10 s is released. Single precision. See plots.md, "Fields".

Attributes: recursive

fortran
subroutine ip_field_image_r32(label, f, x0, x1, y0, y1, colormap, vmin, vmax, scale, nan_color, changed, range, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label (also the cache's id).
freal(kind=real32)incontiguous, targetField: f(i, j), i along x, j along y.
x0real(kind=real64)inLeft edge of the first column [plot units].
x1real(kind=real64)inRight edge of the last column [plot units].
y0real(kind=real64)inBottom edge of row 1 [plot units].
y1real(kind=real64)inTop edge of the last row [plot units].
colormapinteger(kind=int32)inoptionalColormap (ip_colormap; default: Viridis).
vminreal(kind=real64)inoptionalValue at the colormap's bottom (default: the smallest finite value, positive on 'log').
vmaxreal(kind=real64)inoptionalValue at its top (default: the largest).
scalecharacter(len=*)inoptional'linear' (default), 'log', 'symlog'.
nan_colorreal(kind=real64)inoptionalColour of NaN and infinite values (and of values <= 0 on 'log'), RGBA in [0, 1] (default: transparent).
changedlogicalinoptionalThe values changed since the last frame (default: false; FIGURE cannot see a change in place).
rangereal(kind=real64)outoptionalThe range the colours were computed for.
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_field_image_r64 ​

The field f(i, j) through a colormap, as ip_field_image_r32; double precision.

Attributes: recursive

fortran
subroutine ip_field_image_r64(label, f, x0, x1, y0, y1, colormap, vmin, vmax, scale, nan_color, changed, range, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label (also the cache's id).
freal(kind=real64)incontiguous, targetField: f(i, j), i along x, j along y.
x0real(kind=real64)inLeft edge of the first column [plot units].
x1real(kind=real64)inRight edge of the last column [plot units].
y0real(kind=real64)inBottom edge of row 1 [plot units].
y1real(kind=real64)inTop edge of the last row [plot units].
colormapinteger(kind=int32)inoptionalColormap (ip_colormap; default: Viridis).
vminreal(kind=real64)inoptionalValue at the colormap's bottom (default: the smallest finite value, positive on 'log').
vmaxreal(kind=real64)inoptionalValue at its top (default: the largest).
scalecharacter(len=*)inoptional'linear' (default), 'log', 'symlog'.
nan_colorreal(kind=real64)inoptionalColour of NaN and infinite values (and of values <= 0 on 'log'), RGBA in [0, 1] (default: transparent).
changedlogicalinoptionalThe values changed since the last frame (default: false).
rangereal(kind=real64)outoptionalThe range the colours were computed for.
statinteger(kind=int32)outoptionalStatus.

Call graph

field_image ​

ip_field_image of either kind: arguments checked, then coloured and drawn natively.

Attributes: recursive

fortran
subroutine field_image(caller, label, p, kind, nx, ny, x0, x1, y0, y1, colormap, vmin, vmax, scale, nan_color, changed, range, stat)

Arguments

NameTypeIntentAttributesDescription
callercharacter(len=*)inThe procedure, for the messages.
labelcharacter(len=*)inLegend label.
ptype(c_ptr)inField address (null when empty).
kindinteger(kind=c_int)in4 or 8.
nxinteger(kind=int64)insize(f, 1).
nyinteger(kind=int64)insize(f, 2).
x0real(kind=real64)inLeft edge.
x1real(kind=real64)inRight edge.
y0real(kind=real64)inBottom edge.
y1real(kind=real64)inTop edge.
colormapinteger(kind=int32)inoptionalColormap.
vminreal(kind=real64)inoptionalColormap bottom.
vmaxreal(kind=real64)inoptionalColormap top.
scalecharacter(len=*)inoptionalScale name.
nan_colorreal(kind=real64)inoptionalNaN colour.
changedlogicalinoptionalValues changed.
rangereal(kind=real64)outoptionalThe range applied.
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_load_colormap ​

Read a colormap from file and register it under name for ip_colormap. The file is a CSV table, one colour a row, r, g, b (or x, r, g, b, with x a position: resampled to 256 uniform positions), separated by commas, semicolons, blanks or tabs, components in [0, 1] (or [0, 255] when one exceeds 1), # comments and a header line allowed; or a ParaView JSON preset (a file of ParaView's "Export" of presets, or one preset): the one whose Name is name, or the only one, its RGBPoints sampled at 256 positions in its ColorSpace (RGB, Lab, Diverging, HSV or Step). The map is kept for the program's life. Statuses: FIG_ERR_FAILED if the file cannot be read, FIG_ERR_ARGUMENT if it is malformed (the message gives the line) or the name is taken (a map, or the reverse of one: ImPlot cannot replace a colormap), empty, holds | or starts with 'FIGURE '; FIG_ERR_STATE from a task. The same in every mode, before init* too.

Attributes: recursive

fortran
subroutine ip_load_colormap(name, file, stat)

Arguments

NameTypeIntentAttributesDescription
namecharacter(len=*)inName to register the map under.
filecharacter(len=*)inCSV table or ParaView JSON preset.
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_colormap_stops ​

The stops of the colormap name, sorted by position: as ig_gradient_edit shows and edits them. A map not edited yet has stops derived from its colours: every key of a short table (ImPlot's own maps, a CSV of up to 16 rows), else some of its 256 colours, each the farthest from the last between which the map is linear within 2 levels of 0-255 per channel (10 to 21 stops for the bundled maps). A CSV file of the rows x, r, g, b written from them is read back by ip_load_colormap as the same map. Statuses as ig_gradient_edit (FIG_ERR_STATE before init* and from a task); on a failure the arrays have size 0.

Attributes: recursive

fortran
subroutine ip_colormap_stops(name, positions, colours, stat)

Arguments

NameTypeIntentAttributesDescription
namecharacter(len=*)inColormap name.
positionsreal(kind=real64)outallocatablePositions, in [0, 1].
coloursreal(kind=real64)outallocatableColours, colours(:, k) RGB in [0, 1].
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_colormap_names ​

The names ip_colormap knows: the bundled maps (alphabetical), ImPlot's own (in ImPlot's order), then the maps loaded with ip_load_colormap (in load order); reversed and discrete maps are not listed. From a task: none.

Attributes: recursive

fortran
subroutine ip_colormap_names(names)

Arguments

NameTypeIntentAttributesDescription
namescharacter(len=:)outallocatableNames (as long as the longest).

Call graph

ip_annotation ​

A text at the point (x, y) of the current plot (between ip_begin_plot and ip_end_plot), drawn when the plot ends, over its items and kept inside the plot area. Without color: the text alone, in the plot's text colour; with it: in a box of that colour, the text black or white for contrast. offset moves it [pixels] from the point, with a leader line to it (x right, y down); a zero component centres it on the point along that axis (the default). Statuses: FIG_ERR_ARGUMENT for a colour of size /= 4 or an offset of size /= 2, FIG_ERR_STATE outside a plot and from a task.

Attributes: recursive

fortran
subroutine ip_annotation(x, y, text, color, offset, stat)

Arguments

NameTypeIntentAttributesDescription
xreal(kind=real64)inAbscissa [plot units].
yreal(kind=real64)inOrdinate [plot units].
textcharacter(len=*)inText (UTF-8).
colorreal(kind=real64)inoptionalBox colour, RGBA in [0, 1] (default: no box).
offsetreal(kind=real64)inoptionalOffset [pixels], (x right, y down) (default: centred).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_plot_mouse ​

The pointer's position in plot units (GetPlotMousePos), on the axes the items use now or on xaxis/yaxis: wherever the pointer is (ip_plot_hovered tells whether it is over the plot); -huge(1.0_real64) for both when there is no pointer (no mouse event yet). Between ip_begin_plot and ip_end_plot; it ends the setup. Statuses: FIG_ERR_ARGUMENT for a name that is not an axis of its direction; FIG_ERR_STATE outside a plot, for an axis not set up, from a task (x and y are then 0).

Attributes: recursive

fortran
subroutine ip_plot_mouse(x, y, xaxis, yaxis, stat)

Arguments

NameTypeIntentAttributesDescription
xreal(kind=real64)outAbscissa [x axis units].
yreal(kind=real64)outOrdinate [y axis units].
xaxischaracter(len=*)inoptional'x1', 'x2' or 'x3' (default: the current one).
yaxischaracter(len=*)inoptional'y1', 'y2' or 'y3' (default: the current one).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_plot_to_pixels ​

The display pixel of the plot point (x, y) (PlotToPixels), on the axes the items use now or on xaxis/yaxis: where test_click aims, where ig_draw_* draw on the window's layer. Between ip_begin_plot and ip_end_plot; it ends the setup. Statuses: FIG_ERR_ARGUMENT for a NaN coordinate or a name that is not an axis of its direction; FIG_ERR_STATE outside a plot, for an axis not set up, from a task (px and py are then 0).

Attributes: recursive

fortran
subroutine ip_plot_to_pixels(x, y, px, py, xaxis, yaxis, stat)

Arguments

NameTypeIntentAttributesDescription
xreal(kind=real64)inAbscissa [x axis units].
yreal(kind=real64)inOrdinate [y axis units].
pxreal(kind=real64)outAbscissa [pixels], right from the display's left edge.
pyreal(kind=real64)outOrdinate [pixels], down from the display's top edge.
xaxischaracter(len=*)inoptional'x1', 'x2' or 'x3' (default: the current one).
yaxischaracter(len=*)inoptional'y1', 'y2' or 'y3' (default: the current one).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_pixels_to_plot ​

The plot point at the display pixel (px, py) (PixelsToPlot), on the axes the items use now or on xaxis/yaxis: the inverse of ip_plot_to_pixels. Between ip_begin_plot and ip_end_plot; it ends the setup. Statuses: FIG_ERR_ARGUMENT for a NaN pixel or a name that is not an axis of its direction; FIG_ERR_STATE outside a plot, for an axis not set up, from a task (x and y are then 0).

Attributes: recursive

fortran
subroutine ip_pixels_to_plot(px, py, x, y, xaxis, yaxis, stat)

Arguments

NameTypeIntentAttributesDescription
pxreal(kind=real64)inAbscissa [pixels], right from the display's left edge.
pyreal(kind=real64)inOrdinate [pixels], down from the display's top edge.
xreal(kind=real64)outAbscissa [x axis units].
yreal(kind=real64)outOrdinate [y axis units].
xaxischaracter(len=*)inoptional'x1', 'x2' or 'x3' (default: the current one).
yaxischaracter(len=*)inoptional'y1', 'y2' or 'y3' (default: the current one).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_cancel_selection ​

End the box the user is dragging (CancelPlotSelection) without the zoom ImPlot applies on release: the program keeps the box (ip_plot_selection on this frame) as its own choice. Nothing happens without a box. Between ip_begin_plot and ip_end_plot; it ends the setup. Statuses: FIG_ERR_STATE outside a plot, from a task.

Attributes: recursive

fortran
subroutine ip_cancel_selection(stat)

Arguments

NameTypeIntentAttributesDescription
statinteger(kind=int32)outoptionalStatus.

Call graph

Link axis ('x1'..'y3') of the plot being set up to the group group (SetupAxisLinks): every plot linked to a group shows the same range, and a pan or a zoom in any of them moves all. FIGURE keeps the group's range; a new group takes the range its first plot fits on its first frame. Call it in the setup, after ip_setup_axes/ip_setup_axis, every frame. Statuses: FIG_ERR_ARGUMENT for an unknown axis or an empty group name; FIG_ERR_STATE outside a plot, after its setup is over, for an axis not set up, from a task.

Attributes: recursive

fortran
subroutine ip_link_axis(axis, group, stat)

Arguments

NameTypeIntentAttributesDescription
axischaracter(len=*)in'x1', 'x2', 'x3', 'y1', 'y2', 'y3'.
groupcharacter(len=*)inThe group's name (any text, not empty).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_end_aligned ​

End a group of aligned plots (only after ip_begin_aligned returned true).

Attributes: recursive

fortran
subroutine ip_end_aligned(stat)

Arguments

NameTypeIntentAttributesDescription
statinteger(kind=int32)outoptional

Call graph

ip_end_legend_popup ​

End a legend entry's popup (only after ip_begin_legend_popup returned true).

Attributes: recursive

fortran
subroutine ip_end_legend_popup(stat)

Arguments

NameTypeIntentAttributesDescription
statinteger(kind=int32)outoptional

Call graph

ip_hide_next_item ​

Hide (default) or show the next item (HideNextItem): its legend entry stays, greyed while hidden, and a click on it shows it again. The first time the item is drawn only, unless always=.true.: then on this frame, whatever the user did (the program decides, every frame it calls it). Before the item, inside a plot. Statuses: FIG_ERR_STATE outside a plot or from a task.

Attributes: recursive

fortran
subroutine ip_hide_next_item(hidden, always, stat)

Arguments

NameTypeIntentAttributesDescription
hiddenlogicalinoptionalHidden (default true) or shown.
alwayslogicalinoptionalOn this frame (default: the item's first frame only).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_digital_r64 ​

A digital signal (PlotDigital): y(i) at x(i), held to x(i+1), drawn in a band of its own at the bottom of the plot whatever the y axis (0 and 1 as low and high; larger values as taller steps), double precision; read in place with any stride (plots.md, "Data in place"). The y axis does not fit it; the x axis does. spec's size is the band's height [pixels].

Attributes: recursive

fortran
subroutine ip_digital_r64(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real64)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousValues.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_bar_groups_r64 ​

Items in groups of bars (PlotBarGroups), double precision: values(g, i) is item i in group g, group g centred at x = g - 1 (0, 1, ...; shift moves them all), the items of a group side by side in group_size (a fraction of the unit, in (0, 1], default 0.67) or, stacked=.true., on top of each other (negative values below 0); horizontal=.true.: along y. labels(i) names item i (its legend entry; trailing blanks dropped). The items take the colours of colormap (an id of ip_colormap) in order, default the plot's line colours; spec's fill_color paints them all. Statuses: FIG_ERR_ARGUMENT for size(labels) not size(values, 2), no values, group_size outside (0, 1], an unknown colormap; FIG_ERR_STATE outside a plot or from a task.

Attributes: recursive

fortran
subroutine ip_bar_groups_r64(labels, values, group_size, shift, horizontal, stacked, colormap, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelscharacter(len=*)inOne per item.
valuesreal(kind=real64)invalues(group, item).
group_sizereal(kind=real64)inoptionalWidth of a group [x units] (default 0.67).
shiftreal(kind=real64)inoptionalShift of every group [x units] (default 0).
horizontallogicalinoptionalGroups along y (default: along x).
stackedlogicalinoptionalItems stacked (default: side by side).
colormapinteger(kind=int32)inoptionalThe items' colours (default: the plot's).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_digital_r32 ​

A digital signal (PlotDigital): y(i) at x(i), held to x(i+1), drawn in a band of its own at the bottom of the plot whatever the y axis (0 and 1 as low and high; larger values as taller steps), single precision; read in place with any stride (plots.md, "Data in place"). The y axis does not fit it; the x axis does. spec's size is the band's height [pixels].

Attributes: recursive

fortran
subroutine ip_digital_r32(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real32)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousValues.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_bar_groups_r32 ​

Items in groups of bars (PlotBarGroups), single precision: values(g, i) is item i in group g, group g centred at x = g - 1 (0, 1, ...; shift moves them all), the items of a group side by side in group_size (a fraction of the unit, in (0, 1], default 0.67) or, stacked=.true., on top of each other (negative values below 0); horizontal=.true.: along y. labels(i) names item i (its legend entry; trailing blanks dropped). The items take the colours of colormap (an id of ip_colormap) in order, default the plot's line colours; spec's fill_color paints them all. Statuses: FIG_ERR_ARGUMENT for size(labels) not size(values, 2), no values, group_size outside (0, 1], an unknown colormap; FIG_ERR_STATE outside a plot or from a task.

Attributes: recursive

fortran
subroutine ip_bar_groups_r32(labels, values, group_size, shift, horizontal, stacked, colormap, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelscharacter(len=*)inOne per item.
valuesreal(kind=real32)invalues(group, item).
group_sizereal(kind=real64)inoptionalWidth of a group [x units] (default 0.67).
shiftreal(kind=real64)inoptionalShift of every group [x units] (default 0).
horizontallogicalinoptionalGroups along y (default: along x).
stackedlogicalinoptionalItems stacked (default: side by side).
colormapinteger(kind=int32)inoptionalThe items' colours (default: the plot's).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_tag ​

A tag on an axis of the current plot (TagX, TagY): a box at value over the axis, holding text or, without it, the value labelled as the axis labels its ticks (its format). Drawn when the plot ends, over the axis's tick labels. Default colour: that of the last item drawn (a tag after a line marks the line's last value). axis is one of 'x1'..'x3', 'y1'..'y3', set up on this frame. Statuses: FIG_ERR_ARGUMENT for an unknown axis, a colour of size /= 4 or a NaN value; FIG_ERR_STATE outside a plot, for an axis not set up, from a task.

Attributes: recursive

fortran
subroutine ip_tag(axis, value, color, text, stat)

Arguments

NameTypeIntentAttributesDescription
axischaracter(len=*)in'x1', 'x2', 'x3', 'y1', 'y2', 'y3'.
valuereal(kind=real64)inPosition [axis units].
colorreal(kind=real64)inoptionalBox colour, RGBA in [0, 1] (default: the last item's).
textcharacter(len=*)inoptionalText (UTF-8; default: the value, in the axis's format).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_text ​

A text centred on the plot point (x, y) of the current plot (PlotText), in the plot's inlay text colour, clipped to the plot area; offset moves it [pixels] (x right, y down), vertical=.true. writes it bottom to top. Not an item: no legend entry; it takes part in fitting the axes. Statuses: FIG_ERR_ARGUMENT for a NaN coordinate or an offset of size /= 2; FIG_ERR_STATE outside a plot, from a task.

Attributes: recursive

fortran
subroutine ip_text(text, x, y, offset, vertical, stat)

Arguments

NameTypeIntentAttributesDescription
textcharacter(len=*)inText (UTF-8).
xreal(kind=real64)inAbscissa [plot units].
yreal(kind=real64)inOrdinate [plot units].
offsetreal(kind=real64)inoptionalOffset [pixels], (x right, y down) (default: none).
verticallogicalinoptionalWritten bottom to top (default: horizontal).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_stairs_r32 ​

A staircase through the points (x(i), y(i)) (PlotStairs): y(i) held from x(i) to x(i+1) (with ImPlotStairsFlags_PreStep in the spec, from x(i-1) to x(i)), single precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_stairs_r32(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real32)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_stairs_i32_r32 ​

A staircase through the points (x(i), y(i)) (PlotStairs): y(i) held from x(i) to x(i+1) (with ImPlotStairsFlags_PreStep in the spec, from x(i-1) to x(i)), single precision, abscissae integer(int32): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_stairs_i32_r32(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int32)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_stairs_i64_r32 ​

A staircase through the points (x(i), y(i)) (PlotStairs): y(i) held from x(i) to x(i+1) (with ImPlotStairsFlags_PreStep in the spec, from x(i-1) to x(i)), single precision, abscissae integer(int64): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_stairs_i64_r32(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int64)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_stairs_r64 ​

A staircase through the points (x(i), y(i)) (PlotStairs): y(i) held from x(i) to x(i+1) (with ImPlotStairsFlags_PreStep in the spec, from x(i-1) to x(i)), double precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_stairs_r64(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real64)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_stairs_i32_r64 ​

A staircase through the points (x(i), y(i)) (PlotStairs): y(i) held from x(i) to x(i+1) (with ImPlotStairsFlags_PreStep in the spec, from x(i-1) to x(i)), double precision, abscissae integer(int32): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_stairs_i32_r64(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int32)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_stairs_i64_r64 ​

A staircase through the points (x(i), y(i)) (PlotStairs): y(i) held from x(i) to x(i+1) (with ImPlotStairsFlags_PreStep in the spec, from x(i-1) to x(i)), double precision, abscissae integer(int64): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_stairs_i64_r64(label, x, y, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int64)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_stems_r32 ​

A stem from y = ref to each point (x(i), y(i)), with a marker at its end (PlotStems), single precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_stems_r32(label, x, y, ref, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real32)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
refreal(kind=real64)inoptionalBase of the stems [y units] (default 0).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_stems_i32_r32 ​

A stem from y = ref to each point (x(i), y(i)), with a marker at its end (PlotStems), single precision, abscissae integer(int32): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_stems_i32_r32(label, x, y, ref, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int32)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
refreal(kind=real64)inoptionalBase of the stems [y units] (default 0).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_stems_i64_r32 ​

A stem from y = ref to each point (x(i), y(i)), with a marker at its end (PlotStems), single precision, abscissae integer(int64): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_stems_i64_r32(label, x, y, ref, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int64)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
refreal(kind=real64)inoptionalBase of the stems [y units] (default 0).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_stems_r64 ​

A stem from y = ref to each point (x(i), y(i)), with a marker at its end (PlotStems), double precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_stems_r64(label, x, y, ref, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real64)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
refreal(kind=real64)inoptionalBase of the stems [y units] (default 0).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_stems_i32_r64 ​

A stem from y = ref to each point (x(i), y(i)), with a marker at its end (PlotStems), double precision, abscissae integer(int32): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_stems_i32_r64(label, x, y, ref, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int32)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
refreal(kind=real64)inoptionalBase of the stems [y units] (default 0).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_stems_i64_r64 ​

A stem from y = ref to each point (x(i), y(i)), with a marker at its end (PlotStems), double precision, abscissae integer(int64): converted into one temporary, the ordinates read in place (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_stems_i64_r64(label, x, y, ref, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xinteger(kind=int64)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
refreal(kind=real64)inoptionalBase of the stems [y units] (default 0).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_inf_lines_r32 ​

Lines across the whole plot (PlotInfLines): vertical at x = values(i), or horizontal at y = values(i) with horizontal=.true., single precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_inf_lines_r32(label, values, horizontal, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
valuesreal(kind=real32)intarget, asynchronousPositions [x units; y units when horizontal].
horizontallogicalinoptionalHorizontal lines (default: vertical).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_inf_lines_r64 ​

Lines across the whole plot (PlotInfLines): vertical at x = values(i), or horizontal at y = values(i) with horizontal=.true., double precision; read in place with any stride (plots.md, "Data in place").

Attributes: recursive

fortran
subroutine ip_inf_lines_r64(label, values, horizontal, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
valuesreal(kind=real64)intarget, asynchronousPositions [x units; y units when horizontal].
horizontallogicalinoptionalHorizontal lines (default: vertical).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_inf_lines_i32 ​

Lines across the whole plot (PlotInfLines) at integer positions (iterations): vertical at x = values(i), or horizontal with horizontal=.true.; converted to double precision into one temporary.

Attributes: recursive

fortran
subroutine ip_inf_lines_i32(label, values, horizontal, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
valuesinteger(kind=int32)inasynchronousPositions [x units; y units when horizontal].
horizontallogicalinoptionalHorizontal lines (default: vertical).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_inf_lines_i64 ​

Lines across the whole plot (PlotInfLines) at integer positions (iterations): vertical at x = values(i), or horizontal with horizontal=.true.; converted to double precision into one temporary.

Attributes: recursive

fortran
subroutine ip_inf_lines_i64(label, values, horizontal, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
valuesinteger(kind=int64)inasynchronousPositions [x units; y units when horizontal].
horizontallogicalinoptionalHorizontal lines (default: vertical).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_histogram_r32 ​

A histogram of values (PlotHistogram): bins bars over [vmin, vmax] (default: the range of the finite values), each as high as the values that fall in its bin, single precision. NaN and infinite values are left out (a temporary of the finite ones); a strided array is copied contiguous (ImPlot passes the item's stride on to the bars it draws from its own counts). Flags in the spec: ImPlotHistogramFlags_Horizontal, _Cumulative, _Density, _NoOutliers.

Attributes: recursive

fortran
subroutine ip_histogram_r32(label, values, bins, vmin, vmax, bar_scale, max_count, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
valuesreal(kind=real32)intargetValues.
binsinteger(kind=int32)inoptionalA count > 0, or a rule: ImPlotBin_Sqrt, ImPlotBin_Sturges (default), ImPlotBin_Rice, ImPlotBin_Scott.
vminreal(kind=real64)inoptionalLeft end of the first bin [values units] (with vmax).
vmaxreal(kind=real64)inoptionalRight end of the last bin [values units] (with vmin).
bar_scalereal(kind=real64)inoptionalBar width over bin width (default 1).
max_countreal(kind=real64)outoptionalHeight of the tallest bar (a count, or a density).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_histogram2d_r32 ​

A 2-D histogram of the points (x(i), y(i)) (PlotHistogram2D): xbins x ybins cells over [xmin, xmax] x [ymin, ymax] (default: the range of the finite points), coloured through colormap by how many points fall in each, single precision; read in place with any stride (plots.md, "Data in place"). Points with a NaN or infinite coordinate are left out (temporaries of the finite ones). Flags in the spec: ImPlotHistogramFlags_Density, _NoOutliers.

Attributes: recursive

fortran
subroutine ip_histogram2d_r32(label, x, y, xbins, ybins, xmin, xmax, ymin, ymax, colormap, max_count, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real32)intarget, asynchronousAbscissae.
yreal(kind=real32)intarget, asynchronousOrdinates.
xbinsinteger(kind=int32)inoptionalBins along x: a count > 0 or an ImPlotBin_* rule (default ImPlotBin_Sturges).
ybinsinteger(kind=int32)inoptionalBins along y: the same.
xminreal(kind=real64)inoptionalLeft end [x units] (with xmax).
xmaxreal(kind=real64)inoptionalRight end [x units] (with xmin).
yminreal(kind=real64)inoptionalBottom end [y units] (with ymax).
ymaxreal(kind=real64)inoptionalTop end [y units] (with ymin).
colormapinteger(kind=int32)inoptionalColormap (ip_colormap; default: Viridis).
max_countreal(kind=real64)outoptionalPoints in the fullest cell (a count, or a density).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_histogram_r64 ​

A histogram of values (PlotHistogram): bins bars over [vmin, vmax] (default: the range of the finite values), each as high as the values that fall in its bin, double precision. NaN and infinite values are left out (a temporary of the finite ones); a strided array is copied contiguous (ImPlot passes the item's stride on to the bars it draws from its own counts). Flags in the spec: ImPlotHistogramFlags_Horizontal, _Cumulative, _Density, _NoOutliers.

Attributes: recursive

fortran
subroutine ip_histogram_r64(label, values, bins, vmin, vmax, bar_scale, max_count, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
valuesreal(kind=real64)intargetValues.
binsinteger(kind=int32)inoptionalA count > 0, or a rule: ImPlotBin_Sqrt, ImPlotBin_Sturges (default), ImPlotBin_Rice, ImPlotBin_Scott.
vminreal(kind=real64)inoptionalLeft end of the first bin [values units] (with vmax).
vmaxreal(kind=real64)inoptionalRight end of the last bin [values units] (with vmin).
bar_scalereal(kind=real64)inoptionalBar width over bin width (default 1).
max_countreal(kind=real64)outoptionalHeight of the tallest bar (a count, or a density).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_histogram2d_r64 ​

A 2-D histogram of the points (x(i), y(i)) (PlotHistogram2D): xbins x ybins cells over [xmin, xmax] x [ymin, ymax] (default: the range of the finite points), coloured through colormap by how many points fall in each, double precision; read in place with any stride (plots.md, "Data in place"). Points with a NaN or infinite coordinate are left out (temporaries of the finite ones). Flags in the spec: ImPlotHistogramFlags_Density, _NoOutliers.

Attributes: recursive

fortran
subroutine ip_histogram2d_r64(label, x, y, xbins, ybins, xmin, xmax, ymin, ymax, colormap, max_count, spec, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
xreal(kind=real64)intarget, asynchronousAbscissae.
yreal(kind=real64)intarget, asynchronousOrdinates.
xbinsinteger(kind=int32)inoptionalBins along x: a count > 0 or an ImPlotBin_* rule (default ImPlotBin_Sturges).
ybinsinteger(kind=int32)inoptionalBins along y: the same.
xminreal(kind=real64)inoptionalLeft end [x units] (with xmax).
xmaxreal(kind=real64)inoptionalRight end [x units] (with xmin).
yminreal(kind=real64)inoptionalBottom end [y units] (with ymax).
ymaxreal(kind=real64)inoptionalTop end [y units] (with ymin).
colormapinteger(kind=int32)inoptionalColormap (ip_colormap; default: Viridis).
max_countreal(kind=real64)outoptionalPoints in the fullest cell (a count, or a density).
spectype(plot_spec_object)inoptionalStyle (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_contour_r32 ​

Contour lines of the field f(i, j), sampled at x = x0 .. x1 (i = 1 .. size(f, 1)) and y = y0 .. y1 (j = 1 .. size(f, 2)), uniformly spaced, read in place: as ip_contour_r64. Single precision.

Attributes: recursive

fortran
subroutine ip_contour_r32(label, f, x0, x1, y0, y1, levels, nlevels, colormap, color, labels, line_weight, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label (one entry for every level).
freal(kind=real32)inField: f(i, j), i along x, j along y.
x0real(kind=real64)inAbscissa of f(1, 😃.
x1real(kind=real64)inAbscissa of f(size(f, 1), 😃.
y0real(kind=real64)inOrdinate of f(:, 1).
y1real(kind=real64)inOrdinate of f(:, size(f, 2)).
levelsreal(kind=real64)inoptionalLevels (default: ip_contour_levels(f, nlevels)).
nlevelsinteger(kind=int32)inoptionalAutomatic levels wanted, about (default 10).
colormapinteger(kind=int32)inoptionalColour each level from this colormap (ip_colormap).
colorreal(kind=real64)inoptionalOne colour for every level, RGBA in [0, 1].
labelslogicalinoptionalLabel each level with its value (default: no).
line_weightreal(kind=real64)inoptionalLine weight [pixels] (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_contour_r64 ​

Contour lines of the field f(i, j), sampled at x = x0 .. x1 (i = 1 .. size(f, 1)) and y = y0 .. y1 (j = 1 .. size(f, 2)), uniformly spaced, read in place (between ip_begin_plot and ip_end_plot). The segments are computed every call (ip_contour_lines, marching squares) and drawn as one ImPlot line item per level, with one legend entry (label). Levels: levels, or about nlevels round numbers inside the field's range (ip_contour_levels). Colours: from colormap, the level's value placed in the field's finite range (as a heatmap of the field with the same colormap colours it); or color for every level; or the item's automatic colour. labels=.true.: each level's value in a box of its colour on one of its segments (an annotation, drawn when the plot ends), the segments chosen part-way through each level's list so that labels of nearby levels fall apart. Non-finite values (NaN, infinities) leave holes: a cell with one is skipped. A field with fewer than 2 points along an axis has no lines. Statuses: FIG_ERR_ARGUMENT for a colour of size /= 4, a colormap that is not registered, nlevels < 1, or a level with more segments than a C int counts; FIG_ERR_STATE from a task. Double precision.

Attributes: recursive

fortran
subroutine ip_contour_r64(label, f, x0, x1, y0, y1, levels, nlevels, colormap, color, labels, line_weight, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label (one entry for every level).
freal(kind=real64)inField: f(i, j), i along x, j along y.
x0real(kind=real64)inAbscissa of f(1, 😃.
x1real(kind=real64)inAbscissa of f(size(f, 1), 😃.
y0real(kind=real64)inOrdinate of f(:, 1).
y1real(kind=real64)inOrdinate of f(:, size(f, 2)).
levelsreal(kind=real64)inoptionalLevels (default: ip_contour_levels(f, nlevels)).
nlevelsinteger(kind=int32)inoptionalAutomatic levels wanted, about (default 10).
colormapinteger(kind=int32)inoptionalColour each level from this colormap (ip_colormap).
colorreal(kind=real64)inoptionalOne colour for every level, RGBA in [0, 1].
labelslogicalinoptionalLabel each level with its value (default: no).
line_weightreal(kind=real64)inoptionalLine weight [pixels] (default: ImPlot's).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_contour_lines_r32 ​

The contour lines of f at levels, as segments: as ip_contour_lines_r64. Single precision.

Attributes: pure

fortran
subroutine ip_contour_lines_r32(f, x0, x1, y0, y1, levels, x, y, first)

Arguments

NameTypeIntentAttributesDescription
freal(kind=real32)inField: f(i, j), i along x, j along y.
x0real(kind=real64)inAbscissa of f(1, 😃.
x1real(kind=real64)inAbscissa of f(size(f, 1), 😃.
y0real(kind=real64)inOrdinate of f(:, 1).
y1real(kind=real64)inOrdinate of f(:, size(f, 2)).
levelsreal(kind=real64)inLevels.
xreal(kind=real64)outallocatableSegment ends, x: (x(2s-1), y(2s-1)) to (x(2s), y(2s)).
yreal(kind=real64)outallocatableSegment ends, y.
firstinteger(kind=int64)outallocatableEnds of level k: first(k) .. first(k+1)-1.

Call graph

ip_contour_lines_r64 ​

The contour lines of f at levels, as segments, without drawing them (no GUI needed): marching squares on the cells of four neighbouring samples, f sampled at x = x0 .. x1 and y = y0 .. y1 (uniformly spaced). Level k's segments join (x(e), y(e)) to (x(e+1), y(e+1)) for e = first(k), first(k) + 2, ... < first(k+1). A line crosses a cell's edge where linear interpolation of the edge's two values gives the level (a value equal to the level counts as above it); in a saddle cell (two opposite corners above, the others below) the cell's centre value, the mean of its corners, decides which corners the lines join. A shared edge gives its point exactly the same in both cells: closed lines close. Cells with a non-finite corner are skipped (holes); so are non-finite levels. Double precision.

Attributes: pure

fortran
subroutine ip_contour_lines_r64(f, x0, x1, y0, y1, levels, x, y, first)

Arguments

NameTypeIntentAttributesDescription
freal(kind=real64)inField: f(i, j), i along x, j along y.
x0real(kind=real64)inAbscissa of f(1, 😃.
x1real(kind=real64)inAbscissa of f(size(f, 1), 😃.
y0real(kind=real64)inOrdinate of f(:, 1).
y1real(kind=real64)inOrdinate of f(:, size(f, 2)).
levelsreal(kind=real64)inLevels.
xreal(kind=real64)outallocatableSegment ends, x: (x(2s-1), y(2s-1)) to (x(2s), y(2s)).
yreal(kind=real64)outallocatableSegment ends, y.
firstinteger(kind=int64)outallocatableEnds of level k: first(k) .. first(k+1)-1.

Call graph

cell_segments ​

Marching squares in one cell: the segments of the contour line at level through the cell with corner values v = (bottom-left, bottom-right, top-right, top-left). An edge is crossed when its ends lie on opposite sides of the level (a value equal to it is above); its point is interpolated from the edge's left (bottom) end, so a shared edge gives the same point in both cells. A saddle (four edges crossed) is resolved by the centre value, the mean of the corners: the corners on its side are joined through the centre. A non-finite corner: no segments.

Attributes: pure

fortran
subroutine cell_segments(v, level, xl, xr, yb, yt, m, sx, sy)

Arguments

NameTypeIntentAttributesDescription
vreal(kind=real64)inCorner values: bottom-left, bottom-right, top-right, top-left.
levelreal(kind=real64)inLevel.
xlreal(kind=real64)inLeft abscissa.
xrreal(kind=real64)inRight abscissa.
ybreal(kind=real64)inBottom ordinate.
ytreal(kind=real64)inTop ordinate.
minteger(kind=int32)outSegments: 0, 1 or 2.
sxreal(kind=real64)outSegment ends, x: (sx(1), sy(1)) to (sx(2), sy(2)), then 3 to 4.
syreal(kind=real64)outSegment ends, y.

Call graph

finite_range_r32 ​

The smallest and largest finite values of f (0, 0 and found false if none).

Attributes: pure

fortran
subroutine finite_range_r32(f, fmin, fmax, found)

Arguments

NameTypeIntentAttributesDescription
freal(kind=real32)inField.
fminreal(kind=real64)outSmallest finite value.
fmaxreal(kind=real64)outLargest finite value.
foundlogicaloutf has finite values.

Call graph

finite_range_r64 ​

The smallest and largest finite values of f (0, 0 and found false if none).

Attributes: pure

fortran
subroutine finite_range_r64(f, fmin, fmax, found)

Arguments

NameTypeIntentAttributesDescription
freal(kind=real64)inField.
fminreal(kind=real64)outSmallest finite value.
fmaxreal(kind=real64)outLargest finite value.
foundlogicaloutf has finite values.

Call graph

contour_draw ​

Draw contour segments, one line item per level, all under label.

fortran
subroutine contour_draw(label, lev, xs, ys, first, fmin, fmax, by_map, cmap, color, labels, line_weight, stat)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inLegend label.
levreal(kind=real64)inLevels.
xsreal(kind=real64)intargetSegment ends, x.
ysreal(kind=real64)intargetSegment ends, y.
firstinteger(kind=int64)inFirst end of each level.
fminreal(kind=real64)inField's finite range: the colormap's bottom ...
fmaxreal(kind=real64)in... and top.
by_maplogicalinColour from the colormap.
cmapinteger(kind=c_int)inColormap id.
colorreal(kind=real64)inoptionalOne colour, RGBA.
labelslogicalinoptionalWrite the levels' values.
line_weightreal(kind=real64)inoptionalLine weight [pixels].
statinteger(kind=int32)outoptionalStatus.

Call graph

widen ​

A range of one value made one unit wide around it: ImPlot divides by the width of a bin.

Attributes: pure

fortran
subroutine widen(r)

Arguments

NameTypeIntentAttributesDescription
rtype(im_plot_range)inoutRange.

Call graph

set_flag ​

Set (on true) or clear (on false) flag in flags; unchanged when on is absent.

Attributes: pure

fortran
subroutine set_flag(flags, flag, on)

Arguments

NameTypeIntentAttributesDescription
flagsinteger(kind=c_int)inoutFlags.
flaginteger(kind=c_int)inThe flag.
onlogicalinoptionalSet or clear.

Call graph

lead_r32 ​

Place the array that sets an item's stride (its ordinates) in slot k: read in place with its own stride when that is a positive multiple of the element size within a C int; otherwise (a reversed section, a stride beyond a C int) copied, contiguous, into the slot's scratch.

fortran
subroutine lead_r32(d, k, a)

Arguments

NameTypeIntentAttributesDescription
dtype(series_r32)inoutThe item's arrays.
kinteger(kind=int32)inSlot.
areal(kind=real32)intarget, asynchronousArray.

Call graph

put_r32 ​

Place an array of an item in slot k: read in place when its stride is the item's (set by series_lead, which comes first); otherwise copied at the item's stride into the slot's scratch.

fortran
subroutine put_r32(d, k, a)

Arguments

NameTypeIntentAttributesDescription
dtype(series_r32)inoutThe item's arrays.
kinteger(kind=int32)inSlot.
areal(kind=real32)intarget, asynchronousArray.

Call graph

put_i32_r32 ​

Place integer abscissae of an item in slot k: converted to real(real32) (ImPlot reads x and y of one type), into the slot's scratch laid out at the item's stride, so that the ordinates stay in place.

fortran
subroutine put_i32_r32(d, k, a)

Arguments

NameTypeIntentAttributesDescription
dtype(series_r32)inoutThe item's arrays.
kinteger(kind=int32)inSlot.
ainteger(kind=int32)inasynchronousAbscissae.

Call graph

put_i64_r32 ​

Place integer abscissae of an item in slot k: converted to real(real32) (ImPlot reads x and y of one type), into the slot's scratch laid out at the item's stride, so that the ordinates stay in place.

fortran
subroutine put_i64_r32(d, k, a)

Arguments

NameTypeIntentAttributesDescription
dtype(series_r32)inoutThe item's arrays.
kinteger(kind=int32)inSlot.
ainteger(kind=int64)inasynchronousAbscissae.

Call graph

lead_r64 ​

Place the array that sets an item's stride (its ordinates) in slot k: read in place with its own stride when that is a positive multiple of the element size within a C int; otherwise (a reversed section, a stride beyond a C int) copied, contiguous, into the slot's scratch.

fortran
subroutine lead_r64(d, k, a)

Arguments

NameTypeIntentAttributesDescription
dtype(series_r64)inoutThe item's arrays.
kinteger(kind=int32)inSlot.
areal(kind=real64)intarget, asynchronousArray.

Call graph

put_r64 ​

Place an array of an item in slot k: read in place when its stride is the item's (set by series_lead, which comes first); otherwise copied at the item's stride into the slot's scratch.

fortran
subroutine put_r64(d, k, a)

Arguments

NameTypeIntentAttributesDescription
dtype(series_r64)inoutThe item's arrays.
kinteger(kind=int32)inSlot.
areal(kind=real64)intarget, asynchronousArray.

Call graph

put_i32_r64 ​

Place integer abscissae of an item in slot k: converted to real(real64) (ImPlot reads x and y of one type), into the slot's scratch laid out at the item's stride, so that the ordinates stay in place.

fortran
subroutine put_i32_r64(d, k, a)

Arguments

NameTypeIntentAttributesDescription
dtype(series_r64)inoutThe item's arrays.
kinteger(kind=int32)inSlot.
ainteger(kind=int32)inasynchronousAbscissae.

Call graph

put_i64_r64 ​

Place integer abscissae of an item in slot k: converted to real(real64) (ImPlot reads x and y of one type), into the slot's scratch laid out at the item's stride, so that the ordinates stay in place.

fortran
subroutine put_i64_r64(d, k, a)

Arguments

NameTypeIntentAttributesDescription
dtype(series_r64)inoutThe item's arrays.
kinteger(kind=int32)inSlot.
ainteger(kind=int64)inasynchronousAbscissae.

Call graph

scratch_age ​

Free the items' scratch (both precisions) when no item has copied into it in this frame or the one before: a program that stops plotting reversed or converted data gives the memory back at its next item. A new Dear ImGui context (its frame count restarted) frees it too.

fortran
subroutine scratch_age()

Call graph

scratch_slot_r32 ​

The scratch of slot k (single precision), at least n elements long, for an array an item lays out itself (figure_implot3d: a surface's grid), counted as a copy (test_plot_copies). Valid until the next item.

fortran
subroutine scratch_slot_r32(k, n, v)

Arguments

NameTypeIntentAttributesDescription
kinteger(kind=int32)inSlot.
ninteger(kind=int64)inElements needed.
vreal(kind=real32)outpointer, contiguousThe slot's first n elements.

Call graph

scratch_slot_r64 ​

The scratch of slot k (double precision), at least n elements long, for an array an item lays out itself (figure_implot3d: a surface's grid), counted as a copy (test_plot_copies). Valid until the next item.

fortran
subroutine scratch_slot_r64(k, n, v)

Arguments

NameTypeIntentAttributesDescription
kinteger(kind=int32)inSlot.
ninteger(kind=int64)inElements needed.
vreal(kind=real64)outpointer, contiguousThe slot's first n elements.

Call graph

scratch_reserve_r32 ​

Make the scratch of slot k (single precision) at least n elements long: kept from item to item and from frame to frame, grown by half again when too short (a series that grows by a point per frame is not reallocated every frame), freed by scratch_age. A temporary allocated and freed by every item can cost the memory's first touch every frame (nvfortran 26.9 with glibc: 2.4 ms against 1.0 ms to copy 10**6 doubles; plots.md, "Data in place").

fortran
subroutine scratch_reserve_r32(k, n)

Arguments

NameTypeIntentAttributesDescription
kinteger(kind=int32)inSlot.
ninteger(kind=int64)inElements needed.

Call graph

copy_r32 ​

Copy a into v at a stride of m elements, v(1), v(1 + m), ... (the elements between left as they are), single precision. A reversed section of adjacent elements (a(n:1:-1)) is read through a contiguous view of its memory: with the descending unit stride known to the compiler, the copy runs as fast as a contiguous one (nvfortran 26.9 takes twice as long through the section's descriptor).

fortran
subroutine copy_r32(a, v, m)

Arguments

NameTypeIntentAttributesDescription
areal(kind=real32)intarget, asynchronousArray, any stride.
vreal(kind=real32)inoutScratch, at least (size(a) - 1) m + 1 elements long.
minteger(kind=int64)inStride in v [elements].

Call graph

copy_i32_r32 ​

Convert int32 values to real(real32) into v at a stride of m elements.

fortran
subroutine copy_i32_r32(a, v, m)

Arguments

NameTypeIntentAttributesDescription
ainteger(kind=int32)inasynchronousValues, any stride.
vreal(kind=real32)inoutScratch, at least (size(a) - 1) m + 1 elements long.
minteger(kind=int64)inStride in v [elements].

copy_i64_r32 ​

Convert int64 values to real(real32) into v at a stride of m elements.

fortran
subroutine copy_i64_r32(a, v, m)

Arguments

NameTypeIntentAttributesDescription
ainteger(kind=int64)inasynchronousValues, any stride.
vreal(kind=real32)inoutScratch, at least (size(a) - 1) m + 1 elements long.
minteger(kind=int64)inStride in v [elements].

scratch_reserve_r64 ​

Make the scratch of slot k (double precision) at least n elements long: kept from item to item and from frame to frame, grown by half again when too short (a series that grows by a point per frame is not reallocated every frame), freed by scratch_age. A temporary allocated and freed by every item can cost the memory's first touch every frame (nvfortran 26.9 with glibc: 2.4 ms against 1.0 ms to copy 10**6 doubles; plots.md, "Data in place").

fortran
subroutine scratch_reserve_r64(k, n)

Arguments

NameTypeIntentAttributesDescription
kinteger(kind=int32)inSlot.
ninteger(kind=int64)inElements needed.

Call graph

copy_r64 ​

Copy a into v at a stride of m elements, v(1), v(1 + m), ... (the elements between left as they are), double precision. A reversed section of adjacent elements (a(n:1:-1)) is read through a contiguous view of its memory: with the descending unit stride known to the compiler, the copy runs as fast as a contiguous one (nvfortran 26.9 takes twice as long through the section's descriptor).

fortran
subroutine copy_r64(a, v, m)

Arguments

NameTypeIntentAttributesDescription
areal(kind=real64)intarget, asynchronousArray, any stride.
vreal(kind=real64)inoutScratch, at least (size(a) - 1) m + 1 elements long.
minteger(kind=int64)inStride in v [elements].

Call graph

copy_i32_r64 ​

Convert int32 values to real(real64) into v at a stride of m elements.

fortran
subroutine copy_i32_r64(a, v, m)

Arguments

NameTypeIntentAttributesDescription
ainteger(kind=int32)inasynchronousValues, any stride.
vreal(kind=real64)inoutScratch, at least (size(a) - 1) m + 1 elements long.
minteger(kind=int64)inStride in v [elements].

copy_i64_r64 ​

Convert int64 values to real(real64) into v at a stride of m elements.

fortran
subroutine copy_i64_r64(a, v, m)

Arguments

NameTypeIntentAttributesDescription
ainteger(kind=int64)inasynchronousValues, any stride.
vreal(kind=real64)inoutScratch, at least (size(a) - 1) m + 1 elements long.
minteger(kind=int64)inStride in v [elements].

Functions ​

ip_begin_plot ​

Begin a plot; if true, declare its content and call ip_end_plot.

Attributes: recursive

Returns: logical

fortran
function ip_begin_plot(title, width, height, equal) result(visible)

Arguments

NameTypeIntentAttributesDescription
titlecharacter(len=*)inTitle (also the plot id; '##id' hides it).
widthreal(kind=real64)inoptionalWidth [pixels] (default: full width).
heightreal(kind=real64)inoptionalHeight [pixels] (default: ImPlot's).
equallogicalinoptionalSame scale on both axes (one unit = as many pixels on x and y).

Call graph

ip_begin_subplots ​

A grid of rows x cols plots in one figure; when true, declare the plots (ip_begin_plot/ip_end_plot, one per cell, row by row), then ip_end_subplots. link_x/link_y: the plots share the x (y) range, so zooming one zooms all. Size as ip_begin_plot (a negative height fills the space left). The first time a figure is drawn, its plots fit to their data; linked axes take the range of the last plot (the common abscissa, in practice).

Attributes: recursive

Returns: logical

fortran
function ip_begin_subplots(title, rows, cols, width, height, link_x, link_y) result(visible)

Arguments

NameTypeIntentAttributesDescription
titlecharacter(len=*)inTitle (also the id; '##id' hides it).
rowsinteger(kind=int32)inRows of plots.
colsinteger(kind=int32)inColumns of plots.
widthreal(kind=real64)inoptionalWidth [pixels] (default: full width).
heightreal(kind=real64)inoptionalHeight [pixels] (default: 300 per row).
link_xlogicalinoptionalShare the x range.
link_ylogicalinoptionalShare the y range.

Call graph

ip_spec ​

Item style: ImPlot's defaults, with the given properties overridden. Colours are RGBA in [0, 1]; an absent colour stays automatic (from the colormap).

Returns: type(plot_spec_object)

fortran
function ip_spec(line_color, line_weight, fill_color, fill_alpha, marker, marker_size, marker_line_color, marker_fill_color, size, flags, stat) result(spec)

Arguments

NameTypeIntentAttributesDescription
line_colorreal(kind=real64)inoptionalLine colour, RGBA.
line_weightreal(kind=real64)inoptionalLine weight [pixels] (lines, bar edges, markers).
fill_colorreal(kind=real64)inoptionalFill colour, RGBA (bars, shaded areas).
fill_alphareal(kind=real64)inoptionalAlpha multiplier of the fill colours.
markerinteger(kind=int32)inoptionalMarker shape (ImPlotMarker_*).
marker_sizereal(kind=real64)inoptionalMarker radius [pixels].
marker_line_colorreal(kind=real64)inoptionalMarker outline colour, RGBA.
marker_fill_colorreal(kind=real64)inoptionalMarker fill colour, RGBA.
sizereal(kind=real64)inoptionalError-bar whisker and digital-bar size [pixels].
flagsinteger(kind=int32)inoptionalItem flags (ImPlotItemFlags_*, the item's own).
statinteger(kind=int32)outoptionalStatus: FIG_ERR_ARGUMENT for a colour of size /= 4.

Call graph

ip_colormap_legend_edit ​

ip_colormap_legend whose range the user changes (ImPlotExtra.jl's colorbar!): dragging along the bar moves [vmin, vmax] with the pointer, the mouse wheel over it zooms the range about the value under the pointer (10% a step; wheel up narrows it), both in the scale's space (on 'log' the range moves by factors and stays positive). vmin and vmax are updated in place; true on the frame they changed: pass them to ip_field_image, which colours the field again. The wheel is the legend's while the pointer is over it (a scrolling window does not scroll). The program keeps its own reset (a button setting vmin and vmax back). Arguments, statuses and modes as ip_colormap_legend; on a failure the range is unchanged and the result false.

Attributes: recursive

Returns: logical

fortran
function ip_colormap_legend_edit(id, colormap, vmin, vmax, levels, horizontal, width, height, label_format, scale, stat) result(changed)

Arguments

NameTypeIntentAttributesDescription
idcharacter(len=*)inWidget id, unique in the window (not shown).
colormapinteger(kind=int32)inColormap (ip_colormap).
vminreal(kind=real64)inoutValue at the bottom (left); updated by the user.
vmaxreal(kind=real64)inoutValue at the top (right); updated by the user.
levelsinteger(kind=int32)inoptionalDiscrete bands, in [2, 256] (default: continuous).
horizontallogicalinoptionalHorizontal bar (default: vertical).
widthreal(kind=real64)inoptionalWidth [pixels].
heightreal(kind=real64)inoptionalHeight [pixels].
label_formatcharacter(len=*)inoptionalprintf format of one real, the values, or text (default, and '': '%g').
scalecharacter(len=*)inoptional'linear' (default), 'log', 'symlog'.
statinteger(kind=int32)outoptionalStatus.

Call graph

field_scale_ok ​

The scale of a field or a legend: 0 linear (also when absent), 1 log, 2 symlog; false (reported, FIG_ERR_ARGUMENT) for any other name ('time' included: a field has no time scale).

Returns: logical

fortran
function field_scale_ok(caller, scale, code, stat) result(ok)

Arguments

NameTypeIntentAttributesDescription
callercharacter(len=*)inThe procedure.
scalecharacter(len=*)inoptional'linear', 'log', 'symlog'.
codeinteger(kind=c_int)outScale code.
statinteger(kind=int32)outoptionalStatus, on a refusal.

Call graph

ip_colormap ​

The colormap name as an ImPlot id, for the colormap argument of ip_heatmap and ip_colormap_scale: a bundled map ('cividis', 'batlow', 'cool-warm', ...), one of ImPlot's own ('Viridis', 'Jet', ...) or a map loaded with ip_load_colormap; names are case-sensitive, their trailing blanks ignored (ip_colormap_names lists them). <name>_r is the map reversed; levels gives that many discrete bands of equal width, each coloured as the map at its centre. A map is registered with ImPlot (AddColormap) at its first use, and the same id is returned after; ids hold for the application's life (a new init registers the maps again). Statuses: FIG_ERR_ARGUMENT for an unknown name or levels outside [2, 256], FIG_ERR_STATE before init* and from a task; the id is then -1 (and ip_heatmap refuses it). The same in every mode.

Attributes: recursive

Returns: integer(kind=int32)

fortran
function ip_colormap(name, levels, stat) result(id)

Arguments

NameTypeIntentAttributesDescription
namecharacter(len=*)inColormap name; _r: reversed.
levelsinteger(kind=int32)inoptionalDiscrete bands, in [2, 256] (default: continuous).
statinteger(kind=int32)outoptionalStatus.

Call graph

ig_gradient_edit ​

A gradient editor of the colormap named colormap (ImGuizmo's ImGradient): the map's strip, its stops below it (a square each, of the stop's colour), and on their right the selected stop's colour and a Remove button. A stop dragged along the strip moves, a double click on the stops' row adds one there (the map's colour at that point), a click selects one, whose colour the colour button changes (Dear ImGui's picker) and Remove removes (a map keeps two). Each change resamples the map from its stops, linearly between them and constant beyond the first and the last: its table (256 colours for a bundled or loaded map, its keys for one of ImPlot's) and every variant registered (<name>_r, discrete levels), so heatmaps, fields, legends and 3-D views drawn with it show the new colours from this frame on (fields and views are coloured again). True on the frame the map changed. The stops are those ip_colormap_stops gives; the edit lasts for the program's life. An item of the current window. Sizes [pixels]: width positive given, else the space left plus it (default 0: all of it); height the strip and the stops' row (default: two rows of a frame). Statuses: FIG_ERR_ARGUMENT for an unknown name, a reversed (_r) or discrete map or a qualitative one (Deep, Dark, Pastel, Paired: lists of colours); FIG_ERR_STATE outside a frame and from a task. The same in every mode.

Attributes: recursive

Returns: logical

fortran
function ig_gradient_edit(id, colormap, width, height, stat) result(changed)

Arguments

NameTypeIntentAttributesDescription
idcharacter(len=*)inWidget id, unique in the window (not shown).
colormapcharacter(len=*)inColormap name (ip_colormap_names).
widthreal(kind=real64)inoptionalWidth [pixels].
heightreal(kind=real64)inoptionalHeight [pixels].
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_drag_line_x ​

A vertical line at x in the current plot that the user drags along x (between ip_begin_plot and ip_end_plot): x is updated in place, and the result is true in the frames it moves. id tells the drag tools of a plot apart (any integer, unique in the plot). Statuses: FIG_ERR_ARGUMENT for a colour of size /= 4, FIG_ERR_STATE outside a plot (a usage error, from v0.4.0) and from a task.

Attributes: recursive

Returns: logical

fortran
function ip_drag_line_x(id, x, color, thickness, stat) result(moved)

Arguments

NameTypeIntentAttributesDescription
idinteger(kind=int32)inId, unique among the plot's drag tools.
xreal(kind=real64)inouttargetPosition [plot units].
colorreal(kind=real64)inoptionalColour, RGBA in [0, 1] (default: the text colour).
thicknessreal(kind=real64)inoptionalLine thickness [pixels] (default 1).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_drag_line_y ​

A horizontal line at y in the current plot that the user drags along y: as ip_drag_line_x.

Attributes: recursive

Returns: logical

fortran
function ip_drag_line_y(id, y, color, thickness, stat) result(moved)

Arguments

NameTypeIntentAttributesDescription
idinteger(kind=int32)inId, unique among the plot's drag tools.
yreal(kind=real64)inouttargetPosition [plot units].
colorreal(kind=real64)inoptionalColour, RGBA in [0, 1] (default: the text colour).
thicknessreal(kind=real64)inoptionalLine thickness [pixels] (default 1).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_drag_point ​

A point at (x, y) in the current plot that the user drags: as ip_drag_line_x, both coordinates updated.

Attributes: recursive

Returns: logical

fortran
function ip_drag_point(id, x, y, color, radius, stat) result(moved)

Arguments

NameTypeIntentAttributesDescription
idinteger(kind=int32)inId, unique among the plot's drag tools.
xreal(kind=real64)inouttargetAbscissa [plot units].
yreal(kind=real64)inouttargetOrdinate [plot units].
colorreal(kind=real64)inoptionalColour, RGBA in [0, 1] (default: the text colour).
radiusreal(kind=real64)inoptionalRadius [pixels] (default 4).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_plot_hovered ​

Whether the pointer is over the data area of the plot being declared (IsPlotHovered), on this frame. Between ip_begin_plot and ip_end_plot; it ends the setup. Statuses: FIG_ERR_STATE outside a plot, from a task.

Attributes: recursive

Returns: logical

fortran
function ip_plot_hovered(stat) result(hovered)

Arguments

NameTypeIntentAttributesDescription
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_plot_selection ​

The box the user is dragging with the right button (ImPlot's box selection, IsPlotSelected, GetPlotSelection): true on the frames the box is drawn, with its extent in plot units on the axes the items use now or on xaxis/yaxis (a locked axis spans its whole range). When the button is released ImPlot zooms to the box; a program that takes the box as its own window calls ip_cancel_selection on the frame it takes it. Between ip_begin_plot and ip_end_plot; it ends the setup. Statuses: FIG_ERR_ARGUMENT for a name that is not an axis of its direction; FIG_ERR_STATE outside a plot, for an axis not set up, from a task (the extent is 0).

Attributes: recursive

Returns: logical

fortran
function ip_plot_selection(xmin, xmax, ymin, ymax, xaxis, yaxis, stat) result(selected)

Arguments

NameTypeIntentAttributesDescription
xminreal(kind=real64)outLeft end [x axis units] (0 without a box).
xmaxreal(kind=real64)outRight end [x axis units].
yminreal(kind=real64)outBottom end [y axis units].
ymaxreal(kind=real64)outTop end [y axis units].
xaxischaracter(len=*)inoptional'x1', 'x2' or 'x3' (default: the current one).
yaxischaracter(len=*)inoptional'y1', 'y2' or 'y3' (default: the current one).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_drag_rect ​

A rectangle [xmin, xmax] x [ymin, ymax] in the current plot that the user drags (DragRect): by its centre to move it, by a corner or an edge to resize it; the four values are updated in place and the result is true in the frames it changes. An edge dragged past the opposite one crosses it while the button is held; the values are put in order when it is released. A rectangle of no width and no height cannot be grabbed. id as the other drag tools. Statuses: FIG_ERR_ARGUMENT for a colour of size /= 4 or a NaN; FIG_ERR_STATE outside a plot, from a task.

Attributes: recursive

Returns: logical

fortran
function ip_drag_rect(id, xmin, xmax, ymin, ymax, color, stat) result(moved)

Arguments

NameTypeIntentAttributesDescription
idinteger(kind=int32)inId, unique among the plot's drag tools.
xminreal(kind=real64)inouttargetLeft edge [plot units].
xmaxreal(kind=real64)inouttargetRight edge [plot units].
yminreal(kind=real64)inouttargetBottom edge [plot units].
ymaxreal(kind=real64)inouttargetTop edge [plot units].
colorreal(kind=real64)inoptionalColour, RGBA in [0, 1] (default: the text colour).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_drop_target ​

Make the plot being declared a target of drag and drop for payloads of type type (as ig_drop_target): true on the frame one is dropped, payload then holding it and (x, y) the point it was dropped at, in plot units. With axis ('x1', ..., 'y3') only that axis receives it, with legend only the legend. Call it after the plot's items, before ip_end_plot, every frame. Statuses: FIG_ERR_ARGUMENT for a bad type (as ig_drag_source), an unknown axis or both axis and legend; FIG_ERR_STATE outside a plot, for an axis not set up, or from a task.

Attributes: recursive

Returns: logical

fortran
function ip_drop_target(type, payload, axis, legend, x, y, stat) result(dropped)

Arguments

NameTypeIntentAttributesDescription
typecharacter(len=*)inType accepted (1 to 32 characters).
payloadcharacter(len=:)inoutallocatableThe payload dropped (unchanged otherwise).
axischaracter(len=*)inoptionalOnly this axis receives (default: the plot).
legendlogicalinoptionalOnly the legend receives (default: false).
xreal(kind=real64)inoutoptionalAbscissa of the drop [plot units].
yreal(kind=real64)inoutoptionalOrdinate of the drop [plot units].
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_begin_aligned ​

Begin a group of aligned plots (BeginAlignedPlots): the plots begun until ip_end_aligned have their plot areas start and end at the same pixels, whatever the width of their tick labels (stacked plots: the same left and right edges; horizontal=.true., side by side: the same top and bottom). When true, close it with ip_end_aligned. One group at a time. Statuses: FIG_ERR_STATE inside another group, outside a frame or from a task.

Attributes: recursive

Returns: logical

fortran
function ip_begin_aligned(group, horizontal, stat) result(open)

Arguments

NameTypeIntentAttributesDescription
groupcharacter(len=*)inThe group's id.
horizontallogicalinoptionalPlots side by side (default: stacked).
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_legend_hovered ​

True while the pointer is on the legend entry of the item label (IsLegendEntryHovered): a program shows more about the item then (a tooltip). After the item, before ip_end_plot. Statuses: FIG_ERR_STATE outside a plot or from a task.

Attributes: recursive

Returns: logical

fortran
function ip_legend_hovered(label, stat) result(hovered)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inThe item's label.
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_begin_legend_popup ​

A popup of the legend entry of the item label (BeginLegendPopup), opened by a click of button ('right', default, 'left' or 'middle') on the entry: when true, draw its contents (widgets), then ip_end_legend_popup. After the item, before ip_end_plot. Statuses: FIG_ERR_ARGUMENT for an unknown button; FIG_ERR_STATE outside a plot or from a task.

Attributes: recursive

Returns: logical

fortran
function ip_begin_legend_popup(label, button, stat) result(open)

Arguments

NameTypeIntentAttributesDescription
labelcharacter(len=*)inThe item's label.
buttoncharacter(len=*)inoptional'right' (default), 'left' or 'middle'.
statinteger(kind=int32)outoptionalStatus.

Call graph

ip_contour_levels_r32 ​

About count levels at round numbers strictly inside the finite range of f: as ip_contour_levels_r64.

Attributes: pure

Returns: real(kind=real64)

fortran
function ip_contour_levels_r32(f, count) result(levels)

Arguments

NameTypeIntentAttributesDescription
freal(kind=real32)inField.
countinteger(kind=int32)inoptionalLevels wanted, about (default 10).

Call graph

ip_contour_levels_r64 ​

About count levels at round numbers strictly inside the finite range [fmin, fmax] of f (NaNs and infinities ignored): the multiples of a step of 1, 2, 2.5 or 5 times a power of ten, the smallest such step not below (fmax - fmin) / count. None for a constant field, one without finite values, or count < 1. Double precision.

Attributes: pure

Returns: real(kind=real64)

fortran
function ip_contour_levels_r64(f, count) result(levels)

Arguments

NameTypeIntentAttributesDescription
freal(kind=real64)inField.
countinteger(kind=int32)inoptionalLevels wanted, about (default 10).

Call graph

nice_levels ​

About count levels at multiples of a round step strictly inside (fmin, fmax) (see ip_contour_levels_r64).

Attributes: pure

Returns: real(kind=real64)

fortran
function nice_levels(fmin, fmax, found, count) result(levels)

Arguments

NameTypeIntentAttributesDescription
fminreal(kind=real64)inSmallest value.
fmaxreal(kind=real64)inLargest value.
foundlogicalinThe range exists.
countinteger(kind=int32)inoptionalLevels wanted (default 10).

Call graph

contour_ok ​

Whether ip_contour's options are valid; the colormap id to draw with.

Returns: logical

fortran
function contour_ok(nlevels, colormap, color, cmap, stat) result(ok)

Arguments

NameTypeIntentAttributesDescription
nlevelsinteger(kind=int32)inoptionalAutomatic levels wanted.
colormapinteger(kind=int32)inoptionalColormap id.
colorreal(kind=real64)inoptionalOne colour, RGBA.
cmapinteger(kind=c_int)outThe colormap id (Viridis when absent).
statinteger(kind=int32)outoptionalStatus, on a failure.

Call graph

level_text ​

A level's value, short: 0.25, -3, 1.5e+06.

Attributes: pure

Returns: character(len=:)

fortran
function level_text(v) result(text)

Arguments

NameTypeIntentAttributesDescription
vreal(kind=real64)inValue.

Call graph

drag_ok ​

Whether a drag tool can be drawn: not from a task, a colour of 4 components if given.

Attributes: recursive

Returns: logical

fortran
function drag_ok(caller, color, stat) result(ok)

Arguments

NameTypeIntentAttributesDescription
callercharacter(len=*)inThe entry point.
colorreal(kind=real64)inoptionalColour, RGBA.
statinteger(kind=int32)outoptionalStatus, on a failure.

Call graph

drag_color ​

A drag tool's colour: the given one, or ImPlot's automatic colour (IMPLOT_AUTO_COL: alpha -1).

Attributes: pure

Returns: type(im_vec4)

fortran
function drag_color(color) result(v)

Arguments

NameTypeIntentAttributesDescription
colorreal(kind=real64)inoptionalColour, RGBA.

Call graph

colormap_ok ​

The colormap id to draw with (default ImPlot's Viridis); false, with FIG_ERR_ARGUMENT, if it is not registered.

Returns: logical

fortran
function colormap_ok(caller, colormap, cmap, stat) result(ok)

Arguments

NameTypeIntentAttributesDescription
callercharacter(len=*)inCalling procedure, for the message.
colormapinteger(kind=int32)inoptionalColormap id, if given.
cmapinteger(kind=c_int)outThe id to use.
statinteger(kind=int32)outoptionalStatus, on a failure.

Call graph

axis_index ​

ImAxis of an axis name: 'x1', 'x2', 'x3', 'y1', 'y2', 'y3' ('x' and 'y': x1 and y1); -1 for any other.

Attributes: pure

Returns: integer(kind=c_int)

fortran
function axis_index(name) result(code)

Arguments

NameTypeIntentAttributesDescription
namecharacter(len=*)inAxis name.

Call graph

scale_given_ok ​

The scale asked by a log flag (v0.3) and a scale name: its ImPlotScale in code; false (reported, FIG_ERR_ARGUMENT) for an unknown name or a flag and a name that disagree.

Returns: logical

fortran
function scale_given_ok(caller, prefix, log, scale, code, stat) result(ok)

Arguments

NameTypeIntentAttributesDescription
callercharacter(len=*)inThe procedure.
prefixcharacter(len=*)in'x', 'y' (xscale, xlog) or '' (scale).
loglogicalinoptionalLogarithmic (deprecated flag).
scalecharacter(len=*)inoptional'linear', 'log', 'symlog', 'time'.
codeinteger(kind=c_int)outImPlotScale.
statinteger(kind=int32)outoptionalStatus, on a refusal.

Call graph

plot_refused ​

True (a usage error reported, FIG_ERR_STATE) with no plot being declared or, when setup, with its setup over.

Attributes: recursive

Returns: logical

fortran
function plot_refused(caller, setup, stat) result(refused)

Arguments

NameTypeIntentAttributesDescription
callercharacter(len=*)inThe procedure.
setuplogicalinThe call is part of the setup.
statinteger(kind=int32)outoptionalStatus, on a refusal.

Call graph

setup_refused ​

True (a usage error reported) outside a plot or after its setup is over: the ImPlot setup calls assert there.

Attributes: recursive

Returns: logical

fortran
function setup_refused(caller, stat) result(refused)

Arguments

NameTypeIntentAttributesDescription
callercharacter(len=*)inThe procedure.
statinteger(kind=int32)outoptionalStatus, on a refusal.

Call graph

axis_refused ​

True (reported) for an unknown axis name (FIG_ERR_ARGUMENT), no plot being declared, its setup over when setup, or an axis not set up on this frame (usage errors, FIG_ERR_STATE). code: the axis's ImAxis.

Attributes: recursive

Returns: logical

fortran
function axis_refused(caller, axis, code, setup, stat) result(refused)

Arguments

NameTypeIntentAttributesDescription
callercharacter(len=*)inThe procedure.
axischaracter(len=*)inAxis name.
codeinteger(kind=c_int)outImAxis.
setuplogicalinThe call is part of the setup.
statinteger(kind=int32)outoptionalStatus, on a refusal.

Call graph

pair_ok ​

The ImAxis of an x axis name x (argument xname, skipped when '') and of a y axis name y; false (reported, FIG_ERR_ARGUMENT) for a name that is not an axis of its direction.

Returns: logical

fortran
function pair_ok(caller, xname, x, yname, y, cx, cy, stat) result(ok)

Arguments

NameTypeIntentAttributesDescription
callercharacter(len=*)inThe procedure.
xnamecharacter(len=*)inArgument name of x ('': no x).
xcharacter(len=*)inX axis name.
ynamecharacter(len=*)inArgument name of y ('': no y).
ycharacter(len=*)inY axis name.
cxinteger(kind=c_int)inoutImAxis of x (unchanged without x).
cyinteger(kind=c_int)inoutImAxis of y (unchanged without y).
statinteger(kind=int32)outoptionalStatus, on a refusal.

Call graph

range_ok ​

False (reported, FIG_ERR_ARGUMENT) for a NaN end or lo >= hi.

Returns: logical

fortran
function range_ok(caller, lo_name, lo, hi_name, hi, stat) result(ok)

Arguments

NameTypeIntentAttributesDescription
callercharacter(len=*)inThe procedure.
lo_namecharacter(len=*)inName of the lower end.
loreal(kind=real64)inLower end.
hi_namecharacter(len=*)inName of the upper end.
hireal(kind=real64)inUpper end.
statinteger(kind=int32)outoptionalStatus, on a refusal.

Call graph

axes_refused ​

The ImAxis of an optional x axis name and y axis name (-1, the current axes, when absent); true (reported) for a name that is not an axis of its direction (FIG_ERR_ARGUMENT), no plot being declared or an axis not set up (usage errors, FIG_ERR_STATE).

Attributes: recursive

Returns: logical

fortran
function axes_refused(caller, xaxis, yaxis, cx, cy, stat) result(refused)

Arguments

NameTypeIntentAttributesDescription
callercharacter(len=*)inThe procedure.
xaxischaracter(len=*)inoptional'x1', 'x2' or 'x3'.
yaxischaracter(len=*)inoptional'y1', 'y2' or 'y3'.
cxinteger(kind=c_int)outImAxis of x (-1: the current one).
cyinteger(kind=c_int)outImAxis of y (-1: the current one).
statinteger(kind=int32)outoptionalStatus, on a refusal.

Call graph

inf_spec ​

The spec of infinite lines: c with ImPlot's horizontal flag set when horizontal is true.

Attributes: pure

Returns: type(im_plot_spec)

fortran
function inf_spec(c, horizontal) result(s)

Arguments

NameTypeIntentAttributesDescription
ctype(im_plot_spec)inSpec.
horizontallogicalinoptionalHorizontal lines.

Call graph

bins_ok ​

The bins of a histogram: a count > 0 or an ImPlotBin_* rule (default Sturges'), in nb; false (reported, FIG_ERR_ARGUMENT) for any other value.

Returns: logical

fortran
function bins_ok(caller, name, bins, nb, stat) result(ok)

Arguments

NameTypeIntentAttributesDescription
callercharacter(len=*)inThe procedure.
namecharacter(len=*)inThe argument's name.
binsinteger(kind=int32)inoptionalBins given.
nbinteger(kind=c_int)outBins: a count, or a rule (negative).
statinteger(kind=int32)outoptionalStatus, on a refusal.

Call graph

ends_ok ​

Two optional ends of a range: both or neither, not NaN, lo < hi; false (reported, FIG_ERR_ARGUMENT) otherwise.

Returns: logical

fortran
function ends_ok(caller, lo_name, lo, hi_name, hi, stat) result(ok)

Arguments

NameTypeIntentAttributesDescription
callercharacter(len=*)inThe procedure.
lo_namecharacter(len=*)inName of the lower end.
loreal(kind=real64)inoptionalLower end.
hi_namecharacter(len=*)inName of the upper end.
hireal(kind=real64)inoptionalUpper end.
statinteger(kind=int32)outoptionalStatus, on a refusal.

Call graph

rule_bins ​

A count of bins: nb when it is one, or by its rule over n values in the range r (ImPlot's formulas, computed here: ImPlot's Scott rule divides by a zero spread or gives no bin for a narrow range).

Attributes: pure

Returns: integer(kind=c_int)

fortran
function rule_bins(nb, n, r, sd) result(bins)

Arguments

NameTypeIntentAttributesDescription
nbinteger(kind=c_int)inA count (> 0) or an ImPlotBin_* rule.
ninteger(kind=int64)inValues.
rtype(im_plot_range)inRange.
sdreal(kind=real64)inStandard deviation of the values (Scott's rule).

Call graph

std_dev ​

Standard deviation of values (population: divided by their count; 0 for none).

Attributes: pure

Returns: real(kind=real64)

fortran
function std_dev(v) result(s)

Arguments

NameTypeIntentAttributesDescription
vreal(kind=real64)inValues.

Call graph

in_line_r32 ​

Whether an array's elements are adjacent in memory (its stride is its element size).

Returns: logical

fortran
function in_line_r32(a) result(contiguous_)

Arguments

NameTypeIntentAttributesDescription
areal(kind=real32)intargetArray.

Call graph

in_line_r64 ​

Whether an array's elements are adjacent in memory (its stride is its element size).

Returns: logical

fortran
function in_line_r64(a) result(contiguous_)

Arguments

NameTypeIntentAttributesDescription
areal(kind=real64)intargetArray.

Call graph

outside_plot ​

True (a usage error reported) when no plot is being declared: ImPlot's items need one (with its assertions off, as in the 'report' and 'recover' checks modes, an item outside a plot dereferences a null plot).

Attributes: recursive

Returns: logical

fortran
function outside_plot(caller, stat) result(refused)

Arguments

NameTypeIntentAttributesDescription
callercharacter(len=*)inThe procedure.
statinteger(kind=int32)outoptionalStatus, on a refusal.

Call graph

series_ok ​

Whether two series can be plotted together: same size, and a size ImPlot's int count holds.

Returns: logical

fortran
function series_ok(nx, ny, item, stat) result(ok)

Arguments

NameTypeIntentAttributesDescription
nxinteger(kind=int64)inSize of the first series.
nyinteger(kind=int64)inSize of the second series.
itemcharacter(len=*)inItem name, for the message.
statinteger(kind=int32)outoptionalStatus.

Call graph

field_ok ​

Whether a field can be drawn as a heatmap: a cell count ImPlot's int holds, and both scale ends or none.

Returns: logical

fortran
function field_ok(nx, ny, has_min, has_max, stat) result(ok)

Arguments

NameTypeIntentAttributesDescription
nxinteger(kind=int64)insize(f, 1).
nyinteger(kind=int64)insize(f, 2).
has_minlogicalinscale_min given.
has_maxlogicalinscale_max given.
statinteger(kind=int32)outoptionalStatus.

Call graph

row_ok ​

Whether a matrix row can be plotted in place: the row exists, and ImPlot's int count and byte stride hold it.

Returns: logical

fortran
function row_ok(rows, cols, bits, row, stat) result(ok)

Arguments

NameTypeIntentAttributesDescription
rowsinteger(kind=int64)insize(y, 1).
colsinteger(kind=int64)insize(y, 2): points.
bitsinteger(kind=int64)instorage_size of an element [bits].
rowinteger(kind=int32)inRow to plot.
statinteger(kind=int32)outoptionalStatus.

Call graph

uniform ​

An optional abscissa parameter, or its default, as a C double.

Attributes: pure

Returns: real(kind=c_double)

fortran
function uniform(value, default) result(v)

Arguments

NameTypeIntentAttributesDescription
valuereal(kind=real64)inoptionalGiven value.
defaultreal(kind=real64)inDefault.

Call graph

spec_stride_r32 ​

The C spec to pass: the given one, or ImPlot's defaults, with the item's stride.

Returns: type(im_plot_spec)

fortran
function spec_stride_r32(d, spec) result(c)

Arguments

NameTypeIntentAttributesDescription
dtype(series_r32)inThe item's arrays.
spectype(plot_spec_object)inoptionalStyle.

Call graph

spec_stride_r64 ​

The C spec to pass: the given one, or ImPlot's defaults, with the item's stride.

Returns: type(im_plot_spec)

fortran
function spec_stride_r64(d, spec) result(c)

Arguments

NameTypeIntentAttributesDescription
dtype(series_r64)inThe item's arrays.
spectype(plot_spec_object)inoptionalStyle.

Call graph

gap ​

Bytes from one address to the next one: the stride of an array, from the addresses of two consecutive elements. The integer TRANSFER gives for a C address is processor-dependent; gfortran, nvfortran and ifx give the address.

Returns: integer(kind=int64)

fortran
function gap(first, second) result(bytes)

Arguments

NameTypeIntentAttributesDescription
firsttype(c_ptr)inAddress of a(i).
secondtype(c_ptr)inAddress of a(i + 1).

Call graph

spec_c ​

The C spec to pass: the given one, or ImPlot's defaults.

Returns: type(im_plot_spec)

fortran
function spec_c(spec) result(c)

Arguments

NameTypeIntentAttributesDescription
spectype(plot_spec_object)inoptionalStyle.

Call graph

rgba_ok ​

Whether an optional colour is absent or has 4 components.

Attributes: pure

Returns: logical

fortran
function rgba_ok(color) result(ok)

Arguments

NameTypeIntentAttributesDescription
colorreal(kind=real64)inoptionalColour, RGBA.

Call graph

rgba ​

RGBA colour as an ImVec4.

Attributes: pure

Returns: type(im_vec4)

fortran
function rgba(color) result(v)

Arguments

NameTypeIntentAttributesDescription
colorreal(kind=real64)inColour, RGBA, 4 components.

Call graph

Released under the MIT licence.