Pair


NAME

draw - Image Vector Drawing Methods


SYNOPSIS

void DrawAffine( DrawContext context, const AffineMatrix *affine );

DrawContext DrawAllocateContext( const DrawInfo *draw_info, Image *image );

void DrawAnnotation( DrawContext context, const double x, const double y, const unsigned char *text );

void DrawArc( DrawContext context, const double sx, const double sy, const double ex, const double ey, const double sd, const double ed );

void DrawBezier( DrawContext context, const size_t num_coords, const PointInfo *coordinates );

void DrawCircle( DrawContext context, const double ox, const double oy, const double px, const double py );

void DrawColor( DrawContext context, const double x, const double y, const PaintMethod paintMethod );

void DrawComment( DrawContext context, const char *comment );

void DrawComposite( DrawContext context, const CompositeOperator composite_operator, const double x, const double y, const double width, const double height, const Image *image );

void DrawDestroyContext( DrawContext context );

void DrawEllipse( DrawContext context, const double ox, const double oy, const double rx, const double ry, const double start, const double end );

void DrawGetClipPath( DrawContext context, char ** clip_path );

void DrawGetClipRule( DrawContext context, FillRule *fill_rule );

void DrawGetClipUnits( DrawContext context, ClipPathUnits *clip_units );

void DrawGetFillColor( DrawContext context, PixelPacket ** fill_color );

void DrawGetFillOpacity( DrawContext context, double *fill_opacity );

void DrawGetFillRule( DrawContext context, FillRule *fill_rule );

void DrawGetFont( DrawContext context, char ** font_name );

void DrawGetFontFamily( DrawContext context, char ** font_family );

void DrawGetFontSize( DrawContext context, double *pointsize );

void DrawGetFontStretch( DrawContext context, StretchType *font_stretch );

void DrawGetFontStyle( DrawContext context, StyleType *style );

void DrawGetFontWeight( DrawContext context, unsigned long *font_weight );

void DrawGetGravity( DrawContext context, GravityType *gravity );

void DrawGetStrokeAntialias( DrawContext context, unsigned int *stroke_antialias );

void DrawGetStrokeColor( DrawContext context, PixelPacket *stroke_color );

void DrawGetStrokeDashArray( DrawContext context, size_t *num_elems, double ** dasharray );

void DrawGetStrokeDashOffset( DrawContext context, double *dash_offset );

void DrawGetStrokeLineCap( DrawContext context, LineCap *linecap );

void DrawGetStrokeLineJoin( DrawContext context, LineJoin *linejoin );

void DrawGetStrokeMiterLimit( DrawContext context, unsigned long *miterlimit );

void DrawGetStrokeOpacity( DrawContext context, double *stroke_opacity );

void DrawGetStrokeWidth( DrawContext context, double *stroke_width );

void DrawGetTextAntialias( DrawContext context, unsigned int *text_antialias );

void DrawGetTextDecoration( DrawContext context, DecorationType *decoration );

void DrawGetTextEncoding( DrawContext context, char ** encoding );

void DrawGetTextUnderColor( DrawContext context, PixelPacket *under_color );

void DrawLine( DrawContext context, const double sx, const double sy, const double ex, const double ey );

void DrawMatte( DrawContext context, const double x, const double y, const PaintMethod paint_method );

void DrawPathClose( DrawContext context );

void DrawPathCurveToAbsolute( DrawContext context, const double x1, const double y1, const double x2, const double y2, const double x, const double y );

void DrawPathCurveToRelative( DrawContext context, const double x1, const double y1, const double x2, const double y2, const double x, const double y );

void DrawPathCurveToSmoothAbsolute( DrawContext context, const double x2, const double y2, const double x, const double y );

void DrawPathCurveToSmoothRelative( DrawContext context, const double x2, const double y2, const double x, const double y );

void DrawPathEllipticArcAbsolute( DrawContext context, const double rx, const double ry, const double x_axis_rotation, unsigned int large_arc_flag, unsigned int sweep_flag, const double x, const double y );

void DrawPathEllipticArcRelative( DrawContext context, const double rx, const double ry, const double x_axis_rotation, unsigned int large_arc_flag, unsigned int sweep_flag, const double x, const double y );

void DrawPathFinish( DrawContext context );

void DrawPathLineToAbsolute( DrawContext context, const double x, const double y );

void DrawPathLineToHorizontalAbsolute( DrawContext context, const double x );

void DrawPathLineToHorizontalRelative( DrawContext context, const double x );

void DrawPathLineToRelative( DrawContext context, const double x, const double y );

void DrawPathLineToVerticalAbsolute( DrawContext context, const double y );

void DrawPathLineToVerticalRelative( DrawContext context, const double y );

void DrawPathMoveToAbsolute( DrawContext context, const double x, const double y );

void DrawPathMoveToRelative( DrawContext context, const double x, const double y );

void DrawPathStart( DrawContext context );

void DrawPoint( DrawContext context, const double x, const double y );

void DrawPolygon( DrawContext context, const size_t num_coords, const PointInfo *coordinates );

void DrawPolyline( DrawContext context, const size_t num_coords, const PointInfo *coordinates );

void DrawPopClipPath( DrawContext context );

void DrawPopDefs( DrawContext context );

void DrawPopGraphicContext( DrawContext context );

void DrawPopPattern( DrawContext context );

void DrawPushClipPath( DrawContext context, const char *clip_path_id );

void DrawPushDefs( DrawContext context );

void DrawPushGraphicContext( DrawContext context );

void DrawPushPattern( DrawContext context, const char *pattern_id, const double x, const double y, const double width, const double height );

void DrawRectangle( DrawContext context, const double x1, const double y1, const double x2, const double y2 );

int DrawRender( const DrawContext context );

void DrawRotate( DrawContext context, const double degrees );

void DrawRoundRectangle( DrawContext context, double x1, double y1, double x2, double y2, double rx, double ry );

void DrawScale( DrawContext context, const double x, const double y );

void DrawSetClipPath( DrawContext context, const char *clip_path );

void DrawSetClipRule( DrawContext context, const FillRule fill_rule );

void DrawSetClipUnits( DrawContext context, const ClipPathUnits clip_units );

void DrawSetFillColor( DrawContext context, const PixelPacket *fill_color );

void DrawSetFillColorString( DrawContext context, const char *fill_color );

void DrawSetFillOpacity( DrawContext context, const double fill_opacity );

void DrawSetFillPatternURL( DrawContext context, const char *fill_url );

void DrawSetFillRule( DrawContext context, const FillRule fill_rule );

void DrawSetFont( DrawContext context, const char *font_name );

void DrawSetFontFamily( DrawContext context, const char *font_family );

void DrawSetFontSize( DrawContext context, const double pointsize );

void DrawSetFontStretch( DrawContext context, const StretchType font_stretch );

void DrawSetFontStyle( DrawContext context, const StyleType style );

void DrawSetFontWeight( DrawContext context, const unsigned long font_weight );

void DrawSetGravity( DrawContext context, const GravityType gravity );

void DrawSetStopColor( DrawContext context, const PixelPacket *stop_color, const double offset );

void DrawSetStrokeAntialias( DrawContext context, const unsigned int stroke_antialias );

