![]() |
![]() |
![]() |
V_Sim API - Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
visu_dumpvisu_dump — Some resources to add the ability to export the rendered data to an other format (usually image format). |
gboolean (*VisuDumpWriteFunc) (ToolFileFormat *format
,const char *fileName
,int width
,int height
,VisuData *dataObj
,guchar *image
,GError **error
,ToolVoidDataFunc functionWait
,gpointer data
); VisuDump; #define VISU_ERROR_DUMP GQuark visu_dump_getQuark (); enum DumpErrorFlag; VisuDump * (*VisuDumpInitFunc) (); void visuDumpAdd (VisuDump *dump
); gboolean visu_dump_callWriteFunc (VisuDump *dump
,const char *fileName
,int width
,int height
,VisuData *dataObj
,GArray *image
,ToolVoidDataFunc functionWait
,gpointer data
,GError **error
); GList* visu_dump_getAllModules (); gint visu_dump_getNModules (); void visuDumpAbort (GObject *obj
,gpointer data
);
V_Sim can export loaded data to othe formats. This module descibes the methods and structure to create a dumping extension. Basically, a dumping extension is just a FileFormat and a method that is called when exporting is required. No method exists to create a dumping extension, just allocate and initialize the DumpType structure.
The writeDumpFunc should suspend its process to allow the
calling program to refresh itself if the dump process is
slow. Ideally, the argument waitFunction
should be called exactly
100 times.
gboolean (*VisuDumpWriteFunc) (ToolFileFormat *format
,const char *fileName
,int width
,int height
,VisuData *dataObj
,guchar *image
,GError **error
,ToolVoidDataFunc functionWait
,gpointer data
);
This is a prototype of a method implemented by a dumping extension that is called when the current rendering must be dumped to a file.
|
a ToolFileFormat object, corresponding to the write method ; |
|
a string that defined the file to write to ; |
|
an integer ; |
|
an integer. |
|
the VisuData to be exported ; |
|
the data to be written ; |
|
a location to store some error (not NULL) ;. allow-none. |
|
a method to call periodically during the dump ;. scope call |
|
some pointer on object to be passed to the wait function.. closure |
Returns : |
TRUE if everything went right. |
typedef struct { gboolean bitmap, glRequired; ToolFileFormat *fileType; gboolean hasAlpha; VisuDumpWriteFunc writeFunc; } VisuDump;
This structure is used to store a dumping extension. Such an extension is characterized by its ToolFileFormat and a method that can write a file from the current rendered data.
gboolean |
TRUE if the format requires to export the view into a bitmap ;. in. |
gboolean |
TRUE if the method requires to run OpenGL.. in. |
ToolFileFormat * |
a ToolFileFormat ; |
gboolean |
TRUE if the format support alpha channel ; |
VisuDumpWriteFunc |
a pointer to a write func.. scope call |
typedef enum { DUMP_ERROR_OPENGL, DUMP_ERROR_FILE, DUMP_ERROR_ENCODE } DumpErrorFlag;
These are flags used when dumping to a file.
void visuDumpAdd (VisuDump *dump
);
Add the provided dump method to the list of available ones.
|
a VisuDump method. |
Since 3.6
gboolean visu_dump_callWriteFunc (VisuDump *dump
,const char *fileName
,int width
,int height
,VisuData *dataObj
,GArray *image
,ToolVoidDataFunc functionWait
,gpointer data
,GError **error
);
Use the write function of dump
to export the current dataObj
to
file fileName
.
|
a VisuDump object ; |
|
a string that defined the file to write to ; |
|
an integer ; |
|
an integer ; |
|
the VisuData to be exported ; |
|
the data to be written ;. allow-none. element-type gint8. |
|
a location to store some error (not NULL) ; |
|
a method to call periodically during the dump ;. scope call |
|
some pointer on object to be passed to the wait function.. closure |
Returns : |
TRUE if dump succeed. |
Since 3.6
GList* visu_dump_getAllModules ();
All dumping extensions are stored in an opaque way in V_Sim. But they can be listed by a call to this method.
Returns : |
a list of all the known dumping extensions. This list is own by V_Sim and should be considered read-only.. transfer none. element-type VisuDump*. |
gint visu_dump_getNModules ();
A convenient way to know how many dumping extensions are registered.
Returns : |
the number of known dumping extensions. |