<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Imports image pixels</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.implodeimage.html">Imagick::implodeImage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.labelimage.html">Imagick::labelImage</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="imagick.importimagepixels" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::importImagePixels</h1>
<p class="verinfo">(No version information available, might only be in SVN)</p><p class="refpurpose"><span class="refname">Imagick::importImagePixels</span> — <span class="dc-title">Imports image pixels</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.importimagepixels-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>Imagick::importImagePixels</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$x</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$y</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$width</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$height</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$map</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$storage</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter">$pixels</code></span>
)</div>
<p class="para rdfs-comment">
Imports pixels from an array into an image. The <em><code class="parameter">map</code></em> is usually
'RGB'. This method imposes the following constraints for the parameters: amount of pixels
in the array must match <em><code class="parameter">width</code></em> x <em><code class="parameter">height</code></em> x length of the map.
This method is available if Imagick has been compiled against ImageMagick version 6.4.5 or newer.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.importimagepixels-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">x</code></em></span>
<dd>
<p class="para">
The image x position
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">y</code></em></span>
<dd>
<p class="para">
The image y position
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">width</code></em></span>
<dd>
<p class="para">
The image width
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">height</code></em></span>
<dd>
<p class="para">
The image height
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">map</code></em></span>
<dd>
<p class="para">
Map of pixel ordering as a string. This can be for example <em>RGB</em>.
The value can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent),
O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">storage</code></em></span>
<dd>
<p class="para">
The pixel storage method.
Refer to this list of <a href="imagick.constants.html#imagick.constants.pixel" class="link">pixel constants</a>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">pixels</code></em></span>
<dd>
<p class="para">
The array of pixels
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.importimagepixels-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 errors" id="refsect1-imagick.importimagepixels-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws ImagickException on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.importimagepixels-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3327">
<p><strong>Example #1 <span class="methodname"><strong>Imagick::importImagePixels()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">/* Generate array of pixels. 2000 pixels per color stripe */<br /></span><span style="color: #0000BB">$count </span><span style="color: #007700">= </span><span style="color: #0000BB">2000 </span><span style="color: #007700">* </span><span style="color: #0000BB">3</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$pixels </span><span style="color: #007700">= <br /> </span><span style="color: #0000BB">array_merge</span><span style="color: #007700">(</span><span style="color: #0000BB">array_pad</span><span style="color: #007700">(array(), </span><span style="color: #0000BB">$count</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">),<br /> </span><span style="color: #0000BB">array_pad</span><span style="color: #007700">(array(), </span><span style="color: #0000BB">$count</span><span style="color: #007700">, </span><span style="color: #0000BB">255</span><span style="color: #007700">), <br /> </span><span style="color: #0000BB">array_pad</span><span style="color: #007700">(array(), </span><span style="color: #0000BB">$count</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">),<br /> </span><span style="color: #0000BB">array_pad</span><span style="color: #007700">(array(), </span><span style="color: #0000BB">$count</span><span style="color: #007700">, </span><span style="color: #0000BB">255</span><span style="color: #007700">),<br /> </span><span style="color: #0000BB">array_pad</span><span style="color: #007700">(array(), </span><span style="color: #0000BB">$count</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">/* Width and height. The area is amount of pixels divided<br /> by three. Three comes from 'RGB', three values per pixel */<br /></span><span style="color: #0000BB">$width </span><span style="color: #007700">= </span><span style="color: #0000BB">$height </span><span style="color: #007700">= </span><span style="color: #0000BB">pow</span><span style="color: #007700">((</span><span style="color: #0000BB">count</span><span style="color: #007700">(</span><span style="color: #0000BB">$pixels</span><span style="color: #007700">) / </span><span style="color: #0000BB">3</span><span style="color: #007700">), </span><span style="color: #0000BB">0.5</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Create empty image */<br /></span><span style="color: #0000BB">$im </span><span style="color: #007700">= new </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$im</span><span style="color: #007700">-></span><span style="color: #0000BB">newImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$width</span><span style="color: #007700">, </span><span style="color: #0000BB">$height</span><span style="color: #007700">, </span><span style="color: #DD0000">'gray'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Import the pixels into image.<br /> width * height * strlen("RGB") must match count($pixels) */<br /></span><span style="color: #0000BB">$im</span><span style="color: #007700">-></span><span style="color: #0000BB">importImagePixels</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">$width</span><span style="color: #007700">, </span><span style="color: #0000BB">$height</span><span style="color: #007700">, </span><span style="color: #DD0000">"RGB"</span><span style="color: #007700">, </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">::</span><span style="color: #0000BB">PIXEL_CHAR</span><span style="color: #007700">, </span><span style="color: #0000BB">$pixels</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* output as jpeg image */<br /></span><span style="color: #0000BB">$im</span><span style="color: #007700">-></span><span style="color: #0000BB">setImageFormat</span><span style="color: #007700">(</span><span style="color: #DD0000">'jpg'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">"Content-Type: image/jpg"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$im</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="mediaobject">
<div class="imageobject">
<img src="images/c0d23d2d6769e53e24a1b3136c064577-importimagepixels.jpg" alt="Output of example : Imagick::importImagePixels()" width="100" height="100" />
</div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.implodeimage.html">Imagick::implodeImage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.labelimage.html">Imagick::labelImage</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