void DrawSetStrokeColor( DrawContext context, const PixelPacket *stroke_color );

void DrawSetStrokeColorString( DrawContext context, const char *stroke_color );

void DrawSetStrokeDashArray( DrawContext context, const size_t num_elems, const double *dasharray );

void DrawSetStrokeDashOffset( DrawContext context, const double dash_offset );

void DrawSetStrokeLineCap( DrawContext context, const LineCap linecap );

void DrawSetStrokeLineJoin( DrawContext context, const LineJoin linejoin );

void DrawSetStrokeMiterLimit( DrawContext context, const unsigned long miterlimit );

void DrawSetStrokeOpacity( DrawContext context, const double stroke_opacity );

void DrawSetStrokePatternURL( DrawContext context, const char *stroke_url );

void DrawSetStrokeWidth( DrawContext context, const double stroke_width );

void DrawSetTextAntialias( DrawContext context, const unsigned int text_antialias );

void DrawSetTextDecoration( DrawContext context, const DecorationType decoration );

void DrawSetTextEncoding( DrawContext context, const char *encoding );

void DrawSetTextUnderColor( DrawContext context, const PixelPacket *under_color );

void DrawSetTextUnderColorString( DrawContext context, const char *under_color );

void DrawSetViewbox( DrawContext context, unsigned long x1, unsigned long y1, unsigned long x2, unsigned long y2 );

void DrawSkewX( DrawContext context, const double degrees );

void DrawSkewY( DrawContext context, const double degrees );

void DrawTranslate( DrawContext context, const double x, const double y );


FUNCTION DESCRIPTIONS

DrawAnnotation

DrawAnnotation() draws text on the image.

The format of the DrawAnnotation method is:

void DrawAnnotation ( DrawContext context, const double x, const double y, const unsigned char *text );

A description of each parameter follows:

o context:
drawing context

o x:
x ordinate to left of text

o y:
y ordinate to text baseline

o text:
text to draw

DrawAffine

DrawAffine() adjusts the current affine transformation matrix with the specified affine transformation matrix. Note that the current affine transform is adjusted rather than replaced.

The format of the DrawAffine method is:

void DrawAffine ( DrawContext context, const AffineMatrix *affine );

A description of each parameter follows:

o context:
Drawing context

o affine:
Affine matrix parameters

DrawAllocateContext

DrawAllocateContext() allocates an initial drawing context which is an opaque handle required by the remaining drawing methods.

The format of the DrawAllocateContext method is:

DrawContext DrawAllocateContext ( const DrawInfo *draw_info, Image *image );

A description of each parameter follows:

o draw_info:
Initial drawing defaults. Set to NULL to use ImageMagick defaults.

o image:
The image to draw on.

DrawArc

DrawArc() draws an arc falling within a specified bounding rectangle on the image.

The format of the DrawArc method is:

void DrawArc ( DrawContext context, const double sx, const double sy, const double ex, const double ey, const double sd, const double ed );

A description of each parameter follows:

o context:
drawing context

o sx:
starting x ordinate of bounding rectangle

o sy:
starting y ordinate of bounding rectangle

o ex:
ending x ordinate of bounding rectangle

o ey:
ending y ordinate of bounding rectangle

o sd:
starting degrees of rotation

o ed:
ending degrees of rotation

DrawBezier

DrawBezier() draws a bezier curve through a set of points on the image.

The format of the DrawBezier method is:

void DrawBezier ( DrawContext context, const size_t num_coords, const PointInfo *coordinates );

A description of each parameter follows:

o context:
drawing context

o num_coords:
number of coordinates

o coordinates:
coordinates

DrawCircle

DrawCircle() draws a circle on the image.

The format of the DrawCircle method is:

void DrawCircle ( DrawContext context, const double ox, const double oy, const double px, const double py );

A description of each parameter follows:

o context:
drawing context

o ox:
origin x ordinate

o oy:
origin y ordinate

o px:
perimeter x ordinate

o py:
perimeter y ordinate

DrawGetClipPath

DrawGetClipPath() obtains the current clipping path.

The format of the DrawGetClipPath method is:

void DrawGetClipPath ( DrawContext context, char **clip_path );

A description of each parameter follows:

o context:
drawing context

o clip_path:
Address of pointer to update with clip-path string. Pointer value is set to NULL if there is no clip-path present. String must be freed with LiberateMemory() by user once it is no longer needed.

DrawSetClipPath

DrawSetClipPath() associates a named clipping path with the image. Only the areas drawn on by the clipping path will be modified as long as it remains in effect.

The format of the DrawSetClipPath method is:

void DrawSetClipPath ( DrawContext context, const char *clip_path );

A description of each parameter follows:

o context:
drawing context

o clip_path:
name of clipping path to associate with image

DrawGetClipRule

DrawGetClipRule() obtains the current polygon fill rule to be used by the clipping path.

The format of the DrawGetClipRule method is:

void DrawGetClipRule ( DrawContext context, FillRule *fill_rule );

A description of each parameter follows:

o context:
drawing context

o fill_rule:
Addess of object to update with fill rule

DrawSetClipRule

DrawSetClipRule() set the polygon fill rule to be used by the clipping path.

The format of the DrawSetClipRule method is:

void DrawSetClipRule ( DrawContext context, const FillRule fill_rule );

A description of each parameter follows:

o context:
drawing context

o fill_rule:
fill rule (EvenOddRule or NonZeroRule)

DrawGetClipUnits

DrawGetClipUnits() obtains the interpretation of clip path units.

The format of the DrawGetClipUnits method is:

void DrawGetClipUnits ( DrawContext context, ClipPathUnits *clip_units );

A description of each parameter follows:

o context:
drawing context

o clip_units:
Address of ClipPathUnits.

DrawSetClipUnits

DrawSetClipUnits() sets the interpretation of clip path units.

The format of the DrawSetClipUnits method is:

void DrawSetClipUnits ( DrawContext context, const ClipPathUnits clip_units );

A description of each parameter follows:

o context:
drawing context

o clip_units:
units to use (UserSpace, UserSpaceOnUse, or ObjectBoundingBox)

DrawColor

DrawColor() draws color on image using the current fill color, starting at specified position, and using specified paint method. The available paint methods are:
  PointMethod: Recolors the target pixel
  ReplaceMethod: Recolor any pixel that matches the target pixel.
  FloodfillMethod: Recolors target pixels and matching neighbors.
  FillToBorderMethod: Recolor target pixels and neighbors not matching border color.
  ResetMethod: Recolor all pixels.

The format of the DrawColor method is:

void DrawColor ( DrawContext context, const double x, const double y, const PaintMethod paintMethod );

A description of each parameter follows:

o context:
drawing context

o x:
x ordinate

o y:
y ordinate

o paintMethod:
paint method

DrawComment

DrawComment() adds a comment to a vector output stream.

The format of the DrawComment method is:

void DrawComment ( DrawContext context, const char *comment );

A description of each parameter follows:

o context:
drawing context

o comment:
comment text

DrawDestroyContext

DrawDestroyContext() frees all resources associated with the drawing context. Once the drawing context has been freed, it should not be used any further unless it re-allocated.

The format of the DrawDestroyContext method is:

void DrawDestroyContext ( DrawContext context );

A description of each parameter follows:

