Skip to content

Update docs for 8.17 #541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 5, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 75 additions & 31 deletions doc/vimage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,7 @@ Autogenerated methods
~pngsave_buffer
~pngsave_target
~ppmload
~ppmload_buffer
~ppmload_source
~ppmsave
~ppmsave_target
Expand Down Expand Up @@ -337,6 +338,7 @@ Autogenerated methods
~relational_const
~remainder
~remainder_const
~remosaic
~replicate
~resize
~rot
Expand Down Expand Up @@ -4735,9 +4737,31 @@ Autogenerated methods
:rtype: Image or list[Image, Dict[str, mixed]]
:raises Error:

.. staticmethod:: ppmload_buffer(buffer, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool)

Load ppm from buffer.

Example:
out = pyvips.Image.ppmload_buffer(buffer, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool)

:param buffer: Buffer to load from
:type buffer: str
:param memory: Force open via memory
:type memory: bool
:param access: Required access pattern for this file
:type access: Union[str, Access]
:param fail_on: Error level to fail on
:type fail_on: Union[str, FailOn]
:param revalidate: Don't use a cached result for this operation
:type revalidate: bool
:param flags: enable output: Flags for this file
:type flags: bool
:rtype: Image or list[Image, Dict[str, mixed]]
:raises Error:

.. staticmethod:: ppmload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool)

Load ppm base class.
Load ppm from source.

Example:
out = pyvips.Image.ppmload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool)
Expand Down Expand Up @@ -5233,6 +5257,20 @@ Autogenerated methods
:rtype: Image
:raises Error:

.. method:: remosaic(old_str, new_str)

Rebuild an mosaiced image.

Example:
out = in.remosaic(old_str, new_str)

:param old_str: Search for this string
:type old_str: str
:param new_str: And swap for this string
:type new_str: str
:rtype: Image
:raises Error:

.. method:: replicate(across, down)

Replicate an image.
Expand Down Expand Up @@ -5673,12 +5711,12 @@ Autogenerated methods
:rtype: Image
:raises Error:

.. staticmethod:: svgload(filename, dpi=float, scale=float, unlimited=bool, stylesheet=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool)
.. staticmethod:: svgload(filename, dpi=float, scale=float, unlimited=bool, stylesheet=str, high_bitdepth=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool)

Load SVG with rsvg.

Example:
out = pyvips.Image.svgload(filename, dpi=float, scale=float, unlimited=bool, stylesheet=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool)
out = pyvips.Image.svgload(filename, dpi=float, scale=float, unlimited=bool, stylesheet=str, high_bitdepth=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool)

:param filename: Filename to load from
:type filename: str
Expand All @@ -5690,6 +5728,8 @@ Autogenerated methods
:type unlimited: bool
:param stylesheet: Custom CSS
:type stylesheet: str
:param high_bitdepth: Enable scRGB 128-bit output (32-bit per channel)
:type high_bitdepth: bool
:param memory: Force open via memory
:type memory: bool
:param access: Required access pattern for this file
Expand All @@ -5703,12 +5743,12 @@ Autogenerated methods
:rtype: Image or list[Image, Dict[str, mixed]]
:raises Error:

.. staticmethod:: svgload_buffer(buffer, dpi=float, scale=float, unlimited=bool, stylesheet=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool)
.. staticmethod:: svgload_buffer(buffer, dpi=float, scale=float, unlimited=bool, stylesheet=str, high_bitdepth=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool)

Load SVG with rsvg.

Example:
out = pyvips.Image.svgload_buffer(buffer, dpi=float, scale=float, unlimited=bool, stylesheet=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool)
out = pyvips.Image.svgload_buffer(buffer, dpi=float, scale=float, unlimited=bool, stylesheet=str, high_bitdepth=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool)

:param buffer: Buffer to load from
:type buffer: str
Expand All @@ -5720,6 +5760,8 @@ Autogenerated methods
:type unlimited: bool
:param stylesheet: Custom CSS
:type stylesheet: str
:param high_bitdepth: Enable scRGB 128-bit output (32-bit per channel)
:type high_bitdepth: bool
:param memory: Force open via memory
:type memory: bool
:param access: Required access pattern for this file
Expand All @@ -5733,12 +5775,12 @@ Autogenerated methods
:rtype: Image or list[Image, Dict[str, mixed]]
:raises Error:

