Add missing Draw#alpha method (#14)

rmagick/rmagick#1456
rmagick · Feb 12, 2024 · 62fa335 · 62fa335
1 parent bffd878
commit 62fa335
Show file tree

Hide file tree

Showing 27 changed files with 110 additions and 65 deletions.
diff --git a/comtasks.html b/comtasks.html
@@ -4,7 +4,7 @@
   <head>
     <meta name="generator" content="HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
 
-    <title>RMagick 5.4.0: Common Tasks</title>
+    <title>RMagick 5.4.2: Common Tasks</title>
     <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
     <meta name="GENERATOR" content="Quanta Plus" />
     <meta name="Copyright" content="Copyright (C) 2006 by Timothy P. Hunter" />
@@ -25,7 +25,7 @@
   </head>
 
   <body>
-    <h6 id="header">RMagick 5.4.0 User's Guide and Reference</h6>
+    <h6 id="header">RMagick 5.4.2 User's Guide and Reference</h6>
 
     <div class="nav">&laquo;&nbsp;<a href="optequiv.html">Prev</a> | <a href="index.html">Contents</a> | <a href="magick.html">Next</a>&nbsp;&raquo;</div>
 

diff --git a/constants.html b/constants.html
@@ -4,7 +4,7 @@
   <head>
     <meta name="generator" content="HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
 
-    <title>RMagick 5.4.0: Constants</title>
+    <title>RMagick 5.4.2: Constants</title>
     <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
     <meta name="GENERATOR" content="Quanta Plus" />
     <meta name="Copyright" content="Copyright (C) 2006 by Timothy P. Hunter" />
@@ -57,7 +57,7 @@
   </head>
 
   <body>
-    <h6 id="header">RMagick 5.4.0 User's Guide and Reference</h6>
+    <h6 id="header">RMagick 5.4.2 User's Guide and Reference</h6>
 
     <div class="nav">&laquo;&nbsp;<a href="info.html">Prev</a> | <a href="index.html">Contents</a> | <a href="rvgtut.html">Next</a>&nbsp;&raquo;</div>
 

diff --git a/draw.html b/draw.html
@@ -4,7 +4,7 @@
   <head>
     <meta name="generator" content="HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
 
-    <title>RMagick 5.4.0: class Draw</title>
+    <title>RMagick 5.4.2: class Draw</title>
     <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
     <meta name="GENERATOR" content="Quanta Plus" />
     <meta name="Copyright" content="Copyright (C) 2006 by Timothy P. Hunter" />
@@ -20,7 +20,7 @@
   </head>
 
   <body>
-    <h6 id="header">RMagick 5.4.0 User's Guide and Reference</h6>
+    <h6 id="header">RMagick 5.4.2 User's Guide and Reference</h6>
 
     <div class="nav">&laquo;&nbsp;<a href="image3.html">Prev</a> | <a href="index.html">Contents</a> | <a href="struct.html">Next</a>&nbsp;&raquo;</div>
 
@@ -75,6 +75,8 @@ <h3>drawing primitive methods</h3>
         <ul>
           <li><a href="#affine">affine</a></li>
 
+          <li><a href="#alpha">alpha</a></li>
+
           <li><a href="#arc">arc</a></li>
 
           <li><a href="#bezier">bezier</a></li>
@@ -898,6 +900,43 @@ <h4>See also</h4>
       <a href="#translate">translate</a>
     </div>
 
+    <div class="sig">
+      <h3 id="alpha">alpha</h3>
+
+      <p><span class="arg">draw</span>.alpha(<span class="arg">x, y, method</span>) -&gt; <em>self</em></p>
+    </div>
+
+    <div class="desc">
+      <h4>Description</h4>
+
+      <p>Set alpha (make transparent) in image according to the specified colorization rule.</p>
+
+      <h4>Arguments</h4>
+
+      <dl>
+        <dt>x, y</dt>
+
+        <dd>The point in the <em>x</em> and <em>y</em> to start filling color</dd>
+
+        <dt>method</dt>
+
+        <dd>
+          A <a href="constants.html#PaintMethod">PaintMethod</a> constant. If you use the <code>FillToBorderMethod</code>, assign the border color with the
+          <code>Draw#border_color=</code> attribute before calling <a href="#draw">draw</a>.
+        </dd>
+      </dl>
+
+      <h4>Returns</h4>
+
+      <p>self</p>
+
+      <h4>Example</h4>
+      <pre>
+  draw.alpha(x, y, FillToBorderMethod)
+</pre
+      >
+    </div>
+
     <div class="sig">
       <h3 id="arc">arc</h3>
 
@@ -1196,10 +1235,18 @@ <h4>Description</h4>
 
       <h4>Arguments</h4>
 
