Skip to content

Commit

Permalink
regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jcupitt committed Dec 18, 2020
1 parent 3efb599 commit c3a4019
Showing 1 changed file with 23 additions and 38 deletions.
61 changes: 23 additions & 38 deletions doc/vimage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,6 @@ Autogenerated methods
~subtract
~sum
~svgload
~svgload
~svgload_buffer
~svgload_source
~switch
Expand Down Expand Up @@ -1793,50 +1792,53 @@ Autogenerated methods
:rtype: Image or list[Image, Dict[str, mixed]]
:raises Error:

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

Save image in HEIF format.

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

:param str filename: Filename to load from
:param int Q: Q factor
:param bool lossless: Enable lossless compression
:param str compression: Compression format
:param int speed: CPU effort
:param bool strip: Strip all metadata from image
:param list[float] background: Background value
:param int page_height: Set page height for multipage save
:rtype: list[]
:raises Error:

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

Save image in HEIF format.

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

:param int Q: Q factor
:param bool lossless: Enable lossless compression
:param str compression: Compression format
:param int speed: CPU effort
:param bool strip: Strip all metadata from image
:param list[float] background: Background value
:param int page_height: Set page height for multipage save
:rtype: str
:raises Error:

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

Save image in HEIF format.

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

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

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

:param Image sec: Secondary image
:param str direction: Horizontal or vertcial mosaic
:param str direction: Horizontal or vertical mosaic
:param int xref: Position of reference tie-point
:param int yref: Position of reference tie-point
:param int xsec: Position of secondary tie-point
Expand All @@ -2869,7 +2871,7 @@ Autogenerated methods
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)

:param Image sec: Secondary image
:param str direction: Horizontal or vertcial mosaic
:param str direction: Horizontal or vertical mosaic
:param int xr1: Position of first reference tie-point
:param int yr1: Position of first reference tie-point
:param int xs1: Position of first secondary tie-point
Expand Down Expand Up @@ -3243,7 +3245,7 @@ Autogenerated methods
:param str filename: Filename to save to
:param bool ascii: save as ascii
:param bool squash: save as one bit
:param int bitdepth: Write as a 1 bit image
:param int bitdepth: set to 1 to write as a 1 bit image
:param bool strip: Strip all metadata from image
:param list[float] background: Background value
:param int page_height: Set page height for multipage save
Expand All @@ -3260,7 +3262,7 @@ Autogenerated methods
:param Target target: Target to save to
:param bool ascii: save as ascii
:param bool squash: save as one bit
:param int bitdepth: Write as a 1 bit image
:param int bitdepth: set to 1 to write as a 1 bit image
:param bool strip: Strip all metadata from image
:param list[float] background: Background value
:param int page_height: Set page height for multipage save
Expand Down Expand Up @@ -3947,26 +3949,6 @@ Autogenerated methods
:rtype: Image or list[Image, Dict[str, mixed]]
:raises Error:

.. staticmethod:: svgload(filename, dpi=float, scale=float, unlimited=bool, memory=bool, access=str, sequential=bool, fail=bool, disc=bool, flags=bool)

Load SVG with rsvg.

Example:
out = pyvips.Image.svgload(filename, dpi=float, scale=float, unlimited=bool, memory=bool, access=str, sequential=bool, fail=bool, disc=bool)

:param str filename: Filename to load from
:param float dpi: Render at this DPI
:param float scale: Scale output by this factor
:param bool unlimited: Allow SVG of any size
:param bool memory: Force open via memory
:param str access: Required access pattern for this file
:param bool sequential: Sequential read only
:param bool fail: Fail on first error
:param bool disc: Open to disc
:param bool flags: enable output: Flags for this file
:rtype: Image or list[Image, Dict[str, mixed]]
:raises Error:

.. staticmethod:: svgload_buffer(buffer, dpi=float, scale=float, unlimited=bool, memory=bool, access=str, sequential=bool, fail=bool, disc=bool, flags=bool)

Load SVG with rsvg.
Expand Down Expand Up @@ -4426,12 +4408,12 @@ Autogenerated methods
:rtype: Image or list[Image, Dict[str, mixed]]
:raises Error:

.. 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)
.. 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)

Save image to webp file.

Example:
= 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)
= 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)

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

.. 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)
.. 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)

Save image to webp buffer.

Example:
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)
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)

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

.. 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)
.. 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)

Save image to webp target.

Example:
= 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)
= 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)

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

0 comments on commit c3a4019

Please sign in to comment.