VisuDump

VisuDump — Some resources to add the ability to export the rendered data to an other format (usually image format).

Functions

Types and Values

Object Hierarchy

    GObject
    ╰── ToolDbgObj
        ╰── ToolFileFormat
            ╰── VisuDump
                ├── VisuDumpData
                ╰── VisuDumpScene

Description

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 ToolFileFormat and a method that is called when exporting is required.

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.

Functions

visu_dump_getQuark ()

GQuark
visu_dump_getQuark ();

Internal routine to get the GQuark to handle error related to dump actions.

[skip]


VisuDumpInitFunc ()

const VisuDump *
(*VisuDumpInitFunc) ();

This protoype defines initializing function for dumping extension. Create such a function and add its name in the list listInitDumpModuleFunc defined in dumpModules/externalDumpModules.h thus the new dumping extension will be initialized on startup.

[skip]

Returns

a newly allocated VisuDump.


visu_dump_pool_getAllModules ()

GList *
visu_dump_pool_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*]


visu_dump_getNModules ()

gint
visu_dump_getNModules ();

A convenient way to know how many dumping extensions are registered.

Returns

the number of known dumping extensions.


visu_dump_pool_finalize ()

void
visu_dump_pool_finalize (void);

Free the list of VisuDump modules.

Since: 3.8


visu_dump_abort ()

void
visu_dump_abort (GObject *obj,
                 gpointer data);

Does nothing for the moment.

Parameters

obj

an object ;

 

data

some data.

 

Types and Values

struct VisuDumpClass

struct VisuDumpClass {
  ToolFileFormatClass parent;
};

An opaque structure.

Members

ToolFileFormatClass parent;

the parent class.

 

enum VisuDumpErrorFlag

These are flags used when dumping to a file.

Members

DUMP_ERROR_OPENGL

Error with OpenGL dumping.

 

DUMP_ERROR_FILE

Error when opening.

 

DUMP_ERROR_ENCODE

Wrongness when computing the encoding format.