Skip to content

Commit 2d83848

Browse files
committed
docs: 更新 API 文档,添加 PipelineSpec 列映射
- 在所有 API 文档的函数映射表中添加 PipelineSpec 列 - 补充 Pipeline Method 和 PipelineSpec 方法的对应关系 - 更新异步处理指南,使用 PipelineSpec 替代 VipsPipeline - 添加 PipelineSpec 的完整使用示例和可用操作列表 - 涉及文档:arithmetic、colour、complex、conversion、convolution、frequency、io、morphology、resample 和 async 指南 Signed-off-by: Caijinglong <[email protected]>
1 parent 3be6710 commit 2d83848

File tree

17 files changed

+395
-250
lines changed

17 files changed

+395
-250
lines changed

docs/website/docs/api/arithmetic.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,24 @@ Mathematical operations on images.
88

99
## Function Mapping
1010

11-
| libvips C | Dart Binding | Pipeline Method |
12-
|-----------|--------------|-----------------|
13-
| `vips_add()` | `arithmeticBindings.add()` | - |
14-
| `vips_subtract()` | `arithmeticBindings.subtract()` | - |
15-
| `vips_multiply()` | `arithmeticBindings.multiply()` | - |
16-
| `vips_divide()` | `arithmeticBindings.divide()` | - |
17-
| `vips_abs()` | `arithmeticBindings.abs()` | - |
18-
| `vips_sign()` | `arithmeticBindings.sign()` | - |
19-
| `vips_min()` | `arithmeticBindings.min()` | - |
20-
| `vips_max()` | `arithmeticBindings.max()` | - |
21-
| `vips_avg()` | `arithmeticBindings.avg()` | - |
22-
| `vips_deviate()` | `arithmeticBindings.deviate()` | - |
23-
| `vips_stats()` | `arithmeticBindings.stats()` | - |
24-
| `vips_math()` | `arithmeticBindings.math()` | - |
25-
| `vips_math2()` | `arithmeticBindings.math2()` | - |
26-
| `vips_clamp()` | `arithmeticBindings.clamp()` | `pipeline.clamp()` |
11+
| libvips C | Dart Binding | Pipeline Method | PipelineSpec |
12+
|-----------|--------------|-----------------|--------------|
13+
| `vips_add()` | `arithmeticBindings.add()` | - | - |
14+
| `vips_subtract()` | `arithmeticBindings.subtract()` | - | - |
15+
| `vips_multiply()` | `arithmeticBindings.multiply()` | - | - |
16+
| `vips_divide()` | `arithmeticBindings.divide()` | - | - |
17+
| `vips_abs()` | `arithmeticBindings.abs()` | `pipeline.abs()` | `spec.abs()` |
18+
| `vips_sign()` | `arithmeticBindings.sign()` | `pipeline.sign()` | `spec.sign()` |
19+
| `vips_min()` | `arithmeticBindings.min()` | - | - |
20+
| `vips_max()` | `arithmeticBindings.max()` | - | - |
21+
| `vips_avg()` | `arithmeticBindings.avg()` | - | - |
22+
| `vips_deviate()` | `arithmeticBindings.deviate()` | - | - |
23+
| `vips_stats()` | `arithmeticBindings.stats()` | - | - |
24+
| `vips_math()` | `arithmeticBindings.math()` | - | - |
25+
| `vips_math2()` | `arithmeticBindings.math2()` | - | - |
26+
| `vips_clamp()` | `arithmeticBindings.clamp()` | `pipeline.clamp()` | - |
27+
| `vips_ceil()` | - | `pipeline.ceil()` | `spec.ceil()` |
28+
| `vips_floor()` | - | `pipeline.floor()` | `spec.floor()` |
2729

2830
## add
2931

docs/website/docs/api/colour.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,22 @@ Colour space conversions and colour operations.
88

99
## Function Mapping
1010

