<!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>Get the image format</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="cairoimagesurface.getdata.html">CairoImageSurface::getData</a></div> <div class="next" style="text-align: right; float: right;"><a href="cairoimagesurface.getheight.html">CairoImageSurface::getHeight</a></div> <div class="up"><a href="class.cairoimagesurface.html">CairoImageSurface</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="cairoimagesurface.getformat" class="refentry"> <div class="refnamediv"> <h1 class="refname">CairoImageSurface::getFormat</h1> <p class="verinfo">(PECL cairo >= 0.1.0)</p><p class="refpurpose"><span class="refname">CairoImageSurface::getFormat</span> — <span class="dc-title">Get the image format</span></p> </div> <div class="refsect1 description" id="refsect1-cairoimagesurface.getformat-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><strong>CairoImageSurface::getFormat</strong></span> ( <span class="methodparam">void</span> )</div> <p class="para rdfs-comment"> Retrieves the image format, as one of the <a href="class.cairoformat.html" class="classname">CairoFormat</a> defined </p> </div> <div class="refsect1 parameters" id="refsect1-cairoimagesurface.getformat-parameters"> <h3 class="title">Parameters</h3> <p class="para">This function has no parameters.</p> </div> <div class="refsect1 returnvalues" id="refsect1-cairoimagesurface.getformat-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> One of the <a href="class.cairoformat.html" class="classname">CairoFormat</a> enums </p> </div> <div class="refsect1 examples" id="refsect1-cairoimagesurface.getformat-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-3622"> <p><strong>Example #1 <span class="methodname"><strong>CairoImageSurface::getFormat()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br />$surface </span><span style="color: #007700">= new </span><span style="color: #0000BB">CairoImageSurface</span><span style="color: #007700">(</span><span style="color: #0000BB">CairoFormat</span><span style="color: #007700">::</span><span style="color: #0000BB">ARGB32</span><span style="color: #007700">, </span><span style="color: #0000BB">50</span><span style="color: #007700">, </span><span style="color: #0000BB">50</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$surface</span><span style="color: #007700">-></span><span style="color: #0000BB">getFormat</span><span style="color: #007700">()); </span><span style="color: #FF8000">// 0<br /><br /></span><span style="color: #0000BB">$surface2 </span><span style="color: #007700">= new </span><span style="color: #0000BB">CairoImageSurface</span><span style="color: #007700">(</span><span style="color: #0000BB">CairoFormat</span><span style="color: #007700">::</span><span style="color: #0000BB">A8</span><span style="color: #007700">, </span><span style="color: #0000BB">50</span><span style="color: #007700">, </span><span style="color: #0000BB">50</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$surface2</span><span style="color: #007700">-></span><span style="color: #0000BB">getFormat</span><span style="color: #007700">()); </span><span style="color: #FF8000">// 2<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="example-contents screen"> <div class="cdata"><pre> int(0) int(2) </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-cairoimagesurface.getformat-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><span class="methodname"><a href="cairoimagesurface.getheight.html" class="methodname" rel="rdfs-seeAlso">CairoImageSurface::getHeight()</a> - Retrieves the height of the CairoImageSurface</span></li> <li class="member"><span class="methodname"><a href="cairoimagesurface.getwidth.html" class="methodname" rel="rdfs-seeAlso">CairoImageSurface::getWidth()</a> - Retrieves the width of the CairoImageSurface</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="cairoimagesurface.getdata.html">CairoImageSurface::getData</a></div> <div class="next" style="text-align: right; float: right;"><a href="cairoimagesurface.getheight.html">CairoImageSurface::getHeight</a></div> <div class="up"><a href="class.cairoimagesurface.html">CairoImageSurface</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>