Interface PaintCarpetOptions

Options accepted by paintCarpet.

interface PaintCarpetOptions {
    color?: [number, number, number];
    cols?: number;
    normalStrength?: number;
    roughness?: number;
    rows?: number;
    shadePeriod?: number;
    speckle?: number;
    tuftJitter?: number;
}

Properties

color? cols? normalStrength? roughness? rows? shadePeriod? speckle? tuftJitter?

Properties

Optionalcolor

color?: [number, number, number]

Carpet base colour in [0..1]³. Default [0.40, 0.32, 0.28] (warm taupe).

Optionalcols

cols?: number

Loop tufts across the texture's width. Default 32.

OptionalnormalStrength

normalStrength?: number

heightToNormal strength. Default 2.5.

Optionalroughness

roughness?: number

Uniform roughness in [0..1]. Default 0.95.

Optionalrows

rows?: number

Loop tufts across the texture's height. Default 32.

OptionalshadePeriod

shadePeriod?: number

Period of the soft macro-shade fBm, in lattice cells. Default 5.

Optionalspeckle

speckle?: number

Per-pixel fibre speckle amplitude in [0..1]. Default 0.10.

OptionaltuftJitter

tuftJitter?: number

Per-tuft tint jitter amplitude in [0..1]. Default 0.06.

Settings

Member Visibility

On This Page

Properties