<!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>Sets the image background color</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.setimageartifact.html">Imagick::setImageArtifact</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.setimagebias.html">Imagick::setImageBias</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.setimagebackgroundcolor" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::setImageBackgroundColor</h1>
<p class="verinfo">(PECL imagick 2.0.0)</p><p class="refpurpose"><span class="refname">Imagick::setImageBackgroundColor</span> — <span class="dc-title">Sets the image background color</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.setimagebackgroundcolor-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>Imagick::setImageBackgroundColor</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$background</code></span>
)</div>
<p class="para rdfs-comment">
Sets the image background color.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.setimagebackgroundcolor-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">background</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.setimagebackgroundcolor-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.setimagebackgroundcolor-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws ImagickException on error.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-imagick.setimagebackgroundcolor-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>2.1.0</td>
<td>
Now allows a string representing the color as the parameter.
Previous versions allow only an ImagickPixel object.
</td>
</tr>
</tbody>
</table>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.setimageartifact.html">Imagick::setImageArtifact</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.setimagebias.html">Imagick::setImageBias</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>