11-
| libvips C | Dart Binding | Pipeline Method |
12-
|-----------|--------------|-----------------|
13-
| `vips_colourspace()` | `apiBindings.colourspace()` | `pipeline.colourspace()` |
14-
| `vips_linear1()` | `apiBindings.linear1()` | `pipeline.brightness()` / `contrast()` |
15-
| `vips_invert()` | `apiBindings.invert()` | `pipeline.invert()` |
16-
| `vips_flatten()` | `apiBindings.flatten()` | - |
17-
| `vips_gamma()` | `apiBindings.gamma()` | - |
18-
| `vips_Lab2XYZ()` | `colourBindings.lab2XYZ()` | - |
19-
| `vips_XYZ2Lab()` | `colourBindings.xyz2Lab()` | - |
20-
| `vips_Lab2LCh()` | `colourBindings.lab2LCh()` | - |
21-
| `vips_LCh2Lab()` | `colourBindings.lch2Lab()` | - |
22-
| `vips_sRGB2scRGB()` | `colourBindings.srgb2scrgb()` | - |
23-
| `vips_scRGB2sRGB()` | `colourBindings.scrgb2srgb()` | - |
24-
| `vips_icc_import()` | `colourBindings.iccImport()` | - |
25-
| `vips_icc_export()` | `colourBindings.iccExport()` | - |
26-
| `vips_icc_transform()` | `colourBindings.iccTransform()` | - |
11+
| libvips C | Dart Binding | Pipeline Method | PipelineSpec |
12+
|-----------|--------------|-----------------|--------------|
13+
| `vips_colourspace()` | `apiBindings.colourspace()` | `pipeline.colourspace()` | `spec.colourspace()` |
14+
| `vips_linear1()` | `apiBindings.linear1()` | `pipeline.brightness()` / `contrast()` | `spec.brightness()` / `spec.contrast()` |
15+
| `vips_invert()` | `apiBindings.invert()` | `pipeline.invert()` | `spec.invert()` |
16+
| `vips_flatten()` | `apiBindings.flatten()` | `pipeline.flatten()` | `spec.flatten()` |
17+
| `vips_gamma()` | `apiBindings.gamma()` | `pipeline.gamma()` | `spec.gamma()` |
18+
| `vips_Lab2XYZ()` | `colourBindings.lab2XYZ()` | - | - |
19+
| `vips_XYZ2Lab()` | `colourBindings.xyz2Lab()` | - | - |
20+
| `vips_Lab2LCh()` | `colourBindings.lab2LCh()` | - | - |
21+
| `vips_LCh2Lab()` | `colourBindings.lch2Lab()` | - | - |
22+
| `vips_sRGB2scRGB()` | `colourBindings.srgb2scrgb()` | - | - |
23+
| `vips_scRGB2sRGB()` | `colourBindings.scrgb2srgb()` | - | - |
24+
| `vips_icc_import()` | `colourBindings.iccImport()` | - | - |
25+
| `vips_icc_export()` | `colourBindings.iccExport()` | - | - |
26+
| `vips_icc_transform()` | `colourBindings.iccTransform()` | - | - |
2727

2828
## colourspace
2929

docs/website/docs/api/complex.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ Complex number operations for signal processing and FFT.
88

99
## Function Mapping
1010

11-
| libvips C | Dart Binding | Description |
12-
|-----------|--------------|-------------|
13-
| `vips_complex()` | `complexBindings.complex()` | Unary complex operation |
14-
| `vips_complex2()` | `complexBindings.complex2()` | Binary complex operation |
15-
| `vips_complexget()` | `complexBindings.complexget()` | Extract component |
16-
| `vips_complexform()` | `complexBindings.complexform()` | Form complex from components |
17-
| `vips_polar()` | `complexBindings.polar()` | Cartesian to polar |
18-
| `vips_rect()` | `complexBindings.rect()` | Polar to Cartesian |
19-
| `vips_conj()` | `complexBindings.conj()` | Complex conjugate |
20-
| `vips_real()` | `complexBindings.real()` | Get real part |
21-
| `vips_imag()` | `complexBindings.imag()` | Get imaginary part |
22-
| `vips_cross_phase()` | `complexBindings.crossPhase()` | Cross-phase correlation |
11+
| libvips C | Dart Binding | Pipeline Method | PipelineSpec |
12+
|-----------|--------------|-----------------|--------------|
13+
| `vips_complex()` | `complexBindings.complex()` | - | - |
14+
| `vips_complex2()` | `complexBindings.complex2()` | - | - |
15+
| `vips_complexget()` | `complexBindings.complexget()` | - | - |
16+
| `vips_complexform()` | `complexBindings.complexform()` | - | - |
17+
| `vips_polar()` | `complexBindings.polar()` | `pipeline.polar()` | `spec.polar()` |
18+
| `vips_rect()` | `complexBindings.rect()` | `pipeline.rect()` | `spec.rect()` |
19+
| `vips_conj()` | `complexBindings.conj()` | `pipeline.conj()` | `spec.conj()` |
20+
| `vips_real()` | `complexBindings.real()` | `pipeline.real()` | `spec.real()` |
21+
| `vips_imag()` | `complexBindings.imag()` | `pipeline.imag()` | `spec.imag()` |
22+
| `vips_cross_phase()` | `complexBindings.crossPhase()` | - | - |
2323

