8000 Update 8.17 docs by kleisauke · Pull Request #4555 · libvips/libvips · GitHub
[go: up one dir, main page]
Skip to content

Update 8.17 docs #4555

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.

Sign up for GitHub

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

Update 8.17 docs #4555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 4 additions & 1 deletion API/8.17/callback.RegionWrite.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,10 @@ <h4 id="description" style="display:flex;">
<div class="docblock">
<p>The function should write the pixels in <code>area</code> from <code>region</code>. <code>a</code> is the
value passed into <a href="method.Image.sink_disc.html"><code>vips_sink_disc()</code></a>.</p>
<p>See also: <a href="method.Image.sink_disc.html"><code>vips_sink_disc()</code></a>.</p>
<div class="admonition seealso">
<p class="admonition-title">See&nbsp;also</p>
<p><a href="method.Image.sink_disc.html"><code>vips_sink_disc()</code></a>.</p>
</div>
</div>

<div class="docblock">
Expand Down
22 changes: 11 additions & 11 deletions API/8.17/class.Connection.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,49 +188,49 @@ <h4 id="hierarchy">
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for Vips.Connection">
<!-- Generated by graphviz version 2.42.4 (0)
<!-- Generated by graphviz version 12.2.1 (20241206.2353)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="112pt" height="188pt"
viewBox="0.00 0.00 112.00 188.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<svg width="135pt" height="188pt"
viewBox="0.00 0.00 135.00 188.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 184)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="VipsConnection">
<path fill="none" stroke="black" d="M92,-36C92,-36 12,-36 12,-36 6,-36 0,-30 0,-24 0,-24 0,-12 0,-12 0,-6 6,0 12,0 12,0 92,0 92,0 98,0 104,-6 104,-12 104,-12 104,-24 104,-24 104,-30 98,-36 92,-36"/>
<text text-anchor="middle" x="52" y="-14.3" font-family="Times,serif" font-size="14.00">VipsConnection</text>
<path fill="none" stroke="black" d="M115,-36C115,-36 12,-36 12,-36 6,-36 0,-30 0,-24 0,-24 0,-12 0,-12 0,-6 6,0 12,0 12,0 115,0 115,0 121,0 127,-6 127,-12 127,-12 127,-24 127,-24 127,-30 121,-36 115,-36"/>
<text text-anchor="middle" x="63.5" y="-13.32" font-family="Times,serif" font-size="14.00">VipsConnection</text>
</a>
</g>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node link">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:href="class.Object.html" xlink:title="VipsObject">
<path fill="none" stroke="black" d="M79,-108C79,-108 25,-108 25,-108 19,-108 13,-102 13,-96 13,-96 13,-84 13,-84 13,-78 19,-72 25,-72 25,-72 79,-72 79,-72 85,-72 91,-78 91,-84 91,-84 91,-96 91,-96 91,-102 85,-108 79,-108"/>
<text text-anchor="middle" x="52" y="-86.3" font-family="Times,serif" font-size="14.00">VipsObject</text>
<path fill="none" stroke="black" d="M98.12,-108C98.12,-108 28.88,-108 28.88,-108 22.88,-108 16.88,-102 16.88,-96 16.88,-96 16.88,-84 16.88,-84 16.88,-78 22.88,-72 28.88,-72 28.88,-72 98.12,-72 98.12,-72 104.12,-72 110.12,-78 110.12,-84 110.12,-84 110.12,-96 110.12,-96 110.12,-102 104.12,-108 98.12,-108"/>
<text text-anchor="middle" x="63.5" y="-85.33" font-family="Times,serif" font-size="14.00">VipsObject</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge2" class="edge">
<title>ancestor_0&#45;&#45;this</title>
<path fill="none" stroke="black" d="M52,-71.7C52,-60.85 52,-46.92 52,-36.1"/>
<path fill="none" stroke="black" d="M63.5,-71.7C63.5,-60.85 63.5,-46.92 63.5,-36.1"/>
</g>
<!-- ancestor_1 -->
<g id="node3" class="node">
<title>ancestor_1</title>
<g id="a_node3"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M71,-180C71,-180 33,-180 33,-180 27,-180 21,-174 21,-168 21,-168 21,-156 21,-156 21,-150 27,-144 33,-144 33,-144 71,-144 71,-144 77,-144 83,-150 83,-156 83,-156 83,-168 83,-168 83,-174 77,-180 71,-180"/>
<text text-anchor="middle" x="52" y="-158.3" font-family="Times,serif" font-size="14.00">GObject</text>
<path fill="none" stroke="black" d="M88.38,-180C88.38,-180 38.62,-180 38.62,-180 32.62,-180 26.63,-174 26.63,-168 26.63,-168 26.63,-156 26.63,-156 26.63,-150 32.63,-144 38.63,-144 38.63,-144 88.38,-144 88.38,-144 94.38,-144 100.38,-150 100.38,-156 100.38,-156 100.38,-168 100.38,-168 100.38,-174 94.38,-180 88.38,-180"/>
<text text-anchor="middle" x="63.5" y="-157.32" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_1&#45;&#45;ancestor_0 -->
<g id="edge1" class="edge">
<title>ancestor_1&#45;&#45;ancestor_0</title>
<path fill="none" stroke="black" d="M52,-143.7C52,-132.85 52,-118.92 52,-108.1"/>
<path fill="none" stroke="black" d="M63.5,-143.7C63.5,-132.85 63.5,-118.92 63.5,-108.1"/>
</g>
</g>
</svg>
Expand Down
30 changes: 15 additions & 15 deletions API/8.17/class.Foreign.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,63 +225,63 @@ <h4 id="hierarchy">
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for Vips.Foreign">
<!-- Generated by graphviz version 2.42.4 (0)
<!-- Generated by graphviz version 12.2.1 (20241206.2353)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="104pt" height="260pt"
viewBox="0.00 0.00 104.00 260.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<svg width="126pt" height="260pt"
viewBox="0.00 0.00 126.00 260.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 256)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="VipsForeign">
<path fill="none" stroke="black" d="M78,-36C78,-36 18,-36 18,-36 12,-36 6,-30 6,-24 6,-24 6,-12 6,-12 6,-6 12,0 18,0 18,0 78,0 78,0 84,0 90,-6 90,-12 90,-12 90,-24 90,-24 90,-30 84,-36 78,-36"/>
<text text-anchor="middle" x="48" y="-14.3" font-family="Times,serif" font-size="14.00">VipsForeign</text>
<path fill="none" stroke="black" d="M97.75,-36C97.75,-36 20.25,-36 20.25,-36 14.25,-36 8.25,-30 8.25,-24 8.25,-24 8.25,-12 8.25,-12 8.25,-6 14.25,0 20.25,0 20.25,0 97.75,0 97.75,0 103.75,0 109.75,-6 109.75,-12 109.75,-12 109.75,-24 109.75,-24 109.75,-30 103.75,-36 97.75,-36"/>
<text text-anchor="middle" x="59" y="-13.32" font-family="Times,serif" font-size="14.00">VipsForeign</text>
</a>
</g>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node link">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:href="class.Operation.html" xlink:title="VipsOperation">
<path fill="none" stroke="black" d="M84,-108C84,-108 12,-108 12,-108 6,-108 0,-102 0,-96 0,-96 0,-84 0,-84 0,-78 6,-72 12,-72 12,-72 84,-72 84,-72 90,-72 96,-78 96,-84 96,-84 96,-96 96,-96 96,-102 90,-108 84,-108"/>
<text text-anchor="middle" x="48" y="-86.3" font-family="Times,serif" font-size="14.00">VipsOperation</text>
<path fill="none" stroke="black" d="M106,-108C106,-108 12,-108 12,-108 6,-108 0,-102 0,-96 0,-96 0,-84 0,-84 0,-78 6,-72 12,-72 12,-72 106,-72 106,-72 112,-72 118,-78 118,-84 118,-84 118,-96 118,-96 118,-102 112,-108 106,-108"/>
<text text-anchor="middle" x="59" y="-85.33" font-family="Times,serif" font-size="14.00">VipsOperation</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge3" class="edge">
<title>ancestor_0&#45;&#45;this</title>
<path fill="none" stroke="black" d="M48,-71.7C48,-60.85 48,-46.92 48,-36.1"/>
<path fill="none" stroke="black" d="M59,-71.7C59,-60.85 59,-46.92 59,-36.1"/>
</g>
<!-- ancestor_1 -->
<g id="node3" class="node link">
<title>ancestor_1</title>
<g id="a_node3"><a xlink:href="class.Object.html" xlink:title="VipsObject">
<path fill="none" stroke="black" d="M75,-180C75,-180 21,-180 21,-180 15,-180 9,-174 9,-168 9,-168 9,-156 9,-156 9,-150 15,-144 21,-144 21,-144 75,-144 75,-144 81,-144 87,-150 87,-156 87,-156 87,-168 87,-168 87,-174 81,-180 75,-180"/>
<text text-anchor="middle" x="48" y="-158.3" font-family="Times,serif" font-size="14.00">VipsObject</text>
<path fill="none" stroke="black" d="M93.62,-180C93.62,-180 24.38,-180 24.38,-180 18.38,-180 12.38,-174 12.38,-168 12.38,-168 12.38,-156 12.38,-156 12.38,-150 18.38,-144 24.38,-144 24.38,-144 93.62,-144 93.62,-144 99.62,-144 105.62,-150 105.62,-156 105.62,-156 105.62,-168 105.62,-168 105.62,-174 99.62,-180 93.62,-180"/>
<text text-anchor="middle" x="59" y="-157.32" font-family="Times,serif" font-size="14.00">VipsObject</text>
</a>
</g>
</g>
<!-- ancestor_1&#45;&#45;ancestor_0 -->
<g id="edge2" class="edge">
<title>ancestor_1&#45;&#45;ancestor_0</title>
<path fill="none" stroke="black" d="M48,-143.7C48,-132.85 48,-118.92 48,-108.1"/>
<path fill="none" stroke="black" d="M59,-143.7C59,-132.85 59,-118.92 59,-108.1"/>
</g>
<!-- ancestor_2 -->
<g id="node4" class="node">
<title>ancestor_2</title>
<g id="a_node4"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M67,-252C67,-252 29,-252 29,-252 23,-252 17,-246 17,-240 17,-240 17,-228 17,-228 17,-222 23,-216 29,-216 29,-216 67,-216 67,-216 73,-216 79,-222 79,-228 79,-228 79,-240 79,-240 79,-246 73,-252 67,-252"/>
<text text-anchor="middle" x="48" y="-230.3" font-family="Times,serif" font-size="14.00">GObject</text>
<path fill="none" stroke="black" d="M83.88,-252C83.88,-252 34.12,-252 34.12,-252 28.12,-252 22.12,-246 22.12,-240 22.12,-240 22.12,-228 22.12,-228 22.12,-222 28.12,-216 34.12,-216 34.12,-216 83.88,-216 83.88,-216 89.88,-216 95.88,-222 95.88,-228 95.88,-228 95.88,-240 95.88,-240 95.88,-246 89.88,-252 83.88,-252"/>
<text text-anchor="middle" x="59" y="-229.32" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_2&#45;&#45;ancestor_1 -->
<g id="edge1" class="edge">
<title>ancestor_2&#45;&#45;ancestor_1</title>
<path fill="none" stroke="black" d="M48,-215.7C48,-204.85 48,-190.92 48,-180.1"/>
<path fill="none" stroke="black" d="M59,-215.7C59,-204.85 59,-190.92 59,-180.1"/>
</g>
</g>
</svg>< E29B /td>
Expand Down Expand Up @@ -455,7 +455,7 @@ <h6><a href="type_func.Foreign.is_a_source.html">vips_foreign_is_a_source</a></h
<div class="">
<h6><a href="type_func.Foreign.map.html">vips_foreign_map</a></h6>
<div class="docblock">
<p>Apply a function to every <code>VipsForeign</code>Class that <span class="caps">VIPS</span> knows about. Foreigns
<p>Apply a function to every <code>VipsForeign</code> that <span class="caps">VIPS</span> knows about. Foreigns
are presented to the function in priority&nbsp;order.</p>
</div>
<div class="docblock">
Expand Down
34 changes: 17 additions & 17 deletions API/8.17/class.ForeignLoad.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,77 +300,77 @@ <h4 id="hierarchy">
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for Vips.ForeignLoad">
<!-- Generated by graphviz version 2.42.4 (0)
<!-- Generated by graphviz version 12.2.1 (20241206.2353)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="120pt" height="332pt"
viewBox="0.00 0.00 120.00 332.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<svg width="144pt" height="332pt"
viewBox="0.00 0.00 144.00 332.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 328)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="VipsForeignLoad">
<path fill="none" stroke="black" d="M100,-36C100,-36 12,-36 12,-36 6,-36 0,-30 0,-24 0,-24 0,-12 0,-12 0,-6 6,0 12,0 12,0 100,0 100,0 106,0 112,-6 112,-12 112,-12 112,-24 112,-24 112,-30 106,-36 100,-36"/>
<text text-anchor="middle" x="56" y="-14.3" font-family="Times,serif" font-size="14.00">VipsForeignLoad</text>
<path fill="none" stroke="black" d="M124,-36C124,-36 12,-36 12,-36 6,-36 0,-30 0,-24 0,-24 0,-12 0,-12 0,-6 6,0 12,0 12,0 124,0 124,0 130,0 136,-6 136,-12 136,-12 136,-24 136,-24 136,-30 130,-36 124,-36"/>
<text text-anchor="middle" x="68" y="-13.32" font-family="Times,serif" font-size="14.00">VipsForeignLoad</text>
</a>
</g>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node link">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:href="class.Foreign.html" xlink:title="VipsForeign">
<path fill="none" stroke="black" d="M86,-108C86,-108 26,-108 26,-108 20,-108 14,-102 14,-96 14,-96 14,-84 14,-84 14,-78 20,-72 26,-72 26,-72 86,-72 86,-72 92,-72 98,-78 98,-84 98,-84 98,-96 98,-96 98,-102 92,-108 86,-108"/>
<text text-anchor="middle" x="56" y="-86.3" font-family="Times,serif" font-size="14.00">VipsForeign</text>
<path fill="none" stroke="black" d="M106.75,-108C106.75,-108 29.25,-108 29.25,-108 23.25,-108 17.25,-102 17.25,-96 17.25,-96 17.25,-84 17.25,-84 17.25,-78 23.25,-72 29.25,-72 29.25,-72 106.75,-72 106.75,-72 112.75,-72 118.75,-78 118.75,-84 118.75,-84 118.75,-96 118.75,-96 118.75,-102 112.75,-108 106.75,-108"/>
<text text-anchor="middle" x="68" y="-85.33" font-family="Times,serif" font-size="14.00">VipsForeign</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge4" class="edge">
<title>ancestor_0&#45;&#45;this</title>
<path fill="none" stroke="black" d="M56,-71.7C56,-60.85 56,-46.92 56,-36.1"/>
<path fill="none" stroke="black" d="M68,-71.7C68,-60.85 68,-46.92 68,-36.1"/>
</g>
<!-- ancestor_1 -->
<g id="node3" class="node link">
<title>ancestor_1</title>
<g id="a_node3"><a xlink:href="class.Operation.html" xlink:title="VipsOperation">
<path fill="none" stroke="black" d="M92,-180C92,-180 20,-180 20,-180 14,-180 8,-174 8,-168 8,-168 8,-156 8,-156 8,-150 14,-144 20,-144 20,-144 92,-144 92,-144 98,-144 104,-150 104,-156 104,-156 104,-168 104,-168 104,-174 98,-180 92,-180"/>
<text text-anchor="middle" x="56" y="-158.3" font-family="Times,serif" font-size="14.00">VipsOperation</text>
<path fill="none" stroke="black" d="M115,-180C115,-180 21,-180 21,-180 15,-180 9,-174 9,-168 9,-168 9,-156 9,-156 9,-150 15,-144 21,-144 21,-144 115,-144 115,-144 121,-144 127,-150 127,-156 127,-156 127,-168 127,-168 127,-174 121,-180 115,-180"/>
<text text-anchor="middle" x="68" y="-157.32" font-family="Times,serif" font-size="14.00">VipsOperation</text>
</a>
</g>
</g>
<!-- ancestor_1&#45;&#45;ancestor_0 -->
<g id="edge3" class="edge">
<title>ancestor_1&#45;&#45;ancestor_0</title>
<path fill="none" stroke="black" d="M56,-143.7C56,-132.85 56,-118.92 56,-108.1"/>
<path fill="none" stroke="black" d="M68,-143.7C68,-132.85 68,-118.92 68,-108.1"/>
</g>
<!-- ancestor_2 -->
<g id="node4" class="node link">
<title>ancestor_2</title>
<g id="a_node4"><a xlink:href="class.Object.html" xlink:title="VipsObject">
<path fill="none" stroke="black" d="M83,-252C83,-252 29,-252 29,-252 23,-252 17,-246 17,-240 17,-240 17,-228 17,-228 17,-222 23,-216 29,-216 29,-216 83,-216 83,-216 89,-216 95,-222 95,-228 95,-228 95,-240 95,-240 95,-246 89,-252 83,-252"/>
<text text-anchor="middle" x="56" y="-230.3" font-family="Times,serif" font-size="14.00">VipsObject</text>
<path fill="none" stroke="black" d="M102.62,-252C102.62,-252 33.38,-252 33.38,-252 27.38,-252 21.38,-246 21.38,-240 21.38,-240 21.38,-228 21.38,-228 21.38,-222 27.38,-216 33.38,-216 33.38,-216 102.62,-216 102.62,-216 108.62,-216 114.62,-222 114.62,-228 114.62,-228 114.62,-240 114.62,-240 114.62,-246 108.62,-252 102.62,-252"/>
<text text-anchor="middle" x="68" y="-229.32" font-family="Times,serif" font-size="14.00">VipsObject</text>
</a>
</g>
</g>
<!-- ancestor_2&#45;&#45;ancestor_1 -->
<g id="edge2" class="edge">
<title>ancestor_2&#45;&#45;ancestor_1</title>
<path fill="none" stroke="black" d="M56,-215.7C56,-204.85 56,-190.92 56,-180.1"/>
<path fill="none" stroke="black" d="M68,-215.7C68,-204.85 68,-190.92 68,-180.1"/>
</g>
<!-- ancestor_3 -->
<g id="node5" class="node">
<title>ancestor_3</title>
<g id="a_node5"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M75,-324C75,-324 37,-324 37,-324 31,-324 25,-318 25,-312 25,-312 25,-300 25,-300 25,-294 31,-288 37,-288 37,-288 75,-288 75,-288 81,-288 87,-294 87,-300 87,-300 87,-312 87,-312 87,-318 81,-324 75,-324"/>
<text text-anchor="middle" x="56" y="-302.3" font-family="Times,serif" font-size="14.00">GObject</text>
<path fill="none" stroke="black" d="M92.88,-324C92.88,-324 43.12,-324 43.12,-324 37.12,-324 31.12,-318 31.12,-312 31.12,-312 31.12,-300 31.12,-300 31.12,-294 37.12,-288 43.12,-288 43.12,-288 92.88,-288 92.88,-288 98.88,-288 104.88,-294 104.88,-300 104.88,-300 104.88,-312 104.88,-312 104.88,-318 98.88,-324 92.88,-324"/>
<text text-anchor="middle" x="68" y="-301.32" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_3&#45;&#45;ancestor_2 -->
<g id="edge1" class="edge">
<title>ancestor_3&#45;&#45;ancestor_2</title>
<path fill="none" stroke="black" d="M56,-287.7C56,-276.85 56,-262.92 56,-252.1"/>
<path fill="none" stroke="black" d="M68,-287.7C68,-276.85 68,-262.92 68,-252.1"/>
</g>
</g>
</svg>
Expand Down
Loading
0