Skip to content

Commit c3a4019

Browse files
jcupittjcupitt
committed
regenerate docs
1 parent 3efb599 commit c3a4019

File tree

1 file changed

+23
-38
lines changed

1 file changed

+23
-38
lines changed

‎doc/vimage.rst

+23-38
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,6 @@ Autogenerated methods
351351
~subtract
352352
~sum
353353
~svgload
354-
~svgload
355354
~svgload_buffer
356355
~svgload_source
357356
~switch
@@ -1793,50 +1792,53 @@ Autogenerated methods
17931792
:rtype: Image or list[Image, Dict[str, mixed]]
17941793
:raises Error:
17951794

1796-
.. method:: heifsave(filename, Q=int, lossless=bool, compression=str, strip=bool, background=list[float], page_height=int)
1795+
.. method:: heifsave(filename, Q=int, lossless=bool, compression=str, speed=int, strip=bool, background=list[float], page_height=int)
17971796

17981797
Save image in HEIF format.
17991798

18001799
Example:
1801-
= in.heifsave(filename, Q=int, lossless=bool, compression=str, strip=bool, background=list[float], page_height=int)
1800+
= in.heifsave(filename, Q=int, lossless=bool, compression=str, speed=int, strip=bool, background=list[float], page_height=int)
18021801

18031802
:param str filename: Filename to load from
18041803
:param int Q: Q factor
18051804
:param bool lossless: Enable lossless compression
18061805
:param str compression: Compression format
1806+
:param int speed: CPU effort
18071807
:param bool strip: Strip all metadata from image
18081808
:param list[float] background: Background value
18091809
:param int page_height: Set page height for multipage save
18101810
:rtype: list[]
18111811
:raises Error:
18121812

1813-
.. method:: heifsave_buffer(Q=int, lossless=bool, compression=str, strip=bool, background=list[float], page_height=int)
1813+
.. method:: heifsave_buffer(Q=int, lossless=bool, compression=str, speed=int, strip=bool, background=list[float], page_height=int)
18141814

18151815
Save image in HEIF format.
18161816

18171817
Example:
1818-
buffer = in.heifsave_buffer(Q=int, lossless=bool, compression=str, strip=bool, background=list[float], page_height=int)
1818+
buffer = in.heifsave_buffer(Q=int, lossless=bool, compression=str, speed=int, strip=bool, background=list[float], page_height=int)
18191819

18201820
:param int Q: Q factor
18211821
:param bool lossless: Enable lossless compression
18221822
:param str compression: Compression format
1823+
:param int speed: CPU effort
18231824
:param bool strip: Strip all metadata from image
18241825
:param list[float] background: Background value
18251826
:param int page_height: Set page height for multipage save
18261827
:rtype: str
18271828
:raises Error:
18281829

1829-
.. method:: heifsave_target(target, Q=int, lossless=bool, compression=str, strip=bool, background=list[float], page_height=int)
1830+
.. method:: heifsave_target(target, Q=int, lossless=bool, compression=str, speed=int, strip=bool, background=list[float], page_height=int)
18301831

18311832
Save image in HEIF format.
18321833

18331834
Example:
1834-
= in.heifsave_target(target, Q=int, lossless=bool, compression=str, strip=bool, background=list[float], page_height=int)
1835+
= in.heifsave_target(target, Q=int, lossless=bool, compression=str, speed=int, strip=bool, background=list[float], page_height=int)
18351836

18361837
:param Target target: Target to save to
18371838
:param int Q: Q factor
18381839
:param bool lossless: Enable lossless compression
18391840
:param str compression: Compression format
1841+
:param int speed: CPU effort
18401842
:param bool strip: Strip all metadata from image
18411843
:param list[float] background: Background value
18421844
:param int page_height: Set page height for multipage save
@@ -2800,7 +2802,7 @@ Autogenerated methods
28002802
out = ref.merge(sec, direction, dx, dy, mblend=int)
28012803

28022804
:param Image sec: Secondary image
2803-
:param str direction: Horizontal or vertcial merge
2805+
:param str direction: Horizontal or vertical merge
28042806
:param int dx: Horizontal displacement from sec to ref
28052807
:param int dy: Vertical displacement from sec to ref
28062808
:param int mblend: Maximum blend size
@@ -2843,7 +2845,7 @@ Autogenerated methods
28432845
out = ref.mosaic(sec, direction, xref, yref, xsec, ysec, hwindow=int, harea=int, mblend=int, bandno=int)
28442846