2424
## complex
2525

docs/website/docs/api/conversion.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ Image format and type conversion operations.
88

99
## Function Mapping
1010

11-
| libvips C | Dart Binding | Pipeline Method |
12-
|-----------|--------------|-----------------|
13-
| `vips_crop()` | `apiBindings.crop()` | `pipeline.crop()` |
14-
| `vips_extract_area()` | `apiBindings.extractArea()` | - |
15-
| `vips_smartcrop()` | `apiBindings.smartcrop()` | `pipeline.smartCrop()` |
16-
| `vips_flip()` | `apiBindings.flip()` | `pipeline.flipHorizontal()` / `flipVertical()` |
17-
| `vips_embed()` | `apiBindings.embed()` | - |
18-
| `vips_gravity()` | `apiBindings.gravity()` | - |
19-
| `vips_zoom()` | `apiBindings.zoom()` | - |
20-
| `vips_autorot()` | `apiBindings.autorot()` | `pipeline.autoRotate()` |
21-
| `vips_cast()` | `conversionBindings.cast()` | - |
22-
| `vips_bandjoin()` | `conversionBindings.bandjoin()` | - |
23-
| `vips_bandmean()` | `conversionBindings.bandmean()` | - |
24-
| `vips_copy()` | `conversionBindings.copy()` | - |
11+
| libvips C | Dart Binding | Pipeline Method | PipelineSpec |
12+
|-----------|--------------|-----------------|--------------|
13+
| `vips_crop()` | `apiBindings.crop()` | `pipeline.crop()` | `spec.crop()` |
14+
| `vips_extract_area()` | `apiBindings.extractArea()` | - | - |
15+
| `vips_smartcrop()` | `apiBindings.smartcrop()` | `pipeline.smartCrop()` | `spec.smartCrop()` |
16+
| `vips_flip()` | `apiBindings.flip()` | `pipeline.flip()` | `spec.flip()` / `spec.flipHorizontal()` / `spec.flipVertical()` |
17+
| `vips_embed()` | `apiBindings.embed()` | `pipeline.embed()` | `spec.embed()` |
18+
| `vips_gravity()` | `apiBindings.gravity()` | `pipeline.gravity()` | `spec.gravity()` |
19+
| `vips_zoom()` | `apiBindings.zoom()` | `pipeline.zoom()` | `spec.zoom()` |
20+
| `vips_autorot()` | `apiBindings.autorot()` | `pipeline.autoRotate()` | `spec.autoRotate()` |
21+
| `vips_cast()` | `conversionBindings.cast()` | `pipeline.cast()` | `spec.cast()` |
22+
| `vips_bandjoin()` | `conversionBindings.bandjoin()` | - | - |
23+
| `vips_bandmean()` | `conversionBindings.bandmean()` | `pipeline.bandmean()` | `spec.bandmean()` |
24+
| `vips_copy()` | `conversionBindings.copy()` | `pipeline.copy()` | `spec.copy()` |
2525

2626
## crop / extract_area
2727

docs/website/docs/api/convolution.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ Convolution operations including blur, sharpen, and edge detection.
88

