diff options
| author | Mike Wey | 2011-10-26 22:50:34 +0200 |
|---|---|---|
| committer | Mike Wey | 2011-10-26 22:50:34 +0200 |
| commit | 521e46122b7068cdea4482cb704c08c7c62c2b94 (patch) | |
| tree | c82f5f3ace451b00828a56d3c2f758ea00c37036 | |
| parent | 7fb35ecefdb79b77d8cde8bf2159bf9178dd4124 (diff) | |
Document the symbols used by DrawingContext.
| -rw-r--r-- | dmagick/c/draw.d | 135 | ||||
| -rw-r--r-- | dmagick/c/type.d | 40 |
2 files changed, 139 insertions, 36 deletions
diff --git a/dmagick/c/draw.d b/dmagick/c/draw.d index 3a74115..5621ed7 100644 --- a/dmagick/c/draw.d +++ b/dmagick/c/draw.d @@ -10,38 +10,68 @@ import dmagick.c.type; extern(C) { + /** + * Specify text alignment. + */ enum AlignType { - UndefinedAlign, - LeftAlign, - CenterAlign, - RightAlign + UndefinedAlign, /// No alignment specified. Equivalent to LeftAlign. + LeftAlign, /// Align the leftmost part of the text to the starting point. + CenterAlign, /// Center the text around the starting point. + RightAlign /// Align the rightmost part of the text to the starting point. } + /** + * Defines the coordinate system for the contents of a clip path. + */ enum ClipPathUnits { + /** */ UndefinedPathUnits, + + /** + * The contents of the clipPath represent values in the current + * user coordinate system. + */ UserSpace, + + /** + * The contents of the clipPath represent values in the current + * user coordinate system in place at the time when the clipPath + * element is referenced. + */ UserSpaceOnUse, + + /** + * The user coordinate system for the contents of the clipPath + * element is established using the bounding box of the element to + * which the clipping path is applied. + */ ObjectBoundingBox } + /** + * Specify the text decoration. + */ enum DecorationType { - UndefinedDecoration, - NoDecoration, - UnderlineDecoration, - OverlineDecoration, - LineThroughDecoration + UndefinedDecoration, /// + NoDecoration, /// Don't decorate the text. + UnderlineDecoration, /// Underline the text. + OverlineDecoration, /// Overline the text. + LineThroughDecoration /// Draw a horizontal line through the middle of the text. } static if (MagickLibVersion >= 0x662) { + /** + * Defines the text direction. + */ enum DirectionType { - UndefinedDirection, - RightToLeftDirection, - LeftToRightDirection + UndefinedDirection, /// + RightToLeftDirection, /// ditto + LeftToRightDirection /// ditto } } else @@ -54,11 +84,34 @@ extern(C) } } + /** + * FillRule indicates the algorithm which is to be used to determine + * what parts of the canvas are included inside the shape. + */ enum FillRule { + /** */ UndefinedRule, + /** + * This rule determines the "insideness" of a point on the canvas by + * drawing a ray from that point to infinity in any direction and + * counting the number of path segments from the given shape that + * the ray crosses. If this number is odd, the point is inside; if + * even, the point is outside. + */ EvenOddRule, + + /** + * This rule determines the "insideness" of a point on the canvas by + * drawing a ray from that point to infinity in any direction and + * then examining the places where a segment of the shape crosses + * the ray. Starting with a count of zero, add one each time a path + * segment crosses the ray from left to right and subtract one each + * time a path segment crosses the ray from right to left. After + * counting the crossings, if the result is zero then the point is + * outside the path. Otherwise, it is inside. + */ NonZeroRule } @@ -69,29 +122,71 @@ extern(C) RadialGradient } + /** + * Specifies the shape to be used at the end of open subpaths when they + * are stroked. + * + * See_Also: $(LINK2 http://www.w3.org/TR/SVG/painting.html#StrokeLinecapProperty, + * the 'stroke-linecap' property) in the Scalable Vector Graphics (SVG) + * 1.1 Specification. + */ enum LineCap { - UndefinedCap, - ButtCap, - RoundCap, - SquareCap + UndefinedCap, /// + ButtCap, /// ditto + RoundCap, /// ditto + SquareCap /// ditto } + /** + * Specifies the shape to be used at the corners of paths or basic + * shapes when they are stroked. + * + * See_Also: $(LINK2 http://www.w3.org/TR/SVG/painting.html#StrokeLinejoinProperty, + * the 'stroke-linejoin' property) in the Scalable Vector Graphics (SVG) + * 1.1 Specification. + */ enum LineJoin { - UndefinedJoin, - MiterJoin, - RoundJoin, - BevelJoin + UndefinedJoin, /// + MiterJoin, /// ditto + RoundJoin, /// ditto + BevelJoin /// ditto } + /** + * Specify how pixel colors are to be replaced in the image. + */ enum PaintMethod { + /** */ UndefinedMethod, + + /** + * Replace pixel color at point. + */ PointMethod, + + /** + * Replace color for all image pixels matching color at point. + */ ReplaceMethod, + + /** + * Replace color for pixels surrounding point until encountering + * pixel that fails to match color at point. + */ FloodfillMethod, + + /** + * Replace color for pixels surrounding point until encountering + * pixels matching border color. + */ FillToBorderMethod, + + /** + * Replace colors for all pixels in image with fill color. + */ ResetMethod } diff --git a/dmagick/c/type.d b/dmagick/c/type.d index 0291b18..4006d06 100644 --- a/dmagick/c/type.d +++ b/dmagick/c/type.d @@ -7,28 +7,36 @@ import dmagick.c.magickType; extern(C) { + /** + * This setting suggests a type of stretch that ImageMagick should try + * to apply to the currently selected font family. + */ enum StretchType { - UndefinedStretch, - NormalStretch, - UltraCondensedStretch, - ExtraCondensedStretch, - CondensedStretch, - SemiCondensedStretch, - SemiExpandedStretch, - ExpandedStretch, - ExtraExpandedStretch, - UltraExpandedStretch, - AnyStretch + UndefinedStretch, /// + NormalStretch, /// ditto + UltraCondensedStretch, /// ditto + ExtraCondensedStretch, /// ditto + CondensedStretch, /// ditto + SemiCondensedStretch, /// ditto + SemiExpandedStretch, /// ditto + ExpandedStretch, /// ditto + ExtraExpandedStretch, /// ditto + UltraExpandedStretch, /// ditto + AnyStretch /// ditto } + /** + * This setting suggests a font style that ImageMagick should try to + * apply to the currently selected font family. + */ enum StyleType { - UndefinedStyle, - NormalStyle, - ItalicStyle, - ObliqueStyle, - AnyStyle + UndefinedStyle, /// + NormalStyle, /// ditto + ItalicStyle, /// ditto + ObliqueStyle, /// ditto + AnyStyle /// ditto } struct TypeInfo |