.. staticmethod:: svgload_source(source, dpi=float, scale=float, unlimited=bool, stylesheet=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool)
.. staticmethod:: svgload_source(source, dpi=float, scale=float, unlimited=bool, stylesheet=str, high_bitdepth=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool)

Load svg from source.

Example:
out = pyvips.Image.svgload_source(source, dpi=float, scale=float, unlimited=bool, stylesheet=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool)
out = pyvips.Image.svgload_source(source, dpi=float, scale=float, unlimited=bool, stylesheet=str, high_bitdepth=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool)

:param source: Source to load from
:type source: Source
Expand All @@ -5750,6 +5792,8 @@ Autogenerated methods
:type unlimited: bool
:param stylesheet: Custom CSS
:type stylesheet: str
:param high_bitdepth: Enable scRGB 128-bit output (32-bit per channel)
:type high_bitdepth: bool
:param memory: Force open via memory
:type memory: bool
:param access: Required access pattern for this file
Expand Down Expand Up @@ -5831,12 +5875,12 @@ Autogenerated methods
:rtype: Image or list[Image, Dict[str, mixed]]
:raises Error:

.. staticmethod:: thumbnail(filename, width, height=int, size=Union[str, Size], no_rotate=bool, crop=Union[str, Interesting], linear=bool, import_profile=str, export_profile=str, intent=Union[str, Intent], fail_on=Union[str, FailOn])
.. staticmethod:: thumbnail(filename, width, height=int, size=Union[str, Size], no_rotate=bool, crop=Union[str, Interesting], linear=bool, input_profile=str, output_profile=str, intent=Union[str, Intent], fail_on=Union[str, FailOn])

Generate thumbnail from file.

Example:
out = pyvips.Image.thumbnail(filename, width, height=int, size=Union[str, Size], no_rotate=bool, crop=Union[str, Interesting], linear=bool, import_profile=str, export_profile=str, intent=Union[str, Intent], fail_on=Union[str, FailOn])
out = pyvips.Image.thumbnail(filename, width, height=int, size=Union[str, Size], no_rotate=bool, crop=Union[str, Interesting], linear=bool, input_profile=str, output_profile=str, intent=Union[str, Intent], fail_on=Union[str, FailOn])

:param filename: Filename to read from
:type filename: str
Expand All @@ -5852,23 +5896,23 @@ Autogenerated methods
:type crop: Union[str, Interesting]
:param linear: Reduce in linear light
:type linear: bool
:param import_profile: Fallback import profile
:type import_profile: str
:param export_profile: Fallback export profile
:type export_profile: str
:param input_profile: Fallback input profile
:type input_profile: str
:param output_profile: Fallback output profile
:type output_profile: str
:param intent: Rendering intent
:type intent: Union[str, Intent]
:param fail_on: Error level to fail on
:type fail_on: Union[str, FailOn]
:rtype: Image
:raises Error:

.. staticmethod:: thumbnail_buffer(buffer, width, option_string=str, height=int, size=Union[str, Size], no_rotate=bool, crop=Union[str, Interesting], linear=bool, import_profile=str, export_profile=str, intent=Union[str, Intent], fail_on=Union[str, FailOn])
.. staticmethod:: thumbnail_buffer(buffer, width, option_string=str, height=int, size=Union[str, Size], no_rotate=bool, crop=Union[str, Interesting], linear=bool, input_profile=str, output_profile=str, intent=Union[str, Intent], fail_on=Union[str, FailOn])

Generate thumbnail from buffer.

Example:
out = pyvips.Image.thumbnail_buffer(buffer, width, option_string=str, height=int, size=Union[str, Size], no_rotate=bool, crop=Union[str, Interesting], linear=bool, import_profile=str, export_profile=str, intent=Union[str, Intent], fail_on=Union[str, FailOn])
out = pyvips.Image.thumbnail_buffer(buffer, width, option_string=str, height=int, size=Union[str, Size], no_rotate=bool, crop=Union[str, Interesting], linear=bool, input_profile=str, output_profile=str, intent=Union[str, Intent], fail_on=Union[str, FailOn])

