Skip to content

Commit b844d96

Browse files
epezentbrenocq
authored andcommitted
more doc additions/corrections
1 parent c96f18f commit b844d96

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

implot.h

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -134,17 +134,17 @@ enum ImAxis_ {
134134
ImAxis_COUNT
135135
};
136136

137-
// Plotting properties. These provide syntactic sugar for creating ImPlotSpecs from ImProp,value pairs.
137+
// Plotting properties. These provide syntactic sugar for creating ImPlotSpecs from ImProp,value pairs. See ImPlotSpec documentation.
138138
enum ImProp_ {
139-
ImProp_LineColor,
140-
ImProp_LineWeight,
141-
ImProp_FillColor,
142-
ImProp_FillAlpha,
143-
ImProp_Marker,
144-
ImProp_Size,
145-
ImProp_Offset,
146-
ImProp_Stride,
147-
ImProp_Flags
139+
ImProp_LineColor, // line color (applies to lines, bar edges, marker edges); IMPLOT_AUTO_COL will use next Colormap color or current item color
140+
ImProp_LineWeight, // line weight in pixels (applies to lines, bar edges, marker edges)
141+
ImProp_FillColor, // fill color (applies to shaded regions, bar faces, marker faces); IMPLOT_AUTO_COL will use next Colormap color or current item color
142+
ImProp_FillAlpha, // alpha multiplier (applies to FillColor)
143+
ImProp_Marker, // marker type; specify ImPlotMarker_Auto to use the next unused marker
144+
ImProp_Size, // size of markers (radius), error bar whiskers (width or height), and digital bars (height) *in pixels*
145+
ImProp_Offset, // data index offset
146+
ImProp_Stride, // data stride in bytes; IMPLOT_AUTO will result in sizeof(T) where T is the type passed to PlotX
147+
ImProp_Flags // optional item flags; can be composed from common ImPlotItemFlags and/or specialized ImPlotXFlags
148148
};
149149

150150
// Options for plots (see BeginPlot).
@@ -494,14 +494,13 @@ enum ImPlotBin_ {
494494
struct ImPlotSpec {
495495
ImVec4 LineColor = IMPLOT_AUTO_COL; // line color (applies to lines, bar edges, marker edges); IMPLOT_AUTO_COL will use next Colormap color or current item color
496496
float LineWeight = 1.0f; // line weight in pixels (applies to lines, bar edges, marker edges)
497-
ImVec4 FillColor = IMPLOT_AUTO_COL; // fill color (applies to bar faces and shaded regions); IMPLOT_AUTO_COL will use next Colormap color or current item color
497+
ImVec4 FillColor = IMPLOT_AUTO_COL; // fill color (applies to shaded regions, bar faces, marker faces); IMPLOT_AUTO_COL will use next Colormap color or current item color
498498
float FillAlpha = 1.0f; // alpha multiplier (applies to FillColor)
499499
ImPlotMarker Marker = ImPlotMarker_None; // marker type; specify ImPlotMarker_Auto to use the next unused marker
500500
float Size = 4; // size of markers (radius), error bar whiskers (width or height), and digital bars (height) *in pixels*
501501
int Offset = 0; // data index offset
502502
int Stride = IMPLOT_AUTO; // data stride in bytes; IMPLOT_AUTO will result in sizeof(T) where T is the type passed to PlotX
503-
ImPlotItemFlags Flags = ImPlotItemFlags_None; // optional item flags; can be composed from common ImPlotItemFlags and/or specific ImPlotXFlags where X corresponds
504-
// with the PlotX function to which this is passed (e.g. ImPlotLineFlags is only compatible with PlotLine)
503+
ImPlotItemFlags Flags = ImPlotItemFlags_None; // optional item flags; can be composed from common ImPlotItemFlags and/or specialized ImPlotXFlags
505504

506505
ImPlotSpec() { }
507506

0 commit comments

Comments
 (0)