![]() |
![]() |
![]() |
V_Sim API - Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces |
OpenGLWidget; OpenGLWidgetClass; void (*RedrawMethod) (const char **lists
,VisuData *data
); #define TYPE_OPENGL_WIDGET #define OPENGL_WIDGET (obj) #define OPENGL_WIDGET_CLASS (obj) #define IS_OPENGL_WIDGET (obj) #define IS_OPENGL_WIDGET_CLASS (obj) #define OPENGL_WIDGET_GET_CLASS (obj) GType openGLWidget_get_type (void
); GtkWidget* openGLWidgetNew (gboolean contextIsDirect
); gboolean openGLWidgetSet_current (OpenGLWidget *render
,gboolean force
); void openGLWidgetSet_redraw (OpenGLWidget *render
,RedrawMethod method
,VisuData *data
); void openGLWidgetRedraw (OpenGLWidget *render
); void openGLWidgetSwap_buffers (OpenGLWidget *render
); GArray* openGLWidgetGet_pixmapData (OpenGLWidget *render
,int *width
,int *height
,gboolean offScreen
,gboolean hasAlpha
); OpenGLWidget* openGLWidgetClassGet_currentContext ();
This is a simple implementation of GtkGlExt to create an
OpenGL surface that is a full GtkWidget. When creating such a
widget, one should give then a RedrawMethod()
to tell the widget
how to redraw itself when needed.
The current implementation is working on X11 (built-in or with GtkGlExt) and Win32.
typedef struct _OpenGLWidget OpenGLWidget;
Short name to address OpenGLWidget_struct objects.
typedef struct _OpenGLWidgetClass OpenGLWidgetClass;
Short name to address OpenGLWidgetClass_struct objects.
void (*RedrawMethod) (const char **lists
,VisuData *data
);
Methods of this prototype are called when the redraw of the OpenGL zone should be done.
|
a string array, NULL terminated. |
|
the VisuData to draw. |
#define TYPE_OPENGL_WIDGET (openGLWidget_get_type())
The type of OpenGLWidget objects.
#define OPENGL_WIDGET_CLASS(obj)
Cast obj
to OpenGLWidgetClass if possible.
|
a pointer. |
#define IS_OPENGL_WIDGET(obj)
Return TRUE is obj
is an OpenGLWidget object (or inherit from).
|
a pointer. |
#define IS_OPENGL_WIDGET_CLASS(obj)
Return TRUE is obj
is an OpenGLWidgetClass object (or inherit from).
|
a pointer. |
#define OPENGL_WIDGET_GET_CLASS(obj)
Return the class of the given OpenGLWidget object.
|
a pointer. |
GType openGLWidget_get_type (void
);
Retrive the type of OpenGLWidget objects.
Returns : |
the id used by OBjects for OpenGLWidget objects. |
GtkWidget* openGLWidgetNew (gboolean contextIsDirect
);
Create a new OpenGL area inside a GTK widget. If contextIsDirect
then
it tries to initialise the OpenGL context to a direct one.
|
a boolean. |
Returns : |
a newly created widget. |
gboolean openGLWidgetSet_current (OpenGLWidget *render
,gboolean force
);
Make this object current. This means that all future OpenGL primitive will be
rendered on this surface. If force
is TRUE, the GL routine is
actually called whereas in other cases, if render
believe being
already current, nothing is done.
|
a OpenGLWidget object ; |
|
a boolean. |
Returns : |
TRUE if succeed. |
void openGLWidgetSet_redraw (OpenGLWidget *render
,RedrawMethod method
,VisuData *data
);
This method is used to defined a redraw method for the OpenGL area. By doing this
the area will automatically redraw itself when necessary. Before doing it
it calls openGLWidgetSet_current()
; and after it calls openGLWidgetSwap_buffers()
.
|
a OpenGLWidget object ; |
|
a redraw method ; |
|
the VisuData to draw. |
void openGLWidgetRedraw (OpenGLWidget *render
);
Force redraw on the given surface, if a redraw method have been given (see
openGLWidgetSet_redraw()
).
|
a OpenGLWidget object. |
void openGLWidgetSwap_buffers (OpenGLWidget *render
);
Swap the buffers of the OpenGL area.
|
a OpenGLWidget object. |
GArray* openGLWidgetGet_pixmapData (OpenGLWidget *render
,int *width
,int *height
,gboolean offScreen
,gboolean hasAlpha
);
Create an image from the OpenGL area. The size can be changed, using width
and
height
. If these pointers contains positive values, then they are used to set the
size for the image. If not, the current size is used and stored in these pointers.
The boolean offScreen is used to tell if the image is taken from current context
or if an offscreen pixmap is created for the rendering.
|
a OpenGLWidget object ; |
|
a pointer to the desired width or -1 ; |
|
a pointer to the desired height or -1 ; |
|
a boolean ; |
|
if TRUE, the returned data is RGBA, else only RGB. |
Returns : |
image data, row by row. |
OpenGLWidget* openGLWidgetClassGet_currentContext ();
Class routine that returns the OpenGL widget which has the current context.
Returns : |
the OpenGLWidget with the current OpenGL context. |