480 lines
10 KiB
HTML
480 lines
10 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of XMBUF</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>XMBUF</H1>
|
|
Section: X FUNCTIONS (3)<BR>Updated: libXext 1.3.4<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
XmbufQueryExtension, XmbufGetVersion, XmbufCreateBuffers, XmbufDestroyBuffers, XmbufDisplayBuffers, XmbufGetWindowAttributes, XmbufChangeWindowAttributes, XmbufGetBufferAttributes, XmbufChangeBufferAttributes, XmbufGetScreenInfo, XmbufCreateStereoWindow - X multibuffering functions
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNTAX</H2>
|
|
|
|
|
|
<PRE>
|
|
#include <<A HREF="file:///usr/include/X11/extensions/multibuf.h">X11/extensions/multibuf.h</A>>
|
|
|
|
Bool XmbufQueryExtension(
|
|
Display *dpy,
|
|
Display *dpy,
|
|
int *event_base_return,
|
|
int *error_base_return);
|
|
|
|
Status XmbufGetVersion(
|
|
Display *dpy,
|
|
int *major_version_return,
|
|
int *minor_version_return);
|
|
|
|
int XmbufCreateBuffers(
|
|
Display *dpy,
|
|
Window window,
|
|
int count,
|
|
int update_action,
|
|
int update_hint,
|
|
Multibuffer *buffers_update);
|
|
|
|
void XmbufDestroyBuffers(
|
|
Display *dpy,
|
|
Window window);
|
|
|
|
void XmbufDisplayBuffers(
|
|
Display *dpy,
|
|
int count,
|
|
Multibuffer *buffers,
|
|
int min_delay,
|
|
int max_delay);
|
|
|
|
Status XmbufGetWindowAttributes(
|
|
Display *dpy,
|
|
Window window,
|
|
XmbufWindowAttributes *attributes);
|
|
|
|
void XmbufChangeWindowAttributes(
|
|
Display *dpy,
|
|
Window window,
|
|
unsigned long valuemask,
|
|
XmbufSetWindowAttributes *attributes);
|
|
|
|
Status XmbufGetBufferAttributes(
|
|
Display *dpy,
|
|
Multibuffer buffer,
|
|
XmbufBufferAttributes *attributes);
|
|
|
|
void XmbufChangeBufferAttributes(
|
|
Display *dpy,
|
|
Multibuffer buffer,
|
|
unsigned long valuemask,
|
|
XmbufSetBufferAttributes *attributes);
|
|
|
|
Status XmbufGetScreenInfo(
|
|
Display *dpy,
|
|
Drawable drawable,
|
|
int *nmono_return,
|
|
XmbufBufferInfo **mono_info_return,
|
|
int *nstereo_return,
|
|
XmbufBufferInfo **stereo_info_return);
|
|
|
|
Window XmbufCreateStereoWindow(
|
|
Display *dpy,
|
|
Window parent,
|
|
int x,
|
|
int y,
|
|
unsigned int width,
|
|
unsigned int height,
|
|
unsigned int border_width,
|
|
int depth,
|
|
unsigned int class, /* InputOutput, InputOnly*/
|
|
Visual *visual,
|
|
unsigned long valuemask,
|
|
XSetWindowAttributes *attributes,
|
|
Multibuffer *left_return,
|
|
Multibuffer *right_return);
|
|
|
|
</PRE>
|
|
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>STRUCTURES</H2>
|
|
|
|
<I>Events:</I>
|
|
|
|
<PRE>
|
|
typedef struct {
|
|
int type; /* of event */
|
|
unsigned long serial; /* # of last request processed by server */
|
|
int send_event; /* true if this came from a SendEvent request */
|
|
Display *display; /* Display the event was read from */
|
|
Multibuffer buffer; /* buffer of event */
|
|
int state; /* see Clobbered constants above */
|
|
} XmbufClobberNotifyEvent;
|
|
|
|
typedef struct {
|
|
int type; /* of event */
|
|
unsigned long serial; /* # of last request processed by server */
|
|
int send_event; /* true if this came from a SendEvent request */
|
|
Display *display; /* Display the event was read from */
|
|
Multibuffer buffer; /* buffer of event */
|
|
} XmbufUpdateNotifyEvent;
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
<I>Per-window attributes that can be got:</I>
|
|
<P>
|
|
|
|
<PRE>
|
|
typedef struct {
|
|
int displayed_index; /* which buffer is being displayed */
|
|
int update_action; /* Undefined, Background, Untouched, Copied */
|
|
int update_hint; /* Frequent, Intermittent, Static */
|
|
int window_mode; /* Mono, Stereo */
|
|
int nbuffers; /* Number of buffers */
|
|
Multibuffer *buffers; /* Buffers */
|
|
} XmbufWindowAttributes;
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
<I>Per-window attributes that can be set:</I>
|
|
<P>
|
|
|
|
<PRE>
|
|
typedef struct {
|
|
int update_hint; /* Frequent, Intermittent, Static */
|
|
} XmbufSetWindowAttributes;
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
<I>Per-buffer attributes that can be got:</I>
|
|
<P>
|
|
|
|
<PRE>
|
|
typedef struct {
|
|
Window window; /* which window this belongs to */
|
|
unsigned long event_mask; /* events that have been selected */
|
|
int buffer_index; /* which buffer is this */
|
|
int side; /* Mono, Left, Right */
|
|
} XmbufBufferAttributes;
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
<I>Per-buffer attributes that can be set:</I>
|
|
<P>
|
|
|
|
<PRE>
|
|
typedef struct {
|
|
unsigned long event_mask; /* events that have been selected */
|
|
} XmbufSetBufferAttributes;
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
<I>Per-screen buffer info (there will be lists of them):</I>
|
|
<P>
|
|
|
|
<PRE>
|
|
typedef struct {
|
|
VisualID visualid; /* visual usable at this depth */
|
|
int max_buffers; /* most buffers for this visual */
|
|
int depth; /* depth of buffers to be created */
|
|
} XmbufBufferInfo;
|
|
|
|
</PRE>
|
|
|
|
|
|
<A NAME="lbAE"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The application programming library for the
|
|
<I>X11 Double-Buffering, Multi-Buffering, and Stereo Extension</I>
|
|
contains the interfaces described below.
|
|
With the exception of
|
|
|
|
|
|
<I>XmbufQueryExtension</I>,
|
|
|
|
if any of these routines are
|
|
called with a display that does not support the extension, the
|
|
ExtensionErrorHandler (which can be set with
|
|
|
|
|
|
<I>XSetExtensionErrorHandler</I>
|
|
|
|
and functions the same way as
|
|
|
|
|
|
<I>XSetErrorHandler</I>)
|
|
|
|
will be called and the function will then return.
|
|
<P>
|
|
|
|
|
|
|
|
<I>XmbufQueryExtension</I>
|
|
|
|
returns
|
|
|
|
|
|
<I>True</I>
|
|
|
|
if the multibuffering/stereo
|
|
extension is available on the
|
|
given display. If the extension exists, the value of the first event
|
|
code (which should be added to the event type constants
|
|
|
|
|
|
<I>MultibufferClobberNotify</I>
|
|
|
|
and
|
|
|
|
|
|
<I>MultibufferUpdateNotify</I>
|
|
|
|
to get the actual
|
|
values) is stored into event_base_return and the value of the first
|
|
error code (which should be added to the error type constant
|
|
|
|
|
|
<I>MultibufferBadBuffer</I>
|
|
|
|
to get the actual value) is stored into error_base_return.
|
|
<P>
|
|
|
|
|
|
|
|
<I>XmbufGetVersion</I>
|
|
|
|
gets the major and minor version numbers of the extension.
|
|
The return
|
|
value is zero if an error occurs or non-zero if no error happens.
|
|
<P>
|
|
|
|
|
|
|
|
<I>XmbufCreateBuffers</I>
|
|
|
|
requests that "count" buffers be
|
|
created with the given update_action
|
|
and update_hint and be associated with the indicated window. The
|
|
number of buffers created is returned (zero if an error occurred)
|
|
and buffers_update is filled in with that many Multibuffer identifiers.
|
|
<P>
|
|
|
|
|
|
|
|
<I>XmbufDestroyBuffers</I>
|
|
|
|
destroys the buffers associated
|
|
with the given window.
|
|
<P>
|
|
|
|
|
|
|
|
<I>XmbufDisplayBuffers</I>
|
|
|
|
displays the indicated buffers their
|
|
appropriate windows within
|
|
max_delay milliseconds after min_delay milliseconds have passed.
|
|
No two buffers may be associated with the same window or else a Match
|
|
error is generated.
|
|
<P>
|
|
|
|
|
|
|
|
<I>XmbufGetWindowAttributes</I>
|
|
|
|
gets the multibuffering attributes that apply
|
|
to all buffers associated
|
|
with the given window.
|
|
The list of buffers returns may be freed with
|
|
|
|
|
|
<I>XFree</I>.
|
|
|
|
Returns non-zero on success and zero if an error occurs.
|
|
<P>
|
|
|
|
|
|
|
|
<I>XmbufChangeWindowAttributes</I>
|
|
|
|
sets the multibuffering attributes
|
|
that apply to all buffers associated
|
|
with the given window. This is currently limited to the update_hint.
|
|
<P>
|
|
|
|
|
|
|
|
<I>XmbufGetBufferAttributes</I>
|
|
|
|
gets the attributes for the indicated buffer.
|
|
Returns non-zero on
|
|
success and zero if an error occurs.
|
|
<P>
|
|
|
|
|
|
|
|
<I>XmbufChangeBufferAttributes</I>
|
|
|
|
sets the attributes for the indicated buffer.
|
|
This is currently limited to the event_mask.
|
|
<P>
|
|
|
|
|
|
|
|
<I>XmbufGetScreenInfo</I>
|
|
|
|
gets the parameters controlling how
|
|
mono and stereo windows may be
|
|
created on the screen of the given drawable. The numbers of sets of
|
|
visual and depths are returned in nmono_return and nstereo_return. If
|
|
nmono_return is greater than zero, then mono_info_return is set to the
|
|
address of an array of
|
|
|
|
|
|
<I>XmbufBufferInfo</I>
|
|
|
|
structures describing the
|
|
various visuals and depths that may be used. Otherwise,
|
|
mono_info_return is set to NULL. Similarly, stereo_info_return is set
|
|
according to nstereo_return. The storage returned in mono_info_return
|
|
and stereo_info_return may be released by
|
|
|
|
|
|
<I>XFree</I>.
|
|
|
|
If no errors are
|
|
encounted, non-zero will be returned.
|
|
<P>
|
|
|
|
|
|
|
|
<I>XmbufCreateStereoWindow</I>
|
|
|
|
creates a stereo window in the same way that
|
|
|
|
|
|
<I>XCreateWindow</I>
|
|
|
|
creates a mono window. The buffer ids for the left and right buffers are
|
|
returned in left_return and right_return, respectively. If an
|
|
extension error handler that returns is installed,
|
|
|
|
|
|
<I>None</I>
|
|
|
|
will be returned if the extension is not available on this display.
|
|
<A NAME="lbAF"> </A>
|
|
<H2>PREDEFINED VALUES</H2>
|
|
|
|
<P>
|
|
Update_action field:
|
|
<DL COMPACT><DT id="1"><DD>
|
|
<PRE>
|
|
|
|
<I>MultibufferUpdateActionUndefined</I>
|
|
<I>MultibufferUpdateActionBackground</I>
|
|
<I>MultibufferUpdateActionUntouched</I>
|
|
<I>MultibufferUpdateActionCopied</I></PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
Update_hint field:
|
|
<DL COMPACT><DT id="2"><DD>
|
|
<PRE>
|
|
|
|
<I>MultibufferUpdateHintFrequent</I>
|
|
<I>MultibufferUpdateHintIntermittent</I>
|
|
<I>MultibufferUpdateHintStatic</I></PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
Valuemask fields:
|
|
<DL COMPACT><DT id="3"><DD>
|
|
<PRE>
|
|
|
|
<I>MultibufferWindowUpdateHint</I>
|
|
<I>MultibufferBufferEventMask</I></PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
Mono vs. stereo and left vs. right:
|
|
<DL COMPACT><DT id="4"><DD>
|
|
<PRE>
|
|
|
|
<I>MultibufferModeMono</I>
|
|
<I>MultibufferModeStereo</I>
|
|
<I>MultibufferSideMono</I>
|
|
<I>MultibufferSideLeft</I>
|
|
<I>MultibufferSideRight</I></PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
Clobber state:
|
|
<DL COMPACT><DT id="5"><DD>
|
|
<PRE>
|
|
|
|
<I>MultibufferUnclobbered</I>
|
|
<I>MultibufferPartiallyClobbered</I>
|
|
<I>MultibufferFullyClobbered</I></PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
Event stuff:
|
|
<DL COMPACT><DT id="6"><DD>
|
|
<PRE>
|
|
|
|
<I>MultibufferClobberNotifyMask</I>
|
|
<I>MultibufferUpdateNotifyMask</I>
|
|
<I>MultibufferClobberNotify</I>
|
|
<I>MultibufferUpdateNotify</I>
|
|
<I>MultibufferNumberEvents</I>
|
|
<I>MultibufferBadBuffer</I>
|
|
<I>MultibufferNumberErrors</I></PRE>
|
|
|
|
</DL>
|
|
|
|
<A NAME="lbAG"> </A>
|
|
<H2>BUGS</H2>
|
|
|
|
This manual page needs more work.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<I>Extending X for Double Buffering, Multi-Buffering, and Stereo</I>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="7"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="8"><A HREF="#lbAC">SYNTAX</A><DD>
|
|
<DT id="9"><A HREF="#lbAD">STRUCTURES</A><DD>
|
|
<DT id="10"><A HREF="#lbAE">DESCRIPTION</A><DD>
|
|
<DT id="11"><A HREF="#lbAF">PREDEFINED VALUES</A><DD>
|
|
<DT id="12"><A HREF="#lbAG">BUGS</A><DD>
|
|
<DT id="13"><A HREF="#lbAH">SEE ALSO</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:01 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|