Skip to main content

RoughConfig

interface RoughConfig 

Configuration options for rough rendering.

These options control the appearance of the hand-drawn style. All numeric values can be animated using signals.

Properties

bowing

bowing: number

Controls the curve deviation from a straight line.

A value of 0 will cause lines to be perfectly straight. Higher values introduce more curvature.

Default Value: ```ts 1 ```

curveStepCount

Curve tightness for hachure lines.

Lower values create more curved hachure lines.

Default Value: ```ts 0.95 ```

disableMultiStroke

Whether to disable multi-stroke rendering.

By default, Rough.js renders strokes with multiple lines for a more sketchy appearance. Set to true to use a single stroke.

Default Value: ```ts false ```

disableMultiStrokeFill

Whether to disable multi-stroke fill.

By default, Rough.js renders fills with multiple passes. Set to true to use a single fill pass.

Default Value: ```ts false ```

fillStyle

fillStyle: RoughFillStyle

Fill style for the shape.

Default Value: ```ts 'hachure' ```

fillWeight

fillWeight?: number

Thickness of the lines used for filling.

Only applicable for hachure, cross-hatch, and similar fill styles.

Default Value: ```ts Half of strokeWidth, or 1 ```

hachureAngle

hachureAngle: number

Angle of the hachure lines in degrees.

Only applicable for hachure and cross-hatch fill styles.

Default Value: ```ts -41 ```

hachureGap

hachureGap: number

Gap between hachure lines in pixels.

Only applicable for hachure, cross-hatch, and similar fill styles.

Default Value: ```ts 4 times strokeWidth ```

roughness

roughness: number

Numerical value indicating how rough the drawing is.

A value of 0 will produce a smooth shape, while higher values introduce more irregularity. Typical range is 0-10.

Default Value: ```ts 1 ```

seed

seed?: number

Seed for the random number generator.

Using the same seed produces consistent results, which is useful for reproducible animations.


simplification

Simplification tolerance for paths.

Higher values simplify the path more aggressively.

Default Value: ```ts 0 ```