:param buffer: Buffer to load from
:type buffer: str
Expand All @@ -5886,23 +5930,23 @@ Autogenerated methods
:type crop: Union[str, Interesting]
:param linear: Reduce in linear light
:type linear: bool
:param import_profile: Fallback import profile
:type import_profile: str
:param export_profile: Fallback export profile
:type export_profile: str
:param input_profile: Fallback input profile
:type input_profile: str
:param output_profile: Fallback output profile
:type output_profile: str
:param intent: Rendering intent
:type intent: Union[str, Intent]
:param fail_on: Error level to fail on
:type fail_on: Union[str, FailOn]
:rtype: Image
:raises Error:

.. method:: thumbnail_image(width, height=int, size=Union[str, Size], no_rotate=bool, crop=Union[str, Interesting], linear=bool, import_profile=str, export_profile=str, intent=Union[str, Intent], fail_on=Union[str, FailOn])
.. method:: thumbnail_image(width, height=int, size=Union[str, Size], no_rotate=bool, crop=Union[str, Interesting], linear=bool, input_profile=str, output_profile=str, intent=Union[str, Intent], fail_on=Union[str, FailOn])

Generate thumbnail from image.

Example:
out = in.thumbnail_image(width, height=int, size=Union[str, Size], no_rotate=bool, crop=Union[str, Interesting], linear=bool, import_profile=str, export_profile=str, intent=Union[str, Intent], fail_on=Union[str, FailOn])
out = in.thumbnail_image(width, height=int, size=Union[str, Size], no_rotate=bool, crop=Union[str, Interesting], linear=bool, input_profile=str, output_profile=str, intent=Union[str, Intent], fail_on=Union[str, FailOn])

:param width: Size to this width
:type width: int
Expand All @@ -5916,23 +5960,23 @@ Autogenerated methods
:type crop: Union[str, Interesting]
:param linear: Reduce in linear light
:type linear: bool
:param import_profile: Fallback import profile
:type import_profile: str
:param export_profile: Fallback export profile
:type export_profile: str
:param input_profile: Fallback input profile
:type input_profile: str
:param output_profile: Fallback output profile
:type output_profile: str
:param intent: Rendering intent
:type intent: Union[str, Intent]
:param fail_on: Error level to fail on
:type fail_on: Union[str, FailOn]
:rtype: Image
:raises Error:

.. staticmethod:: thumbnail_source(source, width, option_string=str, height=int, size=Union[str, Size], no_rotate=bool, crop=Union[str, Interesting], linear=bool, import_profile=str, export_profile=str, intent=Union[str, Intent], fail_on=Union[str, FailOn])
.. staticmethod:: thumbnail_source(source, width, option_string=str, height=int, size=Union[str, Size], no_rotate=bool, crop=Union[str, Interesting], linear=bool, input_profile=str, output_profile=str, intent=Union[str, Intent], fail_on=Union[str, FailOn])

Generate thumbnail from source.

Example:
out = pyvips.Image.thumbnail_source(source, width, option_string=str, height=int, size=Union[str, Size], no_rotate=bool, crop=Union[str, Interesting], linear=bool, import_profile=str, export_profile=str, intent=Union[str, Intent], fail_on=Union[str, FailOn])
out = pyvips.Image.thumbnail_source(source, width, option_string=str, height=int, size=Union[str, Size], no_rotate=bool, crop=Union[str, Interesting], linear=bool, input_profile=str, output_profile=str, intent=Union[str, Intent], fail_on=Union[str, FailOn])

:param source: Source to load from
:type source: Source
Expand All @@ -5950,10 +5994,10 @@ Autogenerated methods
:type crop: Union[str, Interesting]
:param linear: Reduce in linear light
:type linear: bool
:param import_profile: Fallback import profile
:type import_profile: str
:param export_profile: Fallback export profile
:type export_profile: str
:param input_profile: Fallback input profile
:type input_profile: str
:param output_profile: Fallback output profile
:type output_profile: str
:param intent: Rendering intent
:type intent: Union[str, Intent]
:param fail_on: Error level to fail on
Expand Down