Skip to content

Commit 6888bbd

Browse files
kleisaukekleisauke
authored
Update docs for 8.17 (#541)
1 parent 495e00d commit 6888bbd

File tree

1 file changed

+75
-31
lines changed

1 file changed

+75
-31
lines changed

‎doc/vimage.rst‎

Lines changed: 75 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,7 @@ Autogenerated methods
308308
~pngsave_buffer
309309
~pngsave_target
310310
~ppmload
311+
~ppmload_buffer
311312
~ppmload_source
312313
~ppmsave
313314
~ppmsave_target
@@ -337,6 +338,7 @@ Autogenerated methods
337338
~relational_const
338339
~remainder
339340
~remainder_const
341+
~remosaic
340342
~replicate
341343
~resize
342344
~rot
@@ -4735,9 +4737,31 @@ Autogenerated methods
47354737
:rtype: Image or list[Image, Dict[str, mixed]]
47364738
:raises Error:
47374739

4740+
.. staticmethod:: ppmload_buffer(buffer, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool)
4741+
4742+
Load ppm from buffer.
4743+
4744+
Example:
4745+
out = pyvips.Image.ppmload_buffer(buffer, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool)
4746+
4747+
:param buffer: Buffer to load from
4748+
:type buffer: str
4749+
:param memory: Force open via memory
4750+
:type memory: bool
4751+
:param access: Required access pattern for this file
4752+
:type access: Union[str, Access]
4753+
:param fail_on: Error level to fail on
4754+
:type fail_on: Union[str, FailOn]
4755+
:param revalidate: Don't use a cached result for this operation
4756+
:type revalidate: bool
4757+
:param flags: enable output: Flags for this file
4758+
:type flags: bool
4759+
:rtype: Image or list[Image, Dict[str, mixed]]
4760+
:raises Error:
4761+
47384762
.. staticmethod:: ppmload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool)
47394763

4740-
Load ppm base class.
4764+
Load ppm from source.
47414765

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

5260+
.. method:: remosaic(old_str, new_str)
5261+
5262+
Rebuild an mosaiced image.
5263+
5264+
Example:
5265+
out = in.remosaic(old_str, new_str)
5266+
5267+
:param old_str: Search for this string
5268+
:type old_str: str
5269+
:param new_str: And swap for this string
5270+
:type new_str: str
5271+
:rtype: Image
5272+
:raises Error:
5273+
52365274
.. method:: replicate(across, down)
52375275

52385276
Replicate an image.
@@ -5673,12 +5711,12 @@ Autogenerated methods
56735711
:rtype: Image
56745712
:raises Error:
56755713

5676-
.. 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)
5714+
.. 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)
56775715

56785716
Load SVG with rsvg.
56795717

56805718
Example:
5681-
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)
5719+
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)
56825720

56835721
:param filename: Filename to load from
56845722
:type filename: str
@@ -5690,6 +5728,8 @@ Autogenerated methods
56905728
:type unlimited: bool
56915729
:param stylesheet: Custom CSS
56925730
:type stylesheet: str
5731+
:param high_bitdepth: Enable scRGB 128-bit output (32-bit per channel)
5732+
:type high_bitdepth: bool
56935733
:param memory: Force open via memory
56945734
:type memory: bool
56955735
:param access: Required access pattern for this file
@@ -5703,12 +5743,12 @@ Autogenerated methods
57035743
:rtype: Image or list[Image, Dict[str, mixed]]
57045744
:raises Error:
57055745

5706-
.. 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)
5746+
.. 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)
57075747

57085748
Load SVG with rsvg.
57095749

57105750
Example:
5711-
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)
5751+
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)
57125752

57135753
:param buffer: Buffer to load from
57145754
:type buffer: str
@@ -5720,6 +5760,8 @@ Autogenerated methods
57205760
:type unlimited: bool
57215761
:param stylesheet: Custom CSS
57225762
:type stylesheet: str
5763+
:param high_bitdepth: Enable scRGB 128-bit output (32-bit per channel)
5764+
:type high_bitdepth: bool
57235765
:param memory: Force open via memory
57245766
:type memory: bool
57255767
:param access: Required access pattern for this file
@@ -5733,12 +5775,12 @@ Autogenerated methods
57335775
:rtype: Image or list[Image, Dict[str, mixed]]
57345776
:raises Error:
57355777

5736-
.. 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)
5778+
.. 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)
57375779

57385780
Load svg from source.
57395781

57405782
Example:
5741-
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)
5783+
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)
57425784

