drawing_pen.h
Overview
The drawing_pen.h file declares the functions related to the pen in the drawing module.
File to include: <native_drawing/drawing_pen.h>
Library: libnative_drawing.so
Since: 8
Related module: Drawing
Summary
Enums
| Name | Description |
|---|---|
| OH_Drawing_PenLineCapStyle { LINE_FLAT_CAP, LINE_SQUARE_CAP, LINE_ROUND_CAP } |
Enumerates the line cap styles of a pen. The line cap style defines the style of both ends of a line segment drawn by the pen. |
| OH_Drawing_PenLineJoinStyle { LINE_MITER_JOIN, LINE_ROUND_JOIN, LINE_BEVEL_JOIN } |
Enumerates the line join styles of a pen. The line join style defines the shape of the joints of a polyline segment drawn by the pen. |
Functions
| Name | Description |
|---|---|
| OH_Drawing_Pen * OH_Drawing_PenCreate (void) | Creates an OH_Drawing_Path object. |
| void OH_Drawing_PenDestroy (OH_Drawing_Pen *) | Destroys an OH_Drawing_Path object and reclaims the memory occupied by the object. |
| bool OH_Drawing_PenIsAntiAlias (const OH_Drawing_Pen *) | Checks whether anti-aliasing is enabled for a pen. Anti-aliasing makes the pixels around the shape edges semi-transparent. |
| void OH_Drawing_PenSetAntiAlias (OH_Drawing_Pen *, bool) | Enables or disables anti-aliasing for a pen. Anti-aliasing makes the pixels around the shape edges semi-transparent. |
| uint32_t OH_Drawing_PenGetColor (const OH_Drawing_Pen *) | Obtains the color of a pen. The color is used by the pen to outline a shape. |
| void OH_Drawing_PenSetColor (OH_Drawing_Pen *, uint32_t color) | Sets the color for a pen. The color is used by the pen to outline a shape. |
| uint8_t OH_Drawing_PenGetAlpha (const OH_Drawing_Pen *) | Obtains the alpha value of a pen. This value is used by the alpha channel when the pen outlines a shape. |
| void OH_Drawing_PenSetAlpha (OH_Drawing_Pen *, uint8_t alpha) | Sets the alpha value for a pen. This value is used by the alpha channel when the pen outlines a shape. |
| float OH_Drawing_PenGetWidth (const OH_Drawing_Pen *) | Obtains the thickness of a pen. This thickness determines the width of the outline of a shape. |
| void OH_Drawing_PenSetWidth (OH_Drawing_Pen *, float width) | Sets the thickness for a pen. This thickness determines the width of the outline of a shape. |
| float OH_Drawing_PenGetMiterLimit (const OH_Drawing_Pen *) | Obtains the stroke miter limit of a polyline drawn by a pen. When the corner type is bevel, a beveled corner is displayed if the miter limit is exceeded, and a mitered corner is displayed if the miter limit is not exceeded. |
| void OH_Drawing_PenSetMiterLimit (OH_Drawing_Pen *, float miter) | Sets the stroke miter limit for a polyline drawn by a pen. When the corner type is bevel, a beveled corner is displayed if the miter limit is exceeded, and a mitered corner is displayed if the miter limit is not exceeded. |
| OH_Drawing_PenLineCapStyleOH_Drawing_PenGetCap (const OH_Drawing_Pen *) | Obtains the line cap style of a pen. |
| void OH_Drawing_PenSetCap (OH_Drawing_Pen *, OH_Drawing_PenLineCapStyle) | Sets the line cap style for a pen. |
| OH_Drawing_PenLineJoinStyleOH_Drawing_PenGetJoin (const OH_Drawing_Pen *) | Obtains the line join style of a pen. |
| void OH_Drawing_PenSetJoin (OH_Drawing_Pen *, OH_Drawing_PenLineJoinStyle) | Sets the line join style for a pen. |