VisuSurfaceResource

VisuSurfaceResource — Define the rendering parameters of a surface.

Functions

Properties

ToolColor * color Read / Write
gchar * label Read / Write / Construct Only
gboolean maskable Read / Write
ToolMaterial * material Read / Write
gboolean rendered Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── ToolDbgObj
        ╰── VisuSurfaceResource

Description

This structure stores all the rendering elements of a set of VisuSurface.

Functions

visu_surface_resource_new_fromName ()

VisuSurfaceResource *
visu_surface_resource_new_fromName (const gchar *surf_name,
                                    gboolean *new_surf);

This returns the resource information matching the given surf_name . If the resource doesn't exist, it is created and new is set to TRUE. If the given name (surf_name ) is NULL, then a new resource is created, but it is not stored and will not be shared by surfaces.

Parameters

surf_name

the name of the surface (can be NULL) ;

 

new_surf

a location to store a boolean value (can be NULL).

 

Returns

the resource (created or retrieved).

[transfer full]


visu_surface_resource_new_fromCopy ()

VisuSurfaceResource *
visu_surface_resource_new_fromCopy (const gchar *surf_name,
                                    const VisuSurfaceResource *orig);

Copy constructor of VisuSurfaceResource objects.

Parameters

surf_name

a label.

 

orig

a VisuSurfaceResource obejct.

 

Returns

a newly created VisuSurfaceResource object.

[transfer full]

Since: 3.8


visu_surface_resource_getLabel ()

const gchar *
visu_surface_resource_getLabel (const VisuSurfaceResource *res);

Retrieves the label of res .

Parameters

res

a VisuSurfaceResource object.

 

Returns

a string.

Since: 3.8


visu_surface_resource_getColor ()

const ToolColor *
visu_surface_resource_getColor (const VisuSurfaceResource *res);

Retrieves the color of res .

Parameters

res

a VisuSurfaceResource object.

 

Returns

a color.

Since: 3.8


visu_surface_resource_getMaterial ()

const float *
visu_surface_resource_getMaterial (const VisuSurfaceResource *res);

Retrieves the material of res .

Parameters

res

a VisuSurfaceResource object.

 

Returns

a material.

Since: 3.8


visu_surface_resource_getRendered ()

gboolean
visu_surface_resource_getRendered (const VisuSurfaceResource *res);

Retrieves wether res is drawn or not.

Parameters

res

a VisuSurfaceResource object.

 

Returns

a boolean.

Since: 3.8


visu_surface_resource_getMaskable ()

gboolean
visu_surface_resource_getMaskable (const VisuSurfaceResource *res);

Retrieves if res is sensitive to masking properties.

Parameters

res

a VisuSurfaceResource object.

 

Returns

a boolean.

Since: 3.8


visu_surface_resource_pool_finalize ()

void
visu_surface_resource_pool_finalize (void);

Free memory allocated to store various VisuSurfaceResource objects.

[skip]

Since: 3.8

Types and Values

struct VisuSurfaceResourceClass

struct VisuSurfaceResourceClass {
  VisuObjectClass parent;
};

Common name to refer to a _VisuSurfaceResourceClass.

Members

VisuObjectClass parent;

private.

 

Property Details

The “color” property

  “color”                    ToolColor *

rendering color.

Flags: Read / Write


The “label” property

  “label”                    gchar *

label of the resource.

Flags: Read / Write / Construct Only

Default value: NULL


The “maskable” property

  “maskable”                 gboolean

masked or not.

Flags: Read / Write

Default value: FALSE


The “material” property

  “material”                 ToolMaterial *

rendering material.

Flags: Read / Write


The “rendered” property

  “rendered”                 gboolean

rendered or not.

Flags: Read / Write

Default value: FALSE