← Back to branch summary

~ubuntu-branches/ubuntu/trusty/graphicsmagick/trusty-proposed

« back to all changes in this revision

Viewing changes to www/api/composite.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Kobras
  • Date: 2009-05-07 20:09:28 UTC
  • mfrom: (5.1.3 sid)
  • Revision ID: james.westby@ubuntu.com-20090507200928-5rb3jyvrsi9x3zfl
Tags: 1.3.5-5
http://bugs.debian.org/526482
http://bugs.debian.org/523596
* debian/control: Update Conflicts/Replaces of -dev-compat package to
  follow libmagick-dev package split. Closes: #526482
* magick/GraphicsMagick-config.{in,1}: Do not expose compiler options
  used to build the library itself via GraphicsMagick-config. Only
  provide options that are actually useful to depending applications.
  Adjust documentation accordingly. Closes: #523596

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/api/composite.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2
 
<html xmlns="http://www.w3.org/1999/xhtml">
 
1
<?xml version="1.0" encoding="utf-8" ?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
3
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
3
4
<head>
4
 
<title>composite - Merge image pixels using a specified algorithm</title>
5
 
<link rev="made" href="mailto:bfriesen@blade.simplesystems.org" />
 
5
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
6
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
 
7
<title>composite</title>
 
8
<link rel="stylesheet" href="../docutils-api.css" type="text/css" />
6
9
</head>
7
 
 
8
 
<body style="background-color: white">
9
 
 
10
 
<P><a name="__index__"></a></P>
11
 
<!-- INDEX BEGIN -->
12
 
 
13
 
<ul>
14
 
 
15
 
        <li><a href="#name">NAME</a></li>
16
 
        <li><a href="#synopsis">SYNOPSIS</a></li>
17
 
        <li><a href="#function_descriptions">FUNCTION DESCRIPTIONS</a></li>
18
 
        <ul>
19
 
 
20
 
                <li><a href="#compositeimage">CompositeImage</a></li>
21
 
        </ul>
22
 
 
23
 
</ul>
24
 
<!-- INDEX END -->
25
 
 
26
 
<hr />
27
 
<P>
28
 
</P>
29
 
<h1><a name="name">NAME</a></h1>
30
 
<P>composite - Merge image pixels using a specified algorithm</P>
31
 
<P>
32
 
</P>
33
 
<hr />
34
 
<h1><a name="synopsis">SYNOPSIS</a></h1>
35
 
<P>unsigned int  <strong>CompositeImage</strong>( Image *canvas_image, const CompositeOperator compose, const Image *composite_image, const long x_offset, const long y_offset );</P>
36
 
<P>
37
 
</P>
38
 
<hr />
39
 
<h1><a name="function_descriptions">FUNCTION DESCRIPTIONS</a></h1>
40
 
<P>
41
 
</P>
42
 
<h2><a name="compositeimage">CompositeImage</a></h2>
43
 
<blockquote>CompositeImage() returns the second image ( composite_image ) composited onto the first ( canvas_image ) at the specified offsets. </blockquote><P>The format of the CompositeImage method is:</P>
44
 
<blockquote>unsigned int CompositeImage ( <A HREF="types.html#Image">Image</A> *canvas_image, const <A HREF="types.html#CompositeOperator">CompositeOperator</A> compose, const <A HREF="types.html#Image">Image</A> *composite_image, const long x_offset, const long y_offset ); </blockquote><P>A description of each parameter follows:</P>
45
 
<dl>
46
 
<dt><strong><a name="item_o_canvas_image_3a">canvas_image:</a></strong><br />
47
 
</dt>
48
 
<DD>
49
 
The image to be updated.
50
 
</dd>
51
 
<P></P>
52
 
<dt><strong><a name="item_o_compose_3a">compose:</a></strong><br />
53
 
</dt>
54
 
<DD>
55
 
This operator affects how the composite is applied to the image.  The default is Over.  Choose from one of these operators: OverCompositeOp, InCompositeOp, OutCompositeOP, AtopCompositeOP, XorCompositeOP, PlusCompositeOP, MinusCompositeOP, AddCompositeOP, SubtractCompositeOP, DifferenceCompositeOP, BumpmapCompositeOP, CopyCompositeOP, CopyRedCompositeOP, CopyGreenCompositeOP, CopyBlueCompositeOP, CopyOpacityCompositeOP.
56
 
</dd>
57
 
<P></P>
58
 
<dt><strong><a name="item_o_composite_image_3a">composite_image:</a></strong><br />
59
 
</dt>
60
 
<DD>
61
 
The composite image.
62
 
</dd>
63
 
<P></P>
64
 
<dt><strong><a name="item_o_x_offset_3a">x_offset:</a></strong><br />
65
 
</dt>
66
 
<DD>
67
 
The column offset of the composited image.
68
 
</dd>
69
 
<P></P>
70
 
<dt><strong><a name="item_o_y_offset_3a">y_offset:</a></strong><br />
71
 
</dt>
72
 
<DD>
73
 
The row offset of the composited image.
74
 
</dd>
 
10
<body>
 
11
 
 
12
<div class="banner">
 
13
<span>
 
14
<img src="../images/gm-107x76.png" alt="GraphicMagick logo" width="107" height="76" />
 
15
<span class="title">GraphicsMagick</span>
 
16
<form action="http://www.google.com/search">
 
17
    Search&nbsp;site
 
18
        <input type=hidden name="domains" value="www.graphicsmagick.org" />
 