o context:
drawing context to destroy

DrawEllipse

DrawEllipse() draws an ellipse on the image.

The format of the DrawEllipse method is:

void DrawEllipse ( DrawContext context, const double ox, const double oy, const double rx, const double ry, const double start, const double end );

A description of each parameter follows:

o context:
drawing context

o ox:
origin x ordinate

o oy:
origin y ordinate

o rx:
radius in x

o ry:
radius in y

o start:
starting rotation in degrees

o end:
ending rotation in degrees

DrawGetFillColor

DrawGetFillColor() obtains the fill color to be used for drawing filled objects.

The format of the DrawGetFillColor method is:

void DrawGetFillColor ( DrawContext context, PixelPacket **fill_color );

A description of each parameter follows:

o context:
drawing context

o fill_color:
Address of object to set

DrawSetFillColor

DrawSetFillColor() sets the fill color to be used for drawing filled objects.

The format of the DrawSetFillColor method is:

void DrawSetFillColor ( DrawContext context, const PixelPacket *fill_color );

A description of each parameter follows:

o context:
drawing context

o fill_color:
fill color

DrawSetFillColorString

DrawSetFillColorString() sets the fill color to be used for drawing filled objects.

The format of the DrawSetFillColorString method is:

void DrawSetFillColorString ( DrawContext context, const char *fill_color );

A description of each parameter follows:

o context:
drawing context

o fill_color:
fill color

DrawSetFillPatternURL

DrawSetFillPatternURL() sets the URL to use as a fill pattern for filling objects. Only local URLs ( "#identifier" ) are supported at this time. These local URLs are normally created by defining a named fill pattern with DrawPushPattern/DrawPopPattern.

The format of the DrawSetFillPatternURL method is:

void DrawSetFillPatternURL ( DrawContext context, const char *fill_url );

A description of each parameter follows:

o context:
drawing context

o fill_url:
URL to use to obtain fill pattern.

DrawGetFillOpacity

DrawGetFillOpacity() obtains the opacity to use when drawing using the fill color or fill texture. Fully opaque is 1.0.

The format of the DrawGetFillOpacity method is:

void DrawGetFillOpacity ( DrawContext context, double *fill_opacity );

A description of each parameter follows:

o context:
drawing context

o fill_opacity:
address of fill opacity

DrawSetFillOpacity

DrawSetFillOpacity() sets the opacity to use when drawing using the fill color or fill texture. Fully opaque is 1.0.

The format of the DrawSetFillOpacity method is:

void DrawSetFillOpacity ( DrawContext context, const double fill_opacity );

A description of each parameter follows:

o context:
drawing context

o fill_opacity:
fill opacity

DrawGetFillRule

DrawGetFillRule() obtains the fill rule to use while drawing polygons.

The format of the DrawGetFillRule method is:

void DrawGetFillRule ( DrawContext context, FillRule *fill_rule );

A description of each parameter follows:

o context:
drawing context

o fill_rule:
address of fill rule (EvenOddRule or NonZeroRule)

DrawSetFillRule

DrawSetFillRule() sets the fill rule to use while drawing polygons.

The format of the DrawSetFillRule method is:

void DrawSetFillRule ( DrawContext context, const FillRule fill_rule );

A description of each parameter follows:

o context:
drawing context

o fill_rule:
fill rule (EvenOddRule or NonZeroRule)

DrawGetFont

DrawGetFont() obtains the fully-sepecified font used when annotating with text.

The format of the DrawGetFont method is:

void DrawGetFont ( DrawContext context, char **font_name );

A description of each parameter follows:

o context:
drawing context

o font_name:
address of pointer to store address of font name string. Set to NULL if there is no font name set. Value must be freed by the user when no longer needed.

DrawSetFont

DrawSetFont() sets the fully-sepecified font to use when annotating with text.

The format of the DrawSetFont method is:

void DrawSetFont ( DrawContext context, const char *font_name );

A description of each parameter follows:

o context:
drawing context

o font_name:
font name

DrawGetFontFamily

DrawGetFontFamily() obtains the font family to use when annotating with text.

The format of the DrawGetFontFamily method is:

void DrawGetFontFamily ( DrawContext context, char **font_family );

A description of each parameter follows:

o context:
drawing context

o font_family:
Address of pointer to place font family string. Value is set to NULL if the font family is not set. The value must be freed by the user when it is no longer needed.

DrawSetFontFamily

DrawSetFontFamily() sets the font family to use when annotating with text.

The format of the DrawSetFontFamily method is:

void DrawSetFontFamily ( DrawContext context, const char *font_family );

A description of each parameter follows:

o context:
drawing context

o font_family:
font family

DrawGetFontSize

DrawGetFontSize() obtains the font pointsize used when annotating with text.

The format of the DrawGetFontSize method is:

void DrawGetFontSize ( DrawContext context, double *pointsize );

A description of each parameter follows:

o context:
drawing context

o pointsize:
address to place value

DrawSetFontSize

DrawSetFontSize() sets the font pointsize to use when annotating with text.

The format of the DrawSetFontSize method is:

void DrawSetFontSize ( DrawContext context, const double pointsize );

A description of each parameter follows:

o context:
drawing context

o pointsize:
text pointsize

DrawGetFontStretch

DrawGetFontStretch() obtains the font stretch used when annotating with text.

The format of the DrawGetFontStretch method is:

void DrawGetFontStretch ( DrawContext context, StretchType *font_stretch );

A description of each parameter follows:

o context:
drawing context

o font_stretch:
address to place font stretch

DrawSetFontStretch

DrawSetFontStretch() sets the font stretch to use when annotating with text. The AnyStretch enumeration acts as a wild-card "don't care" option.

The format of the DrawSetFontStretch method is:

void DrawSetFontStretch ( DrawContext context, const StretchType font_stretch );

A description of each parameter follows:

o context:
drawing context

o font_stretch:
font stretch (NormalStretch, UltraCondensedStretch, CondensedStretch, SemiCondensedStretch, SemiExpandedStretch, ExpandedStretch, ExtraExpandedStretch, UltraExpandedStretch, AnyStretch)

DrawGetFontStyle

DrawGetFontStyle() obtains the font style used when annotating with text.

The format of the DrawGetFontStyle method is:

void DrawGetFontStyle ( DrawContext context, StyleType *style );

A description of each parameter follows:

o context:
drawing context

o style:
address to place value

DrawSetFontStyle

DrawSetFontStyle() sets the font style to use when annotating with text. The AnyStyle enumeration acts as a wild-card "don't care" option.

The format of the DrawSetFontStyle method is:

void DrawSetFontStyle ( DrawContext context, const StyleType style );

A description of each parameter follows:

o context:
drawing context

o style:
font style (NormalStyle, ItalicStyle, ObliqueStyle, AnyStyle)

DrawGetFontWeight

DrawGetFontWeight() obtains the font weight used when annotating with text.

The format of the DrawGetFontWeight method is:

void DrawGetFontWeight ( DrawContext context, unsigned long *font_weight );

A description of each parameter follows:

o context:
drawing context

o font_weight:
address to place value

DrawSetFontWeight

DrawSetFontWeight() sets the font weight to use when annotating with text.

The format of the DrawSetFontWeight method is:

void DrawSetFontWeight ( DrawContext context, const unsigned long font_weight );

A description of each parameter follows:

o context:
drawing context

o font_weight:
font weight (valid range 100-900)

DrawGetGravity

DrawGetGravity() obtains the text placement gravity used when annotating with text.

The format of the DrawGetGravity method is:

void DrawGetGravity ( DrawContext context, GravityType *gravity );

A description of each parameter follows:

o context:
drawing context

o gravity:
address to place value

DrawSetGravity

DrawSetGravity() sets the text placement gravity to use when annotating with text.

The format of the DrawSetGravity method is:

void DrawSetGravity ( DrawContext context, const GravityType gravity );

A description of each parameter follows:

o context:
drawing context

o gravity:
positioning gravity (NorthWestGravity, NorthGravity, NorthEastGravity, WestGravity, CenterGravity, EastGravity, SouthWestGravity, SouthGravity, SouthEastGravity)

DrawComposite

DrawComposite() composites an image onto the current image, using the specified composition operator, specified position, and at the specified size.

The format of the DrawComposite method is:

void DrawComposite ( DrawContext context, const CompositeOperator composite_operator, const double x, const double y, const double width, const double height, const Image *image );

A description of each parameter follows:

o context:
drawing context

o composite_operator:
composition operator

o x:
x ordinate of top left corner

o y:
y ordinate of top left corner

o width:
Width to resize image to prior to compositing. Specify zero to use existing width.

o height:
Height to resize image to prior to compositing. Specify zero to use existing height.

o image:
Image to composite

DrawLine

DrawLine() draws a line on the image using the current stroke color, stroke opacity, and stroke width.

The format of the DrawLine method is:

void DrawLine ( DrawContext context, const double sx, const double sy, const double ex, const double ey );

A description of each parameter follows:

o context:
drawing context

o sx:
starting x ordinate

o sy:
starting y ordinate

o ex:
ending x ordinate

o ey:
ending y ordinate

DrawMatte

DrawMatte() paints on the image's opacity channel in order to set effected pixels to transparent. to influence the opacity of pixels. The available paint methods are:
  PointMethod: Select the target pixel
  ReplaceMethod: Select any pixel that matches the target pixel.
  FloodfillMethod: Select the target pixel and matching neighbors.
  FillToBorderMethod: Select the target pixel and neighbors not matching
                      border color.
  ResetMethod: Select all pixels.

The format of the DrawMatte method is:

void DrawMatte ( DrawContext context, const double x, const double y, const PaintMethod paint_method );

A description of each parameter follows:

o context:
drawing context

o x:
x ordinate

o y:
y ordinate

o
paint_method:

DrawPathClose

DrawPathClose() adds a path element to the current path which closes the current subpath by drawing a straight line from the current point to the current subpath's most recent starting point ( usually, the most recent moveto point ) .

The format of the DrawPathClose method is:

void DrawPathClose ( DrawContext context );

A description of each parameter follows:

o context:
drawing context

DrawPathCurveToAbsolute

DrawPathCurveToAbsolute() draws a cubic Bézier curve from the current point to ( x, y ) using ( x1, y1 ) as the control point at the beginning of the curve and ( x2, y2 ) as the control point at the end of the curve using absolute coordinates. At the end of the command, the new current point becomes the final ( x, y ) coordinate pair used in the polybezier.

The format of the DrawPathCurveToAbsolute method is:

void DrawPathCurveToAbsolute ( DrawContext context, const double x1, const double y1, const double x2, const double y2, const double x, const double y );

A description of each parameter follows:

o context:
drawing context

o x1:
x ordinate of control point for curve beginning

o y1:
y ordinate of control point for curve beginning

o x2:
x ordinate of control point for curve ending

o y2:
y ordinate of control point for curve ending

o x:
x ordinate of the end of the curve

o y:
y ordinate of the end of the curve

DrawPathCurveToRelative

DrawPathCurveToRelative() draws a cubic Bézier curve from the current point to ( x, y ) using ( x1, y1 ) as the control point at the beginning of the curve and ( x2, y2 ) as the control point at the end of the curve using relative coordinates. At the end of the command, the new current point becomes the final ( x, y ) coordinate pair used in the polybezier.

The format of the DrawPathCurveToRelative method is:

void DrawPathCurveToRelative ( DrawContext context, const double x1, const double y1, const double x2, const double y2, const double x, const double y );

A description of each parameter follows:

o context:
drawing context

o x1:
x ordinate of control point for curve beginning

o y1:
y ordinate of control point for curve beginning

o x2:
x ordinate of control point for curve ending

o y2:
y ordinate of control point for curve ending

o x:
x ordinate of the end of the curve

o y:
y ordinate of the end of the curve

DrawPathCurveToQuadraticBezierAbsolute() draws a quadratic Bézier curve from the current point to (x,y) using (x1,y1) as the control point using absolute coordinates. At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier.

The format of the DrawPathCurveToQuadraticBezierAbsolute method is:

    void DrawPathCurveToQuadraticBezierAbsolute(DrawContext context,
                                                const double x1,
                                                const double y1,
                                                const double x,
                                                const double y)

A description of each parameter follows:

o context:
drawing context

o x1:
x ordinate of the control point

o y1:
y ordinate of the control point

o x:
x ordinate of final point

o y:
y ordinate of final point

DrawPathCurveToQuadraticBezierRelative() draws a quadratic Bézier curve from the current point to (x,y) using (x1,y1) as the control point using relative coordinates. At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier.

The format of the DrawPathCurveToQuadraticBezierRelative method is:

    void DrawPathCurveToQuadraticBezierRelative(DrawContext context,
                                                const double x1,
                                                const double y1,
                                                const double x,
                                                const double y)

A description of each parameter follows:

o context:
drawing context

o x1:
x ordinate of the control point

o y1:
y ordinate of the control point

o x:
x ordinate of final point

o y:
y ordinate of final point

DrawPathCurveToQuadraticBezierSmoothAbsolute() draws a quadratic Bézier curve (using absolute coordinates) from the current point to (x,y). The control point is assumed to be the reflection of the control point on the previous command relative to the current point. (If there is no previous command or if the previous command was not a DrawPathCurveToQuadraticBezierAbsolute, DrawPathCurveToQuadraticBezierRelative, DrawPathCurveToQuadraticBezierSmoothAbsolut or DrawPathCurveToQuadraticBezierSmoothRelative, assume the control point is coincident with the current point.). At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier.

The format of the DrawPathCurveToQuadraticBezierSmoothAbsolute method is:

    void DrawPathCurveToQuadraticBezierSmoothAbsolute(DrawContext
                                                      context,
                                                      const double x,
                                                      const double y)

A description of each parameter follows:

o context:
drawing context

o x:
x ordinate of final point

o y:
y ordinate of final point

DrawPathCurveToQuadraticBezierSmoothAbsolute() draws a quadratic Bézier curve (using relative coordinates) from the current point to (x,y). The control point is assumed to be the reflection of the control point on the previous command relative to the current point. (If there is no previous command or if the previous command was not a DrawPathCurveToQuadraticBezierAbsolute, DrawPathCurveToQuadraticBezierRelative, DrawPathCurveToQuadraticBezierSmoothAbsolut or DrawPathCurveToQuadraticBezierSmoothRelative, assume the control point is coincident with the current point.). At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier.