57435785
:param source: Source to load from
57445786
:type source: Source
@@ -5750,6 +5792,8 @@ Autogenerated methods
57505792
:type unlimited: bool
57515793
:param stylesheet: Custom CSS
57525794
:type stylesheet: str
5795+
:param high_bitdepth: Enable scRGB 128-bit output (32-bit per channel)
5796+
:type high_bitdepth: bool
57535797
:param memory: Force open via memory
57545798
:type memory: bool
57555799
:param access: Required access pattern for this file
@@ -5831,12 +5875,12 @@ Autogenerated methods
58315875
:rtype: Image or list[Image, Dict[str, mixed]]
58325876
:raises Error:
58335877

5834-
.. 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])
5878+
.. 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])
58355879

58365880
Generate thumbnail from file.
58375881

58385882
Example:
5839-
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])
5883+
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])
58405884

58415885
:param filename: Filename to read from
58425886
:type filename: str
@@ -5852,23 +5896,23 @@ Autogenerated methods
58525896
:type crop: Union[str, Interesting]
58535897
:param linear: Reduce in linear light
58545898
:type linear: bool
5855-
:param import_profile: Fallback import profile
5856-
:type import_profile: str
5857-
:param export_profile: Fallback export profile
5858-
:type export_profile: str
5899+
:param input_profile: Fallback input profile
5900+
:type input_profile: str
5901+
:param output_profile: Fallback output profile
5902+
:type output_profile: str
58595903
:param intent: Rendering intent
58605904
:type intent: Union[str, Intent]
58615905
:param fail_on: Error level to fail on
58625906
:type fail_on: Union[str, FailOn]
58635907
:rtype: Image
58645908
:raises Error:
58655909

5866-
.. 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])
5910+
.. 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])
58675911

58685912
Generate thumbnail from buffer.
58695913

58705914
Example:
5871-
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])
5915+
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])
58725916

58735917
:param buffer: Buffer to load from
58745918
:type buffer: str
@@ -5886,23 +5930,23 @@ Autogenerated methods
58865930
:type crop: Union[str, Interesting]
58875931
:param linear: Reduce in linear light
58885932
:type linear: bool
5889-
:param import_profile: Fallback import profile
5890-
:type import_profile: str
5891-
:param export_profile: Fallback export profile
5892-
:type export_profile: str
5933+
:param input_profile: Fallback input profile
5934+
:type input_profile: str
5935+
:param output_profile: Fallback output profile
5936+
:type output_profile: str
58935937
:param intent: Rendering intent
58945938
:type intent: Union[str, Intent]
58955939
:param fail_on: Error level to fail on
58965940
:type fail_on: Union[str, FailOn]
58975941
:rtype: Image
58985942
:raises Error:
58995943

5900-
.. 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])
5944+
.. 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])
59015945

59025946
Generate thumbnail from image.
59035947

59045948
Example:
5905-
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])
5949+
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])
59065950

59075951
:param width: Size to this width
59085952
:type width: int
@@ -5916,23 +5960,23 @@ Autogenerated methods
59165960
:type crop: Union[str, Interesting]
59175961
:param linear: Reduce in linear light
59185962
:type linear: bool
5919-
:param import_profile: Fallback import profile
5920-
:type import_profile: str
5921-
:param export_profile: Fallback export profile
5922-
:type export_profile: str
5963+
:param input_profile: Fallback input profile
5964+
:type input_profile: str
5965+
:param output_profile: Fallback output profile
5966+
:type output_profile: str
59235967
:param intent: Rendering intent
59245968
:type intent: Union[str, Intent]
59255969
:param fail_on: Error level to fail on
59265970
:type fail_on: Union[str, FailOn]
59275971
:rtype: Image
59285972
:raises Error:
59295973

5930-
.. 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])
5974+
.. 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])
59315975

59325976
Generate thumbnail from source.
59335977

59345978
Example:
5935-
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])
5979+
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])
59365980

59375981
:param source: Source to load from
59385982
:type source: Source
@@ -5950,10 +5994,10 @@ Autogenerated methods
59505994
:type crop: Union[str, Interesting]
59515995
:param linear: Reduce in linear light
59525996
:type linear: bool
5953-
:param import_profile: Fallback import profile
5954-
:type import_profile: str
5955-
:param export_profile: Fallback export profile
5956-
:type export_profile: str
5997+
:param input_profile: Fallback input profile
5998+
:type input_profile: str
5999+
:param output_profile: Fallback output profile
6000+
:type output_profile: str
59576001
:param intent: Rendering intent
59586002
:type intent: Union[str, Intent]
59596003
:param fail_on: Error level to fail on

0 commit comments

Comments
 (0)