Skip to content

pencilSketch

Computational photographyfunctionOpenCV 5.0.0
import { pencilSketch } from '@banou/opencv-wasm'

Use after await initOpenCV(). See the initialization and named imports guide.

ARGUMENTSsrc, dst1, dst2, sigma_s
FUNCTIONpencilSketch
RETURN TYPEvoid
Call structure. A void return can still write to destination arguments. The parameter descriptions define inputs, outputs and ownership.

example: samples/cpp/tutorial_code/photo/non_photorealistic_rendering/npr_demo.cpp An example using non-photorealistic line drawing functions Pencil-like non-photorealistic line drawing

pencilSketch(src: Mat, dst1: Mat, dst2: Mat, sigma_s: number, sigma_r: number, shade_factor: number): void;
4 available overloads
pencilSketch(src: Mat, dst1: Mat, dst2: Mat): void;
pencilSketch(src: Mat, dst1: Mat, dst2: Mat, sigma_s: number): void;
pencilSketch(src: Mat, dst1: Mat, dst2: Mat, sigma_s: number, sigma_r: number): void;
pencilSketch(src: Mat, dst1: Mat, dst2: Mat, sigma_s: number, sigma_r: number, shade_factor: number): void;
src

Input 8-bit 3-channel image.

dst1

Output destination, filled by the native operation. Output 8-bit 1-channel image.

dst2

Output destination, filled by the native operation. Output image with the same size and type as src.

sigma_s

%Range between 0 to 200.

sigma_r

%Range between 0 to 1.

shade_factor

%Range between 0 to 0.1.

These signatures describe this package. Upstream documentation can mention optional backends that are absent from this build. Check runtime compatibility before choosing a backend or file format.