The format of the DrawPathCurveToQuadraticBezierSmoothRelative method is:

    void DrawPathCurveToQuadraticBezierSmoothRelative(DrawContext
                                                      context,
                                                      const double x,
                                                      const double y)

A description of each parameter follows:

o context:
drawing context

o x:
x ordinate of final point

o y:
y ordinate of final point

DrawPathCurveToSmoothAbsolute

DrawPathCurveToSmoothAbsolute() draws a cubic Bézier curve from the current point to ( x, y ) using absolute coordinates. The first control point is assumed to be the reflection of the second control point on the previous command relative to the current point. ( If there is no previous command or if the previous command was not an DrawPathCurveToAbsolute, DrawPathCurveToRelative, DrawPathCurveToSmoothAbsolute or DrawPathCurveToSmoothRelative, assume the first control point is coincident with the current point. ) ( x2, y2 ) is the second control point ( i.e., the control point at the end of the curve ) . At the end of the command, the new current point becomes the final ( x, y ) coordinate pair used in the polybezier.

The format of the DrawPathCurveToSmoothAbsolute method is:

void DrawPathCurveToSmoothAbsolute ( DrawContext context, const double x2, const double y2, const double x, const double y );

A description of each parameter follows:

o context:
drawing context

o x2:
x ordinate of second control point

o y2:
y ordinate of second control point

o x:
x ordinate of termination point

o y:
y ordinate of termination point

DrawPathCurveToSmoothRelative

DrawPathCurveToSmoothRelative() draws a cubic Bézier curve from the current point to ( x, y ) using relative coordinates. The first control point is assumed to be the reflection of the second control point on the previous command relative to the current point. ( If there is no previous command or if the previous command was not an DrawPathCurveToAbsolute, DrawPathCurveToRelative, DrawPathCurveToSmoothAbsolute or DrawPathCurveToSmoothRelative, assume the first control point is coincident with the current point. ) ( x2, y2 ) is the second control point ( i.e., the control point at the end of the curve ) . At the end of the command, the new current point becomes the final ( x, y ) coordinate pair used in the polybezier.

The format of the DrawPathCurveToSmoothRelative method is:

void DrawPathCurveToSmoothRelative ( DrawContext context, const double x2, const double y2, const double x, const double y );

A description of each parameter follows:

o context:
drawing context

o x2:
x ordinate of second control point

o y2:
y ordinate of second control point

o x:
x ordinate of termination point

o y:
y ordinate of termination point

DrawPathEllipticArcAbsolute

DrawPathEllipticArcAbsolute() draws an elliptical arc from the current point to ( x, y ) using absolute coordinates. The size and orientation of the ellipse are defined by two radii ( rx, ry ) and an xAxisRotation, which indicates how the ellipse as a whole is rotated relative to the current coordinate system. The center ( cx, cy ) of the ellipse is calculated automatically to satisfy the constraints imposed by the other parameters. largeArcFlag and sweepFlag contribute to the automatic calculations and help determine how the arc is drawn. If largeArcFlag is true then draw the larger of the available arcs. If sweepFlag is true, then draw the arc matching a clock-wise rotation.

The format of the DrawPathEllipticArcAbsolute method is:

void DrawPathEllipticArcAbsolute ( DrawContext context, const double rx, const double ry, const double x_axis_rotation, unsigned int large_arc_flag, unsigned int sweep_flag, const double x, const double y );

A description of each parameter follows:

o context:
drawing context

o rx:
x radius

o ry:
y radius

o x_axis_rotation:
indicates how the ellipse as a whole is rotated relative to the current coordinate system

o large_arc_flag:
If non-zero (true) then draw the larger of the available arcs

o sweep_flag:
If non-zero (true) then draw the arc matching a clock-wise rotation

DrawPathEllipticArcRelative

DrawPathEllipticArcRelative() draws an elliptical arc from the current point to ( x, y ) using relative coordinates. The size and orientation of the ellipse are defined by two radii ( rx, ry ) and an xAxisRotation, which indicates how the ellipse as a whole is rotated relative to the current coordinate system. The center ( cx, cy ) of the ellipse is calculated automatically to satisfy the constraints imposed by the other parameters. largeArcFlag and sweepFlag contribute to the automatic calculations and help determine how the arc is drawn. If largeArcFlag is true then draw the larger of the available arcs. If sweepFlag is true, then draw the arc matching a clock-wise rotation.

The format of the DrawPathEllipticArcRelative method is:

void DrawPathEllipticArcRelative ( DrawContext context, const double rx, const double ry, const double x_axis_rotation, unsigned int large_arc_flag, unsigned int sweep_flag, const double x, const double y );

A description of each parameter follows:

o context:
drawing context

o rx:
x radius

o ry:
y radius

o x_axis_rotation:
indicates how the ellipse as a whole is rotated relative to the current coordinate system

o large_arc_flag:
If non-zero (true) then draw the larger of the available arcs

o sweep_flag:
If non-zero (true) then draw the arc matching a clock-wise rotation

DrawPathFinish

DrawPathFinish() terminates the current path.

The format of the DrawPathFinish method is:

void DrawPathFinish ( DrawContext context );

A description of each parameter follows:

o context:
drawing context

DrawPathLineToAbsolute

DrawPathLineToAbsolute() draws a line path from the current point to the given coordinate using absolute coordinates. The coordinate then becomes the new current point.

The format of the DrawPathLineToAbsolute method is:

void DrawPathLineToAbsolute ( DrawContext context, const double x, const double y );

A description of each parameter follows:

o context:
drawing context

o x:
target x ordinate

o y:
target y ordinate

DrawPathLineToRelative

DrawPathLineToRelative() draws a line path from the current point to the given coordinate using relative coordinates. The coordinate then becomes the new current point.

The format of the DrawPathLineToRelative method is:

void DrawPathLineToRelative ( DrawContext context, const double x, const double y );

A description of each parameter follows:

o context:
drawing context

o x:
target x ordinate

o y:
target y ordinate

DrawPathLineToHorizontalAbsolute

DrawPathLineToHorizontalAbsolute() draws a horizontal line path from the current point to the target point using absolute coordinates. The target point then becomes the new current point.

The format of the DrawPathLineToHorizontalAbsolute method is:

void DrawPathLineToHorizontalAbsolute ( DrawContext context, const double x );

A description of each parameter follows:

o context:
drawing context

o x:
target x ordinate

DrawPathLineToHorizontalRelative

DrawPathLineToHorizontalRelative() draws a horizontal line path from the current point to the target point using relative coordinates. The target point then becomes the new current point.

The format of the DrawPathLineToHorizontalRelative method is:

void DrawPathLineToHorizontalRelative ( DrawContext context, const double x );

A description of each parameter follows:

o context:
drawing context

o x:
target x ordinate

DrawPathLineToVerticalAbsolute

DrawPathLineToVerticalAbsolute() draws a vertical line path from the current point to the target point using absolute coordinates. The target point then becomes the new current point.

The format of the DrawPathLineToVerticalAbsolute method is:

void DrawPathLineToVerticalAbsolute ( DrawContext context, const double y );

A description of each parameter follows:

o context:
drawing context

