blob: c858e79f412e55523f0233ae97451d1f716768bd [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MixDisplayX11</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="Mi-X Video Reference Manual">
<link rel="up" href="ch01.html" title="MI-X Video API">
<link rel="prev" href="MixDisplay.html" title="MixDisplay">
<link rel="next" href="MixBuffer.html" title="MixBuffer">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="MI-X Video API">
<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
<link rel="index" href="api-index-full.html" title="API Index">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="MixDisplay.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Mi-X Video Reference Manual</th>
<td><a accesskey="n" href="MixBuffer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#MixDisplayX11.synopsis" class="shortcut">Top</a>
 | 
<a href="#MixDisplayX11.description" class="shortcut">Description</a>
 | 
<a href="#MixDisplayX11.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" title="MixDisplayX11">
<a name="MixDisplayX11"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="MixDisplayX11.top_of_page"></a>MixDisplayX11</span></h2>
<p>MixDisplayX11 — MI-X Video X11 Display</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="MixDisplayX11.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="MixDisplayX11.html#MixDisplayX11-struct" title="MixDisplayX11">MixDisplayX11</a>;
<a class="link" href="MixDisplayX11.html" title="MixDisplayX11">MixDisplayX11</a> * <a class="link" href="MixDisplayX11.html#mix-displayx11-new" title="mix_displayx11_new ()">mix_displayx11_new</a> (void);
<a class="link" href="MixDisplayX11.html" title="MixDisplayX11">MixDisplayX11</a> * <a class="link" href="MixDisplayX11.html#mix-displayx11-ref" title="mix_displayx11_ref ()">mix_displayx11_ref</a> (<a class="link" href="MixDisplayX11.html" title="MixDisplayX11">MixDisplayX11</a> *mix);
#define <a class="link" href="MixDisplayX11.html#mix-displayx11-unref" title="mix_displayx11_unref()">mix_displayx11_unref</a> (obj)
MIX_RESULT <a class="link" href="MixDisplayX11.html#mix-displayx11-set-display" title="mix_displayx11_set_display ()">mix_displayx11_set_display</a> (<a class="link" href="MixDisplayX11.html" title="MixDisplayX11">MixDisplayX11</a> *obj,
Display *display);
MIX_RESULT <a class="link" href="MixDisplayX11.html#mix-displayx11-get-display" title="mix_displayx11_get_display ()">mix_displayx11_get_display</a> (<a class="link" href="MixDisplayX11.html" title="MixDisplayX11">MixDisplayX11</a> *obj,
Display **dislay);
MIX_RESULT <a class="link" href="MixDisplayX11.html#mix-displayx11-set-drawable" title="mix_displayx11_set_drawable ()">mix_displayx11_set_drawable</a> (<a class="link" href="MixDisplayX11.html" title="MixDisplayX11">MixDisplayX11</a> *obj,
Drawable drawable);
MIX_RESULT <a class="link" href="MixDisplayX11.html#mix-displayx11-get-drawable" title="mix_displayx11_get_drawable ()">mix_displayx11_get_drawable</a> (<a class="link" href="MixDisplayX11.html" title="MixDisplayX11">MixDisplayX11</a> *obj,
Drawable *drawable);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="MixDisplayX11.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a class="link" href="MixDisplay.html" title="MixDisplay">MixDisplay</a>
+----MixDisplayX11
</pre>
</div>
<div class="refsect1" title="Description">
<a name="MixDisplayX11.description"></a><h2>Description</h2>
<p>
A data object which stores X11 specific parameters.
</p>
<p>
</p>
<div class="note" title="Data Structures Used in MixDisplayX11 Fields:" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Data Structures Used in MixDisplayX11 Fields:</h3>
See X11/Xlib.h for Display and Drawable definitions.
</div>
</div>
<div class="refsect1" title="Details">
<a name="MixDisplayX11.details"></a><h2>Details</h2>
<div class="refsect2" title="MixDisplayX11">
<a name="MixDisplayX11-struct"></a><h3>MixDisplayX11</h3>
<pre class="programlisting">typedef struct {
MixDisplay parent;
/* Pointer to a X Window Display structure */
Display *display;
/* An X Window Drawable that is either a Window
* or a Pixmap. This field is not used in
* mix_video_initialize().
* See X11/Xlib.h for Display and Drawable definitions.*/
Drawable drawable;
} MixDisplayX11;
</pre>
<p>
MI-X VideoInit Parameter object</p>
</div>
<hr>
<div class="refsect2" title="mix_displayx11_new ()">
<a name="mix-displayx11-new"></a><h3>mix_displayx11_new ()</h3>
<pre class="programlisting"><a class="link" href="MixDisplayX11.html" title="MixDisplayX11">MixDisplayX11</a> * mix_displayx11_new (void);</pre>
<p>
Use this method to create new instance of <a class="link" href="MixDisplayX11.html" title="MixDisplayX11"><span class="type">MixDisplayX11</span></a></p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
<td> A newly allocated instance of <a class="link" href="MixDisplayX11.html" title="MixDisplayX11"><span class="type">MixDisplayX11</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="mix_displayx11_ref ()">
<a name="mix-displayx11-ref"></a><h3>mix_displayx11_ref ()</h3>
<pre class="programlisting"><a class="link" href="MixDisplayX11.html" title="MixDisplayX11">MixDisplayX11</a> * mix_displayx11_ref (<a class="link" href="MixDisplayX11.html" title="MixDisplayX11">MixDisplayX11</a> *mix);</pre>
<p>
Add reference count.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mix</code></em> :</span></p></td>
<td> object to add reference
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
<td> the <a class="link" href="MixDisplayX11.html" title="MixDisplayX11"><span class="type">MixDisplayX11</span></a> instance where reference count has been increased.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="mix_displayx11_unref()">
<a name="mix-displayx11-unref"></a><h3>mix_displayx11_unref()</h3>
<pre class="programlisting">#define mix_displayx11_unref(obj) mix_display_unref(MIX_DISPLAY(obj))
</pre>
<p>
Decrement reference count of the object.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td> object to unref.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="mix_displayx11_set_display ()">
<a name="mix-displayx11-set-display"></a><h3>mix_displayx11_set_display ()</h3>
<pre class="programlisting">MIX_RESULT mix_displayx11_set_display (<a class="link" href="MixDisplayX11.html" title="MixDisplayX11">MixDisplayX11</a> *obj,
Display *display);</pre>
<p>
Set Display</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td> <a class="link" href="MixDisplayX11.html" title="MixDisplayX11"><span class="type">MixDisplayX11</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>display</code></em> :</span></p></td>
<td> Pointer to a X Window Display structure
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
<td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="mix_displayx11_get_display ()">
<a name="mix-displayx11-get-display"></a><h3>mix_displayx11_get_display ()</h3>
<pre class="programlisting">MIX_RESULT mix_displayx11_get_display (<a class="link" href="MixDisplayX11.html" title="MixDisplayX11">MixDisplayX11</a> *obj,
Display **dislay);</pre>
<p>
Get Display</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td> <a class="link" href="MixDisplayX11.html" title="MixDisplayX11"><span class="type">MixDisplayX11</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>display</code></em> :</span></p></td>
<td> Pointer to pointer of X Window Display structure
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
<td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="mix_displayx11_set_drawable ()">
<a name="mix-displayx11-set-drawable"></a><h3>mix_displayx11_set_drawable ()</h3>
<pre class="programlisting">MIX_RESULT mix_displayx11_set_drawable (<a class="link" href="MixDisplayX11.html" title="MixDisplayX11">MixDisplayX11</a> *obj,
Drawable drawable);</pre>
<p>
Set drawable</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td> <a class="link" href="MixDisplayX11.html" title="MixDisplayX11"><span class="type">MixDisplayX11</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>drawable</code></em> :</span></p></td>
<td> An X Window Drawable that is either a Window or a Pixmap.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
<td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="mix_displayx11_get_drawable ()">
<a name="mix-displayx11-get-drawable"></a><h3>mix_displayx11_get_drawable ()</h3>
<pre class="programlisting">MIX_RESULT mix_displayx11_get_drawable (<a class="link" href="MixDisplayX11.html" title="MixDisplayX11">MixDisplayX11</a> *obj,
Drawable *drawable);</pre>
<p>
Get drawable</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td> <a class="link" href="MixDisplayX11.html" title="MixDisplayX11"><span class="type">MixDisplayX11</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>drawable</code></em> :</span></p></td>
<td> An X Window Drawable that is either a Window or a Pixmap to be returned.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
<td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>