VisuDumpScene

VisuDumpScene — A generic class defining interface to export VisuGlNodeScene into image formats.

Functions

Types and Values

Object Hierarchy

    GObject
    ╰── ToolDbgObj
        ╰── ToolFileFormat
            ╰── VisuDump
                ╰── VisuDumpScene

Description

Instance of this class can be used to export any VisuGlNodeScene into image formats.

Functions

VisuDumpSceneWriteFunc ()

gboolean
(*VisuDumpSceneWriteFunc) (ToolFileFormat *format,
                           const char *fileName,
                           VisuGlNodeScene *scene,
                           guint width,
                           guint height,
                           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.

Parameters

format

a ToolFileFormat object, corresponding to the write method ;

 

fileName

a string that defined the file to write to ;

 

scene

the VisuGlNodeScene to be exported ;

 

width

the desired width.

 

height

the desired height.

 

error

a location to store some error (not NULL) ;.

[allow-none]

functionWait

a method to call periodically during the dump ;.

[allow-none][scope call]

data

some pointer on object to be passed to the wait function.

[closure]

Returns

TRUE if everything went right.


visu_dump_scene_new ()

VisuDumpScene *
visu_dump_scene_new (const gchar *descr,
                     const gchar **patterns,
                     VisuDumpSceneWriteFunc method,
                     gboolean hasAlpha);

Creates a new VisuDumpScene object.

Parameters

descr

a description.

 

patterns

a list of file patterns.

[array zero-terminated=1]

method

the write method.

[scope call]

hasAlpha

a boolean.

 

Returns

a newly created VisuDumpScene object.

[transfer full]

Since: 3.8


visu_dump_scene_getAlphaStatus ()

gboolean
visu_dump_scene_getAlphaStatus (VisuDumpScene *dump);

Retrieve if dump use alpha channel or not.

Parameters

dump

a VisuDump method.

 

Returns

TRUE if dump has an alpha channel.


visu_dump_scene_write ()

gboolean
visu_dump_scene_write (VisuDumpScene *dump,
                       const char *fileName,
                       VisuGlNodeScene *scene,
                       guint width,
                       guint height,
                       ToolVoidDataFunc functionWait,
                       gpointer data,
                       GError **error);

Use the write function of dump to export the scene to file fileName .

Parameters

dump

a VisuDump object ;

 

fileName

a string that defined the file to write to ;.

[type filename]

scene

the VisuGlNodeScene to be exported.

 

width

an integer ;

 

height

an integer ;

 

functionWait

a method to call periodically during the dump ;.

[allow-none][closure data][scope call]

data

some pointer on object to be passed to the wait function.

[closure]

error

a location to store some error (not NULL) ;

 

Returns

TRUE if dump succeed.

Since: 3.6

Types and Values

struct VisuDumpScene

struct VisuDumpScene;

Common name to refer to a _VisuDumpScene.


struct VisuDumpSceneClass

struct VisuDumpSceneClass {
  VisuDumpClass parent;
};

Common name to refer to a _VisuDumpSceneClass.

Members

VisuDumpClass parent;

private.