C API Enums¶

Error Code¶

enum fg_err¶

Return Error Codes for Forge C API.

Values:

enumerator FG_ERR_NONE¶: Fuction returned successfully.

enumerator FG_ERR_SIZE¶: Invalid size argument.

enumerator FG_ERR_INVALID_TYPE¶: Invalid type argument.

enumerator FG_ERR_INVALID_ARG¶: Invalid argument.

enumerator FG_ERR_GL_ERROR¶: OpenGL error.

enumerator FG_ERR_FREETYPE_ERROR¶: Freetype library error.

enumerator FG_ERR_FILE_NOT_FOUND¶: File IO errors.

enumerator FG_ERR_NOT_SUPPORTED¶: Feature not supported.

enumerator FG_ERR_NOT_CONFIGURED¶: Library configuration mismatch.

enumerator FG_ERR_FONTCONFIG_ERROR¶: Fontconfig related error.

enumerator FG_ERR_FREEIMAGE_UNKNOWN_FORMAT¶: Unknown format, not supported by freeimage.

enumerator FG_ERR_FREEIMAGE_BAD_ALLOC¶: freeimage memory allocation failed

enumerator FG_ERR_FREEIMAGE_SAVE_FAILED¶: freeimage file save failed

enumerator FG_ERR_INTERNAL¶: Internal error.

enumerator FG_ERR_RUNTIME¶: Runtime error.

enumerator FG_ERR_UNKNOWN¶: Unkown error.

Image Channel Format¶

enum fg_channel_format¶

Image Channel Formats.

Values:

enumerator FG_GRAYSCALE¶: Single channel.

enumerator FG_RG¶: Three(Red, Green & Blue) channels.

enumerator FG_RGB¶: Three(Red, Green & Blue) channels.

enumerator FG_BGR¶: Three(Red, Green & Blue) channels.

enumerator FG_RGBA¶: Four(Red, Green, Blue & Alpha) channels.

enumerator FG_BGRA¶: Four(Red, Green, Blue & Alpha) channels.

Chart Dimensionality¶

enum fg_chart_type¶

Chart dimensionality i.e. 2D or 3D.

Values:

enumerator FG_CHART_2D¶: Two dimensional charts.

enumerator FG_CHART_3D¶: Three dimensional charts.

Color Maps¶

enum fg_color_map¶

Color Maps.

Values:

enumerator FG_COLOR_MAP_DEFAULT¶: Default [0-255] grayscale colormap.

enumerator FG_COLOR_MAP_SPECTRUM¶: Visual spectrum (390nm-830nm) in sRGB colorspace.

enumerator FG_COLOR_MAP_RAINBOW¶: Rainbow color map.

enumerator FG_COLOR_MAP_RED¶: Red color map.

enumerator FG_COLOR_MAP_MOOD¶: Mood color map.

enumerator FG_COLOR_MAP_HEAT¶: Heat color map.

enumerator FG_COLOR_MAP_BLUE¶: Blue color map.

enumerator FG_COLOR_MAP_INFERNO¶: perceptually uniform shades of black-red-yellow

enumerator FG_COLOR_MAP_MAGMA¶: perceptually uniform shades of black-red-white

enumerator FG_COLOR_MAP_PLASMA¶: perceptually uniform shades of blue-red-yellow

enumerator FG_COLOR_MAP_VIRIDIS¶: perceptually uniform shades of blue-green-yellow

Color Codes¶

enum fg_color¶

Color Constants.

Values:

enumerator FG_RED¶

enumerator FG_GREEN¶

enumerator FG_BLUE¶

enumerator FG_YELLOW¶

enumerator FG_CYAN¶

enumerator FG_MAGENTA¶

enumerator FG_WHITE¶

enumerator FG_BLACK¶

Data Type¶

enum fg_dtype¶

Enum representation of internal data types.

Values:

enumerator FG_INT8¶: Signed byte (8-bits)

enumerator FG_UINT8¶: Unsigned byte (8-bits)

enumerator FG_INT32¶: Signed integer (32-bits)

enumerator FG_UINT32¶: Unsigned integer (32-bits)

enumerator FG_FLOAT32¶: Float (32-bits)

enumerator FG_INT16¶: Signed integer (16-bits)

enumerator FG_UINT16¶: Unsigned integer (16-bits)

Plots¶

enum fg_plot_type¶

Plot Style.

Values:

enumerator FG_PLOT_LINE¶: Line plot.

enumerator FG_PLOT_SCATTER¶: Scatter plot.

enumerator FG_PLOT_SURFACE¶: Surface plot.

Point Marker Shapes¶

enum fg_marker_type¶

Markers rendered as sprites.

Values:

enumerator FG_MARKER_NONE¶: No marker.

enumerator FG_MARKER_POINT¶: Point marker.

enumerator FG_MARKER_CIRCLE¶: Circle marker.

enumerator FG_MARKER_SQUARE¶: Square marker.

enumerator FG_MARKER_TRIANGLE¶: Triangle marker.

enumerator FG_MARKER_CROSS¶: Cross-hair marker.

enumerator FG_MARKER_PLUS¶: Plus symbol marker.

enumerator FG_MARKER_STAR¶: Star symbol marker.