99
## Function Mapping
1010

11-
| libvips C | Dart Binding | Pipeline Method |
12-
|-----------|--------------|-----------------|
13-
| `vips_gaussblur()` | `apiBindings.gaussblur()` | `pipeline.gaussianBlur()` |
14-
| `vips_sharpen()` | `apiBindings.sharpen()` | `pipeline.sharpen()` |
15-
| `vips_sobel()` | `apiBindings.sobel()` | - |
16-
| `vips_canny()` | `apiBindings.canny()` | - |
17-
| `vips_conv()` | `convolutionBindings.conv()` | - |
18-
| `vips_conva()` | `convolutionBindings.conva()` | - |
19-
| `vips_convsep()` | `convolutionBindings.convsep()` | - |
20-
| `vips_compass()` | `convolutionBindings.compass()` | - |
11+
| libvips C | Dart Binding | Pipeline Method | PipelineSpec |
12+
|-----------|--------------|-----------------|--------------|
13+
| `vips_gaussblur()` | `apiBindings.gaussblur()` | `pipeline.blur()` | `spec.blur()` |
14+
| `vips_sharpen()` | `apiBindings.sharpen()` | `pipeline.sharpen()` | `spec.sharpen()` |
15+
| `vips_sobel()` | `apiBindings.sobel()` | `pipeline.sobel()` | `spec.sobel()` |
16+
| `vips_canny()` | `apiBindings.canny()` | `pipeline.canny()` | `spec.canny()` |
17+
| `vips_conv()` | `convolutionBindings.conv()` | - | - |
18+
| `vips_conva()` | `convolutionBindings.conva()` | - | - |
19+
| `vips_convsep()` | `convolutionBindings.convsep()` | - | - |
20+
| `vips_compass()` | `convolutionBindings.compass()` | - | - |
2121

2222
## gaussblur
2323

docs/website/docs/api/frequency.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ FFT (Fast Fourier Transform) and frequency domain operations.
88

99
## Function Mapping
1010

11-
| libvips C | Dart Binding | Description |
12-
|-----------|--------------|-------------|
13-
| `vips_fwfft()` | `frequencyBindings.fwfft()` | Forward FFT |
14-
| `vips_invfft()` | `frequencyBindings.invfft()` | Inverse FFT |
15-
| `vips_freqmult()` | `frequencyBindings.freqmult()` | Frequency domain multiplication |
16-
| `vips_spectrum()` | `frequencyBindings.spectrum()` | Compute power spectrum |
17-
| `vips_phasecor()` | `frequencyBindings.phasecor()` | Phase correlation |
11+
| libvips C | Dart Binding | Pipeline Method | PipelineSpec |
12+
|-----------|--------------|-----------------|--------------|
13+
| `vips_fwfft()` | `frequencyBindings.fwfft()` | `pipeline.fwfft()` | `spec.fwfft()` |
14+
| `vips_invfft()` | `frequencyBindings.invfft()` | `pipeline.invfft()` | `spec.invfft()` |
15+
| `vips_freqmult()` | `frequencyBindings.freqmult()` | - | - |
16+
| `vips_spectrum()` | `frequencyBindings.spectrum()` | `pipeline.spectrum()` | `spec.spectrum()` |
17+
| `vips_phasecor()` | `frequencyBindings.phasecor()` | - | - |
1818

1919
## fwfft
2020

docs/website/docs/api/io.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,30 @@ Image loading and saving operations.
1010

1111
### Loading
1212