19
        <input type=hidden name="sitesearch" value="www.graphicsmagick.org" />
 
20
    <input type=text name="q" size="25" maxlength="255" />
 
21
    <input type=submit name="sa" value="Search" />
 
22
</form>
 
23
</span>
 
24
</div>
 
25
 
 
26
<div class="navmenu">
 
27
<ul>
 
28
<li><a href="../index.html">Home</a></li>
 
29
<li><a href="../Copyright.html">License</a></li>
 
30
<li><a href="../mission.html">Mission</a></li>
 
31
<li><a href="../download.html">Download</a></li>
 
32
<li><a href="../README.html">Installation</a></li>
 
33
<li><a href="../FAQ.html">FAQ</a></li>
 
34
<li><a href="../NEWS.html">News</a> </li>
 
35
<li><a href="../formats.html">Formats</a></li>
 
36
</ul>
 
37
</div>
 
38
<div class="navmenu">
 
39
<ul>
 
40
<li><a href="../process.html">Process</a></li>
 
41
<li><a href="../contribute.html">Contribute</a></li>
 
42
<li><a href="../CVS.html">CVS</a></li>
 
43
<li><a href="http://sourceforge.net/mail/?group_id=73485" target="top_">Mailing Lists</a></li>
 
44
<li><a href="../Changelog.html">ChangeLog</a></li>
 
45
<li><a href="http://sourceforge.net/projects/graphicsmagick/" target="top_">Report Bugs</a></li>
 
46
<li><a href="../utilities.html">Utilities</a></li>
 
47
<li><a href="../programming.html">Programming</a></li>
 
48
<li><a href="../links.html">Links</a></li>
 
49
</ul>
 
50
</div>
 
51
<div class="document" id="composite">
 
52
<h1 class="title">composite</h1>
 
53
<h2 class="subtitle" id="merge-image-pixels-using-a-specified-algorithm">Merge image pixels using a specified algorithm</h2>
 
54
<div class="contents topic">
 
55
<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
 
56
<ul class="simple">
 
57
<li><a class="reference" href="#compositeimage" id="id1" name="id1">CompositeImage</a></li>
 
58
</ul>
 
59
</div>
 
60
<div class="section">
 
61
<h1><a class="toc-backref" href="#id1" id="compositeimage" name="compositeimage">CompositeImage</a></h1>
 
62
<div class="section">
 
63
<h2><a id="synopsis" name="synopsis">Synopsis</a></h2>
 
64
<pre class="literal-block">
 
65
MagickPassFail CompositeImage( <a class="reference" href="types.html#image">Image</a> *canvas_image, const <a class="reference" href="types.html#compositeoperator">CompositeOperator</a> compose,
 
66
                               const <a class="reference" href="types.html#image">Image</a> *composite_image, const long x_offset,
 
67
                               const long y_offset );
 
68
</pre>
 
69
</div>
 
70
<div class="section">
 
71
<h2><a id="description" name="description">Description</a></h2>
 
72
<p>CompositeImage() composites the second image (composite_image) onto the
 
73
first (canvas_image) at the specified offsets.</p>
 
74
<p>The format of the CompositeImage method is:</p>
 
75
<pre class="literal-block">
 
76
MagickPassFail CompositeImage( <a class="reference" href="types.html#image">Image</a> *canvas_image, const <a class="reference" href="types.html#compositeoperator">CompositeOperator</a> compose,
 
77
                               const <a class="reference" href="types.html#image">Image</a> *composite_image, const long x_offset,
 
78
                               const long y_offset );
 
79
</pre>
 
80
<dl class="docutils">
 
81
<dt>canvas_image:</dt>
 
82
<dd>The image to be updated.</dd>
 
83
<dt>compose:</dt>
 
84
<dd>This operator affects how the composite is applied to
 
85
the image.  Choose from one of these operators: AddCompositeOp,
 
86
AtopCompositeOp, BumpmapCompositeOp, ClearCompositeOp,
 
87
ColorizeCompositeOp, CopyBlackCompositeOp, CopyBlueCompositeOp,
 
88
CopyCompositeOp, CopyCyanCompositeOp,CopyGreenCompositeOp,
 
89
CopyMagentaCompositeOp, CopyOpacityCompositeOp, CopyRedCompositeOp,
 
90
CopyYellowCompositeOp, DarkenCompositeOp, DifferenceCompositeOp,
 
91
DisplaceCompositeOp, DissolveCompositeOp, DivideCompositeOp,
 
92
HueCompositeOp, InCompositeOp, LightenCompositeOp, LuminizeCompositeOp,
 
93
MinusCompositeOp, ModulateCompositeOp, MultiplyCompositeOp,
 
94
NoCompositeOp, OutCompositeOp, OverlayCompositeOp, PlusCompositeOp,
 
95
SaturateCompositeOp, ScreenCompositeOp, SubtractCompositeOp,
 
96
ThresholdCompositeOp, XorCompositeOp.</dd>
 
97
<dt>composite_image:</dt>
 
98
<dd>The composite image.</dd>
 
99
<dt>x_offset:</dt>
 
100
<dd>The column offset of the composited image.</dd>
 
101
<dt>y_offset:</dt>
 
102
<dd>The row offset of the composited image.</dd>
75
103
</dl>
 
104
</div>
 
105
</div>
 
106
</div>
 
107
<div class="footer">
 
108
<hr class="footer" />
 
109
Generated on: 2009-01-13 20:59 UTC.
76
110
 
 
111
</div>
77
112
</body>
78
 
 
79
113
</html>