o y:
target y ordinate

DrawPathLineToVerticalRelative

DrawPathLineToVerticalRelative() draws a vertical line path from the current point to the target point using relative coordinates. The target point then becomes the new current point.

The format of the DrawPathLineToVerticalRelative method is:

void DrawPathLineToVerticalRelative ( DrawContext context, const double y );

A description of each parameter follows:

o context:
drawing context

o y:
target y ordinate

DrawPathMoveToAbsolute

DrawPathMoveToAbsolute() starts a new sub-path at the given coordinate using absolute coordinates. The current point then becomes the specified coordinate.

The format of the DrawPathMoveToAbsolute method is:

void DrawPathMoveToAbsolute ( DrawContext context, const double x, const double y );

A description of each parameter follows:

o context:
drawing context

o x:
target x ordinate

o y:
target y ordinate

DrawPathMoveToRelative

DrawPathMoveToRelative() starts a new sub-path at the given coordinate using relative coordinates. The current point then becomes the specified coordinate.

The format of the DrawPathMoveToRelative method is:

void DrawPathMoveToRelative ( DrawContext context, const double x, const double y );

A description of each parameter follows:

o context:
drawing context

o x:
target x ordinate

o y:
target y ordinate

DrawPathStart

DrawPathStart() declares the start of a path drawing list which is terminated by a matching DrawPathFinish ( ) command. All other DrawPath commands must be enclosed between a DrawPathStart ( ) and a DrawPathFinish ( ) command. This is because path drawing commands are subordinate commands and they do not function by themselves.

The format of the DrawPathStart method is:

void DrawPathStart ( DrawContext context );

A description of each parameter follows:

o context:
drawing context

DrawPoint

DrawPoint() draws a point using the current stroke color and stroke thickness at the specified coordinates.

The format of the DrawPoint method is:

void DrawPoint ( DrawContext context, const double x, const double y );

A description of each parameter follows:

o context:
drawing context

o x:
target x coordinate

o y:
target y coordinate

DrawPolygon

DrawPolygon() draws a polygon using the current stroke, stroke width, and fill color or texture, using the specified array of coordinates.

The format of the DrawPolygon method is:

void DrawPolygon ( DrawContext context, const size_t num_coords, const PointInfo *coordinates );

A description of each parameter follows:

o context:
drawing context

o num_coords:
number of coordinates

o coordinates:
coordinate array

DrawPolyline

DrawPolyline() draws a polyline using the current stroke, stroke width, and fill color or texture, using the specified array of coordinates.

The format of the DrawPolyline method is:

void DrawPolyline ( DrawContext context, const size_t num_coords, const PointInfo *coordinates );

A description of each parameter follows:

o context:
drawing context

o num_coords:
number of coordinates

o coordinates:
coordinate array

DrawPopClipPath

DrawPopClipPath() terminates a clip path definition.

The format of the DrawPopClipPath method is:

void DrawPopClipPath ( DrawContext context );

A description of each parameter follows:

o context:
drawing context

DrawPopDefs

DrawPopDefs() terminates a definition list

The format of the DrawPopDefs method is:

void DrawPopDefs ( DrawContext context );

A description of each parameter follows:

o context:
drawing context

DrawPopGraphicContext

DrawPopGraphicContext() destroys the current context returning to the previously pushed context. Multiple contexts may exist. It is an error to attempt to pop more contexts than have been pushed, and it is proper form to pop all contexts which have been pushed.

The format of the DrawPopGraphicContext method is:

void DrawPopGraphicContext ( DrawContext context );

A description of each parameter follows:

o context:
drawing context

DrawPopPattern

DrawPopPattern() terminates a pattern definition.

The format of the DrawPopPattern method is:

void DrawPopPattern ( DrawContext context );

A description of each parameter follows:

o context:
drawing context

DrawPushClipPath

DrawPushClipPath() starts a clip path definition which is comprized of any number of drawing commands and terminated by a DrawPopClipPath ( ) command.

The format of the DrawPushClipPath method is:

void DrawPushClipPath ( DrawContext context, const char *clip_path_id );

A description of each parameter follows:

o context:
drawing context

o clip_path_id:
string identifier to associate with the clip path for later use.

DrawPushDefs

DrawPushDefs() indicates that commands up to a terminating DrawPopDefs ( ) command create named elements ( e.g. clip-paths, textures, etc. ) which may safely be processed earlier for the sake of efficiency.

The format of the DrawPushDefs method is:

void DrawPushDefs ( DrawContext context );

A description of each parameter follows:

o context:
drawing context

DrawPushGraphicContext

DrawPushGraphicContext() clones the current drawing context to create a new drawing context. The original drawing context ( s ) may be returned to by invoking DrawPopGraphicContext ( ) . The contexts are stored on a context stack. For every Pop there must have already been an equivalent Push.

The format of the DrawPushGraphicContext method is:

void DrawPushGraphicContext ( DrawContext context );

A description of each parameter follows:

o context:
drawing context

DrawPushPattern

DrawPushPattern() indicates that subsequent commands up to a DrawPopPattern ( ) command comprise the definition of a named pattern. The pattern space is assigned top left corner coordinates, a width and height, and becomes its own drawing space. Anything which can be drawn may be used in a pattern definition. Named patterns may be used as stroke or brush definitions.

The format of the DrawPushPattern method is:

void DrawPushPattern ( DrawContext context, const char *pattern_id, const double x, const double y, const double width, const double height );

A description of each parameter follows:

o context:
drawing context

o pattern_id:
pattern identification for later reference

o x:
x ordinate of top left corner

o y:
y ordinate of top left corner

o width:
width of pattern space

o height:
height of pattern space

DrawRectangle

DrawRectangle() draws a rectangle given two coordinates and using the current stroke, stroke width, and fill settings.

The format of the DrawRectangle method is:

void DrawRectangle ( DrawContext context, const double x1, const double y1, const double x2, const double y2 );

A description of each parameter follows:

o x1:
x ordinate of first coordinate

o y1:
y ordinate of first coordinate

o x2:
x ordinate of second coordinate

o y2:
y ordinate of second coordinate

DrawRender

DrawRender() renders all preceding drawing commands onto the image.

The format of the DrawRender method is:

int DrawRender ( const DrawContext context );

A description of each parameter follows:

o context:
drawing context

DrawRotate

DrawRotate() applies the specified rotation to the current coordinate space.

The format of the DrawRotate method is:

void DrawRotate ( DrawContext context, const double degrees );

A description of each parameter follows:

o context:
drawing context

o degrees:
degrees of rotation

DrawRoundRectangle

DrawRoundRectangle() draws a rounted rectangle given two coordinates, x & y corner radiuses and using the current stroke, stroke width, and fill settings.

The format of the DrawRoundRectangle method is:

void DrawRoundRectangle ( DrawContext context, double x1, double y1, double x2, double y2, double rx, double ry );

A description of each parameter follows:

o context:
drawing context

o x1:
x ordinate of first coordinate

o y1:
y ordinate of first coordinate

o x2:
x ordinate of second coordinate

o y2:
y ordinate of second coordinate

o rx:
radius of corner in horizontal direction

o ry:
radius of corner in vertical direction

DrawScale