28452847
:param Image sec: Secondary image
2846-
:param str direction: Horizontal or vertcial mosaic
2848+
:param str direction: Horizontal or vertical mosaic
28472849
:param int xref: Position of reference tie-point
28482850
:param int yref: Position of reference tie-point
28492851
:param int xsec: Position of secondary tie-point
@@ -2869,7 +2871,7 @@ Autogenerated methods
28692871
out = ref.mosaic1(sec, direction, xr1, yr1, xs1, ys1, xr2, yr2, xs2, ys2, hwindow=int, harea=int, search=bool, interpolate=GObject, mblend=int, bandno=int)
28702872

28712873
:param Image sec: Secondary image
2872-
:param str direction: Horizontal or vertcial mosaic
2874+
:param str direction: Horizontal or vertical mosaic
28732875
:param int xr1: Position of first reference tie-point
28742876
:param int yr1: Position of first reference tie-point
28752877
:param int xs1: Position of first secondary tie-point
@@ -3243,7 +3245,7 @@ Autogenerated methods
32433245
:param str filename: Filename to save to
32443246
:param bool ascii: save as ascii
32453247
:param bool squash: save as one bit
3246-
:param int bitdepth: Write as a 1 bit image
3248+
:param int bitdepth: set to 1 to write as a 1 bit image
32473249
:param bool strip: Strip all metadata from image
32483250
:param list[float] background: Background value
32493251
:param int page_height: Set page height for multipage save
@@ -3260,7 +3262,7 @@ Autogenerated methods
32603262
:param Target target: Target to save to
32613263
:param bool ascii: save as ascii
32623264
:param bool squash: save as one bit
3263-
:param int bitdepth: Write as a 1 bit image
3265+
:param int bitdepth: set to 1 to write as a 1 bit image
32643266
:param bool strip: Strip all metadata from image
32653267
:param list[float] background: Background value
32663268
:param int page_height: Set page height for multipage save
@@ -3947,26 +3949,6 @@ Autogenerated methods
39473949
:rtype: Image or list[Image, Dict[str, mixed]]
39483950
:raises Error:
39493951

3950-
.. staticmethod:: svgload(filename, dpi=float, scale=float, unlimited=bool, memory=bool, access=str, sequential=bool, fail=bool, disc=bool, flags=bool)
3951-
3952-
Load SVG with rsvg.
3953-
3954-
Example:
3955-
out = pyvips.Image.svgload(filename, dpi=float, scale=float, unlimited=bool, memory=bool, access=str, sequential=bool, fail=bool, disc=bool)
3956-
3957-
:param str filename: Filename to load from
3958-
:param float dpi: Render at this DPI
3959-
:param float scale: Scale output by this factor
3960-
:param bool unlimited: Allow SVG of any size
3961-
:param bool memory: Force open via memory
3962-
:param str access: Required access pattern for this file
3963-
:param bool sequential: Sequential read only
3964-
:param bool fail: Fail on first error
3965-
:param bool disc: Open to disc
3966-
:param bool flags: enable output: Flags for this file
3967-
:rtype: Image or list[Image, Dict[str, mixed]]
3968-
:raises Error:
3969-
39703952
.. staticmethod:: svgload_buffer(buffer, dpi=float, scale=float, unlimited=bool, memory=bool, access=str, sequential=bool, fail=bool, disc=bool, flags=bool)
39713953

39723954
Load SVG with rsvg.
@@ -4426,12 +4408,12 @@ Autogenerated methods
44264408
:rtype: Image or list[Image, Dict[str, mixed]]
44274409
:raises Error:
44284410

4429-
.. method:: webpsave(filename, Q=int, lossless=bool, preset=str, smart_subsample=bool, near_lossless=bool, alpha_q=int, min_size=bool, kmin=int, kmax=int, reduction_effort=int, strip=bool, background=list[float], page_height=int)
4411+
.. method:: webpsave(filename, Q=int, lossless=bool, preset=str, smart_subsample=bool, near_lossless=bool, alpha_q=int, min_size=bool, kmin=int, kmax=int, reduction_effort=int, profile=str, strip=bool, background=list[float], page_height=int)
44304412

44314413
Save image to webp file.
44324414

44334415
Example:
4434-
= in.webpsave(filename, Q=int, lossless=bool, preset=str, smart_subsample=bool, near_lossless=bool, alpha_q=int, min_size=bool, kmin=int, kmax=int, reduction_effort=int, strip=bool, background=list[float], page_height=int)
4416+
= in.webpsave(filename, Q=int, lossless=bool, preset=str, smart_subsample=bool, near_lossless=bool, alpha_q=int, min_size=bool, kmin=int, kmax=int, reduction_effort=int, profile=str, strip=bool, background=list[float], page_height=int)
44354417