13-
| libvips C | Dart Binding | Pipeline Method |
14-
|-----------|--------------|-----------------|
15-
| `vips_image_new_from_file()` | `apiBindings.imageNewFromFile()` | `VipsPipeline.fromFile()` |
16-
| `vips_image_new_from_buffer()` | `apiBindings.imageNewFromBuffer()` | `VipsPipeline.fromBuffer()` |
17-
| `vips_jpegload()` | `ioBindings.jpegload()` | - |
18-
| `vips_pngload()` | `ioBindings.pngload()` | - |
19-
| `vips_webpload()` | `ioBindings.webpload()` | - |
20-
| `vips_gifload()` | `ioBindings.gifload()` | - |
21-
| `vips_tiffload()` | `ioBindings.tiffload()` | - |
22-
| `vips_heifload()` | `ioBindings.heifload()` | - |
13+
| libvips C | Dart Binding | Pipeline Method | PipelineSpec |
14+
|-----------|--------------|-----------------|--------------|
15+
| `vips_image_new_from_file()` | `apiBindings.imageNewFromFile()` | `VipsPipeline.fromFile()` | `spec.input()` |
16+
| `vips_image_new_from_buffer()` | `apiBindings.imageNewFromBuffer()` | `VipsPipeline.fromBuffer()` | `spec.inputBuffer()` |
17+
| `vips_jpegload()` | `ioBindings.jpegload()` | - | - |
18+
| `vips_pngload()` | `ioBindings.pngload()` | - | - |
19+
| `vips_webpload()` | `ioBindings.webpload()` | - | - |
20+
| `vips_gifload()` | `ioBindings.gifload()` | - | - |
21+
| `vips_tiffload()` | `ioBindings.tiffload()` | - | - |
22+
| `vips_heifload()` | `ioBindings.heifload()` | - | - |
2323

2424
### Saving
2525

26-
| libvips C | Dart Binding | Pipeline Method |
27-
|-----------|--------------|-----------------|
28-
| `vips_image_write_to_file()` | `apiBindings.imageWriteToFile()` | `pipeline.toFile()` |
29-
| `vips_image_write_to_buffer()` | `apiBindings.imageWriteToBuffer()` | `pipeline.toBuffer()` |
30-
| `vips_jpegsave_buffer()` | `ioBindings.jpegsaveBuffer()` | `pipeline.toJpeg()` |
31-
| `vips_pngsave_buffer()` | `ioBindings.pngsaveBuffer()` | `pipeline.toPng()` |
32-
| `vips_webpsave_buffer()` | `ioBindings.webpsaveBuffer()` | `pipeline.toWebp()` |
33-
| `vips_gifsave_buffer()` | `ioBindings.gifsaveBuffer()` | `pipeline.toGif()` |
34-
| `vips_tiffsave_buffer()` | `ioBindings.tiffsaveBuffer()` | `pipeline.toTiff()` |
35-
| `vips_heifsave_buffer()` | `ioBindings.heifsaveBuffer()` | `pipeline.toHeif()` |
36-
| `vips_dzsave()` | `ioBindings.dzsave()` | `pipeline.toDeepZoom()` |
26+
| libvips C | Dart Binding | Pipeline Method | PipelineSpec |
27+
|-----------|--------------|-----------------|--------------|
28+
| `vips_image_write_to_file()` | `apiBindings.imageWriteToFile()` | `pipeline.toFile()` | - |
29+
| `vips_image_write_to_buffer()` | `apiBindings.imageWriteToBuffer()` | `pipeline.toBuffer()` | `spec.execute()` |
30+
| `vips_jpegsave_buffer()` | `ioBindings.jpegsaveBuffer()` | `pipeline.toJpeg()` | `spec.outputJpeg()` |
31+
| `vips_pngsave_buffer()` | `ioBindings.pngsaveBuffer()` | `pipeline.toPng()` | `spec.outputPng()` |
32+
| `vips_webpsave_buffer()` | `ioBindings.webpsaveBuffer()` | `pipeline.toWebp()` | `spec.outputWebp()` |
33+
| `vips_gifsave_buffer()` | `ioBindings.gifsaveBuffer()` | `pipeline.toGif()` | - |
34+
| `vips_tiffsave_buffer()` | `ioBindings.tiffsaveBuffer()` | `pipeline.toTiff()` | - |
35+
| `vips_heifsave_buffer()` | `ioBindings.heifsaveBuffer()` | `pipeline.toHeif()` | - |
36+
| `vips_dzsave()` | `ioBindings.dzsave()` | `pipeline.toDeepZoom()` | - |
3737

3838
## image_new_from_file
3939

docs/website/docs/api/morphology.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ Morphological operations for image processing.
88

99
## Function Mapping
1010

