| V_Sim API - Reference Manual | ||||
|---|---|---|---|---|
enum RenderingModeId; void openGLInit_renderingMode (); gboolean openGLSet_globalRenderingMode (RenderingModeId value); RenderingModeId openGLGet_globalRenderingOption (); void openGLApply_renderingMode (RenderingModeId mode); const char** openGLGet_allRenderingModes (); gboolean openGLGet_renderingFromName (const char *name, RenderingModeId *id);
This modules creates an interface to access to the way OpenGL renders the objects (glPolygonMode() and glShadeModel() functions). There are then three rendering modes available in V_Sim: wireframe, flat and smooth. They are controls by an enum RenderingModeId. When openGLApply_renderingMode() is called, the current rendering mode is changed for all future drawing calls that uses polygons.
typedef enum
{
Wireframe,
Flat,
Smooth,
SmoothAndEdge,
nb_renderingModes,
followGeneralSetting
} RenderingModeId;
Implemented mode to draw objects.
| objects are rendered with lines only ; | |
| objects are rendered with polygons whose colours are uniform on each polygon ; | |
| objects are rendered with polygons whose colours are shaded to be smooth all along the object. | |
| objects are rendered with lines hightlighting the contours of polygons. | |
| number of rendering mode. | |
| use this value not to choose any rendering mode. |
void openGLInit_renderingMode ();
This method is used by opengl.c to initialise this module (declare config file options...). It should not be called elsewhere.
gboolean openGLSet_globalRenderingMode (RenderingModeId value);
This function change the value of the parameter renderingOption. It controls how V_Sim renders objects, in wireframe for example.
|
an integer to represent the method of rendering. |
Returns : |
TRUE if the signal OpenGLAskForReDraw should be emitted. |
RenderingModeId openGLGet_globalRenderingOption ();
This function retrieve the value of the parameter renderingOption.
Returns : |
the identifier of the current rendering option. |
void openGLApply_renderingMode (RenderingModeId mode);
Change the rendering mode of current OpenGL context.
|
an integer. |
const char** openGLGet_allRenderingModes ();
This function retrieve al the names of available rendering modes.
Returns : |
an array of string, NULL terminated that is private (not to be freed). |
gboolean openGLGet_renderingFromName (const char *name,
RenderingModeId *id);
This function retrieve the rendering mode id associated to the name.
|
a string ; |
|
a location to store the resulting id. |
Returns : |
TRUE if the name exists. |