summaryrefslogtreecommitdiff
path: root/www/api/operator.html
diff options
context:
space:
mode:
Diffstat (limited to 'www/api/operator.html')
-rw-r--r--www/api/operator.html108
1 files changed, 60 insertions, 48 deletions
diff --git a/www/api/operator.html b/www/api/operator.html
index 3ef465a..5dc8e61 100644
--- a/www/api/operator.html
+++ b/www/api/operator.html
@@ -1,12 +1,14 @@
-<?xml version="1.0" encoding="utf-8" ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<!DOCTYPE html>
+<html lang="en">
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.16: http://docutils.sourceforge.net/" />
-<title>operator</title>
-<link rel="stylesheet" href="../docutils-api.css" type="text/css" />
+ <meta charset="utf-8">
+ <meta content="en" name="language">
+ <title>operator</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <link media="screen" href="../docutils-api.css" type="text/css" rel="stylesheet">
+
</head>
+
<body>
<div class="banner">
@@ -19,6 +21,7 @@
</form>
</div>
+
<div class="navmenu">
<ul>
<li><a href="../index.html">Home</a></li>
@@ -32,25 +35,23 @@
<li><a href="../reference.html">Reference</a></li>
</ul>
</div>
+
<div class="document" id="operator">
<h1 class="title">operator</h1>
-<h2 class="subtitle" id="methods-to-apply-mathematic-or-boolean-operators-to-pixels">Methods to apply mathematic or boolean operators to pixels.</h2>
-
+<p class="subtitle" id="methods-to-apply-mathematic-or-boolean-operators-to-pixels">Methods to apply mathematic or boolean operators to pixels.</p>
<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
-<li><a class="reference internal" href="#quantumoperatorimage" id="id3">QuantumOperatorImage</a></li>
-<li><a class="reference internal" href="#quantumoperatorregionimage" id="id4">QuantumOperatorRegionImage</a></li>
+<li><p><a class="reference internal" href="#quantumoperatorimage" id="id3">QuantumOperatorImage</a></p></li>
+<li><p><a class="reference internal" href="#quantumoperatorregionimage" id="id4">QuantumOperatorRegionImage</a></p></li>
</ul>
</div>
<div class="section" id="quantumoperatorimage">
<h1><a class="toc-backref" href="#id3">QuantumOperatorImage</a></h1>
<div class="section" id="synopsis">
<h2>Synopsis</h2>
-<pre class="literal-block">
-MagickPassFail QuantumOperatorImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel,
- QuantumOperator operator, double rvalue );
-</pre>
+<pre class="literal-block">MagickPassFail QuantumOperatorImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel,
+ QuantumOperator operator, double rvalue );</pre>
</div>
<div class="section" id="description">
<h2>Description</h2>
@@ -62,22 +63,22 @@ color channels as a grayscale intensity.</p>
<p>These operations are on the DirectClass pixels of the image and do not
update pixel indexes or colormap.</p>
<p>The format of the QuantumOperatorImage method is:</p>
-<pre class="literal-block">
-MagickPassFail QuantumOperatorImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel,
- QuantumOperator operator, double rvalue );
-</pre>
-<dl class="docutils">
+<pre class="literal-block">MagickPassFail QuantumOperatorImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel,
+ QuantumOperator operator, double rvalue );</pre>
+<dl class="simple">
<dt>image:</dt>
-<dd>The image.</dd>
+<dd><p>The image.</p>
+</dd>
<dt>channel:</dt>
-<dd>Channel to operate on (RedChannel, CyanChannel,
+<dd><p>Channel to operate on (RedChannel, CyanChannel,
GreenChannel, MagentaChannel, BlueChannel, YellowChannel,
OpacityChannel, BlackChannel, MatteChannel, AllChannels,
GrayChannel). The AllChannels type only updates color
channels. The GrayChannel type treats the color channels
-as if they represent an intensity.</dd>
+as if they represent an intensity.</p>
+</dd>
<dt>quantum_operator:</dt>
-<dd>Operator to use (AddQuantumOp, AndQuantumOp,
+<dd><p>Operator to use (AddQuantumOp, AndQuantumOp,
AssignQuantumOp, DepthQuantumOp, DivideQuantumOp, GammaQuantumOp,
LShiftQuantumOp, MultiplyQuantumOp, NegateQuantumOp,
NoiseGaussianQuantumOp, NoiseImpulseQuantumOp,
@@ -86,11 +87,14 @@ NoisePoissonQuantumOp, NoiseRandomQuantumOp, NoiseUniformQuantumOp,
OrQuantumOp, RShiftQuantumOp, SubtractQuantumOp,
ThresholdBlackQuantumOp, ThresholdQuantumOp, ThresholdWhiteQuantumOp,
ThresholdBlackNegateQuantumOp, ThresholdWhiteNegateQuantumOp,
-XorQuantumOp).</dd>
+XorQuantumOp).</p>
+</dd>
<dt>rvalue:</dt>
-<dd>Operator argument.</dd>
+<dd><p>Operator argument.</p>
+</dd>
<dt>exception:</dt>
-<dd>Updated with error description.</dd>
+<dd><p>Updated with error description.</p>
+</dd>
</dl>
</div>
</div>
@@ -98,12 +102,10 @@ XorQuantumOp).</dd>
<h1><a class="toc-backref" href="#id4">QuantumOperatorRegionImage</a></h1>
<div class="section" id="id1">
<h2>Synopsis</h2>
-<pre class="literal-block">
-MagickPassFail QuantumOperatorRegionImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, long x, long y,
+<pre class="literal-block">MagickPassFail QuantumOperatorRegionImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, long x, long y,
unsigned long columns, unsigned long rows,
<a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel,
- QuantumOperator quantum_operator, double rvalue );
-</pre>
+ QuantumOperator quantum_operator, double rvalue );</pre>
</div>
<div class="section" id="id2">
<h2>Description</h2>
@@ -115,32 +117,36 @@ treats the color channels as a grayscale intensity.</p>
<p>These operations are on the DirectClass pixels of the image and do not
update pixel indexes or colormap.</p>
<p>The format of the QuantumOperatorRegionImage method is:</p>
-<pre class="literal-block">
-MagickPassFail QuantumOperatorRegionImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, long x, long y,
+<pre class="literal-block">MagickPassFail QuantumOperatorRegionImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, long x, long y,
unsigned long columns, unsigned long rows,
<a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel,
- QuantumOperator quantum_operator, double rvalue );
-</pre>
-<dl class="docutils">
+ QuantumOperator quantum_operator, double rvalue );</pre>
+<dl class="simple">
<dt>image:</dt>
-<dd>The image.</dd>
+<dd><p>The image.</p>
+</dd>
<dt>channel:</dt>
-<dd>Channel to operate on (RedChannel, CyanChannel,
+<dd><p>Channel to operate on (RedChannel, CyanChannel,
GreenChannel, MagentaChannel, BlueChannel, YellowChannel,
OpacityChannel, BlackChannel, MatteChannel, AllChannels,
GrayChannel). The AllChannels type only updates color
channels. The GrayChannel type treats the color channels
-as if they represent an intensity.</dd>
+as if they represent an intensity.</p>
+</dd>
<dt>x:</dt>
-<dd>Ordinate of left row of region.</dd>
+<dd><p>Ordinate of left row of region.</p>
+</dd>
<dt>y:</dt>
-<dd>Orginate of top column of region.</dd>
+<dd><p>Orginate of top column of region.</p>
+</dd>
<dt>columns:</dt>
-<dd>Width of region.</dd>
+<dd><p>Width of region.</p>
+</dd>
<dt>rows:</dt>
-<dd>Height of region.</dd>
+<dd><p>Height of region.</p>
+</dd>
<dt>quantum_operator:</dt>
-<dd>Operator to use (AddQuantumOp,AndQuantumOp,
+<dd><p>Operator to use (AddQuantumOp,AndQuantumOp,
AssignQuantumOp, DepthQuantumOp, DivideQuantumOp, GammaQuantumOp,
LShiftQuantumOp, MultiplyQuantumOp, NegateQuantumOp,
NoiseGaussianQuantumOp, NoiseImpulseQuantumOp,
@@ -148,19 +154,25 @@ NoiseLaplacianQuantumOp, NoiseMultiplicativeQuantumOp,
NoisePoissonQuantumOp, NoiseRandomQuantumOp, NoiseUniformQuantumOp,
OrQuantumOp, RShiftQuantumOp, SubtractQuantumOp,
ThresholdBlackQuantumOp, ThresholdQuantumOp, ThresholdWhiteQuantumOp,
-XorQuantumOp).</dd>
+XorQuantumOp).</p>
+</dd>
<dt>rvalue:</dt>
-<dd>Operator argument.</dd>
+<dd><p>Operator argument.</p>
+</dd>
<dt>exception:</dt>
-<dd>Updated with error description.</dd>
+<dd><p>Updated with error description.</p>
+</dd>
</dl>
</div>
</div>
</div>
+
<hr class="docutils">
<div class="document">
- <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2022<!--SPONSOR_LOGO--></p>
+ <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2023<!--SPONSOR_LOGO--></p>
+</div>
+
</div>
</body>
</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-22 03:48:53 +0000