diff options
Diffstat (limited to 'man/XFlush.man')
-rw-r--r-- | man/XFlush.man | 70 |
1 files changed, 35 insertions, 35 deletions
diff --git a/man/XFlush.man b/man/XFlush.man index 9e1f21e5..2af3731a 100644 --- a/man/XFlush.man +++ b/man/XFlush.man @@ -93,106 +93,106 @@ int XPending\^(\^Display *\fIdisplay\fP\^); .SH ARGUMENTS .IP \fIdiscard\fP 1i Specifies a Boolean value that indicates whether -.ZN XSync +.B XSync discards all events on the event queue. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fImode\fP 1i Specifies the mode. You can pass -.ZN QueuedAlready , -.ZN QueuedAfterFlush , +.BR QueuedAlready , +.BR QueuedAfterFlush , or -.ZN QueuedAfterReading . +.BR QueuedAfterReading . .SH DESCRIPTION The -.ZN XFlush +.B XFlush function flushes the output buffer. Most client applications need not use this function because the output buffer is automatically flushed as needed by calls to -.ZN XPending , -.ZN XNextEvent , +.BR XPending , +.BR XNextEvent , and -.ZN XWindowEvent . +.BR XWindowEvent . .IN "XPending" .IN "XNextEvent" .IN "XWindowEvent" Events generated by the server may be enqueued into the library's event queue. .LP The -.ZN XSync +.B XSync function flushes the output buffer and then waits until all requests have been received and processed by the X server. Any errors generated must be handled by the error handler. For each protocol error received by Xlib, -.ZN XSync +.B XSync calls the client application's error handling routine (see section 11.8.2). Any events generated by the server are enqueued into the library's event queue. .LP Finally, if you passed -.ZN False , -.ZN XSync +.BR False , +.B XSync does not discard the events in the queue. If you passed -.ZN True , -.ZN XSync +.BR True , +.B XSync discards all events in the queue, including those events that were on the queue before -.ZN XSync +.B XSync was called. Client applications seldom need to call -.ZN XSync . +.BR XSync . .LP If mode is -.ZN QueuedAlready , -.ZN XEventsQueued +.BR QueuedAlready , +.B XEventsQueued returns the number of events already in the event queue (and never performs a system call). If mode is -.ZN QueuedAfterFlush , -.ZN XEventsQueued +.BR QueuedAfterFlush , +.B XEventsQueued returns the number of events already in the queue if the number is nonzero. If there are no events in the queue, -.ZN XEventsQueued +.B XEventsQueued flushes the output buffer, attempts to read more events out of the application's connection, and returns the number read. If mode is -.ZN QueuedAfterReading , -.ZN XEventsQueued +.BR QueuedAfterReading , +.B XEventsQueued returns the number of events already in the queue if the number is nonzero. If there are no events in the queue, -.ZN XEventsQueued +.B XEventsQueued attempts to read more events out of the application's connection without flushing the output buffer and returns the number read. .LP -.ZN XEventsQueued +.B XEventsQueued always returns immediately without I/O if there are events already in the queue. -.ZN XEventsQueued +.B XEventsQueued with mode -.ZN QueuedAfterFlush +.B QueuedAfterFlush is identical in behavior to -.ZN XPending . -.ZN XEventsQueued +.BR XPending . +.B XEventsQueued with mode -.ZN QueuedAlready +.B QueuedAlready is identical to the -.ZN XQLength +.B XQLength function. .LP The -.ZN XPending +.B XPending function returns the number of events that have been received from the X server but have not been removed from the event queue. -.ZN XPending +.B XPending is identical to -.ZN XEventsQueued +.B XEventsQueued with the mode -.ZN QueuedAfterFlush +.B QueuedAfterFlush specified. .SH "SEE ALSO" AllPlanes(__libmansuffix__), |