VisuGlExtSurfaces

VisuGlExtSurfaces — Defines methods to draw surfaces.

Functions

Properties

gboolean draw-intra Read / Write
VisuBox * fitting-box Read / Write

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── ToolDbgObj
        ╰── VisuGlExt
            ╰── VisuGlExtSurfaces

Description

VisuSurface object can be drawn with this class. Simply create a new VisuGlExtSurfaces object and add surfaces with visu_gl_ext_surfaces_add(). It is better to add several surfaces to a single VisuGlExtSurfaces object since all vertices are reordered when necessary to ensure proper transparency.

Functions

visu_gl_ext_surfaces_new ()

VisuGlExtSurfaces *
visu_gl_ext_surfaces_new (const gchar *name);

Creates a new VisuGlExt to draw surfaces.

Parameters

name

the name to give to the extension (default is VISU_GL_EXT_SURFACES_ID).

[allow-none]

Returns

a pointer to the VisuGlExt it created or NULL otherwise.

Since: 3.7


visu_gl_ext_surfaces_add ()

gboolean
visu_gl_ext_surfaces_add (VisuGlExtSurfaces *surfaces,
                          VisuSurface *surf);

Add a new surface to the list of drawn surfaces.

Parameters

surfaces

a VisuGlExtSurfaces object.

 

surf

a VisuSurface object.

[transfer full]

Returns

FALSE if surf was already registered.

Since: 3.7


visu_gl_ext_surfaces_remove ()

gboolean
visu_gl_ext_surfaces_remove (VisuGlExtSurfaces *surfaces,
                             VisuSurface *surf);

Removes surf from the list of drawn surfaces.

Parameters

surfaces

a VisuGlExtSurfaces object.

 

surf

a VisuSurface object.

 

Returns

TRUE if surf was part of the drawn surfaces.

Since: 3.7


visu_gl_ext_surfaces_setMask ()

gboolean
visu_gl_ext_surfaces_setMask (VisuGlExtSurfaces *surfaces,
                              VisuPlaneSet *mask);

Attach mask to every surface of the set.

Parameters

surfaces

a VisuGlExtSurfaces object.

 

mask

a VisuPlaneSet object.

[allow-none]

Returns

TRUE if mask is changed.

Since: 3.8


visu_gl_ext_surfaces_setOnTheFlyOrdering ()

gboolean
visu_gl_ext_surfaces_setOnTheFlyOrdering
                               (VisuGlExtSurfaces *surfaces,
                                VisuGlView *view);

Attach surfaces to view , so it can be rendered there.

Parameters

surfaces

the VisuGlExtSurfaces object to attached to rendering view.

 

view

a VisuGlView object.

[transfer full][allow-none]

Returns

TRUE if the status actually changed.

Since: 3.7


visu_gl_ext_surfaces_setOnObserveOrdering ()

gboolean
visu_gl_ext_surfaces_setOnObserveOrdering
                               (VisuGlExtSurfaces *surfaces,
                                VisuInteractive *inter);

Attach surfaces to inter , so it can be rendered there.

Parameters

surfaces

the VisuGlExtSurfaces object to attached to rendering inter.

 

inter

a VisuInteractive object.

[transfer full][allow-none]

Returns

TRUE if the status actually changed.

Since: 3.7


visu_gl_ext_surfaces_setFittingBox ()

gboolean
visu_gl_ext_surfaces_setFittingBox (VisuGlExtSurfaces *surfaces,
                                    VisuBox *box);

Changes the box from which surfaces are scaled in.

Parameters

surfaces

a VisuGlExtSurfaces object.

 

box

a VisuBox object.

[allow-none]

Returns

TRUE if value is actually changed.

Since: 3.8


visu_gl_ext_surfaces_getDrawIntra ()

gboolean
visu_gl_ext_surfaces_getDrawIntra (VisuGlExtSurfaces *surfs);

Retrieve if the interiors of surfaces are drawn with a colour inverse or not.

Parameters

surfs

a VisuGlExtSurfaces object.

 

Returns

TRUE if the interior is painted in colour inverse.


visu_gl_ext_surfaces_setDrawIntra ()

gboolean
visu_gl_ext_surfaces_setDrawIntra (VisuGlExtSurfaces *surfs,
                                   gboolean status);

Set if the interiors of surfaces are drawn with a colour inverse or not.

Parameters

surfs

a VisuGlExtSurfaces object.

 

status

a boolean.

 

Returns

TRUE if the status actually changed.

Types and Values

VISU_GL_EXT_SURFACES_ID

#define VISU_GL_EXT_SURFACES_ID "Surfaces"

The id used to identify this extension, see visu_gl_ext_rebuild() for instance.

Property Details

The “draw-intra” property

  “draw-intra”               gboolean

use inverse colour for inside.

Flags: Read / Write

Default value: FALSE


The “fitting-box” property

  “fitting-box”              VisuBox *

If set, all surfaces are scaled to fit this box.

Flags: Read / Write

Signal Details

The “added” signal

void
user_function (VisuGlExtSurfaces *set,
               VisuSurface       *surface,
               gpointer           user_data)

This signal is emitted each time a surface is added to the set.

Parameters

set

the object emitting the signal.

 

surface

the added VisuSurface object.

 

user_data

user data set when the signal handler was connected.

 

Flags: No Hooks

Since: 3.8


The “removed” signal

void
user_function (VisuGlExtSurfaces *set,
               VisuSurface       *surface,
               gpointer           user_data)

This signal is emitted each time a surface is removed from the set.

Parameters

set

the object emitting the signal.

 

surface

the removed VisuSurface object.

 

user_data

user data set when the signal handler was connected.

 

Flags: No Hooks

Since: 3.8