diff options
Diffstat (limited to 'libs/cairo-1.16.0/doc/public/html/cairo-Quartz-Surfaces.html')
| -rw-r--r-- | libs/cairo-1.16.0/doc/public/html/cairo-Quartz-Surfaces.html | 249 |
1 files changed, 249 insertions, 0 deletions
diff --git a/libs/cairo-1.16.0/doc/public/html/cairo-Quartz-Surfaces.html b/libs/cairo-1.16.0/doc/public/html/cairo-Quartz-Surfaces.html new file mode 100644 index 0000000..a1bc7e4 --- /dev/null +++ b/libs/cairo-1.16.0/doc/public/html/cairo-Quartz-Surfaces.html @@ -0,0 +1,249 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Quartz Surfaces: Cairo: A Vector Graphics Library</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="Cairo: A Vector Graphics Library"> +<link rel="up" href="cairo-surfaces.html" title="Surfaces"> +<link rel="prev" href="cairo-SVG-Surfaces.html" title="SVG Surfaces"> +<link rel="next" href="cairo-XCB-Surfaces.html" title="XCB Surfaces"> +<meta name="generator" content="GTK-Doc V1.27 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#cairo-Quartz-Surfaces.description" class="shortcut">Description</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="cairo-surfaces.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="cairo-SVG-Surfaces.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="cairo-XCB-Surfaces.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="cairo-Quartz-Surfaces"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="cairo-Quartz-Surfaces.top_of_page"></a>Quartz Surfaces</span></h2> +<p>Quartz Surfaces — Rendering to Quartz surfaces</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="cairo-Quartz-Surfaces.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> * +</td> +<td class="function_name"> +<a class="link" href="cairo-Quartz-Surfaces.html#cairo-quartz-surface-create" title="cairo_quartz_surface_create ()">cairo_quartz_surface_create</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> * +</td> +<td class="function_name"> +<a class="link" href="cairo-Quartz-Surfaces.html#cairo-quartz-surface-create-for-cg-context" title="cairo_quartz_surface_create_for_cg_context ()">cairo_quartz_surface_create_for_cg_context</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">CGContextRef</span> +</td> +<td class="function_name"> +<a class="link" href="cairo-Quartz-Surfaces.html#cairo-quartz-surface-get-cg-context" title="cairo_quartz_surface_get_cg_context ()">cairo_quartz_surface_get_cg_context</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="cairo-Quartz-Surfaces.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody><tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="cairo-Quartz-Surfaces.html#CAIRO-HAS-QUARTZ-SURFACE:CAPS" title="CAIRO_HAS_QUARTZ_SURFACE">CAIRO_HAS_QUARTZ_SURFACE</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="cairo-Quartz-Surfaces.description"></a><h2>Description</h2> +<p>The Quartz surface is used to render cairo graphics targeting the +Apple OS X Quartz rendering system.</p> +</div> +<div class="refsect1"> +<a name="cairo-Quartz-Surfaces.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="cairo-quartz-surface-create"></a><h3>cairo_quartz_surface_create ()</h3> +<pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> * +cairo_quartz_surface_create (<em class="parameter"><code><a class="link" href="cairo-Image-Surfaces.html#cairo-format-t" title="enum cairo_format_t"><span class="type">cairo_format_t</span></a> format</code></em>, + <em class="parameter"><code>unsigned <span class="type">int</span> width</code></em>, + <em class="parameter"><code>unsigned <span class="type">int</span> height</code></em>);</pre> +<p>Creates a Quartz surface backed by a CGBitmap. The surface is +created using the Device RGB (or Device Gray, for A8) color space. +All Cairo operations, including those that require software +rendering, will succeed on this surface.</p> +<div class="refsect3"> +<a name="cairo-quartz-surface-create.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>format</p></td> +<td class="parameter_description"><p>format of pixels in the surface to create</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>width</p></td> +<td class="parameter_description"><p>width of the surface, in pixels</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>height</p></td> +<td class="parameter_description"><p>height of the surface, in pixels</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="cairo-quartz-surface-create.returns"></a><h4>Returns</h4> +<p> the newly created surface.</p> +</div> +<p class="since">Since: 1.6</p> +</div> +<hr> +<div class="refsect2"> +<a name="cairo-quartz-surface-create-for-cg-context"></a><h3>cairo_quartz_surface_create_for_cg_context ()</h3> +<pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> * +cairo_quartz_surface_create_for_cg_context + (<em class="parameter"><code><span class="type">CGContextRef</span> cgContext</code></em>, + <em class="parameter"><code>unsigned <span class="type">int</span> width</code></em>, + <em class="parameter"><code>unsigned <span class="type">int</span> height</code></em>);</pre> +<p>Creates a Quartz surface that wraps the given CGContext. The +CGContext is assumed to be in the standard Cairo coordinate space +(that is, with the origin at the upper left and the Y axis +increasing downward). If the CGContext is in the Quartz coordinate +space (with the origin at the bottom left), then it should be +flipped before this function is called. The flip can be accomplished +using a translate and a scale; for example:</p> +<div class="informalexample"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="function">CGContextTranslateCTM</span> <span class="gtkdoc opt">(</span>cgContext<span class="gtkdoc opt">,</span> <span class="number">0.0</span><span class="gtkdoc opt">,</span> height<span class="gtkdoc opt">);</span> +<span class="function">CGContextScaleCTM</span> <span class="gtkdoc opt">(</span>cgContext<span class="gtkdoc opt">,</span> <span class="number">1.0</span><span class="gtkdoc opt">, -</span><span class="number">1.0</span><span class="gtkdoc opt">);</span></pre></td> + </tr> + </tbody> + </table> +</div> + +<p>All Cairo operations are implemented in terms of Quartz operations, +as long as Quartz-compatible elements are used (such as Quartz fonts).</p> +<div class="refsect3"> +<a name="cairo-quartz-surface-create-for-cg-context.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>cgContext</p></td> +<td class="parameter_description"><p>the existing CGContext for which to create the surface</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>width</p></td> +<td class="parameter_description"><p>width of the surface, in pixels</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>height</p></td> +<td class="parameter_description"><p>height of the surface, in pixels</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="cairo-quartz-surface-create-for-cg-context.returns"></a><h4>Returns</h4> +<p> the newly created Cairo surface.</p> +</div> +<p class="since">Since: 1.6</p> +</div> +<hr> +<div class="refsect2"> +<a name="cairo-quartz-surface-get-cg-context"></a><h3>cairo_quartz_surface_get_cg_context ()</h3> +<pre class="programlisting"><span class="returnvalue">CGContextRef</span> +cairo_quartz_surface_get_cg_context (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre> +<p>Returns the CGContextRef that the given Quartz surface is backed +by.</p> +<p>A call to <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-flush" title="cairo_surface_flush ()"><code class="function">cairo_surface_flush()</code></a> is required before using the +CGContextRef to ensure that all pending drawing operations are +finished and to restore any temporary modification cairo has made +to its state. A call to <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-mark-dirty" title="cairo_surface_mark_dirty ()"><code class="function">cairo_surface_mark_dirty()</code></a> is required +after the state or the content of the CGContextRef has been +modified.</p> +<div class="refsect3"> +<a name="cairo-quartz-surface-get-cg-context.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>surface</p></td> +<td class="parameter_description"><p>the Cairo Quartz surface</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="cairo-quartz-surface-get-cg-context.returns"></a><h4>Returns</h4> +<p> the CGContextRef for the given surface.</p> +</div> +<p class="since">Since: 1.6</p> +</div> +</div> +<div class="refsect1"> +<a name="cairo-Quartz-Surfaces.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="CAIRO-HAS-QUARTZ-SURFACE:CAPS"></a><h3>CAIRO_HAS_QUARTZ_SURFACE</h3> +<pre class="programlisting">#define CAIRO_HAS_QUARTZ_SURFACE 1 +</pre> +<p>Defined if the Quartz surface backend is available. +This macro can be used to conditionally compile backend-specific code.</p> +<p class="since">Since: 1.6</p> +</div> +</div> +<div class="refsect1"> +<a name="cairo-Quartz-Surfaces.see-also"></a><h2>See Also</h2> +<p><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.27</div> +</body> +</html>
\ No newline at end of file |