Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/gtk-doc/html/cairo/cairo-XLib-XRender-Backend.html @ 68:5028fdace37b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 16:23:26 -0400
parents
children
rev   line source
jpayne@68 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
jpayne@68 2 <html>
jpayne@68 3 <head>
jpayne@68 4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
jpayne@68 5 <title>XLib-XRender Backend: Cairo: A Vector Graphics Library</title>
jpayne@68 6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
jpayne@68 7 <link rel="home" href="index.html" title="Cairo: A Vector Graphics Library">
jpayne@68 8 <link rel="up" href="cairo-surfaces.html" title="Surfaces">
jpayne@68 9 <link rel="prev" href="cairo-XLib-Surfaces.html" title="XLib Surfaces">
jpayne@68 10 <link rel="next" href="cairo-Script-Surfaces.html" title="Script Surfaces">
jpayne@68 11 <meta name="generator" content="GTK-Doc V1.27 (XML mode)">
jpayne@68 12 <link rel="stylesheet" href="style.css" type="text/css">
jpayne@68 13 </head>
jpayne@68 14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
jpayne@68 15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
jpayne@68 16 <td width="100%" align="left" class="shortcuts">
jpayne@68 17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
jpayne@68 18 <a href="#cairo-XLib-XRender-Backend.description" class="shortcut">Description</a></span>
jpayne@68 19 </td>
jpayne@68 20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
jpayne@68 21 <td><a accesskey="u" href="cairo-surfaces.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
jpayne@68 22 <td><a accesskey="p" href="cairo-XLib-Surfaces.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
jpayne@68 23 <td><a accesskey="n" href="cairo-Script-Surfaces.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
jpayne@68 24 </tr></table>
jpayne@68 25 <div class="refentry">
jpayne@68 26 <a name="cairo-XLib-XRender-Backend"></a><div class="titlepage"></div>
jpayne@68 27 <div class="refnamediv"><table width="100%"><tr>
jpayne@68 28 <td valign="top">
jpayne@68 29 <h2><span class="refentrytitle"><a name="cairo-XLib-XRender-Backend.top_of_page"></a>XLib-XRender Backend</span></h2>
jpayne@68 30 <p>XLib-XRender Backend — X Window System rendering using XLib and the X Render extension</p>
jpayne@68 31 </td>
jpayne@68 32 <td class="gallery_image" valign="top" align="right"></td>
jpayne@68 33 </tr></table></div>
jpayne@68 34 <div class="refsect1">
jpayne@68 35 <a name="cairo-XLib-XRender-Backend.functions"></a><h2>Functions</h2>
jpayne@68 36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 37 <colgroup>
jpayne@68 38 <col width="150px" class="functions_return">
jpayne@68 39 <col class="functions_name">
jpayne@68 40 </colgroup>
jpayne@68 41 <tbody>
jpayne@68 42 <tr>
jpayne@68 43 <td class="function_type">
jpayne@68 44 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> *
jpayne@68 45 </td>
jpayne@68 46 <td class="function_name">
jpayne@68 47 <a class="link" href="cairo-XLib-XRender-Backend.html#cairo-xlib-surface-create-with-xrender-format" title="cairo_xlib_surface_create_with_xrender_format ()">cairo_xlib_surface_create_with_xrender_format</a> <span class="c_punctuation">()</span>
jpayne@68 48 </td>
jpayne@68 49 </tr>
jpayne@68 50 <tr>
jpayne@68 51 <td class="function_type">
jpayne@68 52 <span class="returnvalue">XRenderPictFormat</span> *
jpayne@68 53 </td>
jpayne@68 54 <td class="function_name">
jpayne@68 55 <a class="link" href="cairo-XLib-XRender-Backend.html#cairo-xlib-surface-get-xrender-format" title="cairo_xlib_surface_get_xrender_format ()">cairo_xlib_surface_get_xrender_format</a> <span class="c_punctuation">()</span>
jpayne@68 56 </td>
jpayne@68 57 </tr>
jpayne@68 58 </tbody>
jpayne@68 59 </table></div>
jpayne@68 60 </div>
jpayne@68 61 <div class="refsect1">
jpayne@68 62 <a name="cairo-XLib-XRender-Backend.other"></a><h2>Types and Values</h2>
jpayne@68 63 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 64 <colgroup>
jpayne@68 65 <col width="150px" class="name">
jpayne@68 66 <col class="description">
jpayne@68 67 </colgroup>
jpayne@68 68 <tbody><tr>
jpayne@68 69 <td class="define_keyword">#define</td>
jpayne@68 70 <td class="function_name"><a class="link" href="cairo-XLib-XRender-Backend.html#CAIRO-HAS-XLIB-XRENDER-SURFACE:CAPS" title="CAIRO_HAS_XLIB_XRENDER_SURFACE">CAIRO_HAS_XLIB_XRENDER_SURFACE</a></td>
jpayne@68 71 </tr></tbody>
jpayne@68 72 </table></div>
jpayne@68 73 </div>
jpayne@68 74 <div class="refsect1">
jpayne@68 75 <a name="cairo-XLib-XRender-Backend.description"></a><h2>Description</h2>
jpayne@68 76 <p>The XLib surface is used to render cairo graphics to X Window System
jpayne@68 77 windows and pixmaps using the XLib and Xrender libraries.</p>
jpayne@68 78 <p>Note that the XLib surface automatically takes advantage of X Render extension
jpayne@68 79 if it is available.</p>
jpayne@68 80 </div>
jpayne@68 81 <div class="refsect1">
jpayne@68 82 <a name="cairo-XLib-XRender-Backend.functions_details"></a><h2>Functions</h2>
jpayne@68 83 <div class="refsect2">
jpayne@68 84 <a name="cairo-xlib-surface-create-with-xrender-format"></a><h3>cairo_xlib_surface_create_with_xrender_format ()</h3>
jpayne@68 85 <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> *
jpayne@68 86 cairo_xlib_surface_create_with_xrender_format
jpayne@68 87 (<em class="parameter"><code><span class="type">Display</span> *dpy</code></em>,
jpayne@68 88 <em class="parameter"><code><span class="type">Drawable</span> drawable</code></em>,
jpayne@68 89 <em class="parameter"><code><span class="type">Screen</span> *screen</code></em>,
jpayne@68 90 <em class="parameter"><code><span class="type">XRenderPictFormat</span> *format</code></em>,
jpayne@68 91 <em class="parameter"><code><span class="type">int</span> width</code></em>,
jpayne@68 92 <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre>
jpayne@68 93 <p>Creates an Xlib surface that draws to the given drawable.
jpayne@68 94 The way that colors are represented in the drawable is specified
jpayne@68 95 by the provided picture format.</p>
jpayne@68 96 <p>Note: If <em class="parameter"><code>drawable</code></em>
jpayne@68 97 is a Window, then the function
jpayne@68 98 <a class="link" href="cairo-XLib-Surfaces.html#cairo-xlib-surface-set-size" title="cairo_xlib_surface_set_size ()"><code class="function">cairo_xlib_surface_set_size()</code></a> must be called whenever the size of the
jpayne@68 99 window changes.</p>
jpayne@68 100 <div class="refsect3">
jpayne@68 101 <a name="cairo-xlib-surface-create-with-xrender-format.parameters"></a><h4>Parameters</h4>
jpayne@68 102 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 103 <colgroup>
jpayne@68 104 <col width="150px" class="parameters_name">
jpayne@68 105 <col class="parameters_description">
jpayne@68 106 <col width="200px" class="parameters_annotations">
jpayne@68 107 </colgroup>
jpayne@68 108 <tbody>
jpayne@68 109 <tr>
jpayne@68 110 <td class="parameter_name"><p>dpy</p></td>
jpayne@68 111 <td class="parameter_description"><p>an X Display</p></td>
jpayne@68 112 <td class="parameter_annotations"> </td>
jpayne@68 113 </tr>
jpayne@68 114 <tr>
jpayne@68 115 <td class="parameter_name"><p>drawable</p></td>
jpayne@68 116 <td class="parameter_description"><p>an X Drawable, (a Pixmap or a Window)</p></td>
jpayne@68 117 <td class="parameter_annotations"> </td>
jpayne@68 118 </tr>
jpayne@68 119 <tr>
jpayne@68 120 <td class="parameter_name"><p>screen</p></td>
jpayne@68 121 <td class="parameter_description"><p>the X Screen associated with <em class="parameter"><code>drawable</code></em>
jpayne@68 122 </p></td>
jpayne@68 123 <td class="parameter_annotations"> </td>
jpayne@68 124 </tr>
jpayne@68 125 <tr>
jpayne@68 126 <td class="parameter_name"><p>format</p></td>
jpayne@68 127 <td class="parameter_description"><p>the picture format to use for drawing to <em class="parameter"><code>drawable</code></em>
jpayne@68 128 . The depth
jpayne@68 129 of <em class="parameter"><code>format</code></em>
jpayne@68 130 must match the depth of the drawable.</p></td>
jpayne@68 131 <td class="parameter_annotations"> </td>
jpayne@68 132 </tr>
jpayne@68 133 <tr>
jpayne@68 134 <td class="parameter_name"><p>width</p></td>
jpayne@68 135 <td class="parameter_description"><p>the current width of <em class="parameter"><code>drawable</code></em>
jpayne@68 136 .</p></td>
jpayne@68 137 <td class="parameter_annotations"> </td>
jpayne@68 138 </tr>
jpayne@68 139 <tr>
jpayne@68 140 <td class="parameter_name"><p>height</p></td>
jpayne@68 141 <td class="parameter_description"><p>the current height of <em class="parameter"><code>drawable</code></em>
jpayne@68 142 .</p></td>
jpayne@68 143 <td class="parameter_annotations"> </td>
jpayne@68 144 </tr>
jpayne@68 145 </tbody>
jpayne@68 146 </table></div>
jpayne@68 147 </div>
jpayne@68 148 <div class="refsect3">
jpayne@68 149 <a name="cairo-xlib-surface-create-with-xrender-format.returns"></a><h4>Returns</h4>
jpayne@68 150 <p> the newly created surface</p>
jpayne@68 151 </div>
jpayne@68 152 <p class="since">Since: 1.0</p>
jpayne@68 153 </div>
jpayne@68 154 <hr>
jpayne@68 155 <div class="refsect2">
jpayne@68 156 <a name="cairo-xlib-surface-get-xrender-format"></a><h3>cairo_xlib_surface_get_xrender_format ()</h3>
jpayne@68 157 <pre class="programlisting"><span class="returnvalue">XRenderPictFormat</span> *
jpayne@68 158 cairo_xlib_surface_get_xrender_format (<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>
jpayne@68 159 <p>Gets the X Render picture format that <em class="parameter"><code>surface</code></em>
jpayne@68 160 uses for rendering with the
jpayne@68 161 X Render extension. If the surface was created by
jpayne@68 162 <a class="link" href="cairo-XLib-XRender-Backend.html#cairo-xlib-surface-create-with-xrender-format" title="cairo_xlib_surface_create_with_xrender_format ()"><code class="function">cairo_xlib_surface_create_with_xrender_format()</code></a> originally, the return
jpayne@68 163 value is the format passed to that constructor.</p>
jpayne@68 164 <div class="refsect3">
jpayne@68 165 <a name="cairo-xlib-surface-get-xrender-format.parameters"></a><h4>Parameters</h4>
jpayne@68 166 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 167 <colgroup>
jpayne@68 168 <col width="150px" class="parameters_name">
jpayne@68 169 <col class="parameters_description">
jpayne@68 170 <col width="200px" class="parameters_annotations">
jpayne@68 171 </colgroup>
jpayne@68 172 <tbody><tr>
jpayne@68 173 <td class="parameter_name"><p>surface</p></td>
jpayne@68 174 <td class="parameter_description"><p>an xlib surface</p></td>
jpayne@68 175 <td class="parameter_annotations"> </td>
jpayne@68 176 </tr></tbody>
jpayne@68 177 </table></div>
jpayne@68 178 </div>
jpayne@68 179 <div class="refsect3">
jpayne@68 180 <a name="cairo-xlib-surface-get-xrender-format.returns"></a><h4>Returns</h4>
jpayne@68 181 <p> the XRenderPictFormat* associated with <em class="parameter"><code>surface</code></em>
jpayne@68 182 ,
jpayne@68 183 or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the surface is not an xlib surface
jpayne@68 184 or if the X Render extension is not available.</p>
jpayne@68 185 </div>
jpayne@68 186 <p class="since">Since: 1.6</p>
jpayne@68 187 </div>
jpayne@68 188 </div>
jpayne@68 189 <div class="refsect1">
jpayne@68 190 <a name="cairo-XLib-XRender-Backend.other_details"></a><h2>Types and Values</h2>
jpayne@68 191 <div class="refsect2">
jpayne@68 192 <a name="CAIRO-HAS-XLIB-XRENDER-SURFACE:CAPS"></a><h3>CAIRO_HAS_XLIB_XRENDER_SURFACE</h3>
jpayne@68 193 <pre class="programlisting">#define CAIRO_HAS_XLIB_XRENDER_SURFACE 1
jpayne@68 194 </pre>
jpayne@68 195 <p>Defined if the XLib/XRender surface functions are available.
jpayne@68 196 This macro can be used to conditionally compile backend-specific code.</p>
jpayne@68 197 <p class="since">Since: 1.6</p>
jpayne@68 198 </div>
jpayne@68 199 </div>
jpayne@68 200 <div class="refsect1">
jpayne@68 201 <a name="cairo-XLib-XRender-Backend.see-also"></a><h2>See Also</h2>
jpayne@68 202 <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>
jpayne@68 203 </div>
jpayne@68 204 </div>
jpayne@68 205 <div class="footer">
jpayne@68 206 <hr>Generated by GTK-Doc V1.27</div>
jpayne@68 207 </body>
jpayne@68 208 </html>