-      <p>
-        A <a href="constants.html#PaintMethod">PaintMethod</a> constant. If you use the <code>FillToBorderMethod</code>, assign the border color with the
-        <code>Draw#border_color=</code> attribute before calling <a href="#draw">draw</a>.
-      </p>
+      <dl>
+        <dt>x, y</dt>
+
+        <dd>The point in the <em>x</em> and <em>y</em> to start filling color</dd>
+
+        <dt>method</dt>
+
+        <dd>
+          A <a href="constants.html#PaintMethod">PaintMethod</a> constant. If you use the <code>FillToBorderMethod</code>, assign the border color with the
+          <code>Draw#border_color=</code> attribute before calling <a href="#draw">draw</a>.
+        </dd>
+      </dl>
 
       <h4>Returns</h4>
 

diff --git a/ilist.html b/ilist.html
@@ -4,7 +4,7 @@
   <head>
     <meta name="generator" content="HTML Tidy for Linux/x86 (vers 6 November 2007), see www.w3.org" />
 
-    <title>RMagick 5.4.0: class ImageList</title>
+    <title>RMagick 5.4.2: class ImageList</title>
     <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
     <meta name="GENERATOR" content="Quanta Plus" />
     <meta name="Copyright" content="Copyright (C) 2005 by Timothy P. Hunter" />
@@ -14,7 +14,7 @@
   </head>
 
   <body>
-    <h6 id="header">RMagick 5.4.0 User's Guide and Reference</h6>
+    <h6 id="header">RMagick 5.4.2 User's Guide and Reference</h6>
 
     <div class="nav">&laquo;&nbsp;<a href="magick.html">Prev</a> | <a href="index.html">Contents</a> | <a href="imageattrs.html">Next</a>&nbsp;&raquo;</div>
 

diff --git a/image1.html b/image1.html
@@ -4,7 +4,7 @@
   <head>
     <meta name="generator" content="HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
 
-    <title>RMagick 5.4.0: class Image (class methods and instance methods a-d)</title>
+    <title>RMagick 5.4.2: class Image (class methods and instance methods a-d)</title>
     <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
     <meta name="GENERATOR" content="Quanta Plus" />
     <meta name="Copyright" content="Copyright (C) 2006 by Timothy P. Hunter" />
@@ -39,7 +39,7 @@
   </head>
 
   <body>
-    <h6 id="header">RMagick 5.4.0 User's Guide and Reference</h6>
+    <h6 id="header">RMagick 5.4.2 User's Guide and Reference</h6>
 
     <div class="nav">&laquo;&nbsp;<a href="imageattrs.html">Prev</a> | <a href="index.html">Contents</a> | <a href="image2.html">Next</a>&nbsp;&raquo;</div>
 

diff --git a/image2.html b/image2.html
@@ -4,7 +4,7 @@
   <head>
     <meta name="generator" content="HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
 
-    <title>RMagick 5.4.0: class Image (instance methods e-o)</title>
+    <title>RMagick 5.4.2: class Image (instance methods e-o)</title>
     <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
     <meta name="GENERATOR" content="Quanta Plus" />
     <meta name="Copyright" content="Copyright (C) 2006 by Timothy P. Hunter" />
@@ -41,7 +41,7 @@
   </head>
 
   <body>
-    <h6 id="header">RMagick 5.4.0 User's Guide and Reference</h6>
+    <h6 id="header">RMagick 5.4.2 User's Guide and Reference</h6>
 
     <div class="nav">&laquo;&nbsp;<a href="image1.html">Prev</a> | <a href="index.html">Contents</a> | <a href="image3.html">Next</a>&nbsp;&raquo;</div>
 

diff --git a/image3.html b/image3.html
@@ -4,7 +4,7 @@
   <head>
     <meta name="generator" content="HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
 
-    <title>RMagick 5.4.0: class Image (instance methods p-w)</title>
+    <title>RMagick 5.4.2: class Image (instance methods p-w)</title>
     <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
     <meta name="GENERATOR" content="Quanta Plus" />
     <meta name="Copyright" content="Copyright (C) 2006 by Timothy P. Hunter" />
@@ -46,7 +46,7 @@
   </head>
 
   <body>
-    <h6 id="header">RMagick 5.4.0 User's Guide and Reference</h6>
+    <h6 id="header">RMagick 5.4.2 User's Guide and Reference</h6>
 
     <div class="nav">&laquo;&nbsp;<a href="image2.html">Prev</a> | <a href="index.html">Contents</a> | <a href="draw.html">Next</a>&nbsp;&raquo;</div>
 

diff --git a/imageattrs.html b/imageattrs.html
@@ -4,7 +4,7 @@
   <head>
     <meta name="generator" content="HTML Tidy for Linux/x86 (vers 6 November 2007), see www.w3.org" />
 
