PgmRenderStrokeIFace

PgmRenderStrokeIFace — An interface for drawing different stroked lines.

Synopsis




enum                PgmRenderStrokePattern;
                    PgmRenderStrokeIFace;
PgmRenderError      pgm_render_stroke_set_width         (PgmRenderStrokeIFace *stroke,
                                                         gfloat width);
PgmRenderError      pgm_render_stroke_get_width         (PgmRenderStrokeIFace *stroke,
                                                         gfloat *width);
PgmRenderError      pgm_render_stroke_set_pattern       (PgmRenderStrokeIFace *stroke,
                                                         PgmRenderStrokePattern pattern);
PgmRenderError      pgm_render_stroke_get_pattern       (PgmRenderStrokeIFace *stroke,
                                                         PgmRenderStrokePattern *pattern);
PgmRenderError      pgm_render_stroke_set_factor        (PgmRenderStrokeIFace *stroke,
                                                         gint factor);
PgmRenderError      pgm_render_stroke_get_factor        (PgmRenderStrokeIFace *stroke,
                                                         gint *factor);
PgmRenderError      pgm_render_stroke_set_color         (PgmRenderStrokeIFace *stroke,
                                                         guchar r,
                                                         guchar g,
                                                         guchar b,
                                                         guchar a);
PgmRenderError      pgm_render_stroke_get_color         (PgmRenderStrokeIFace *stroke,
                                                         guchar *r,
                                                         guchar *g,
                                                         guchar *b,
                                                         guchar *a);


Description

PgmRenderStrokeIFace is an interface to add stroking capabilities to an object.

Details

enum PgmRenderStrokePattern

typedef enum {
  PGM_RENDER_STROKE_CONTINUOUS,
  PGM_RENDER_STROKE_DASHED
} PgmRenderStrokePattern;

The different stroke pattern.

PGM_RENDER_STROKE_CONTINUOUS A linear stroke pattern.
PGM_RENDER_STROKE_DASHED A dashed stroke pattern.

PgmRenderStrokeIFace

typedef struct _PgmRenderStrokeIFace PgmRenderStrokeIFace;


pgm_render_stroke_set_width ()

PgmRenderError      pgm_render_stroke_set_width         (PgmRenderStrokeIFace *stroke,
                                                         gfloat width);

Sets the width of stroke.

stroke : A PgmRenderStrokeIFace object.
width : The width of stroke. 0 by default.
Returns : An error status.

pgm_render_stroke_get_width ()

PgmRenderError      pgm_render_stroke_get_width         (PgmRenderStrokeIFace *stroke,
                                                         gfloat *width);

Retrieves the width of stroke.

stroke : A PgmRenderStrokeIFace object.
width : The width to fill.
Returns : An error status.

pgm_render_stroke_set_pattern ()

PgmRenderError      pgm_render_stroke_set_pattern       (PgmRenderStrokeIFace *stroke,
                                                         PgmRenderStrokePattern pattern);

Sets the pattern of stroke.

stroke : A PgmRenderStrokeIFace object.
pattern : The pattern of stroke. PGM_RENDER_STROKE_CONTINUOUS by default.
Returns : An error status.

pgm_render_stroke_get_pattern ()

PgmRenderError      pgm_render_stroke_get_pattern       (PgmRenderStrokeIFace *stroke,
                                                         PgmRenderStrokePattern *pattern);

Retrieves the pattern of stroke.

stroke : A PgmRenderStrokeIFace object.
pattern : The pattern to fill.
Returns : An error status.

pgm_render_stroke_set_factor ()

PgmRenderError      pgm_render_stroke_set_factor        (PgmRenderStrokeIFace *stroke,
                                                         gint factor);

Sets the factor of stroke. If the pattern is PGM_RENDER_STROKE_DASHED, the factor change the size of the dash as well as the blank between each dash.

stroke : A PgmRenderStrokeIFace object.
factor : The factor of stroke. 3 by default.
Returns : An error status.

pgm_render_stroke_get_factor ()

PgmRenderError      pgm_render_stroke_get_factor        (PgmRenderStrokeIFace *stroke,
                                                         gint *factor);

Retrieves the factor of stroke.

stroke : A PgmRenderStrokeIFace object.
factor : The factor to fill.
Returns : An error status.

pgm_render_stroke_set_color ()

PgmRenderError      pgm_render_stroke_set_color         (PgmRenderStrokeIFace *stroke,
                                                         guchar r,
                                                         guchar g,
                                                         guchar b,
                                                         guchar a);

Sets the color of stroke to (r, g, b, a).

stroke : A PgmRenderStrokeIFace object.
r : The R color layer.
g : The G color layer.
b : The B color layer.
a : The A color layer.
Returns : An error status.

pgm_render_stroke_get_color ()

PgmRenderError      pgm_render_stroke_get_color         (PgmRenderStrokeIFace *stroke,
                                                         guchar *r,
                                                         guchar *g,
                                                         guchar *b,
                                                         guchar *a);

Retrieves the (r, g, b, a) color of stroke.

stroke : A PgmRenderStrokeIFace object.
r : The R color layer to fill.
g : The G color layer to fill.
b : The B color layer to fill.
a : The A color layer to fill.
Returns : An error status.