blob: 3e7a26eebfdc0819a304c6189476c6cdd6fe93dc [file] [log] [blame]
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Magick++: Magick::Pixels Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Magick++
&#160;<span id="projectnumber">7.0.10</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classMagick_1_1Pixels.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="classMagick_1_1Pixels.html#pub-methods">Public Member Functions</a> &#124;
<a href="https://imagemagick.org/api/Magick++/classMagick_1_1Pixels-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Magick::Pixels Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="Pixels_8h_source.html">Pixels.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a80578e4115a89951d0ad1e450e2e7a40"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1Pixels.html#a80578e4115a89951d0ad1e450e2e7a40">Pixels</a> (<a class="el" href="classMagick_1_1Image.html">Magick::Image</a> &amp;image_)</td></tr>
<tr class="separator:a80578e4115a89951d0ad1e450e2e7a40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6ef403ad3cad9416857ba80a464d3fe"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1Pixels.html#af6ef403ad3cad9416857ba80a464d3fe">~Pixels</a> (void)</td></tr>
<tr class="separator:af6ef403ad3cad9416857ba80a464d3fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b3e2b201b7fb669dd03b7db926fc308"><td class="memItemLeft" align="right" valign="top">Quantum *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1Pixels.html#a4b3e2b201b7fb669dd03b7db926fc308">get</a> (const ::ssize_t x_, const ::ssize_t y_, const size_t columns_, const size_t rows_)</td></tr>
<tr class="separator:a4b3e2b201b7fb669dd03b7db926fc308"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca8938cec00ebbe67f719f83e0ec9966"><td class="memItemLeft" align="right" valign="top">const Quantum *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1Pixels.html#aca8938cec00ebbe67f719f83e0ec9966">getConst</a> (const ::ssize_t x_, const ::ssize_t y_, const size_t columns_, const size_t rows_)</td></tr>
<tr class="separator:aca8938cec00ebbe67f719f83e0ec9966"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad50a3a05ee6918ae205856c6ae235c25"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1Pixels.html#ad50a3a05ee6918ae205856c6ae235c25">metacontent</a> (void)</td></tr>
<tr class="separator:ad50a3a05ee6918ae205856c6ae235c25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a281a3132a541cfae7641dfd385a9b70a"><td class="memItemLeft" align="right" valign="top">ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1Pixels.html#a281a3132a541cfae7641dfd385a9b70a">offset</a> (PixelChannel channel) const</td></tr>
<tr class="separator:a281a3132a541cfae7641dfd385a9b70a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7891bb0e43dd1b11a119883533ba7ff"><td class="memItemLeft" align="right" valign="top">Quantum *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1Pixels.html#aa7891bb0e43dd1b11a119883533ba7ff">set</a> (const ::ssize_t x_, const ::ssize_t y_, const size_t columns_, const size_t rows_)</td></tr>
<tr class="separator:aa7891bb0e43dd1b11a119883533ba7ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae289745755c3def39646c5a6bc72945e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1Pixels.html#ae289745755c3def39646c5a6bc72945e">sync</a> (void)</td></tr>
<tr class="separator:ae289745755c3def39646c5a6bc72945e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8fcf4a55dd1f8546e07a17b7469a63d"><td class="memItemLeft" align="right" valign="top">::ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1Pixels.html#ab8fcf4a55dd1f8546e07a17b7469a63d">x</a> (void) const</td></tr>
<tr class="separator:ab8fcf4a55dd1f8546e07a17b7469a63d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc74455cc06e11703404db545dd52ce5"><td class="memItemLeft" align="right" valign="top">::ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1Pixels.html#adc74455cc06e11703404db545dd52ce5">y</a> (void) const</td></tr>
<tr class="separator:adc74455cc06e11703404db545dd52ce5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abaea7110c4c92de4d1c722326c288025"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1Pixels.html#abaea7110c4c92de4d1c722326c288025">columns</a> (void) const</td></tr>
<tr class="separator:abaea7110c4c92de4d1c722326c288025"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa001d18eb51e0179235fbe77cda03f7"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1Pixels.html#aaa001d18eb51e0179235fbe77cda03f7">rows</a> (void) const</td></tr>
<tr class="separator:aaa001d18eb51e0179235fbe77cda03f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="Pixels_8h_source.html#l00018">18</a> of file <a class="el" href="Pixels_8h_source.html">Pixels.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a80578e4115a89951d0ad1e450e2e7a40"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1Pixels.html#a80578e4115a89951d0ad1e450e2e7a40">&#9670;&nbsp;</a></span>Pixels()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Magick::Pixels::Pixels </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classMagick_1_1Image.html">Magick::Image</a> &amp;&#160;</td>
<td class="paramname"><em>image_</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Pixels_8cpp_source.html#l00019">19</a> of file <a class="el" href="Pixels_8cpp_source.html">Pixels.cpp</a>.</p>
<p class="reference">References <a class="el" href="Include_8h_source.html#l01544">GetPPException</a>, <a class="el" href="Image_8cpp_source.html#l05008">Magick::Image::image()</a>, <a class="el" href="Image_8cpp_source.html#l01314">Magick::Image::quiet()</a>, and <a class="el" href="Include_8h_source.html#l01563">ThrowPPException</a>.</p>
</div>
</div>
<a id="af6ef403ad3cad9416857ba80a464d3fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1Pixels.html#af6ef403ad3cad9416857ba80a464d3fe">&#9670;&nbsp;</a></span>~Pixels()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Magick::Pixels::~Pixels </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Pixels_8cpp_source.html#l00031">31</a> of file <a class="el" href="Pixels_8cpp_source.html">Pixels.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abaea7110c4c92de4d1c722326c288025"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1Pixels.html#abaea7110c4c92de4d1c722326c288025">&#9670;&nbsp;</a></span>columns()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t Magick::Pixels::columns </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Pixels_8h_source.html#l00141">141</a> of file <a class="el" href="Pixels_8h_source.html">Pixels.h</a>.</p>
</div>
</div>
<a id="a4b3e2b201b7fb669dd03b7db926fc308"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1Pixels.html#a4b3e2b201b7fb669dd03b7db926fc308">&#9670;&nbsp;</a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Magick::Quantum * Magick::Pixels::get </td>
<td>(</td>
<td class="paramtype">const ::ssize_t&#160;</td>
<td class="paramname"><em>x_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ::ssize_t&#160;</td>
<td class="paramname"><em>y_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t&#160;</td>
<td class="paramname"><em>columns_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t&#160;</td>
<td class="paramname"><em>rows_</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Pixels_8cpp_source.html#l00037">37</a> of file <a class="el" href="Pixels_8cpp_source.html">Pixels.cpp</a>.</p>
<p class="reference">References <a class="el" href="Include_8h_source.html#l01544">GetPPException</a>, and <a class="el" href="Include_8h_source.html#l01563">ThrowPPException</a>.</p>
</div>
</div>
<a id="aca8938cec00ebbe67f719f83e0ec9966"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1Pixels.html#aca8938cec00ebbe67f719f83e0ec9966">&#9670;&nbsp;</a></span>getConst()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const Magick::Quantum * Magick::Pixels::getConst </td>
<td>(</td>
<td class="paramtype">const ::ssize_t&#160;</td>
<td class="paramname"><em>x_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ::ssize_t&#160;</td>
<td class="paramname"><em>y_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t&#160;</td>
<td class="paramname"><em>columns_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t&#160;</td>
<td class="paramname"><em>rows_</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Pixels_8cpp_source.html#l00053">53</a> of file <a class="el" href="Pixels_8cpp_source.html">Pixels.cpp</a>.</p>
<p class="reference">References <a class="el" href="Include_8h_source.html#l01544">GetPPException</a>, and <a class="el" href="Include_8h_source.html#l01563">ThrowPPException</a>.</p>
</div>
</div>
<a id="ad50a3a05ee6918ae205856c6ae235c25"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1Pixels.html#ad50a3a05ee6918ae205856c6ae235c25">&#9670;&nbsp;</a></span>metacontent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * Magick::Pixels::metacontent </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Pixels_8cpp_source.html#l00100">100</a> of file <a class="el" href="Pixels_8cpp_source.html">Pixels.cpp</a>.</p>
</div>
</div>
<a id="a281a3132a541cfae7641dfd385a9b70a"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1Pixels.html#a281a3132a541cfae7641dfd385a9b70a">&#9670;&nbsp;</a></span>offset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t Magick::Pixels::offset </td>
<td>(</td>
<td class="paramtype">PixelChannel&#160;</td>
<td class="paramname"><em>channel</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Pixels_8cpp_source.html#l00069">69</a> of file <a class="el" href="Pixels_8cpp_source.html">Pixels.cpp</a>.</p>
</div>
</div>
<a id="aaa001d18eb51e0179235fbe77cda03f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1Pixels.html#aaa001d18eb51e0179235fbe77cda03f7">&#9670;&nbsp;</a></span>rows()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t Magick::Pixels::rows </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Pixels_8h_source.html#l00147">147</a> of file <a class="el" href="Pixels_8h_source.html">Pixels.h</a>.</p>
</div>
</div>
<a id="aa7891bb0e43dd1b11a119883533ba7ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1Pixels.html#aa7891bb0e43dd1b11a119883533ba7ff">&#9670;&nbsp;</a></span>set()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Magick::Quantum * Magick::Pixels::set </td>
<td>(</td>
<td class="paramtype">const ::ssize_t&#160;</td>
<td class="paramname"><em>x_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ::ssize_t&#160;</td>
<td class="paramname"><em>y_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t&#160;</td>
<td class="paramname"><em>columns_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t&#160;</td>
<td class="paramname"><em>rows_</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Pixels_8cpp_source.html#l00076">76</a> of file <a class="el" href="Pixels_8cpp_source.html">Pixels.cpp</a>.</p>
<p class="reference">References <a class="el" href="Include_8h_source.html#l01544">GetPPException</a>, and <a class="el" href="Include_8h_source.html#l01563">ThrowPPException</a>.</p>
</div>
</div>
<a id="ae289745755c3def39646c5a6bc72945e"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1Pixels.html#ae289745755c3def39646c5a6bc72945e">&#9670;&nbsp;</a></span>sync()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Magick::Pixels::sync </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Pixels_8cpp_source.html#l00092">92</a> of file <a class="el" href="Pixels_8cpp_source.html">Pixels.cpp</a>.</p>
<p class="reference">References <a class="el" href="Include_8h_source.html#l01544">GetPPException</a>, and <a class="el" href="Include_8h_source.html#l01563">ThrowPPException</a>.</p>
</div>
</div>
<a id="ab8fcf4a55dd1f8546e07a17b7469a63d"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1Pixels.html#ab8fcf4a55dd1f8546e07a17b7469a63d">&#9670;&nbsp;</a></span>x()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ssize_t Magick::Pixels::x </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Pixels_8h_source.html#l00129">129</a> of file <a class="el" href="Pixels_8h_source.html">Pixels.h</a>.</p>
</div>
</div>
<a id="adc74455cc06e11703404db545dd52ce5"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1Pixels.html#adc74455cc06e11703404db545dd52ce5">&#9670;&nbsp;</a></span>y()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ssize_t Magick::Pixels::y </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Pixels_8h_source.html#l00135">135</a> of file <a class="el" href="Pixels_8h_source.html">Pixels.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Pixels_8h_source.html">Pixels.h</a></li>
<li><a class="el" href="Pixels_8cpp_source.html">Pixels.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceMagick.html">Magick</a></li><li class="navelem"><a class="el" href="classMagick_1_1Pixels.html">Pixels</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>