-    <title>RMagick 5.4.0: class Image (attribute methods)</title>
+    <title>RMagick 5.4.2: class Image (attribute methods)</title>
     <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
     <meta name="GENERATOR" content="Quanta Plus" />
     <meta name="Copyright" content="Copyright (C) 2006 by Timothy P. Hunter" />
@@ -20,7 +20,7 @@
   </head>
 
   <body>
-    <h6 id="header">RMagick 5.4.0 User's Guide and Reference</h6>
+    <h6 id="header">RMagick 5.4.2 User's Guide and Reference</h6>
 
     <div class="nav">&laquo;&nbsp;<a href="ilist.html">Prev</a> | <a href="index.html">Contents</a> | <a href="image1.html">Next</a>&nbsp;&raquo;</div>
 
@@ -294,9 +294,7 @@ <h4>Returns</h4>
     <div class="sig">
       <h3 id="bounding_box">bounding_box</h3>
 
-      <p>
-        <span class="arg">img.</span>bounding_box -&gt; <em>rectangle</em><br />
-      </p>
+      <p><span class="arg">img.</span>bounding_box -&gt; <em>rectangle</em><br /></p>
     </div>
 
     <div class="desc">
@@ -1336,7 +1334,8 @@ <h3 id="transparent_color">transparent_color</h3>
 
       <p>
         <span class="arg">img</span>.transparent_color -&gt; <em>string</em><br />
-        <span class="arg">img.</span>transparent_color = <span class="arg">string</span> or <span class="arg">pixel</span> -&gt; <em>string</em> or <em>pixel</em>
+        <span class="arg">img.</span>transparent_color = <span class="arg">string</span> or <span class="arg">pixel</span> -&gt; <em>string</em> or
+        <em>pixel</em>
       </p>
     </div>
 

diff --git a/imusage.html b/imusage.html
@@ -4,7 +4,7 @@
   <head>
     <meta name="generator" content="HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
 
-    <title>RMagick 5.4.0: ImageMagick Conventions</title>
+    <title>RMagick 5.4.2: ImageMagick Conventions</title>
     <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
     <meta name="GENERATOR" content="Quanta Plus" />
     <meta name="Copyright" content="Copyright (C) 2006 by Timothy P. Hunter" />
@@ -64,7 +64,7 @@
   </head>
 
   <body>
-    <h6 id="header">RMagick 5.4.0 User's Guide and Reference</h6>
+    <h6 id="header">RMagick 5.4.2 User's Guide and Reference</h6>
 
     <div class="nav">&laquo;&nbsp;<a href="usage.html">Prev</a> | <a href="index.html">Contents</a> | <a href="optequiv.html">Next</a>&nbsp;&raquo;</div>
 

diff --git a/index.html b/index.html
@@ -4,7 +4,7 @@
   <head>
     <meta name="generator" content="HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
 
-    <title>RMagick 5.4.0 User's Guide and Reference</title>
+    <title>RMagick 5.4.2 User's Guide and Reference</title>
     <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
     <meta name="GENERATOR" content="Quanta Plus" />
     <meta name="Copyright" content="Copyright (C) 2006 by Timothy P. Hunter" />
@@ -102,7 +102,7 @@
 
     <p id="magick">
       Ruby+ImageMagick<span class="tm">TM</span><br />
-      Version 5.4.0
+      Version 5.4.2
     </p>
 
     <h1>User's Guide and Reference</h1>
@@ -277,7 +277,7 @@ <h3>What is RMagick?</h3>
     <h3>About this document</h3>
 
     <p>
-      This document describes Version 5.4.0 of RMagick. It is divided into 4 parts. The first is this page. The second part is a user's guide covering both
+      This document describes Version 5.4.2 of RMagick. It is divided into 4 parts. The first is this page. The second part is a user's guide covering both
       RMagick and ImageMagick usage and conventions. The third part is a reference guide to the ImageList, Image, and Draw classes. This guide includes many
       examples. The fourth part covers Ruby Vector Graphics (RVG). RVG is a facade for Draw that provides a high-level API for scalable vector graphics. The RVG
       section includes a tutorial and complete reference documentation.

diff --git a/info.html b/info.html
@@ -4,7 +4,7 @@
   <head>
     <meta name="generator" content="HTML Tidy for Linux/x86 (vers 6 November 2007), see www.w3.org" />
 
-    <title>RMagick 5.4.0: class Image::Info - Optional method arguments</title>
+    <title>RMagick 5.4.2: class Image::Info - Optional method arguments</title>
     <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
     <meta name="GENERATOR" content="Quanta Plus" />
     <meta name="Copyright" content="Copyright (C) 2006 by Timothy P. Hunter" />
