Surface is a graph to display three dimensional data.
More...
#include <surface.h>
Surface is a graph to display three dimensional data.
- Examples
- cpu/surface.cpp, and opencl/surface.cpp.
◆ Surface() [1/3]
Creates a Surface object.
- Parameters
-
[in] | pNumXPoints | is number of data points along X dimension |
[in] | pNumYPoints | is number of data points along Y dimension |
[in] | pDataType | takes one of the values of dtype that indicates the integral data type of surface data |
[in] | pPlotType | is the render type which can be one of PlotType (valid choices are FG_PLOT_SURFACE and FG_PLOT_SCATTER) |
[in] | pMarkerType | is the type of MarkerType to draw for FG_PLOT_SCATTER plot type |
◆ Surface() [2/3]
Copy constructor for surface.
- Parameters
-
[in] | pOther | is the surface of which we make a copy of. |
◆ Surface() [3/3]
Construct Surface ojbect from fg_surface resource handle.
- Parameters
-
[in] | pHandle | is the input fg_surface resource handle |
- Note
- This kind of construction assumes ownership of the resource handle is released during the Surface object's destruction.
◆ ~Surface()
◆ alphas()
FGAPI unsigned alphas |
( |
| ) |
const |
Get the buffer identifier for alpha values per vertex.
- Returns
- alpha values buffer resource id.
◆ alphasSize()
FGAPI unsigned alphasSize |
( |
| ) |
const |
Get the alpha values buffer size in bytes.
- Returns
- alpha buffer size in bytes
◆ colors()
FGAPI unsigned colors |
( |
| ) |
const |
Get the buffer identifier for color values per vertex.
- Returns
- colors buffer resource id.
◆ colorsSize()
FGAPI unsigned colorsSize |
( |
| ) |
const |
Get the colors buffer size in bytes.
- Returns
- colors buffer size in bytes
◆ get()
Get the handle to internal implementation of surface.
◆ setColor() [1/2]
FGAPI void setColor |
( |
const float |
pRed, |
|
|
const float |
pGreen, |
|
|
const float |
pBlue, |
|
|
const float |
pAlpha |
|
) |
| |
Set the color of line graph(surface)
- Parameters
-
[in] | pRed | is Red component in range [0, 1] |
[in] | pGreen | is Green component in range [0, 1] |
[in] | pBlue | is Blue component in range [0, 1] |
[in] | pAlpha | is Blue component in range [0, 1] |
◆ setColor() [2/2]
◆ setLegend()
FGAPI void setLegend |
( |
const char * |
pLegend | ) |
|
Set surface legend.
- Parameters
-
◆ vertices()
FGAPI unsigned vertices |
( |
| ) |
const |
◆ verticesSize()
FGAPI unsigned verticesSize |
( |
| ) |
const |
The documentation for this class was generated from the following file: