Forge
Vector Field

Functions

FGAPI fg_err fg_create_vector_field (fg_vector_field *pField, const unsigned pNPoints, const fg_dtype pType, const fg_chart_type pChartType)
 Create a Vector field object. More...
 
FGAPI fg_err fg_destroy_vector_field (fg_vector_field pField)
 Destroy vector field object. More...
 
FGAPI fg_err fg_set_vector_field_color (fg_vector_field pField, const float pRed, const float pGreen, const float pBlue, const float pAlpha)
 Set the color of vector field. More...
 
FGAPI fg_err fg_set_vector_field_legend (fg_vector_field pField, const char *pLegend)
 Set vector field legend. More...
 
FGAPI fg_err fg_get_vector_field_vertex_buffer (unsigned *pOut, const fg_vector_field pField)
 Get the resource identifier for vertices buffer. More...
 
FGAPI fg_err fg_get_vector_field_color_buffer (unsigned *pOut, const fg_vector_field pField)
 Get the resource identifier for colors buffer. More...
 
FGAPI fg_err fg_get_vector_field_alpha_buffer (unsigned *pOut, const fg_vector_field pField)
 Get the resource identifier for alpha values buffer. More...
 
FGAPI fg_err fg_get_vector_field_direction_buffer (unsigned *pOut, const fg_vector_field pField)
 Get the resource identifier for directions buffer. More...
 
FGAPI fg_err fg_get_vector_field_vertex_buffer_size (unsigned *pOut, const fg_vector_field pField)
 Get the vertices buffer size in bytes. More...
 
FGAPI fg_err fg_get_vector_field_color_buffer_size (unsigned *pOut, const fg_vector_field pField)
 Get the colors buffer size in bytes. More...
 
FGAPI fg_err fg_get_vector_field_alpha_buffer_size (unsigned *pOut, const fg_vector_field pField)
 Get the alpha values buffer size in bytes. More...
 
FGAPI fg_err fg_get_vector_field_direction_buffer_size (unsigned *pOut, const fg_vector_field pField)
 Get the directions buffer size in bytes. More...
 

Detailed Description

Function Documentation

§ fg_create_vector_field()

FGAPI fg_err fg_create_vector_field ( fg_vector_field pField,
const unsigned  pNPoints,
const fg_dtype  pType,
const fg_chart_type  pChartType 
)

Create a Vector field object.

Parameters
[out]pFieldwill be set to surface handle upon creating the surface object
[in]pNPointsis number of data points
[in]pTypetakes one of the values of fg_dtype that indicates the integral data type of surface data
[in]pChartTypedictates the dimensionality of the chart
Returns
fg_err error code

§ fg_destroy_vector_field()

FGAPI fg_err fg_destroy_vector_field ( fg_vector_field  pField)

Destroy vector field object.

Parameters
[in]pFieldis the surface handle
Returns
fg_err error code

§ fg_get_vector_field_alpha_buffer()

FGAPI fg_err fg_get_vector_field_alpha_buffer ( unsigned *  pOut,
const fg_vector_field  pField 
)

Get the resource identifier for alpha values buffer.

Parameters
[out]pOutwill have the buffer identifier after this function is called
[in]pFieldis the vector field handle
Returns
fg_err error code

§ fg_get_vector_field_alpha_buffer_size()

FGAPI fg_err fg_get_vector_field_alpha_buffer_size ( unsigned *  pOut,
const fg_vector_field  pField 
)

Get the alpha values buffer size in bytes.

Parameters
[out]pOutwill have the buffer size in bytes after this function is called
[in]pFieldis the vector field handle
Returns
fg_err error code

§ fg_get_vector_field_color_buffer()

FGAPI fg_err fg_get_vector_field_color_buffer ( unsigned *  pOut,
const fg_vector_field  pField 
)

Get the resource identifier for colors buffer.

Parameters
[out]pOutwill have the buffer identifier after this function is called
[in]pFieldis the vector field handle
Returns
fg_err error code

§ fg_get_vector_field_color_buffer_size()

FGAPI fg_err fg_get_vector_field_color_buffer_size ( unsigned *  pOut,
const fg_vector_field  pField 
)

Get the colors buffer size in bytes.

Parameters
[out]pOutwill have the buffer size in bytes after this function is called
[in]pFieldis the vector field handle
Returns
fg_err error code

§ fg_get_vector_field_direction_buffer()

FGAPI fg_err fg_get_vector_field_direction_buffer ( unsigned *  pOut,
const fg_vector_field  pField 
)

Get the resource identifier for directions buffer.

Parameters
[out]pOutwill have the buffer identifier after this function is called
[in]pFieldis the vector field handle
Returns
fg_err error code

§ fg_get_vector_field_direction_buffer_size()

FGAPI fg_err fg_get_vector_field_direction_buffer_size ( unsigned *  pOut,
const fg_vector_field  pField 
)

Get the directions buffer size in bytes.

Parameters
[out]pOutwill have the buffer size in bytes after this function is called
[in]pFieldis the vector field handle
Returns
fg_err error code

§ fg_get_vector_field_vertex_buffer()

FGAPI fg_err fg_get_vector_field_vertex_buffer ( unsigned *  pOut,
const fg_vector_field  pField 
)

Get the resource identifier for vertices buffer.

Parameters
[out]pOutwill have the buffer identifier after this function is called
[in]pFieldis the vector field handle
Returns
fg_err error code

§ fg_get_vector_field_vertex_buffer_size()

FGAPI fg_err fg_get_vector_field_vertex_buffer_size ( unsigned *  pOut,
const fg_vector_field  pField 
)

Get the vertices buffer size in bytes.

Parameters
[out]pOutwill have the buffer size in bytes after this function is called
[in]pFieldis the vector field handle
Returns
fg_err error code

§ fg_set_vector_field_color()

FGAPI fg_err fg_set_vector_field_color ( fg_vector_field  pField,
const float  pRed,
const float  pGreen,
const float  pBlue,
const float  pAlpha 
)

Set the color of vector field.

Parameters
[in]pFieldis the surface handle
[in]pRedis Red component in range [0, 1]
[in]pGreenis Green component in range [0, 1]
[in]pBlueis Blue component in range [0, 1]
[in]pAlphais Blue component in range [0, 1]
Returns
fg_err error code

§ fg_set_vector_field_legend()

FGAPI fg_err fg_set_vector_field_legend ( fg_vector_field  pField,
const char *  pLegend 
)

Set vector field legend.

Parameters
[in]pFieldis the vector field handle
[in]pLegend
Returns
fg_err error code