44364418
:param str filename: Filename to save to
44374419
:param int Q: Q factor
@@ -4444,18 +4426,19 @@ Autogenerated methods
44444426
:param int kmin: Minimum number of frames between key frames
44454427
:param int kmax: Maximum number of frames between key frames
44464428
:param int reduction_effort: Level of CPU effort to reduce file size
4429+
:param str profile: ICC profile to embed
44474430
:param bool strip: Strip all metadata from image
44484431
:param list[float] background: Background value
44494432
:param int page_height: Set page height for multipage save
44504433
:rtype: list[]
44514434
:raises Error:
44524435

4453-
.. method:: webpsave_buffer(Q=int, lossless=bool, preset=str, smart_subsample=bool, near_lossless=bool, alpha_q=int, min_size=bool, kmin=int, kmax=int, reduction_effort=int, strip=bool, background=list[float], page_height=int)
4436+
.. method:: webpsave_buffer(Q=int, lossless=bool, preset=str, smart_subsample=bool, near_lossless=bool, alpha_q=int, min_size=bool, kmin=int, kmax=int, reduction_effort=int, profile=str, strip=bool, background=list[float], page_height=int)
44544437

44554438
Save image to webp buffer.
44564439

44574440
Example:
4458-
buffer = in.webpsave_buffer(Q=int, lossless=bool, preset=str, smart_subsample=bool, near_lossless=bool, alpha_q=int, min_size=bool, kmin=int, kmax=int, reduction_effort=int, strip=bool, background=list[float], page_height=int)
4441+
buffer = in.webpsave_buffer(Q=int, lossless=bool, preset=str, smart_subsample=bool, near_lossless=bool, alpha_q=int, min_size=bool, kmin=int, kmax=int, reduction_effort=int, profile=str, strip=bool, background=list[float], page_height=int)
44594442

44604443
:param int Q: Q factor
44614444
:param bool lossless: enable lossless compression
@@ -4467,18 +4450,19 @@ Autogenerated methods
44674450
:param int kmin: Minimum number of frames between key frames
44684451
:param int kmax: Maximum number of frames between key frames
44694452
:param int reduction_effort: Level of CPU effort to reduce file size
4453+
:param str profile: ICC profile to embed
44704454
:param bool strip: Strip all metadata from image
44714455
:param list[float] background: Background value
44724456
:param int page_height: Set page height for multipage save
44734457
:rtype: str
44744458
:raises Error:
44754459

4476-
.. method:: webpsave_target(target, Q=int, lossless=bool, preset=str, smart_subsample=bool, near_lossless=bool, alpha_q=int, min_size=bool, kmin=int, kmax=int, reduction_effort=int, strip=bool, background=list[float], page_height=int)
4460+
.. method:: webpsave_target(target, Q=int, lossless=bool, preset=str, smart_subsample=bool, near_lossless=bool, alpha_q=int, min_size=bool, kmin=int, kmax=int, reduction_effort=int, profile=str, strip=bool, background=list[float], page_height=int)
44774461

44784462
Save image to webp target.
44794463

44804464
Example:
4481-
= in.webpsave_target(target, Q=int, lossless=bool, preset=str, smart_subsample=bool, near_lossless=bool, alpha_q=int, min_size=bool, kmin=int, kmax=int, reduction_effort=int, strip=bool, background=list[float], page_height=int)
4465+
= in.webpsave_target(target, Q=int, lossless=bool, preset=str, smart_subsample=bool, near_lossless=bool, alpha_q=int, min_size=bool, kmin=int, kmax=int, reduction_effort=int, profile=str, strip=bool, background=list[float], page_height=int)
44824466

44834467
:param Target target: Target to save to
44844468
:param int Q: Q factor
@@ -4491,6 +4475,7 @@ Autogenerated methods
44914475
:param int kmin: Minimum number of frames between key frames
44924476
:param int kmax: Maximum number of frames between key frames
44934477
:param int reduction_effort: Level of CPU effort to reduce file size
4478+
:param str profile: ICC profile to embed
44944479
:param bool strip: Strip all metadata from image
44954480
:param list[float] background: Background value
44964481
:param int page_height: Set page height for multipage save

0 commit comments

Comments
 (0)