DrawScale() adjusts the scaling factor to apply in the horizontal and vertical directions to the current coordinate space.

The format of the DrawScale method is:

void DrawScale ( DrawContext context, const double x, const double y );

A description of each parameter follows:

o context:
drawing context

o x:
horizontal scale factor

o y:
vertical scale factor

DrawSkewX

DrawSkewX() skews the current coordinate system in the horizontal direction.

The format of the DrawSkewX method is:

void DrawSkewX ( DrawContext context, const double degrees );

A description of each parameter follows:

o context:
drawing context

o degrees:
number of degrees to skew the coordinates

DrawSkewY

DrawSkewY() skews the current coordinate system in the vertical direction.

The format of the DrawSkewY method is:

void DrawSkewY ( DrawContext context, const double degrees );

A description of each parameter follows:

o context:
drawing context

o degrees:
number of degrees to skew the coordinates

DrawSetStopColor

DrawSetStopColor() sets the stop color and offset for gradients

The format of the DrawSetStopColor method is:

void DrawSetStopColor ( DrawContext context, const PixelPacket *stop_color, const double offset );

A description of each parameter follows:

o context:
drawing context

o
stop_color:

o
offset:

DrawGetStrokeColor

DrawGetStrokeColor() obtains the color used for stroking object outlines.

The format of the DrawGetStrokeColor method is:

void DrawGetStrokeColor ( DrawContext context, PixelPacket *stroke_color );

A description of each parameter follows:

o context:
drawing context

o stroke_color:
address to place stroke color

DrawSetStrokeColor

DrawSetStrokeColor() sets the color used for stroking object outlines.

The format of the DrawSetStrokeColor method is:

void DrawSetStrokeColor ( DrawContext context, const PixelPacket *stroke_color );

A description of each parameter follows:

o context:
drawing context

o stroke_color:
stroke color

DrawSetStrokeColorString

DrawSetStrokeColorString() sets the color used for stroking object outlines.

The format of the DrawSetStrokeColorString method is:

void DrawSetStrokeColorString ( DrawContext context, const char *stroke_color );

A description of each parameter follows:

o context:
drawing context

o stroke_color:
stroke color

DrawSetStrokePatternURL

DrawSetStrokePatternURL() sets the pattern used for stroking object outlines.

The format of the DrawSetStrokePatternURL method is:

void DrawSetStrokePatternURL ( DrawContext context, const char *stroke_url );

A description of each parameter follows:

o context:
drawing context

