Blend2D
2D Vector Graphics Engine
Geometries
Geometries, paths, and transformations.
Blend2D offers various geometry structures and objects that can be used with either BLPath for path building or BLContext for rendering. In general there are two categories - BLPath, which specifies a 2D path composed of path segments, and lightweight geometries such as BLRect, BLRoundRect, etc... which are only described by a trivial C/C++ struct.
Paths
- BLPath - path container
- BLPathCore - C API type representing BLPath
- BLPathCmd - path command specifies the type of a path segment withing BLPath
- BLPathFlags - flags associated with BLPath
- BLPathReverseMode - reverse mode accepted by BLPath::addReversedPath()
- BLPathView - view providing all necessary variables to inspect and iterate a BLPath
Path Operations
- BLStrokeOptions - holds stroking options
- BLStrokeOptionsCore - C API type representing BLStrokeOptions
- BLOffsetMode - path offsetting mode
- BLFlattenMode - path flattening mode
- BLStrokeCap - stroke cap option
- BLStrokeCapPosition - stroke cap position (can be specified separately)
- BLStrokeJoin - stroke join option
- BLStrokeTransformOrder - the order of a transformation when rendering a stroked path or geometry
Lightweight Geometries and Structs
- BLPoint - 2D point composed of
[x, y]values (64-bit floats) - BLPointI - 2D point composed of
[x, y]values (32-bit integers) - BLSize - 2D size composed of
[w, h]values (64-bit floats) - BLSizeI - 2D size composed of
[w, h]values (32-bit integers) - BLBox - 2D rectangular area composed of
[x0, y0, x1, y1]values (64-bit floats) - BLBoxI - 2D rectangular area composed of
[x0, y0, x1, y1]values (32-bit integers) - BLRect - 2D rectangular area composed of
[x, y, w, h]values (64-bit floats) - BLRectI - 2D rectangular area composed of
[x, y, w, h]values (32-bit integers) - BLRoundRect - rounded rectangle within
[x, y, w, h]with radius[rx, ry](64-bit floats) - BLCircle - circle at
[cx, cy]with radiusr(64-bit floats) - BLEllipse - ellipse at
[cx, cy]with radius[rx, ry](64-bit floats) - BLArc - arc at
[cx, cy]with radius[rx, ry]andstart+sweepvalues (64-bit floats) - BLLine - line segment from
[x0, y0]to[x1, y1](64-bit floats) - BLTriangle - triangle having
[x0, y0],[x1, y1], and[x2, y2]vertices (64-bit floats)
Geometry Constants
- BLGeometryDirection - specifies a direction
- BLGeometryType - specifies a type of a geometry argument (low-level)
- BLFillRule - specifies a fill rule (used by both BLPath and BLContext)
- BLHitTest - specifies a result of hit-testing
Transformations
- BLMatrix2D - 2D transformation matrix (affine)
- BLTransformOp - transformation operation (low-level)
- BLTransformType - transformation type
Classes
struct BLPointI
struct BLSizeI
struct BLBoxI
struct BLRectI
struct BLPoint
struct BLSize
struct BLBox
struct BLRect
struct BLLine
struct BLTriangle
struct BLRoundRect
struct BLCircle
struct BLEllipse
struct BLArc
struct BLMatrix2D
struct BLApproximationOptions
struct BLPathView
class BLStrokeOptions
class BLPath
struct BLPath::MoveTo
struct BLPath::LineTo
struct BLPath::QuadTo
struct BLPath::CubicTo
Enumerations
enum BLGeometryDirection : uint32_t
enum BLGeometryType : uint32_t
enum BLFillRule : uint32_t
enum BLHitTest : uint32_t
BLPath - Constants
enum BLPathCmd : uint32_t
enum BLPathCmdExtra : uint32_t
enum BLPathFlags : uint32_t
enum BLPathReverseMode : uint32_t
enum BLStrokeJoin : uint32_t
enum BLStrokeCapPosition : uint32_t
enum BLStrokeCap : uint32_t
enum BLStrokeTransformOrder : uint32_t
enum BLFlattenMode : uint32_t
enum BLOffsetMode : uint32_t
BLPath - Sinks
typedef BLResult(* BLPathStrokeSinkFunc)(BLPathCore* a, BLPathCore* b, BLPathCore* c, size_t inputStart, size_t inputEnd, void* userData) noexcept
BLPath - Globals
2D path functionality is provided by BLPathCore in C API and wrapped by BLPath in C++ API.
Global Specializations
Overloaded Operators
typedef BLResult(* BLPathSinkFunc)(BLPathCore* path, const void* info, void* userData) noexceptnoexcept[¶]
Optional callback that can be used to consume a path data.
typedef BLResult(* BLPathStrokeSinkFunc)(BLPathCore* a, BLPathCore* b, BLPathCore* c, size_t inputStart, size_t inputEnd, void* userData) noexceptnoexcept[¶]
This is a sink that is used by path offsetting. This sink consumes both a and b offsets of the path. The sink will be called for each figure and is responsible for joining these paths. If the paths are not closed then the sink must insert start cap, then join b, and then insert end cap.
The sink must also clean up the paths as this is not done by the offsetter. The reason is that in case the a path is the output path you can just keep it and insert b path into it (clearing only b path after each call).
BLGeometryDirection : uint32_tenum[¶]
BLGeometryType : uint32_tenum[¶]
Geometry type.
Geometry describes a shape or path that can be either rendered or added to a BLPath container. Both BLPath and BLContext provide functionality to work with all geometry types. Please note that each type provided here requires to pass a matching struct or class to the function that consumes a geometryType and geometryData arguments.
| Constant | Description |
|---|---|
| BL_GEOMETRY_TYPE_NONE | No geometry provided. |
| BL_GEOMETRY_TYPE_BOXI | BLBoxI struct. |
| BL_GEOMETRY_TYPE_BOXD | BLBox struct. |
| BL_GEOMETRY_TYPE_RECTI | BLRectI struct. |
| BL_GEOMETRY_TYPE_RECTD | BLRect struct. |
| BL_GEOMETRY_TYPE_CIRCLE | BLCircle struct. |
| BL_GEOMETRY_TYPE_ELLIPSE | BLEllipse struct. |
| BL_GEOMETRY_TYPE_ROUND_RECT | BLRoundRect struct. |
| BL_GEOMETRY_TYPE_ARC | BLArc struct. |
| BL_GEOMETRY_TYPE_CHORD | BLArc struct representing chord. |
| BL_GEOMETRY_TYPE_PIE | BLArc struct representing pie. |
| BL_GEOMETRY_TYPE_LINE | BLLine struct. |
| BL_GEOMETRY_TYPE_TRIANGLE | BLTriangle struct. |
| BL_GEOMETRY_TYPE_POLYLINEI | BLArrayView<BLPointI> representing a polyline. |
| BL_GEOMETRY_TYPE_POLYLINED | BLArrayView<BLPoint> representing a polyline. |
| BL_GEOMETRY_TYPE_POLYGONI | BLArrayView<BLPointI> representing a polygon. |
| BL_GEOMETRY_TYPE_POLYGOND | BLArrayView<BLPoint> representing a polygon. |
| BL_GEOMETRY_TYPE_ARRAY_VIEW_BOXI | BLArrayView<BLBoxI> struct. |
| BL_GEOMETRY_TYPE_ARRAY_VIEW_BOXD | BLArrayView<BLBox> struct. |
| BL_GEOMETRY_TYPE_ARRAY_VIEW_RECTI | BLArrayView<BLRectI> struct. |
| BL_GEOMETRY_TYPE_ARRAY_VIEW_RECTD | BLArrayView<BLRect> struct. |
| BL_GEOMETRY_TYPE_PATH | BLPath (or BLPathCore). |
| BL_GEOMETRY_TYPE_MAX_VALUE | Maximum value of |
BLFillRule : uint32_tenum[¶]
BLTransformType : uint32_tenum[¶]
Transformation matrix type that can be obtained by calling BLMatrix2D::type().
Identity Transl. Scale Swap Affine
[1 0] [1 0] [. 0] [0 .] [. .]
[0 1] [0 1] [0 .] [. 0] [. .]
[0 0] [. .] [. .] [. .] [. .]
BLTransformOp : uint32_tenum[¶]
Transformation matrix operation type.
| Constant | Description |
|---|---|
| BL_TRANSFORM_OP_RESET | Reset matrix to identity (argument ignored, should be nullptr). |
| BL_TRANSFORM_OP_ASSIGN | Assign (copy) the other matrix. |
| BL_TRANSFORM_OP_TRANSLATE | Translate the matrix by [x, y]. |
| BL_TRANSFORM_OP_SCALE | Scale the matrix by [x, y]. |
| BL_TRANSFORM_OP_SKEW | Skew the matrix by [x, y]. |
| BL_TRANSFORM_OP_ROTATE | Rotate the matrix by the given angle about [0, 0]. |
| BL_TRANSFORM_OP_ROTATE_PT | Rotate the matrix by the given angle about [x, y]. |
| BL_TRANSFORM_OP_TRANSFORM | Transform this matrix by other BLMatrix2D. |
| BL_TRANSFORM_OP_POST_TRANSLATE | Post-translate the matrix by [x, y]. |
| BL_TRANSFORM_OP_POST_SCALE | Post-scale the matrix by [x, y]. |
| BL_TRANSFORM_OP_POST_SKEW | Post-skew the matrix by [x, y]. |
| BL_TRANSFORM_OP_POST_ROTATE | Post-rotate the matrix about [0, 0]. |
| BL_TRANSFORM_OP_POST_ROTATE_PT | Post-rotate the matrix about a reference BLPoint. |
| BL_TRANSFORM_OP_POST_TRANSFORM | Post-transform this matrix by other BLMatrix2D. |
| BL_TRANSFORM_OP_MAX_VALUE | Maximum value of |
BLPathCmd : uint32_tenum[¶]
Path command.
BLPathCmdExtra : uint32_tenum[¶]
Path command (never stored in path).
| Constant | Description |
|---|---|
| BL_PATH_CMD_PRESERVE | Used by |
BLPathFlags : uint32_tenum[¶]
Path flags.
BLPathReverseMode : uint32_tenum[¶]
BLStrokeJoin : uint32_tenum[¶]
Stroke join type.
BLStrokeCapPosition : uint32_tenum[¶]
BLStrokeCap : uint32_tenum[¶]
A presentation attribute defining the shape to be used at the end of open sub-paths.
BLStrokeTransformOrder : uint32_tenum[¶]
BLFlattenMode : uint32_tenum[¶]
BLOffsetMode : uint32_tenum[¶]
const BLApproximationOptions blDefaultApproximationOptionsextern[¶]
Default approximation options used by Blend2D.