@@ -38,7 +38,7 @@
   </head>
 
   <body>
-    <h6 id="header">RMagick 5.4.0 User's Guide and Reference</h6>
+    <h6 id="header">RMagick 5.4.2 User's Guide and Reference</h6>
 
     <div class="nav">&laquo;&nbsp;<a href="struct.html">Prev</a> | <a href="index.html">Contents</a> | <a href="constants.html">Next</a>&nbsp;&raquo;</div>
 
@@ -1072,14 +1072,13 @@ <h3 id="monochrome">monochrome</h3>
 
     <div class="desc">
       <h4>Description</h4>
-
     </div>
 
     <div class="sig">
       <h3 id="number_scenes">number_scenes</h3>
 
       <p>
-        <span class="arg">self.</span>number_scenes= <span class="arg"><code>integer</code></span></span>
+        <span class="arg">self.</span>number_scenes= <span class="arg"><code>integer</code></span>
       </p>
     </div>
 

diff --git a/magick.html b/magick.html
@@ -4,7 +4,7 @@
   <head>
     <meta name="generator" content="HTML Tidy for Linux/x86 (vers 6 November 2007), see www.w3.org" />
 
-    <title>RMagick 5.4.0: module Magick</title>
+    <title>RMagick 5.4.2: module Magick</title>
     <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
     <meta name="GENERATOR" content="Quanta Plus" />
     <meta name="Copyright" content="Copyright (C) 2006 by Timothy P. Hunter" />
@@ -19,7 +19,7 @@
   </head>
 
   <body>
-    <h6 id="header">RMagick 5.4.0 User's Guide and Reference</h6>
+    <h6 id="header">RMagick 5.4.2 User's Guide and Reference</h6>
 
     <div class="nav">&laquo;&nbsp;<a href="comtasks.html">Prev</a> | <a href="index.html">Contents</a> | <a href="ilist.html">Next</a>&nbsp;&raquo;</div>
 

diff --git a/optequiv.html b/optequiv.html
@@ -4,7 +4,7 @@
   <head>
     <meta name="generator" content="HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
 
-    <title>RMagick 5.4.0: Magick Command Options and Their Equivalent Methods</title>
+    <title>RMagick 5.4.2: Magick Command Options and Their Equivalent Methods</title>
     <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
     <meta name="GENERATOR" content="Quanta Plus" />
     <meta name="Copyright" content="Copyright (C) 2006 by Timothy P. Hunter" />
@@ -63,7 +63,7 @@
   </head>
 
   <body>
-    <h6 id="header">RMagick 5.4.0 User's Guide and Reference</h6>
+    <h6 id="header">RMagick 5.4.2 User's Guide and Reference</h6>
 
     <div class="nav">
       &laquo; <a href="index.html">Prev</a> | <a href="imusage.html">Contents</a> | <a href="comtasks.html">Next</a>

diff --git a/rvg.html b/rvg.html
@@ -4,7 +4,7 @@
   <head>
     <meta name="generator" content="HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
 
-    <title>RMagick 5.4.0: RVG Reference: RVG Class</title>
+    <title>RMagick 5.4.2: RVG Reference: RVG Class</title>
     <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
     <meta name="GENERATOR" content="Quanta Plus" />
     <meta name="Copyright" content="Copyright (C) 2006 by Timothy P. Hunter" />
@@ -22,7 +22,7 @@
   </head>
 
   <body>
-    <h6 id="header">RMagick 5.4.0 User's Guide and Reference</h6>
+    <h6 id="header">RMagick 5.4.2 User's Guide and Reference</h6>
 
     <div class="nav">&laquo;&nbsp;<a href="rvgtut.html">Prev</a> | <a href="index.html">Contents</a> | <a href="rvggroup.html">Next</a>&nbsp;&raquo;</div>
 

diff --git a/rvgclip.html b/rvgclip.html
@@ -4,7 +4,7 @@
   <head>
     <meta name="generator" content="HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
 
-    <title>RMagick 5.4.0: RVG Reference: RVG::ClipPath Class</title>
+    <title>RMagick 5.4.2: RVG Reference: RVG::ClipPath Class</title>
     <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
     <meta name="GENERATOR" content="Quanta Plus" />
     <meta name="Copyright" content="Copyright (C) 2006 by Timothy P. Hunter" />
@@ -22,7 +22,7 @@
   </head>
 
   <body>
-    <h6 id="header">RMagick 5.4.0 User's Guide and Reference</h6>
+    <h6 id="header">RMagick 5.4.2 User's Guide and Reference</h6>
 
     <div class="nav">&laquo;&nbsp;<a href="rvgpattern.html">Prev</a> | <a href="index.html">Contents</a> | <a href="rvgtext.html">Next</a>&nbsp;&raquo;</div>