o stroke_url:
URL specifying pattern ID (e.g. ``#pattern_id'')

DrawGetStrokeAntialias

DrawGetStrokeAntialias() obtains the current stroke antialias setting. Stroked outlines are antialiased by default. When antialiasing is disabled stroked pixels are thresholded to determine if the stroke color or underlying canvas color should be used.

The format of the DrawGetStrokeAntialias method is:

void DrawGetStrokeAntialias ( DrawContext context, unsigned int *stroke_antialias );

A description of each parameter follows:

o context:
drawing context

o stroke_antialias:
address to place value

DrawSetStrokeAntialias

DrawSetStrokeAntialias() controls whether stroked outlines are antialiased. Stroked outlines are antialiased by default. When antialiasing is disabled stroked pixels are thresholded to determine if the stroke color or underlying canvas color should be used.

The format of the DrawSetStrokeAntialias method is:

void DrawSetStrokeAntialias ( DrawContext context, const unsigned int stroke_antialias );

A description of each parameter follows:

o context:
drawing context

o stroke_antialias:
set to false (zero) to disable antialiasing

DrawGetStrokeDashArray

DrawGetStrokeDashArray() obtains the pattern of dashes and gaps used to stroke paths. The strokeDashArray represents an array of numbers that specify the lengths of alternating dashes and gaps in pixels. If an odd number of values is provided, then the list of values is repeated to yield an even number of values. If the value returned in num_elems is zero, then no stroke dash array is defined.

The format of the DrawGetStrokeDashArray method is:

void DrawGetStrokeDashArray ( DrawContext context, size_t *num_elems, double **dasharray );

A description of each parameter follows:

o context:
drawing context

o num_elems:
address to place number of elements in dash array

o dasharray:
address to place array of dash array values

DrawSetStrokeDashArray

*/

DrawSetStrokeDashArray() specifies the pattern of dashes and gaps used to stroke paths. The strokeDashArray represents an array of numbers that specify the lengths of alternating dashes and gaps in pixels. If an odd number of values is provided, then the list of values is repeated to yield an even number of values. To remove an existing dash array, pass a zero num_elems argument and null dasharray. A typical strokeDashArray_ array might contain the members 5 3 2.

The format of the DrawSetStrokeDashArray method is:

void DrawSetStrokeDashArray ( DrawContext context, const size_t num_elems, const double *dasharray );

A description of each parameter follows:

o context:
drawing context

o num_elems:
number of elements in dash array

o dasharray:
dash array values

DrawGetStrokeDashOffset

*/

DrawGetStrokeDashOffset() obtains the offset into the dash pattern to start the dash.

The format of the DrawGetStrokeDashOffset method is:

void DrawGetStrokeDashOffset ( DrawContext context, double *dash_offset );

A description of each parameter follows:

o context:
drawing context

o dash_offset:
address to write dash offset

DrawSetStrokeDashOffset

DrawSetStrokeDashOffset() specifies the offset into the dash pattern to start the dash.

The format of the DrawSetStrokeDashOffset method is:

void DrawSetStrokeDashOffset ( DrawContext context, const double dash_offset );

A description of each parameter follows:

o context:
drawing context

o dash_offset:
dash offset

DrawGetStrokeLineCap

DrawGetStrokeLineCap() obtains the shape to be used at the end of open subpaths when they are stroked. Values of LineCap are UndefinedCap, ButtCap, RoundCap, and SquareCap.

The format of the DrawGetStrokeLineCap method is:

void DrawGetStrokeLineCap ( DrawContext context, LineCap *linecap );

A description of each parameter follows:

o context:
drawing context

o linecap:
address to write linecap style

DrawSetStrokeLineCap

*/

DrawSetStrokeLineCap() specifies the shape to be used at the end of open subpaths when they are stroked. Values of LineCap are UndefinedCap, ButtCap, RoundCap, and SquareCap.

The format of the DrawSetStrokeLineCap method is:

void DrawSetStrokeLineCap ( DrawContext context, const LineCap linecap );

A description of each parameter follows:

o context:
drawing context

o linecap:
linecap style

DrawGetStrokeLineJoin

*/

DrawGetStrokeLineJoin() obtains the shape to be used at the corners of paths ( or other vector shapes ) when they are stroked. Values of LineJoin are UndefinedJoin, MiterJoin, RoundJoin, and BevelJoin.

The format of the DrawGetStrokeLineJoin method is:

void DrawGetStrokeLineJoin ( DrawContext context, LineJoin *linejoin );

A description of each parameter follows:

o context:
drawing context

o linejoin:
address to write line join style

DrawSetStrokeLineJoin

*/

DrawSetStrokeLineJoin() specifies the shape to be used at the corners of paths ( or other vector shapes ) when they are stroked. Values of LineJoin are UndefinedJoin, MiterJoin, RoundJoin, and BevelJoin.

The format of the DrawSetStrokeLineJoin method is:

void DrawSetStrokeLineJoin ( DrawContext context, const LineJoin linejoin );

A description of each parameter follows:

o context:
drawing context

o linejoin:
line join style

DrawGetStrokeMiterLimit

*/

DrawGetStrokeMiterLimit() obtains the miter limit. When two line segments meet at a sharp angle and miter joins have been specified for 'lineJoin', it is possible for the miter to extend far beyond the thickness of the line stroking the path. The miterLimit' imposes a limit on the ratio of the miter length to the 'lineWidth'.

The format of the DrawGetStrokeMiterLimit method is:

void DrawGetStrokeMiterLimit ( DrawContext context, unsigned long *miterlimit );

A description of each parameter follows:

o context:
drawing context

o miterlimit:
address to save miter limit

DrawSetStrokeMiterLimit

*/

DrawSetStrokeMiterLimit() specifies the miter limit. When two line segments meet at a sharp angle and miter joins have been specified for 'lineJoin', it is possible for the miter to extend far beyond the thickness of the line stroking the path. The miterLimit' imposes a limit on the ratio of the miter length to the 'lineWidth'.

The format of the DrawSetStrokeMiterLimit method is:

void DrawSetStrokeMiterLimit ( DrawContext context, const unsigned long miterlimit );

A description of each parameter follows:

o context:
drawing context

o miterlimit:
miter limit

DrawGetStrokeOpacity

*/

DrawGetStrokeOpacity() obtains the opacity of stroked object outlines.

The format of the DrawGetStrokeOpacity method is:

void DrawGetStrokeOpacity ( DrawContext context, double *stroke_opacity );

A description of each parameter follows:

o context:
drawing context

o stroke_opacity:
address to save stroke opacity.

DrawSetStrokeOpacity

DrawSetStrokeOpacity() specifies the opacity of stroked object outlines.

The format of the DrawSetStrokeOpacity method is:

void DrawSetStrokeOpacity ( DrawContext context, const double stroke_opacity );

A description of each parameter follows:

o context:
drawing context

o stroke_opacity:
stroke opacity. The value 1.0 is opaque.

DrawGetStrokeWidth

DrawGetStrokeWidth() obtains the width of the stroke used to draw object outlines.

The format of the DrawGetStrokeWidth method is:

void DrawGetStrokeWidth ( DrawContext context, double *stroke_width );

A description of each parameter follows:

o context:
drawing context

o stroke_width:
address to save stroke width

DrawSetStrokeWidth

DrawSetStrokeWidth() sets the width of the stroke used to draw object outlines.

The format of the DrawSetStrokeWidth method is:

void DrawSetStrokeWidth ( DrawContext context, const double stroke_width );

A description of each parameter follows:

o context:
drawing context

o stroke_width:
stroke width

DrawGetTextAntialias

DrawGetTextAntialias() obtains the current text antialias setting, which determines whether text is antialiased. Text is antialiased by default.

The format of the DrawGetTextAntialias method is:

void DrawGetTextAntialias ( DrawContext context, unsigned int *text_antialias );

A description of each parameter follows:

o context:
drawing context

o text_antialias:
address to save antialias boolean.

DrawSetTextAntialias

DrawSetTextAntialias() controls whether text is antialiased. Text is antialiased by default.

The format of the DrawSetTextAntialias method is:

void DrawSetTextAntialias ( DrawContext context, const unsigned int text_antialias );

A description of each parameter follows:

o context:
drawing context

o text_antialias:
antialias boolean. Set to false (0) to disable antialiasing.

DrawGetTextDecoration

DrawGetTextDecoration() obtains the decoration to be applied when annotating with text.

The format of the DrawGetTextDecoration method is:

void DrawGetTextDecoration ( DrawContext context, DecorationType *decoration );

A description of each parameter follows:

o context:
drawing context

o decoration:
address to save text decoration. One of NoDecoration, UnderlineDecoration, OverlineDecoration, or LineThroughDecoration

DrawSetTextDecoration

DrawSetTextDecoration() specifies a decoration to be applied when annotating with text.

The format of the DrawSetTextDecoration method is:

void DrawSetTextDecoration ( DrawContext context, const DecorationType decoration );

A description of each parameter follows:

o context:
drawing context

o decoration:
text decoration. One of NoDecoration, UnderlineDecoration, OverlineDecoration, or LineThroughDecoration

DrawGetTextEncoding

DrawGetTextEncoding() obtains specifies the code set used for text annotations.

The format of the DrawGetTextEncoding method is:

void DrawGetTextEncoding ( DrawContext context, char **encoding );

A description of each parameter follows:

o context:
drawing context

o encoding:
address specifiying pointer to record string specifying text encoding. If the value is not set, then the string pointer is set to NULL.

DrawSetTextEncoding

*/

DrawSetTextEncoding() specifies specifies the code set to use for text annotations. The only character encoding which may be specified at this time is "UTF-8" for representing Unicode as a sequence of bytes. Specify an empty string to set text encoding to the system's default. Successful text annotation using Unicode may require fonts designed to support Unicode.

The format of the DrawSetTextEncoding method is:

void DrawSetTextEncoding ( DrawContext context, const char *encoding );

A description of each parameter follows:

o context:
drawing context

o encoding:
character string specifying text encoding

DrawGetTextUnderColor

*/

DrawGetTextUnderColor() obtains the color of a background rectangle to place under text annotations.

The format of the DrawGetTextUnderColor method is:

void DrawGetTextUnderColor ( DrawContext context, PixelPacket *under_color );

A description of each parameter follows:

o context:
drawing context

o under_color:
address to save text under-color

DrawSetTextUnderColor

DrawSetTextUnderColor() specifies the color of a background rectangle to place under text annotations.

The format of the DrawSetTextUnderColor method is:

void DrawSetTextUnderColor ( DrawContext context, const PixelPacket *under_color );

A description of each parameter follows:

o context:
drawing context

o under_color:
text under color

DrawSetTextUnderColorString

DrawSetTextUnderColorString() specifies the color of a background rectangle to place under text annotations.

The format of the DrawSetTextUnderColorString method is:

void DrawSetTextUnderColorString ( DrawContext context, const char *under_color );

A description of each parameter follows:

o context:
drawing context

o under_color:
text under color

DrawTranslate

DrawTranslate() applies a translation to the current coordinate system which moves the coordinate system origin to the specified coordinate.

The format of the DrawTranslate method is:

void DrawTranslate ( DrawContext context, const double x, const double y );

A description of each parameter follows:

o context:
drawing context

o x:
new x ordinate for coordinate system origin

o y:
new y ordinate for coordinate system origin

DrawSetViewbox

DrawSetViewbox() sets the overall canvas size to be recorded with the drawing vector data. Usually this will be specified using the same size as the canvas image. When the vector data is saved to SVG or MVG formats, the viewbox is use to specify the size of the canvas image that a viewer will render the vector data on.

The format of the DrawSetViewbox method is:

void DrawSetViewbox ( DrawContext context, unsigned long x1, unsigned long y1, unsigned long x2, unsigned long y2 );

A description of each parameter follows:

o context:
drawing context

o x1:
left x ordinate

o y1:
top y ordinate

o x2:
right x ordinate

o y2:
bottom y ordinate