/usr/include/fg/plot.h is in libforge-dev 0.9.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 | /*******************************************************
* Copyright (c) 2015-2019, ArrayFire
* All rights reserved.
*
* This file is distributed under 3-clause BSD license.
* The complete license agreement can be obtained at:
* http://arrayfire.com/licenses/BSD-3-Clause
********************************************************/
#pragma once
#include <fg/defines.h>
#ifdef __cplusplus
extern "C" {
#endif
/** \addtogroup plot_functions
* @{
*/
/**
Create a Plot object
\param[out] pPlot will be set to plot handle upon creating the plot object
\param[in] pNPoints is number of data points to display
\param[in] pType takes one of the values of \ref fg_dtype that indicates
the integral data type of plot data
\param[in] pChartType dictates the dimensionality of the chart
\param[in] pPlotType dictates the type of plot/graph,
it can take one of the values of \ref fg_plot_type
\param[in] pMarkerType indicates which symbol is rendered as marker. It can take one of
the values of \ref fg_marker_type.
\return \ref fg_err error code
*/
FGAPI fg_err fg_create_plot(fg_plot *pPlot,
const unsigned pNPoints, const fg_dtype pType,
const fg_chart_type pChartType,
const fg_plot_type pPlotType,
const fg_marker_type pMarkerType);
/**
Destroy plot object
\param[in] pPlot is the plot handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_destroy_plot(fg_plot pPlot);
/**
Set the color of line graph(plot)
\param[in] pPlot is the plot handle
\param[in] pRed is Red component in range [0, 1]
\param[in] pGreen is Green component in range [0, 1]
\param[in] pBlue is Blue component in range [0, 1]
\param[in] pAlpha is Blue component in range [0, 1]
\return \ref fg_err error code
*/
FGAPI fg_err fg_set_plot_color(fg_plot pPlot,
const float pRed, const float pGreen,
const float pBlue, const float pAlpha);
/**
Set plot legend
\param[in] pPlot is the plot handle
\param[in] pLegend
\return \ref fg_err error code
*/
FGAPI fg_err fg_set_plot_legend(fg_plot pPlot, const char* pLegend);
/**
Set global marker size
This size will be used for rendering markers if no per vertex marker sizes are provided.
This value defaults to 10
\param[in] pPlot is the plot handle
\param[in] pMarkerSize is the target marker size for scatter plots or line plots with markers
\return \ref fg_err error code
*/
FGAPI fg_err fg_set_plot_marker_size(fg_plot pPlot, const float pMarkerSize);
/**
Get the resource identifier for vertices buffer
\param[out] pOut will have the buffer identifier after this function is called
\param[in] pPlot is the plot handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_plot_vertex_buffer(unsigned* pOut, const fg_plot pPlot);
/**
Get the resource identifier for colors buffer
\param[out] pOut will have the buffer identifier after this function is called
\param[in] pPlot is the plot handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_plot_color_buffer(unsigned* pOut, const fg_plot pPlot);
/**
Get the resource identifier for alpha values buffer
\param[out] pOut will have the buffer identifier after this function is called
\param[in] pPlot is the plot handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_plot_alpha_buffer(unsigned* pOut, const fg_plot pPlot);
/**
Get the resource identifier for markers radii buffer
\param[out] pOut will have the buffer identifier after this function is called
\param[in] pPlot is the plot handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_plot_radii_buffer(unsigned* pOut, const fg_plot pPlot);
/**
Get the vertices buffer size in bytes
\param[out] pOut will have the buffer size in bytes after this function is called
\param[in] pPlot is the plot handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_plot_vertex_buffer_size(unsigned* pOut, const fg_plot pPlot);
/**
Get the colors buffer size in bytes
\param[out] pOut will have the buffer size in bytes after this function is called
\param[in] pPlot is the plot handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_plot_color_buffer_size(unsigned* pOut, const fg_plot pPlot);
/**
Get the alpha values buffer size in bytes
\param[out] pOut will have the buffer size in bytes after this function is called
\param[in] pPlot is the plot handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_plot_alpha_buffer_size(unsigned* pOut, const fg_plot pPlot);
/**
Get the markers buffer size in bytes
\param[out] pOut will have the buffer size in bytes after this function is called
\param[in] pPlot is the plot handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_plot_radii_buffer_size(unsigned* pOut, const fg_plot pPlot);
/** @} */
#ifdef __cplusplus
}
#endif
#ifdef __cplusplus
namespace forge
{
/**
\class Plot
\brief Plot is a line graph to display two dimensional data.
*/
class Plot {
private:
fg_plot mValue;
public:
/**
Creates a Plot object
\param[in] pNumPoints is number of data points to display
\param[in] pDataType takes one of the values of \ref dtype that indicates
the integral data type of plot data
\param[in] pChartType dictates the dimensionality of the chart
\param[in] pPlotType dictates the type of plot/graph,
it can take one of the values of \ref PlotType
\param[in] pMarkerType indicates which symbol is rendered as marker. It can take one of
the values of \ref MarkerType.
*/
FGAPI Plot(const unsigned pNumPoints, const dtype pDataType, const ChartType pChartType,
const PlotType pPlotType=FG_PLOT_LINE, const MarkerType pMarkerType=FG_MARKER_NONE);
/**
Copy constructor for Plot
\param[in] pOther is the Plot of which we make a copy of.
*/
FGAPI Plot(const Plot& pOther);
/**
Plot Destructor
*/
FGAPI ~Plot();
/**
Set the color of line graph(plot)
\param[in] pColor takes values of forge::Color to define plot color
*/
FGAPI void setColor(const forge::Color pColor);
/**
Set the color of line graph(plot)
\param[in] pRed is Red component in range [0, 1]
\param[in] pGreen is Green component in range [0, 1]
\param[in] pBlue is Blue component in range [0, 1]
\param[in] pAlpha is Blue component in range [0, 1]
*/
FGAPI void setColor(const float pRed, const float pGreen,
const float pBlue, const float pAlpha);
/**
Set plot legend
\param[in] pLegend
*/
FGAPI void setLegend(const char* pLegend);
/**
Set global marker size
This size will be used for rendering markers if no per vertex marker sizes are provided.
This value defaults to 10
\param[in] pMarkerSize is the target marker size for scatter plots or line plots with markers
*/
FGAPI void setMarkerSize(const float pMarkerSize);
/**
Get the buffer identifier for vertices
\return vertex buffer resource id.
*/
FGAPI unsigned vertices() const;
/**
Get the buffer identifier for color values per vertex
\return colors buffer resource id.
*/
FGAPI unsigned colors() const;
/**
Get the buffer identifier for alpha values per vertex
\return alpha values buffer resource id.
*/
FGAPI unsigned alphas() const;
/**
Get the buffer identifier for per vertex marker sizes
\return marker sizes buffer resource id.
*/
FGAPI unsigned radii() const;
/**
Get the vertex buffer size in bytes
\return vertex buffer size in bytes
*/
FGAPI unsigned verticesSize() const;
/**
Get the colors buffer size in bytes
\return colors buffer size in bytes
*/
FGAPI unsigned colorsSize() const;
/**
Get the alpha values buffer size in bytes
\return alpha buffer size in bytes
*/
FGAPI unsigned alphasSize() const;
/**
Get the marker sizes buffer size in bytes
\return marker sizes buffer size in bytes
*/
FGAPI unsigned radiiSize() const;
/**
Get the handle to internal implementation of plot
*/
FGAPI fg_plot get() const;
};
}
#endif
|