11-
| libvips C | Dart Binding | Description |
12-
|-----------|--------------|-------------|
13-
| `vips_morph()` | `morphologyBindings.morph()` | Apply morphological operation |
14-
| `vips_rank()` | `morphologyBindings.rank()` | Rank filter |
15-
| `vips_median()` | `morphologyBindings.median()` | Median filter |
16-
| `vips_countlines()` | `morphologyBindings.countlines()` | Count lines |
17-
| `vips_labelregions()` | `morphologyBindings.labelregions()` | Label connected regions |
18-
| `vips_fill_nearest()` | `morphologyBindings.fillNearest()` | Fill with nearest pixel |
11+
| libvips C | Dart Binding | Pipeline Method | PipelineSpec |
12+
|-----------|--------------|-----------------|--------------|
13+
| `vips_morph()` | `morphologyBindings.morph()` | - | - |
14+
| `vips_rank()` | `morphologyBindings.rank()` | `pipeline.rank()` | `spec.rank()` |
15+
| `vips_median()` | `morphologyBindings.median()` | `pipeline.median()` | `spec.median()` |
16+
| `vips_countlines()` | `morphologyBindings.countlines()` | - | - |
17+
| `vips_labelregions()` | `morphologyBindings.labelregions()` | `pipeline.labelregions()` | `spec.labelregions()` |
18+
| `vips_fill_nearest()` | `morphologyBindings.fillNearest()` | `pipeline.fillNearest()` | `spec.fillNearest()` |
1919

2020
## morph
2121

docs/website/docs/api/resample.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ Resize and resampling operations.
88

99
## Function Mapping
1010

11-
| libvips C | Dart Binding | Pipeline Method |
12-
|-----------|--------------|-----------------|
13-
| `vips_resize()` | `apiBindings.resize()` | `pipeline.resize()` |
14-
| `vips_thumbnail()` | `apiBindings.thumbnail()` | - |
15-
| `vips_thumbnail_image()` | `apiBindings.thumbnailImage()` | `pipeline.thumbnail()` |
16-
| `vips_thumbnail_buffer()` | `apiBindings.thumbnailBuffer()` | - |
17-
| `vips_reduce()` | `apiBindings.reduce()` | - |
18-
| `vips_shrink()` | `apiBindings.shrink()` | - |
19-
| `vips_rotate()` | `apiBindings.rotate()` | `pipeline.rotate()` |
20-
| `vips_affine()` | `resampleBindings.affine()` | - |
21-
| `vips_similarity()` | `resampleBindings.similarity()` | - |
22-
| `vips_mapim()` | `resampleBindings.mapim()` | - |
23-
| `vips_quadratic()` | `resampleBindings.quadratic()` | - |
11+
| libvips C | Dart Binding | Pipeline Method | PipelineSpec |
12+
|-----------|--------------|-----------------|--------------|
13+
| `vips_resize()` | `apiBindings.resize()` | `pipeline.resize()` | `spec.resize()` |
14+
| `vips_thumbnail()` | `apiBindings.thumbnail()` | - | - |
15+
| `vips_thumbnail_image()` | `apiBindings.thumbnailImage()` | `pipeline.thumbnail()` | `spec.thumbnail()` |
16+
| `vips_thumbnail_buffer()` | `apiBindings.thumbnailBuffer()` | - | - |
17+
| `vips_reduce()` | `apiBindings.reduce()` | `pipeline.reduce()` | `spec.reduce()` |
18+
| `vips_shrink()` | `apiBindings.shrink()` | `pipeline.shrink()` | `spec.shrink()` |
19+
| `vips_rotate()` | `apiBindings.rotate()` | `pipeline.rotate()` | `spec.rotate()` |
20+
| `vips_affine()` | `resampleBindings.affine()` | - | - |
21+
| `vips_similarity()` | `resampleBindings.similarity()` | - | - |
22+
| `vips_mapim()` | `resampleBindings.mapim()` | - | - |
23+
| `vips_quadratic()` | `resampleBindings.quadratic()` | - | - |
2424

2525
## resize
2626

0 commit comments

Comments
 (0)