Mercurial > repos > rliterman > csp2
view CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/gtk-doc/html/cairo/cairo-XLib-XRender-Backend.html @ 68:5028fdace37b
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author | jpayne |
---|---|
date | Tue, 18 Mar 2025 16:23:26 -0400 |
parents | |
children |
line wrap: on
line source
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>XLib-XRender Backend: 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-XLib-Surfaces.html" title="XLib Surfaces"> <link rel="next" href="cairo-Script-Surfaces.html" title="Script 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-XLib-XRender-Backend.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-XLib-Surfaces.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> <td><a accesskey="n" href="cairo-Script-Surfaces.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="cairo-XLib-XRender-Backend"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> <h2><span class="refentrytitle"><a name="cairo-XLib-XRender-Backend.top_of_page"></a>XLib-XRender Backend</span></h2> <p>XLib-XRender Backend — X Window System rendering using XLib and the X Render extension</p> </td> <td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> <a name="cairo-XLib-XRender-Backend.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-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> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">XRenderPictFormat</span> * </td> <td class="function_name"> <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> </td> </tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="cairo-XLib-XRender-Backend.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-XLib-XRender-Backend.html#CAIRO-HAS-XLIB-XRENDER-SURFACE:CAPS" title="CAIRO_HAS_XLIB_XRENDER_SURFACE">CAIRO_HAS_XLIB_XRENDER_SURFACE</a></td> </tr></tbody> </table></div> </div> <div class="refsect1"> <a name="cairo-XLib-XRender-Backend.description"></a><h2>Description</h2> <p>The XLib surface is used to render cairo graphics to X Window System windows and pixmaps using the XLib and Xrender libraries.</p> <p>Note that the XLib surface automatically takes advantage of X Render extension if it is available.</p> </div> <div class="refsect1"> <a name="cairo-XLib-XRender-Backend.functions_details"></a><h2>Functions</h2> <div class="refsect2"> <a name="cairo-xlib-surface-create-with-xrender-format"></a><h3>cairo_xlib_surface_create_with_xrender_format ()</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_xlib_surface_create_with_xrender_format (<em class="parameter"><code><span class="type">Display</span> *dpy</code></em>, <em class="parameter"><code><span class="type">Drawable</span> drawable</code></em>, <em class="parameter"><code><span class="type">Screen</span> *screen</code></em>, <em class="parameter"><code><span class="type">XRenderPictFormat</span> *format</code></em>, <em class="parameter"><code><span class="type">int</span> width</code></em>, <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre> <p>Creates an Xlib surface that draws to the given drawable. The way that colors are represented in the drawable is specified by the provided picture format.</p> <p>Note: If <em class="parameter"><code>drawable</code></em> is a Window, then the function <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 window changes.</p> <div class="refsect3"> <a name="cairo-xlib-surface-create-with-xrender-format.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>dpy</p></td> <td class="parameter_description"><p>an X Display</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>drawable</p></td> <td class="parameter_description"><p>an X Drawable, (a Pixmap or a Window)</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>screen</p></td> <td class="parameter_description"><p>the X Screen associated with <em class="parameter"><code>drawable</code></em> </p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>format</p></td> <td class="parameter_description"><p>the picture format to use for drawing to <em class="parameter"><code>drawable</code></em> . The depth of <em class="parameter"><code>format</code></em> must match the depth of the drawable.</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>width</p></td> <td class="parameter_description"><p>the current width of <em class="parameter"><code>drawable</code></em> .</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>height</p></td> <td class="parameter_description"><p>the current height of <em class="parameter"><code>drawable</code></em> .</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="cairo-xlib-surface-create-with-xrender-format.returns"></a><h4>Returns</h4> <p> the newly created surface</p> </div> <p class="since">Since: 1.0</p> </div> <hr> <div class="refsect2"> <a name="cairo-xlib-surface-get-xrender-format"></a><h3>cairo_xlib_surface_get_xrender_format ()</h3> <pre class="programlisting"><span class="returnvalue">XRenderPictFormat</span> * 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> <p>Gets the X Render picture format that <em class="parameter"><code>surface</code></em> uses for rendering with the X Render extension. If the surface was created by <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 value is the format passed to that constructor.</p> <div class="refsect3"> <a name="cairo-xlib-surface-get-xrender-format.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>an xlib surface</p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="cairo-xlib-surface-get-xrender-format.returns"></a><h4>Returns</h4> <p> the XRenderPictFormat* associated with <em class="parameter"><code>surface</code></em> , 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 or if the X Render extension is not available.</p> </div> <p class="since">Since: 1.6</p> </div> </div> <div class="refsect1"> <a name="cairo-XLib-XRender-Backend.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> <a name="CAIRO-HAS-XLIB-XRENDER-SURFACE:CAPS"></a><h3>CAIRO_HAS_XLIB_XRENDER_SURFACE</h3> <pre class="programlisting">#define CAIRO_HAS_XLIB_XRENDER_SURFACE 1 </pre> <p>Defined if the XLib/XRender surface functions are 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-XLib-XRender-Backend.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>