Forge
|
Functions | |
FGAPI fg_err | fg_create_surface (fg_surface *pSurface, const unsigned pXPoints, const unsigned pYPoints, const fg_dtype pType, const fg_plot_type pPlotType, const fg_marker_type pMarkerType) |
Create a Surface object. More... | |
FGAPI fg_err | fg_retain_surface (fg_surface *pOut, fg_surface pIn) |
Increase reference count of the resource. More... | |
FGAPI fg_err | fg_release_surface (fg_surface pSurface) |
Destroy surface object. More... | |
FGAPI fg_err | fg_set_surface_color (fg_surface pSurface, const float pRed, const float pGreen, const float pBlue, const float pAlpha) |
Set the color of surface. More... | |
FGAPI fg_err | fg_set_surface_legend (fg_surface pSurface, const char *pLegend) |
Set surface legend. More... | |
FGAPI fg_err | fg_get_surface_vertex_buffer (unsigned *pOut, const fg_surface pSurface) |
Get the resource identifier for vertices buffer. More... | |
FGAPI fg_err | fg_get_surface_color_buffer (unsigned *pOut, const fg_surface pSurface) |
Get the resource identifier for colors buffer. More... | |
FGAPI fg_err | fg_get_surface_alpha_buffer (unsigned *pOut, const fg_surface pSurface) |
Get the resource identifier for alpha values buffer. More... | |
FGAPI fg_err | fg_get_surface_vertex_buffer_size (unsigned *pOut, const fg_surface pSurface) |
Get the vertices buffer size in bytes. More... | |
FGAPI fg_err | fg_get_surface_color_buffer_size (unsigned *pOut, const fg_surface pSurface) |
Get the colors buffer size in bytes. More... | |
FGAPI fg_err | fg_get_surface_alpha_buffer_size (unsigned *pOut, const fg_surface pSurface) |
Get the alpha values buffer size in bytes. More... | |
FGAPI fg_err fg_create_surface | ( | fg_surface * | pSurface, |
const unsigned | pXPoints, | ||
const unsigned | pYPoints, | ||
const fg_dtype | pType, | ||
const fg_plot_type | pPlotType, | ||
const fg_marker_type | pMarkerType | ||
) |
Create a Surface object.
[out] | pSurface | will be set to surface handle upon creating the surface object |
[in] | pXPoints | is number of data points along X dimension |
[in] | pYPoints | is number of data points along Y dimension |
[in] | pType | takes one of the values of fg_dtype that indicates the integral data type of surface data |
[in] | pPlotType | dictates the type of surface/graph, it can take one of the values of fg_plot_type |
[in] | pMarkerType | indicates which symbol is rendered as marker. It can take one of the values of fg_marker_type. |
FGAPI fg_err fg_get_surface_alpha_buffer | ( | unsigned * | pOut, |
const fg_surface | pSurface | ||
) |
Get the resource identifier for alpha values buffer.
[out] | pOut | will have the buffer identifier after this function is called |
[in] | pSurface | is the surface handle |
FGAPI fg_err fg_get_surface_alpha_buffer_size | ( | unsigned * | pOut, |
const fg_surface | pSurface | ||
) |
Get the alpha values buffer size in bytes.
[out] | pOut | will have the buffer size in bytes after this function is called |
[in] | pSurface | is the surface handle |
FGAPI fg_err fg_get_surface_color_buffer | ( | unsigned * | pOut, |
const fg_surface | pSurface | ||
) |
Get the resource identifier for colors buffer.
[out] | pOut | will have the buffer identifier after this function is called |
[in] | pSurface | is the surface handle |
FGAPI fg_err fg_get_surface_color_buffer_size | ( | unsigned * | pOut, |
const fg_surface | pSurface | ||
) |
Get the colors buffer size in bytes.
[out] | pOut | will have the buffer size in bytes after this function is called |
[in] | pSurface | is the surface handle |
FGAPI fg_err fg_get_surface_vertex_buffer | ( | unsigned * | pOut, |
const fg_surface | pSurface | ||
) |
Get the resource identifier for vertices buffer.
[out] | pOut | will have the buffer identifier after this function is called |
[in] | pSurface | is the surface handle |
FGAPI fg_err fg_get_surface_vertex_buffer_size | ( | unsigned * | pOut, |
const fg_surface | pSurface | ||
) |
Get the vertices buffer size in bytes.
[out] | pOut | will have the buffer size in bytes after this function is called |
[in] | pSurface | is the surface handle |
FGAPI fg_err fg_release_surface | ( | fg_surface | pSurface | ) |
FGAPI fg_err fg_retain_surface | ( | fg_surface * | pOut, |
fg_surface | pIn | ||
) |
Increase reference count of the resource.
[out] | pOut | is the new handle to existing resource |
[in] | pIn | is the existing resource handle |
FGAPI fg_err fg_set_surface_color | ( | fg_surface | pSurface, |
const float | pRed, | ||
const float | pGreen, | ||
const float | pBlue, | ||
const float | pAlpha | ||
) |
Set the color of surface.
[in] | pSurface | is the surface handle |
[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] |
FGAPI fg_err fg_set_surface_legend | ( | fg_surface | pSurface, |
const char * | pLegend | ||
) |
Set surface legend.
[in] | pSurface | is the surface handle |
[in] | pLegend |