diff options
| author | Alan Coopersmith <alan.coopersmith@oracle.com> | 2025-07-13 18:05:04 -0700 |
|---|---|---|
| committer | Alan Coopersmith <alan.coopersmith@oracle.com> | 2025-07-19 11:52:33 -0700 |
| commit | a43b0df438b1cfb6516695aac4dad2436c0b4c60 (patch) | |
| tree | 4a04fbfaab5f021eb9303f77217cdd023f020689 | |
| parent | 23eeaa46152fb91a0601571f989c0d625bfc9994 (diff) | |
More closely follow common style as described on
https://man7.org/linux/man-pages/man7/man-pages.7.html
and fix warnings raised by `mandoc -T lint` and `groff -rCHECKSTYLE=10`
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Part-of: <https://gitlab.freedesktop.org/xorg/lib/libxext/-/merge_requests/14>
| -rw-r--r-- | man/DBE.man | 274 | ||||
| -rw-r--r-- | man/DPMSCapable.man | 16 | ||||
| -rw-r--r-- | man/DPMSDisable.man | 18 | ||||
| -rw-r--r-- | man/DPMSEnable.man | 27 | ||||
| -rw-r--r-- | man/DPMSForceLevel.man | 42 | ||||
| -rw-r--r-- | man/DPMSGetTimeouts.man | 41 | ||||
| -rw-r--r-- | man/DPMSGetVersion.man | 37 | ||||
| -rw-r--r-- | man/DPMSInfo.man | 39 | ||||
| -rw-r--r-- | man/DPMSQueryExtension.man | 37 | ||||
| -rw-r--r-- | man/DPMSSetTimeouts.man | 94 | ||||
| -rw-r--r-- | man/XShape.man | 29 | ||||
| -rw-r--r-- | man/XShm.man | 90 | ||||
| -rw-r--r-- | man/XcupGetReservedColormapEntries.man | 26 | ||||
| -rw-r--r-- | man/XcupQueryVersion.man | 33 | ||||
| -rw-r--r-- | man/XcupStoreColors.man | 31 | ||||
| -rw-r--r-- | man/XdbeAllocateBackBufferName.man | 40 | ||||
| -rw-r--r-- | man/XdbeBeginIdiom.man | 25 | ||||
| -rw-r--r-- | man/XdbeDeallocateBackBufferName.man | 31 | ||||
| -rw-r--r-- | man/XdbeEndIdiom.man | 25 | ||||
| -rw-r--r-- | man/XdbeFreeVisualInfo.man | 31 | ||||
| -rw-r--r-- | man/XdbeGetBackBufferAttributes.man | 41 | ||||
| -rw-r--r-- | man/XdbeGetVisualInfo.man | 72 | ||||
| -rw-r--r-- | man/XdbeQueryExtension.man | 44 | ||||
| -rw-r--r-- | man/XdbeSwapBuffers.man | 56 | ||||
| -rw-r--r-- | man/Xevi.man | 9 | ||||
| -rw-r--r-- | man/Xmbuf.man | 263 |
26 files changed, 755 insertions, 716 deletions
diff --git a/man/DBE.man b/man/DBE.man index 6e3d71f..78ed398 100644 --- a/man/DBE.man +++ b/man/DBE.man @@ -23,100 +23,104 @@ .\" dealing in this Software without prior written authorization from the .\" Hewlett-Packard Company. .\" -.TH DBE __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH DBE __libmansuffix__ 1996-03-11 __xorgversion__ .SH NAME DBE - Double Buffer Extension .SH SYNOPSIS The Double Buffer Extension (DBE) provides a standard way to utilize double-buffering within the framework of the X Window System. Double-buffering uses two buffers, called front and back, which hold images. -The front buffer is visible to the user; the back buffer is not. Successive -frames of an animation are rendered into the back buffer while the previously -rendered frame is displayed in the front buffer. When a new frame is ready, -the back and front buffers swap roles, making the new frame visible. Ideally, -this exchange appears to happen instantaneously to the user, with no visual -artifacts. Thus, only completely rendered images are presented to the user, -and remain visible during the entire time it takes to render a new frame. The -result is a flicker-free animation. +The front buffer is visible to the user; the back buffer is not. +Successive frames of an animation are rendered into the back buffer while the +previously rendered frame is displayed in the front buffer. +When a new frame is ready, the back and front buffers swap roles, +making the new frame visible. +Ideally, this exchange appears to happen instantaneously to the user, +with no visual artifacts. +Thus, only completely rendered images are presented to the user, +and remain visible during the entire time it takes to render a new frame. +The result is a flicker-free animation. .SH DESCRIPTION .B Concepts .RS Normal windows are created using .B XCreateWindow() or -.B XCreateSimpleWindow(), -which allocate a set of window attributes and, for InputOutput windows, a front -buffer, into which an image can be drawn. The contents of this buffer will be -displayed when the window is visible. - +.BR XCreateSimpleWindow() , +which allocate a set of window attributes and, for InputOutput windows, +a front buffer, into which an image can be drawn. +The contents of this buffer will be displayed when the window is visible. +.PP This extension enables applications to use double-buffering with a window. This involves creating a second buffer, called a back buffer, and associating one or more back buffer names -.I (XIDs) +.RI ( XIDs ) with the window, for use when referring to (i.e., drawing to or reading from) the window's back buffer. The back buffer name is a drawable of type -.I XdbeBackBuffer. - -DBE provides a relative double-buffering model. One XID, the window, -always refers to the front buffer. One or more other XIDs, the back buffer -names, always refer to the back buffer. After a buffer swap, the window -continues to refer to the (new) front buffer, and the back buffer name -continues to refer to the (new) back buffer. Thus, applications and toolkits -that want to just render to the back buffer always use the back buffer name -for all drawing requests to the window. Portions of an application that want -to render to the front buffer always use the window XID for all drawing -requests to the window. - +.BR XdbeBackBuffer . +.PP +DBE provides a relative double-buffering model. +One XID, the window, always refers to the front buffer. +One or more other XIDs, the back buffer names, always refer to the back buffer. +After a buffer swap, the window continues to refer to the (new) front buffer, +and the back buffer name continues to refer to the (new) back buffer. +Thus, applications and toolkits that want to just render to the back buffer +always use the back buffer name for all drawing requests to the window. +Portions of an application that want to render to the front buffer always use +the window XID for all drawing requests to the window. +.PP Multiple clients and toolkits can all use double-buffering on the same window. DBE does not provide a request for querying whether a window has -double-buffering support, and if so, what the back buffer name is. Given the -asynchronous nature of the X Window System, this would cause race -conditions. Instead, DBE allows multiple back buffer names to exist for the -same window; they all refer to the same physical back buffer. The first time a -back buffer name is allocated for a window, the window becomes +double-buffering support, and if so, what the back buffer name is. +Given the asynchronous nature of the X Window System, this would cause race +conditions. +Instead, DBE allows multiple back buffer names to exist for the same window; +they all refer to the same physical back buffer. +The first time a back buffer name is allocated for a window, the window becomes double-buffered and the back buffer name is associated with the window. Subsequently, the window already is a double-buffered window, and nothing about the window changes when a new back buffer name is allocated, except -that the new back buffer name is associated with the window. The window -remains double-buffered until either the window is destroyed, or until all of -the back buffer names for the window are deallocated. - -In general, both the front and back buffers ae treated the same. In -particular, here are some important characteristics: - +that the new back buffer name is associated with the window. +The window remains double-buffered until either the window is destroyed, +or until all of the back buffer names for the window are deallocated. +.PP +In general, both the front and back buffers ae treated the same. +In particular, here are some important characteristics: .RS +.PP Only one buffer per window can be visible at a time (the front buffer). - +.PP Both buffers associated with a window have the same visual type, depth, width, height, and shape as the window. - +.PP Both buffers associated with a window are "visible" (or "obscured") in -the same way. When an Expose event is generated for a window, this -event is considered to apply to both buffers equally. When a -double-buffered window is exposed, both buffers are tiled with the -window background. +the same way. +When an Expose event is generated for a window, +this event is considered to apply to both buffers equally. +When a double-buffered window is exposed, +both buffers are tiled with the window background. Even though the back buffer is not visible, terms such as obscure apply to the back buffer as well as to the front buffer. - +.PP It is acceptable at any time to pass an -.I XdbeBackBuffer +.B XdbeBackBuffer in any function that expects a drawable. This enables an application to draw directly into -.I XdbeBackBuffer +.B XdbeBackBuffer in the same fashion as it would draw into any other drawable. - +.PP It is an error (Window) to pass an -.I XdbeBackBuffer +.B XdbeBackBuffer in a function that expects a Window. - +.PP An -.I XdbeBackBuffer +.B XdbeBackBuffer will never be sent in a reply, event, or error where a Window is specified. - +.PP If backing-store and save-under applies to a double-buffered window, it applies to both buffers equally. - +.PP If the .B XClearArea() or @@ -125,15 +129,17 @@ function is executed on a double-buffered window, the same area in both the front and back buffers is cleared. .RE - +.PP The effect of passing a window to a function that accepts a drawable -is unchanged by this extension. The window and front buffer are synonymous -with each other. This includes obeying the +is unchanged by this extension. +The window and front buffer are synonymous with each other. +This includes obeying the .B XGetImage() and .B XGetSubImage() semantics and the subwindow-mode semantics if a graphics context is -involved. Regardless of whether the window was explicitly passed in an +involved. +Regardless of whether the window was explicitly passed in an .B XGetImage() or .B XGetSubImage() @@ -147,87 +153,96 @@ and on a back buffer return undefined image contents for any obscured regions of the back buffer that fall within the image. - +.PP Drawing to a back buffer always uses the clip region that would be used to -draw to the front buffer with a GC subwindow-mode of ClipByChildren. If an -ancestor of a double-buffered window is drawn to with a GC having a +draw to the front buffer with a GC subwindow-mode of ClipByChildren. +If an ancestor of a double-buffered window is drawn to with a GC having a subwindow-mode of IncludeInferiors, the effect on the double-buffered window's back buffer depends on the depth of the double-buffered window -and the ancestor. If the depths are the same, the contents of the back buffer -of the double-buffered window are not changed. If the depths are different, +and the ancestor. +If the depths are the same, the contents of the back buffer +of the double-buffered window are not changed. +If the depths are different, the contents of the back buffer of the double-buffered window are undefined for the pixels that the IncludeInferiors drawing touched. - -DBE adds no new events. DBE does not extend the semantics of any existing +.PP +DBE adds no new events. +DBE does not extend the semantics of any existing events with the exception of adding a new drawable type called -.I XdbeBackBuffer. - +.BR XdbeBackBuffer . +.PP If events, replies, or errors that contain a drawable (e.g., GraphicsExpose) are generated in response to a request, the drawable returned will be the one specified in the request. - +.PP DBE advertises which visuals support double buffering. - -DBE does not include any timing or synchronization facilities. Applications -that need such facilities (e.g., to maintain a constant frame rate) should -investigate the Synchronization Extension, an X Consortium standard. +.PP +DBE does not include any timing or synchronization facilities. +Applications that need such facilities (e.g., to maintain a constant frame rate) +should investigate the Synchronization Extension, an X Consortium standard. .RE - +.PP .B Window Management Operations - .RS +.PP The basic philosophy of DBE is that both buffers are treated the same by X window management operations. - +.PP When a double-buffered window is destroyed, both buffers associated with the window are destroyed, and all back buffer names associated with the window are freed. - +.PP If the size of a double-buffered window changes, both buffers assume the new size. If the window's size increases, the effect on the buffers depends on whether the implementation honors bit gravity for buffers. If bit gravity is implemented, then the contents of both buffers are moved in accordance with the window's bit gravity, -and the remaining areas are tiled with the window background. If -bit gravity is not implemented, then the entire unobscured region of both -buffers is tiled with the window background. In either case, Expose events are +and the remaining areas are tiled with the window background. +If bit gravity is not implemented, then the entire unobscured region of both +buffers is tiled with the window background. +In either case, Expose events are generated for the region that is tiled with the window background. - +.PP If the .B XGetGeometry() function is executed on an -.I XdbeBackBuffer, +.BR XdbeBackBuffer , the returned x, y, and border-width will be zero. - +.PP If the Shape extension .B ShapeRectangles, ShapeMask, ShapeCombine, or .B ShapeOffset request is executed on a double-buffered window, both -buffers are reshaped to match the new window shape. The region difference -D = new shape - old shape is tiled with the window background in both +buffers are reshaped to match the new window shape. +The region difference +\fID = new shape - old shape\fP is tiled with the window background in both buffers, and Expose events are generated for D. .RE - +.PP .B Complex Swap Actions - .RS +.PP DBE has no explicit knowledge of ancillary buffers (e.g. depth buffers or -alpha buffers), and only has a limited set of defined swap actions. Some -applications may need a richer set of swap actions than DBE provides. Some -DBE implementations have knowledge of ancillary buffers, and/or can provide -a rich set of swap actions. Instead of continually extending DBE to increase -its set of swap actions, DBE provides a flexible "idiom" mechanism. If an -application's needs are served by the defined swap actions, it should use +alpha buffers), and only has a limited set of defined swap actions. +Some applications may need a richer set of swap actions than DBE provides. +Some DBE implementations have knowledge of ancillary buffers, +and/or can provide a rich set of swap actions. +Instead of continually extending DBE to increase +its set of swap actions, DBE provides a flexible "idiom" mechanism. +If an application's needs are served by the defined swap actions, it should use them; otherwise, it should use the following method of expressing a complex -swap action as an idiom. Following this policy will ensure the best possible +swap action as an idiom. +Following this policy will ensure the best possible performance across a wide variety of implementations. - +.PP As suggested by the term "idiom," a complex swap action should be expressed -as a group/series of requests. Taken together, this group of requests may be -combined into an atomic operation by the implementation, in order to -maximize performance. The set of idioms actually recognized for optimization -is implementation dependent. To help with idiom expression and +as a group/series of requests. +Taken together, this group of requests may be combined into an atomic operation +by the implementation, in order to maximize performance. +The set of idioms actually recognized for optimization +is implementation dependent. +To help with idiom expression and interpretation, an idiom must be surrounded by two function calls: .B XdbeBeginIdiom() and @@ -235,40 +250,41 @@ and Unless this begin-end pair surrounds the idiom, it may not be recognized by a given implementation, and performance will suffer. - +.PP For example, if an application wants to swap buffers for two windows, and use X to clear only certain planes of the back buffers, the application would make the following calls as a group, and in the following order: - .RS +.PP .B XdbeBeginIdiom(). - +.PP .B XdbeSwapBuffers() with XIDs for two windows, each of which uses a swap action of Untouched. - +.PP .B XFillRectangle() to the back buffer of one window. - +.PP .B XFillRectangle() to the back buffer of the other window. - +.PP .B XdbeEndIdiom(). .RE - +.PP The .B XdbeBeginIdiom() and .B XdbeEndIdiom() functions do not perform any -actions themselves. They are treated as markers by implementations that can +actions themselves. +They are treated as markers by implementations that can combine certain groups/series of requests as idioms, and are ignored by other -implementations or for non-recognized groups/series of requests. If these -function calls are made out of order, or are mismatched, no errors are sent, -and the functions are executed as usual, though performance may suffer. - +implementations or for non-recognized groups/series of requests. +If these function calls are made out of order, or are mismatched, no errors are +sent, and the functions are executed as usual, though performance may suffer. +.PP .B XdbeSwapBuffers() -need not be included in an idiom. For -example, if a swap action of Copied is desired, but only some of the planes +need not be included in an idiom. +For example, if a swap action of Copied is desired, but only some of the planes should be copied, .B XCopyArea() may be used instead of @@ -277,12 +293,14 @@ If .B XdbeSwapBuffers() is included in an idiom, it should immediately follow the .B XdbeBeginIdiom() -call. Also, when the +call. +Also, when the .B XdbeSwapBuffers() is included in an idiom, that request's swap action will still be valid, and if the swap action might overlap with another request, then the final result of the idiom must be as if the separate requests were executed -serially. For example, if the specified swap action is Untouched, and if a +serially. +For example, if the specified swap action is Untouched, and if a .B XFillRectangle() using a client clip rectangle is done to the window's back buffer after the @@ -290,24 +308,24 @@ buffer after the call, then the contents of the new back buffer (after the idiom) will be the same as if the idiom was not recognized by the implementation. - +.PP It is highly recommended that API providers define, and application developers use, "convenience" functions that allow client applications to call -one procedure that encapsulates common idioms. These functions will -generate the +one procedure that encapsulates common idioms. +These functions will generate the .B XdbeBeginIdiom(), idiom, and .B XdbeEndIdiom() -calls. Usage of these functions will ensure best possible +calls. +Usage of these functions will ensure best possible performance across a wide variety of implementations. .SH SEE ALSO -.I XdbeAllocateBackBufferName(), -.I XdbeBeginIdiom(), -.I XdbeDeallocateBackBufferName(), -.I XdbeEndIdiom(), -.I XdbeFreeVisualInfo(), -.I XdbeGetBackBufferAttributes(), -.I XdbeGetVisualInfo(), -.I XdbeQueryExtension(), -.I XdbeSwapBuffers(). - +.BR XdbeAllocateBackBufferName (__libmansuffix__), +.BR XdbeBeginIdiom (__libmansuffix__), +.BR XdbeDeallocateBackBufferName (__libmansuffix__), +.BR XdbeEndIdiom (__libmansuffix__), +.BR XdbeFreeVisualInfo (__libmansuffix__), +.BR XdbeGetBackBufferAttributes (__libmansuffix__), +.BR XdbeGetVisualInfo (__libmansuffix__), +.BR XdbeQueryExtension (__libmansuffix__), +.BR XdbeSwapBuffers (__libmansuffix__). diff --git a/man/DPMSCapable.man b/man/DPMSCapable.man index 6a7edaf..8148835 100644 --- a/man/DPMSCapable.man +++ b/man/DPMSCapable.man @@ -29,15 +29,14 @@ .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER .\" DEALINGS IN THE SOFTWARE. .\" -.TH DPMSCapable __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH DPMSCapable __libmansuffix__ 2005-06-28 __xorgversion__ .SH NAME DPMSCapable \- returns the DPMS capability of the X server .SH SYNOPSIS -.PP .nf \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ] \&#include <X11/extensions/dpms.h> -.HP +.sp .BR "Bool DPMSCapable" " ( Display *\fIdisplay\fP\^ );" .if n .ti +5n .if t .ti +.5i @@ -46,20 +45,19 @@ DPMSCapable \- returns the DPMS capability of the X server .I display Specifies the connection to the X server .SH DESCRIPTION -.LP The -.I DPMSCapable +.B DPMSCapable function returns the Display Power Management Signaling (DPMS) capability of the X server, either TRUE \^(capable of DPMS\^) or FALSE \^(incapable of DPMS\^). .SH "RETURN VALUES" .TP 15 -True +.B True The -.I DPMSCapable +.B DPMSCapable function returns True if the X server is capable of DPMS. .TP 15 -False +.B False The -.I DPMSCapable +.B DPMSCapable function returns True if the X server is incapable of DPMS. diff --git a/man/DPMSDisable.man b/man/DPMSDisable.man index 795442e..fc7e45b 100644 --- a/man/DPMSDisable.man +++ b/man/DPMSDisable.man @@ -29,15 +29,14 @@ .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER .\" DEALINGS IN THE SOFTWARE. .\" -.TH DPMSDisable __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH DPMSDisable __libmansuffix__ 2005-06-28 __xorgversion__ .SH NAME DPMSDisable \- disables DPMS on the specified display .SH SYNOPSIS -.PP .nf \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ] \&#include <X11/extensions/dpms.h> -.HP +.sp .BR "Status DPMSDisable" " ( Display \fI*display\fP\^ );" .if n .ti +5n .if t .ti +.5i @@ -46,19 +45,20 @@ DPMSDisable \- disables DPMS on the specified display .I display Specifies the connection to the X server .SH DESCRIPTION -.LP The -.I DPMSDisable +.B DPMSDisable function disables Display Power Management Signaling (DPMS) on the specified -display. When disabled, DPMS sets the display to DPMSModeOn. If -.I DPMSDisable +.IR display . +When disabled, DPMS sets the display to DPMSModeOn. +If +.B DPMSDisable is invoked on a display with DPMS already disabled or on a display which does not support DPMS, no change is made and no error is returned. .SH "RETURN VALUES" .TP 15 -TRUE +.B TRUE The -.I DPMSDisable +.B DPMSDisable function always returns TRUE. .SH "SEE ALSO" .BR DPMSCapable (__libmansuffix__), diff --git a/man/DPMSEnable.man b/man/DPMSEnable.man index e1f6c7f..10d8a08 100644 --- a/man/DPMSEnable.man +++ b/man/DPMSEnable.man @@ -31,15 +31,14 @@ .\" .\" X Window System is a trademark of The Open Group. .\" -.TH DPMSEnable __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH DPMSEnable __libmansuffix__ 2005-06-28 __xorgversion__ .SH NAME DPMSEnable \- enables DPMS on the specified display .SH SYNOPSIS -.PP .nf \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ] \&#include <X11/extensions/dpms.h> -.HP +.sp .BR "Status DPMSEnable" " ( Display *\fIdisplay\fP\^ );" .if n .ti +5n .if t .ti +.5i @@ -48,27 +47,27 @@ DPMSEnable \- enables DPMS on the specified display .I display Specifies the connection to the X server .SH DESCRIPTION -.LP The -.I DPMSEnable +.B DPMSEnable function enables Display Power Management Signaling (DPMS) on the specified -.I display. -When DPMS is enabled, DPMS will use the currently saved timeout values. It will -trigger the appropriate DPMS power level based on the timeout values. Refer to -.I DPMSSetTimeouts. +.IR display . +When DPMS is enabled, DPMS will use the currently saved timeout values. +It will trigger the appropriate DPMS power level based on the timeout values. +Refer to +.BR DPMSSetTimeouts (__libmansuffix__). All physical screens are affected by -.I DPMSEnable +.B DPMSEnable at the same time. - +.PP If -.I DPMSEnable +.B DPMSEnable is invoked on a display which has DPMS already enabled, or on a display which does not support DPMS, no change is made and no error is returned. .SH "RETURN VALUES" .TP 15 -TRUE +.B TRUE The -.I DPMSEnable +.B DPMSEnable function always returns TRUE. .SH "SEE ALSO" .BR DPMSCapable (__libmansuffix__), diff --git a/man/DPMSForceLevel.man b/man/DPMSForceLevel.man index 438d55c..becd457 100644 --- a/man/DPMSForceLevel.man +++ b/man/DPMSForceLevel.man @@ -31,47 +31,57 @@ .\" .\" X Window System is a trademark of The Open Group. .\" -.TH DPMSForceLevel __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH DPMSForceLevel __libmansuffix__ 2005-06-28 __xorgversion__ .SH NAME DPMSForceLevel \- forces a DPMS capable display into the specified power level .SH SYNOPSIS -.PP .nf \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ] \&#include <X11/extensions/dpms.h> -.HP +.sp .BR "Status DPMSForceLevel" " ( Display \fI*display\fP\^, CARD16 \fIlevel\fP\^ );" .if n .ti +5n .if t .ti +.5i .SH ARGUMENTS -.TP +.TP 15 .I display Specifies the connection to the X server -.TP +.TP 15 .I level Specifies the level to force power to .SH DESCRIPTION -.LP The -.I DPMSForceLevel -function forces a DPMS capable display into the specified power level. The -\fIlevel\fP must be one of following four states: DPMSModeOn, DPMSModeStandby, -DPMSModeSuspend, or DPMSModeOff. Values other than these will result in a -BadValue error. If DPMS -is disabled on the display, trying to set the power level on the display will -result in a BadMatch +.B DPMSForceLevel +function forces a DPMS capable display into the specified power level. +The \fIlevel\fP must be one of following four states: +.BR DPMSModeOn , +.BR DPMSModeStandby , +.BR DPMSModeSuspend , +or +.BR DPMSModeOff . +Values other than these will result in a +.B BadValue +error. +If DPMS is disabled on the display, +trying to set the power level on the display will result in a +.B BadMatch protocol error. .SH "RETURN VALUES" .TP 15 -TRUE +.B TRUE The .I DPMSForceLevel function always returns TRUE. .SH ERRORS .TP 15 -BadValue -A level other than DPMSModeOn, DPMSModeStandby, DPMSModeSuspend, or DPMSModeOff +.SM BadValue +A level other than +.BR DPMSModeOn , +.BR DPMSModeStandby , +.BR DPMSModeSuspend , +or +.B DPMSModeOff was specified. .TP 15 .SM BadMatch diff --git a/man/DPMSGetTimeouts.man b/man/DPMSGetTimeouts.man index f4689a2..6bfbdfd 100644 --- a/man/DPMSGetTimeouts.man +++ b/man/DPMSGetTimeouts.man @@ -31,71 +31,64 @@ .\" .\" X Window System is a trademark of The Open Group. .\" -.TH DPMSGetTimeouts __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH DPMSGetTimeouts __libmansuffix__ 2005-06-28 __xorgversion__ .SH NAME DPMSGetTimeouts \- retrieves the timeout values used by the X server for DPMS timings .SH SYNOPSIS -.PP .nf \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ] \&#include <X11/extensions/dpms.h> -.HP -.B Bool DPMSGetTimeouts -( -.br +.sp +.B Bool DPMSGetTimeouts ( Display *\fIdisplay\fP\^, -.br CARD16 *\fIstandby\fP\^, -.br CARD16 *\fIsuspend\fP\^, -.br CARD16 *\fIoff\fP\^ ); .if n .ti +5n .if t .ti +.5i .SH ARGUMENTS -.TP +.TP 15 .I display Specifies the connection to the X server -.TP +.TP 15 .I standby Specifies the current standby timeout in seconds -.TP +.TP 15 .I suspend Specifies the current suspend timeout in seconds -.TP +.TP 15 .I off Specifies the current off timeout in seconds .SH DESCRIPTION -.LP The -.I DPMSGetTimeouts +.B DPMSGetTimeouts function retrieves the timeout values used by the X server for DPMS timings. .LP The value .I standby -is the amount of time of inactivity in seconds before standby mode is invoked. A -value of zero indicates that this mode has been disabled. +is the amount of time of inactivity in seconds before standby mode is invoked. +A value of zero indicates that this mode has been disabled. .LP The value \fIsuspend\fP is the amount of time of inactivity in seconds before -the second level of power savings is invoked. A value of zero indicates that -this mode has been disabled. +the second level of power savings is invoked. +A value of zero indicates that this mode has been disabled. .LP The value \fIoff\fP is the amount of time of inactivity in seconds before the -third and final level of power savings is invoked. A value of zero indicates -that this mode has been disabled. +third and final level of power savings is invoked. +A value of zero indicates that this mode has been disabled. .SH "RETURN VALUES" .TP 15 -TRUE +.B TRUE The .I DPMSGetTimeouts function returns TRUE when values are returned. .TP 15 -FALSE +.B FALSE The .I DPMSGetTimeouts -function returns FALSE when no values returned. +function returns FALSE when no values are returned. .SH "SEE ALSO" .BR DPMSCapable (__libmansuffix__), .BR DPMSInfo (__libmansuffix__), diff --git a/man/DPMSGetVersion.man b/man/DPMSGetVersion.man index e10ae8b..5c40f6c 100644 --- a/man/DPMSGetVersion.man +++ b/man/DPMSGetVersion.man @@ -31,56 +31,51 @@ .\" .\" X Window System is a trademark of The Open Group. .\" -.TH DPMSGetVersion __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH DPMSGetVersion __libmansuffix__ 2005-09-24 __xorgversion__ .SH NAME DPMSGetVersion \- returns the version of the DPMS extension implemented by the X server .SH SYNOPSIS -.PP .nf \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ] \&#include <X11/extensions/dpms.h> -.HP -.B Status DPMSGetVersion -( -.br +.sp +.B Status DPMSGetVersion ( Display *\fIdisplay\fP\^, -.br int *\fImajor_version\fP\^, -.br int *\fIminor_version\fP\^ ); .if n .ti +5n .if t .ti +.5i .SH ARGUMENTS -.TP +.TP 15 .I display Specifies the connection to the X server -.TP +.TP 15 .I major_version Specifies the return location for the extension major version -.TP +.TP 15 .I minor_version Specifies the return location for the extension minor version .SH DESCRIPTION -.LP The -.I DPMSGetVersion +.B DPMSGetVersion function returns the version of the Display Power Management Signaling (DPMS) -extension implemented by the X server. It returns a major and minor version -number. The major version number will be incremented for protocol incompatible -changes, and the minor version number will be incremented for small, upward -compatible changes. +extension implemented by the X server. +It returns a major and minor version number. +The major version number will be incremented for protocol incompatible changes, +and the minor version number will be incremented for small, upward compatible +changes. .SH "RETURN VALUES" .TP 15 -TRUE +.B TRUE The -.I DPMSGetVersion +.B DPMSGetVersion function returns TRUE when the extension is supported and values are returned. .TP 15 -FALSE +.B FALSE The -.I DPMSGetVersion +.B DPMSGetVersion function returns FALSE when the extension is not supported. .SH "SEE ALSO" .BR DPMSCapable (__libmansuffix__), diff --git a/man/DPMSInfo.man b/man/DPMSInfo.man index f25c83a..791472c 100644 --- a/man/DPMSInfo.man +++ b/man/DPMSInfo.man @@ -31,54 +31,53 @@ .\" .\" X Window System is a trademark of The Open Group. .\" -.TH DPMSInfo __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH DPMSInfo __libmansuffix__ 2005-06-28 __xorgversion__ .SH NAME DPMSInfo \- returns information about the current DPMS state .SH SYNOPSIS -.PP .nf \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ] \&#include <X11/extensions/dpms.h> -.HP -.B Status DPMSInfo -( -.br +.sp +.B Status DPMSInfo ( Display \fI*display\fP\^, -.br CARD16 \fI*power_level\fP\^, -.br BOOL \fI*state\fP\^ ); .if n .ti +5n .if t .ti +.5i .SH ARGUMENTS -.TP +.TP 15 .I display Specifies the connection to the X server -.TP +.TP 15 .I power_level Specifies the current power level -.TP +.TP 15 .I state Specifies the current DPMS state .SH DESCRIPTION -.LP The -.I DPMSInfo +.B DPMSInfo function returns information about the current Display Power Management -Signaling (DPMS) state. The \fIstate\fP -return parameter indicates whether or not DPMS is enabled \^(TRUE\^) or -disabled \^(FALSE\^). The \fIpower_level\fP return parameter indicates the -current power level \^(one of DPMSModeOn, DPMSModeStandby, DPMSModeSuspend, or -DPMSModeOff.\^) +Signaling (DPMS) state. +The \fIstate\fP return parameter indicates whether or not DPMS is +enabled \^(TRUE\^) or disabled \^(FALSE\^). +The \fIpower_level\fP return parameter indicates the +current power level \^(one of +.BR DPMSModeOn , +.BR DPMSModeStandby , +.BR DPMSModeSuspend , +or +.BR DPMSModeOff .\^) .SH "RETURN VALUES" .TP 15 -TRUE +.B TRUE The .I DPMSInfo function returns TRUE, if values are returned. .TP 15 -FALSE +.B FALSE The .I DPMSInfo function returns FALSE, if no values are returned. diff --git a/man/DPMSQueryExtension.man b/man/DPMSQueryExtension.man index dfb2e4a..fda7476 100644 --- a/man/DPMSQueryExtension.man +++ b/man/DPMSQueryExtension.man @@ -31,59 +31,52 @@ .\" .\" X Window System is a trademark of The Open Group. .\" -.TH DPMSQueryExtension __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH DPMSQueryExtension __libmansuffix__ 2005-09-24 __xorgversion__ .SH NAME DPMSQueryExtension \- queries the X server to determine the availability of the DPMS Extension .SH SYNOPSIS -.PP .nf \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ] \&#include <X11/extensions/dpms.h> -.HP -.B Bool DPMSQueryExtension -( -.br +.sp +.B Bool DPMSQueryExtension ( Display \fI*display\fP\^, -.br int \fI*event_base\fP\^, -.br int \fI*error_base\fP\^ ); .if n .ti +5n .if t .ti +.5i .SH ARGUMENTS -.TP +.TP 15 .I display Specifies the connection to the X server -.TP +.TP 15 .I event_base Specifies the return location for the assigned base event -.TP +.TP 15 .I error_base Specifies the return location for the assigned base error .SH DESCRIPTION -.LP The -.I DPMSQueryExtension +.B DPMSQueryExtension function queries the X server to determine the availability of the -Display Power Management Signaling (DPMS) -Extension. If the extension is available, it returns TRUE, and the +Display Power Management Signaling (DPMS) Extension. +If the extension is available, it returns TRUE, and the .I event_base and .I error_base -are set to the base event and error numbers, respectively. Otherwise, the -return value is FALSE, and the -values of +are set to the base event and error numbers, respectively. +Otherwise, the return value is FALSE, and the values of .I event_base and .I error_base are undefined. .SH "RETURN VALUES" .TP 15 -TRUE +.B TRUE The -.I DPMSQueryExtension +.B DPMSQueryExtension function returns TRUE if the extension is available, and .I event_base @@ -92,9 +85,9 @@ and are set to the base event number and base error number for the extension, respectively. .TP 15 -FALSE +.B FALSE The -.I DPMSQueryExtension +.B DPMSQueryExtension function returns FALSE if extension is not available, and the values of .I event_base and diff --git a/man/DPMSSetTimeouts.man b/man/DPMSSetTimeouts.man index 77f3af6..3be4823 100644 --- a/man/DPMSSetTimeouts.man +++ b/man/DPMSSetTimeouts.man @@ -31,90 +31,82 @@ .\" .\" X Window System is a trademark of The Open Group. .\" -.TH DPMSSetTimeouts __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH DPMSSetTimeouts __libmansuffix__ 2005-06-28 __xorgversion__ .SH NAME DPMSSetTimeouts \- permits applications to set the timeout values used by the X server for DPMS timings .SH SYNOPSIS -.PP .nf \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ] \&#include <X11/extensions/dpms.h> -.HP -.B Status DPMSSetTimeouts -( -.br +.sp +.B Status DPMSSetTimeouts ( Display *\fIdisplay\fP\^, -.br CARD16 \fIstandby\fP\^, -.br CARD16 \fIsuspend\fP\^, -.br CARD16 \fIoff\fP\^ ); .if n .ti +5n .if t .ti +.5i .SH ARGUMENTS -.TP +.TP 15 .I display Specifies the connection to the X server -.TP +.TP 15 .I standby Specifies the new standby timeout in seconds -.TP +.TP 15 .I suspend Specifies the new suspend timeout in seconds -.TP +.TP 15 .I off Specifies the new off timeout in seconds .SH DESCRIPTION -.LP -The DPMSSetTimeouts function permits applications to set the timeout values +The +.B DPMSSetTimeouts +function permits applications to set the timeout values used by the X server for Display Power Management Signaling (DPMS) timings. .LP The value \fIstandby\fP is the amount of inactivity time, in seconds, before -standby mode is invoked. The actual -effects of this mode are dependent on the characteristics of the monitor and -frame buffer card. Standby mode is -implemented by shutting off the horizontal sync signal, and pulsing the vertical -sync signal. Standby mode -provides the quickest monitor recovery time. Note also that many monitors -implement this mode identical to -suspend mode. A value of zero disables the standby mode. +standby mode is invoked. +The actual effects of this mode are dependent on the characteristics of the +monitor and frame buffer card. +Standby mode is implemented by shutting off the horizontal sync signal, +and pulsing the vertical sync signal. +Standby mode provides the quickest monitor recovery time. +Note also that many monitors implement this mode identical to suspend mode. +A value of zero disables the standby mode. .LP -The value \fIsuspend\fP is the amount of time of inactivity, in seconds, before -the second level of power -savings is invoked. Suspend mode's physical and electrical characteristics are -implementation defined. For DPMS -compliant hardware, setting the suspend mode is implemented by pulsing the -horizontal sync signal and -shutting off the vertical sync signal. In general, suspend mode recovery is -considered to be slower than -standby mode, but faster than off mode. However it may vary from monitor to -monitor. As noted above, many -monitors implement this mode identical to the standby mode. A value of zero -disables this mode. +The value \fIsuspend\fP is the amount of time of inactivity, in seconds, +before the second level of power savings is invoked. +Suspend mode's physical and electrical characteristics are +implementation defined. +For DPMS compliant hardware, setting the suspend mode is implemented by +pulsing the horizontal sync signal and shutting off the vertical sync signal. +In general, suspend mode recovery is considered to be slower than +standby mode, but faster than off mode. +However it may vary from monitor to monitor. +As noted above, many monitors implement this mode identical to the standby mode. +A value of zero disables this mode. .LP -The value \fIoff\fP is the amount of time of inactivity, in seconds, before the -third and final level of power -savings is invoked. Off mode's physical and electrical characteristics are -implementation defined. In DPMS -compliant hardware, it is implemented by shutting off both horizontal and -vertical sync signals, resulting in -powering down of the monitor. Recovery time is implementation dependent. -Usually the recovery time is very -close to the power-up time of the monitor. A value of zero disables this mode. +The value \fIoff\fP is the amount of time of inactivity, in seconds, +before the third and final level of power savings is invoked. +Off mode's physical and electrical characteristics are implementation defined. +In DPMS compliant hardware, it is implemented by shutting off both horizontal +and vertical sync signals, resulting in powering down of the monitor. +Recovery time is implementation dependent. +Usually the recovery time is very close to the power-up time of the monitor. +A value of zero disables this mode. .LP -Chronologically, \fIstandby\fP mode occurs before or simultaneously with -\fIsuspend\fP mode, and +Chronologically, +\fIstandby\fP mode occurs before or simultaneously with \fIsuspend\fP mode, and \fIsuspend\fP mode must occur before or simultaneously with \fIoff\fP mode. -Therefore, non-zero mode timeout -values must be greater than or equal to the timeout values of earlier modes. If -inconsistent values are -supplied, a BadValue error will result. +Therefore, non-zero mode timeout values must be greater than or equal to the +timeout values of earlier modes. +If inconsistent values are supplied, a \fBBadValue\fP error will result. .SH "RETURN VALUES" .TP 15 -TRUE +.B TRUE The .I DPMSSetTimeouts function returns TRUE when the function has succeeded. diff --git a/man/XShape.man b/man/XShape.man index feff37c..4176c32 100644 --- a/man/XShape.man +++ b/man/XShape.man @@ -23,13 +23,12 @@ .\" dealing in this Software without prior written authorization from the .\" X Consortium. .\" -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.TH XSHAPE __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH XSHAPE __libmansuffix__ 1994-04-17 __xorgversion__ .SH NAME -XShapeQueryExtension, XShapeQueryVersion, XShapeCombineRegion, XShapeCombineRectangles, XShapeCombineMask, XShapeCombineShape, XShapeOffsetShape, XShapeQueryExtents, XShapeSelectInput, XShapeInputSelected, XShapeGetRectangles \- X nonrectangular shape functions +XShapeQueryExtension, XShapeQueryVersion, XShapeCombineRegion, +XShapeCombineRectangles, XShapeCombineMask, XShapeCombineShape, +XShapeOffsetShape, XShapeQueryExtents, XShapeSelectInput, XShapeInputSelected, +XShapeGetRectangles \- X nonrectangular shape functions .SH SYNTAX .nf .LP @@ -145,27 +144,27 @@ windows to the X Window System. Operations: .RS .nf -.ZN ShapeSet -.ZN ShapeUnion -.ZN ShapeIntersect -.ZN ShapeSubtract -.ZN ShapeInvert +.B ShapeSet +.B ShapeUnion +.B ShapeIntersect +.B ShapeSubtract +.B ShapeInvert .fi .RE .sp Shape Kinds: .RS .nf -.ZN ShapeBounding -.ZN ShapeClip +.B ShapeBounding +.B ShapeClip .fi .RE .sp Event defines: .RS .nf -.ZN ShapeNotifyMask -.ZN ShapeNotify +.B ShapeNotifyMask +.B ShapeNotify .fi .RE .SH BUGS diff --git a/man/XShm.man b/man/XShm.man index c7fedd4..1d316fa 100644 --- a/man/XShm.man +++ b/man/XShm.man @@ -46,14 +46,11 @@ .\" .\" X Window System is a trademark of The Open Group. .\" -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.TH XShm __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH XShm __libmansuffix__ 2010-07-22 __xorgversion__ .SH NAME XShmQueryExtension, XShmQueryVersion, XShmPixmapFormat, XShmAttach, XShmDetach -XShmCreateImage, XShmPutImage, XShmGetImage, XShmCreatePixmap, XShmGetEventBase - X Shared Memory extension functions +XShmCreateImage, XShmPutImage, XShmGetImage, XShmCreatePixmap, XShmGetEventBase +- X Shared Memory extension functions .SH SYNTAX .nf .LP @@ -80,7 +77,6 @@ Bool XShmAttach( Bool XShmDetach( Display *display; XShmSegmentInfo *shminfo); - .LP XImage *XShmCreateImage ( Display *display; @@ -116,13 +112,12 @@ Pixmap XShmCreatePixmap( .LP Status XShmGetEventBase( Display *display); -.LP - .fi .SH STRUCTURES .nf .ta 3i \fIEvents:\fP +.sp typedef struct { int type; /\&* of event */ unsigned long serial; /\&* # of last request processed by server*/ @@ -136,63 +131,72 @@ typedef struct { } XShmCompletionEvent; .LP \fIa structure of type XShmSegmentInfo :\fP - +.sp typedef struct { ShmSeg shmseg; /\&* resource id */ int shmid; /\&* kernel id */ char *shmaddr; /\&* address in client */ Bool readOnly; /\&* how the server should attach it */ } XShmSegmentInfo; - .SH DESCRIPTION -.PP -.PP -.ZN XShmQueryExtension +.B XShmQueryExtension checks to see if the shared memory extensions are available for the specified display. .PP -.ZN XShmQueryVersion -returns the version numbers of the extension implementation. Shared -memory pixmaps are supported if the pixmaps argument returns true. +.B XShmQueryVersion +returns the version numbers of the extension implementation. +Shared memory pixmaps are supported if the +.I pixmaps +argument returns true. .PP -.ZN XShmAttach -tells the server to attach to your shared memory segment. If all goes -well, you will get a non-zero status, back and your XImage is ready -for use. +.B XShmAttach +tells the server to attach to your shared memory segment. +If all goes well, you will get a non-zero status back, +and your XImage is ready for use. .PP -.ZN XShmDetach +.B XShmDetach tells the server to detach from your shared memory segment. .PP -.ZN XShmPutImage -combines an image in memory with a shape of the specified drawable. If -XYBitmap format is used, the depth must be one, or a ``BadMatch'' -error results. The foreground pixel in the GC defines the source for -the one bits in the image, and the background pixel defines the source -for the zero bits. For XYPixmap and ZPixmap, the depth must match the -depth of the drawable, or a ``BadMatch'' error results. +.B XShmPutImage +combines an image in memory with a shape of the specified drawable. +If XYBitmap format is used, the depth must be one, or a +.B BadMatch +error results. +The foreground pixel in the GC defines the source for the one bits in the image, +and the background pixel defines the source for the zero bits. +For XYPixmap and ZPixmap, the depth must match the +depth of the drawable, or a +.B BadMatch +error results. .PP -.ZN XShmGetImage -reads image data into a shared memory XImage where display is the -display of interest, drawable is the source drawable, image is the -destination XImage, x and y are offsets within the drawable, and -plane_mask defines which planes are to be read. +.B XShmGetImage +reads image data into a shared memory XImage where +.I display +is the display of interest, +.I drawable +is the source drawable, +.I image +is the destination XImage, +.IR x " and " y +are offsets within the drawable, and +.I plane_mask +defines which planes are to be read. .PP -.ZN XShmCreateImage +.B XShmCreateImage allocates the memory needed for an XImage structure for the specified display but does not allocate space for the image itself. .PP -.ZN XShmPixmapFormat -gets the format for the server. If your application can deal with the -server pixmap data format, a shared memory segment and shminfo -structure are created. +.B XShmPixmapFormat +gets the format for the server. +If your application can deal with the server pixmap data format, +a shared memory segment and shminfo structure are created. .PP -.ZN XShmCreatePixmap +.B XShmCreatePixmap points to a pixmap which you can manipulate in all of the usual ways, with the added bonus of being able to edit its contents directly through the shared memory segment. .PP -.ZN XShmGetEventBase +.B XShmGetEventBase gets the completion event value. -.PP .SH SEE ALSO -\fIMIT-SHM - The MIT Shared Memory Extension \fP +\fIMIT-SHM - The MIT Shared Memory Extension\fP diff --git a/man/XcupGetReservedColormapEntries.man b/man/XcupGetReservedColormapEntries.man index 9439601..0a7b284 100644 --- a/man/XcupGetReservedColormapEntries.man +++ b/man/XcupGetReservedColormapEntries.man @@ -22,21 +22,16 @@ .\" .\" X Window System is a trademark of The Open Group. .\" -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.TH XCUP __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH XcupGetReservedColormapEntries __libmansuffix__ 2005-01-22 __xorgversion__ .SH NAME XcupGetReservedColormapEntries \- list colormap entries reserved by the system .SH SYNOPSIS -.PP .nf \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ] \&#include <X11/extensions/Xcup.h> -.HP +.sp Status \fBXcupGetReservedColormapEntries\fP\^(\^Display *\fIdisplay\fP\^, -int \fIscreen\fP\^, XColor **\fIcolors_out\fP\^, int *\fIncolors\fP\^); + int \fIscreen\fP\^, XColor **\fIcolors_out\fP\^, int *\fIncolors\fP\^); .if n .ti +5n .if t .ti +.5i .SH ARGUMENTS @@ -49,22 +44,23 @@ Returns the values reserved by the server. .IP \fIncolors\fP 1i Returns the number of items in \fIcolors_out\fP. .SH DESCRIPTION -.LP The -.ZN XcupGetReservedColormapEntries +.B XcupGetReservedColormapEntries function returns a list of colormap entries (pixels) that are reserved -by the system. This list will, at a minimum, contain entries for the -BlackPixel and WhitePixel of the specified screen. Use -.ZN XFree +by the system. +This list will, at a minimum, contain entries for the +BlackPixel and WhitePixel of the specified screen. +Use +.B XFree to free .I colors_out. .LP To minimize colormap flash, an application which installs its own private colormap should query the special colors by calling -.ZN XCupGetReservedColormapEntries , +.BR XCupGetReservedColormapEntries , and can then store those entries (in the proper location) in its private colormap using -.ZN XCupStoreColors . +.BR XCupStoreColors . .SH "SEE ALSO" .BR XcupQueryVersion (3Xext), .BR XcupStoreColors (3Xext), diff --git a/man/XcupQueryVersion.man b/man/XcupQueryVersion.man index a77fc3d..bcdc3a1 100644 --- a/man/XcupQueryVersion.man +++ b/man/XcupQueryVersion.man @@ -22,21 +22,16 @@ .\" .\" X Window System is a trademark of The Open Group. .\" -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.TH XcupQueryVersion __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH XcupQueryVersion __libmansuffix__ 2005-01-22 __xorgversion__ .SH NAME XcupQueryVersion \- Returns TOG-CUP protocol version supported by the X server .SH SYNOPSIS -.PP .nf \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ] \&#include <X11/extensions/Xcup.h> -.HP +.sp Status \fBXcupQueryVersion\fP\^(\^Display *\fIdisplay\fP\^, -int *\fImajor_version_return\fP\^, int *\fIminor_version_return\fP\^); + int *\fImajor_version_return\fP\^, int *\fIminor_version_return\fP\^); .if n .ti +5n .if t .ti +.5i .SH ARGUMENTS @@ -47,26 +42,28 @@ Returns the major version supported by the server .IP \fIminor_version_return\fP 1i Returns the minor version supported by the server .SH DESCRIPTION -.LP -.ZN XcupQueryVersion +.B XcupQueryVersion sets .I major_version_return and .I minor_version_return to the major and minor TOG-CUP protocol version supported by the -server. If the TOG-CUP library is compatible with the version returned -by the server, it returns nonzero. If the server does not support the TOG-CUP -extension, or if there was an error during communications with the -server, or if the server and library protocol versions are -incompatible, it returns zero. No other Xcup functions may be called -before this function. If a client violates this rule, the effects of +server. +If the TOG-CUP library is compatible with the version returned +by the server, it returns nonzero. +If the server does not support the TOG-CUP extension, +or if there was an error during communications with the server, +or if the server and library protocol versions are incompatible, +it returns zero. +No other Xcup functions may be called before this function. +If a client violates this rule, the effects of all subsequent Xcup calls that it makes are undefined. .LP To get the list of reserved colormap entries, use -.ZN XcupGetReservedColormapEntries. +.BR XcupGetReservedColormapEntries . .LP To allocate one or more read-only color cells with RGB values, use -.ZN XcupStoreColors. +.BR XcupStoreColors . .SH "SEE ALSO" .BR XcupGetReservedColormapEntries (3Xext), .BR XcupStoreColors (3Xext), diff --git a/man/XcupStoreColors.man b/man/XcupStoreColors.man index 043fff2..3f176d6 100644 --- a/man/XcupStoreColors.man +++ b/man/XcupStoreColors.man @@ -22,21 +22,16 @@ .\" .\" X Window System is a trademark of The Open Group. .\" -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.TH XcupStoreColors __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH XcupStoreColors __libmansuffix__ 2005-01-22 __xorgversion__ .SH NAME XcupStoreColors \- initialize shareable colormap entries at specific locations .SH SYNOPSIS -.PP .nf \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ] \&#include <X11/extensions/Xcup.h> -.HP +.sp Status \fBXcupStoreColors\fP\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^, -XColor *\fIcolors_in_out\fP\^, int \fIncolors\fP\^); + XColor *\fIcolors_in_out\fP\^, int \fIncolors\fP\^); .if n .ti +5n .if t .ti +.5i .SH ARGUMENTS @@ -49,26 +44,26 @@ Specifies and returns the values actually used in the colormap .IP \fIncolors\fP 1i Specifies the number of items in colors_in_out .SH DESCRIPTION -.LP The -.ZN XcupStoreColors +.B XcupStoreColors function changes the colormap entries of the pixel values in the pixel -members of the XColor structures. The colormap entries are allocated -as if an AllocColor has been used instead, i.e. the colors are -read-only (shareable). -.ZN XcupStoreColors +members of the XColor structures. +The colormap entries are allocated as if an AllocColor has been used instead, +i.e. the colors are read-only (shareable). +.B XcupStoreColors returns the number of colors that were successfully allocated in the colormap. .LP A -.ZN Value -error is generated if a pixel is not a valid index into the colormap. A -.ZN BadMatch +.B Value +error is generated if a pixel is not a valid index into the colormap. +A +.B BadMatch error is generated if the colormap does not belong to a GrayScale, PseudoColor, or DirectColor visual. .LP Applications which allocate many colors in a screen's default colormap, e.g. a color-cube or a gray-ramp, should allocate them with -.ZN XCupStoreColors . +.BR XCupStoreColors . By using XCupStoreColors the colors will be allocated shareable (read-only) and any other application which allocates the same color will share that color cell. diff --git a/man/XdbeAllocateBackBufferName.man b/man/XdbeAllocateBackBufferName.man index 1a187a9..724bb93 100644 --- a/man/XdbeAllocateBackBufferName.man +++ b/man/XdbeAllocateBackBufferName.man @@ -23,26 +23,31 @@ .\" dealing in this Software without prior written authorization from the .\" Hewlett-Packard Company. .\" -.TH XdbeAllocateBackBufferName __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH XdbeAllocateBackBufferName __libmansuffix__ 1996-03-11 __xorgversion__ .SH NAME XdbeAllocateBackBufferName - allocates a DBE buffer. .SH SYNOPSIS \&#include <X11/extensions/Xdbe.h> - +.sp +.nf XdbeBackBuffer XdbeAllocateBackBufferName( Display *dpy, Window window, XdbeSwapAction swap_action) +.fi .SH DESCRIPTION This function returns a drawable ID used to refer to the back buffer of the -specified window. The swap_action is a hint to indicate the swap action that +specified window. +The +.I swap_action +is a hint to indicate the swap action that will likely be used in subsequent calls to -.B XdbeSwapBuffers(). -The actual swap -action used in calls to -.B XdbeSwapBuffers() +.BR XdbeSwapBuffers (__libmansuffix__). +The actual swap action used in calls to +.BR XdbeSwapBuffers (__libmansuffix__) does not have to be the same as the -swap_action passed to this function, though clients are encouraged to provide +.I swap_action +passed to this function, though clients are encouraged to provide accurate information whenever possible. .SH ERRORS .IP BadAlloc @@ -55,13 +60,12 @@ An invalid swap action was specified. .IP BadWindow An invalid window was specified. .SH SEE ALSO -DBE, -.I XdbeBeginIdiom(), -.I XdbeDeallocateBackBufferName(), -.I XdbeEndIdiom(), -.I XdbeFreeVisualInfo(), -.I XdbeGetBackBufferAttributes(), -.I XdbeGetVisualInfo(), -.I XdbeQueryExtension(), -.I XdbeSwapBuffers(). - +.BR DBE (__libmansuffix__), +.BR XdbeBeginIdiom (__libmansuffix__), +.BR XdbeDeallocateBackBufferName (__libmansuffix__), +.BR XdbeEndIdiom (__libmansuffix__), +.BR XdbeFreeVisualInfo (__libmansuffix__), +.BR XdbeGetBackBufferAttributes (__libmansuffix__), +.BR XdbeGetVisualInfo (__libmansuffix__), +.BR XdbeQueryExtension (__libmansuffix__), +.BR XdbeSwapBuffers (__libmansuffix__). diff --git a/man/XdbeBeginIdiom.man b/man/XdbeBeginIdiom.man index 18ee070..3a5030d 100644 --- a/man/XdbeBeginIdiom.man +++ b/man/XdbeBeginIdiom.man @@ -23,24 +23,25 @@ .\" dealing in this Software without prior written authorization from the .\" Hewlett-Packard Company. .\" -.TH DBE __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH DBE __libmansuffix__ 1996-03-11 __xorgversion__ .SH NAME XdbeBeginIdiom - marks the beginning of a DBE idiom sequence. .SH SYNOPSIS +.nf \&#include <X11/extensions/Xdbe.h> - +.sp Status XdbeBeginIdiom( Display *dpy) +.fi .SH DESCRIPTION This function marks the beginning of an idiom sequence. .SH SEE ALSO -DBE, -.I XdbeAllocateBackBufferName(), -.I XdbeDeallocateBackBufferName(), -.I XdbeEndIdiom(), -.I XdbeFreeVisualInfo(), -.I XdbeGetBackBufferAttributes(), -.I XdbeGetVisualInfo(), -.I XdbeQueryExtension(), -.I XdbeSwapBuffers(). - +.BR DBE (__libmansuffix__), +.BR XdbeAllocateBackBufferName (__libmansuffix__), +.BR XdbeDeallocateBackBufferName (__libmansuffix__), +.BR XdbeEndIdiom (__libmansuffix__), +.BR XdbeFreeVisualInfo (__libmansuffix__), +.BR XdbeGetBackBufferAttributes (__libmansuffix__), +.BR XdbeGetVisualInfo (__libmansuffix__), +.BR XdbeQueryExtension (__libmansuffix__), +.BR XdbeSwapBuffers (__libmansuffix__). diff --git a/man/XdbeDeallocateBackBufferName.man b/man/XdbeDeallocateBackBufferName.man index a128649..f68324b 100644 --- a/man/XdbeDeallocateBackBufferName.man +++ b/man/XdbeDeallocateBackBufferName.man @@ -23,31 +23,34 @@ .\" dealing in this Software without prior written authorization from the .\" Hewlett-Packard Company. .\" -.TH XdbeDeallocateBackBufferName __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH XdbeDeallocateBackBufferName __libmansuffix__ 1996-03-11 __xorgversion__ .SH NAME XdbeDeallocateBackBufferName - frees a DBE buffer. .SH SYNOPSIS +.nf \&#include <X11/extensions/Xdbe.h> - +.sp Status XdbeDeallocateBackBufferName( Display *dpy, XdbeBackBuffer buffer) +.fi .SH DESCRIPTION -This function frees a drawable ID, buffer, that was obtained via -.B XdbeAllocateBackBufferName(). +This function frees a drawable ID, +.IR buffer , +that was obtained via +.BR XdbeAllocateBackBufferName (__libmansuffix__). The buffer must be a valid name for the back buffer of a window, or a protocol error results. .SH ERRORS .IP BadBuffer The specified buffer is not associated with a window. .SH SEE ALSO -DBE, -.I XdbeAllocateBackBufferName(), -.I XdbeBeginIdiom(), -.I XdbeEndIdiom(), -.I XdbeFreeVisualInfo(), -.I XdbeGetBackBufferAttributes(), -.I XdbeGetVisualInfo(), -.I XdbeQueryExtension(), -.I XdbeSwapBuffers(). - +.BR DBE (__libmansuffix__), +.BR XdbeAllocateBackBufferName (__libmansuffix__), +.BR XdbeBeginIdiom (__libmansuffix__), +.BR XdbeEndIdiom (__libmansuffix__), +.BR XdbeFreeVisualInfo (__libmansuffix__), +.BR XdbeGetBackBufferAttributes (__libmansuffix__), +.BR XdbeGetVisualInfo (__libmansuffix__), +.BR XdbeQueryExtension (__libmansuffix__), +.BR XdbeSwapBuffers (__libmansuffix__). diff --git a/man/XdbeEndIdiom.man b/man/XdbeEndIdiom.man index 9218ef5..b6a57a5 100644 --- a/man/XdbeEndIdiom.man +++ b/man/XdbeEndIdiom.man @@ -23,24 +23,25 @@ .\" dealing in this Software without prior written authorization from the .\" Hewlett-Packard Company. .\" -.TH XdbeEndIdiom __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH XdbeEndIdiom __libmansuffix__ 1996-03-11 __xorgversion__ .SH NAME XdbeEndIdiom - marks the end of a DBE idiom sequence. .SH SYNOPSIS +.nf \&#include <X11/extensions/Xdbe.h> - +.sp Status XdbeEndIdiom( Display *dpy) +.fi .SH DESCRIPTION This function marks the end of an idiom sequence. .SH SEE ALSO -DBE, -.I XdbeAllocateBackBufferName(), -.I XdbeBeginIdiom(), -.I XdbeDeallocateBackBufferName(), -.I XdbeFreeVisualInfo(), -.I XdbeGetBackBufferAttributes(), -.I XdbeGetVisualInfo(), -.I XdbeQueryExtension(), -.I XdbeSwapBuffers(). - +.BR DBE (__libmansuffix__), +.BR XdbeAllocateBackBufferName (__libmansuffix__), +.BR XdbeBeginIdiom (__libmansuffix__), +.BR XdbeDeallocateBackBufferName (__libmansuffix__), +.BR XdbeFreeVisualInfo (__libmansuffix__), +.BR XdbeGetBackBufferAttributes (__libmansuffix__), +.BR XdbeGetVisualInfo (__libmansuffix__), +.BR XdbeQueryExtension (__libmansuffix__), +.BR XdbeSwapBuffers (__libmansuffix__). diff --git a/man/XdbeFreeVisualInfo.man b/man/XdbeFreeVisualInfo.man index 04f9083..da419a3 100644 --- a/man/XdbeFreeVisualInfo.man +++ b/man/XdbeFreeVisualInfo.man @@ -23,26 +23,29 @@ .\" dealing in this Software without prior written authorization from the .\" Hewlett-Packard Company. .\" -.TH XdbeFreeVisualInfo __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH XdbeFreeVisualInfo __libmansuffix__ 1996-03-11 __xorgversion__ .SH NAME XdbeFreeVisualInfo - frees information returned by .B XdbeGetVisualInfo(). .SH SYNOPSIS +.nf \&#include <X11/extensions/Xdbe.h> - +.sp void XdbeFreeVisualInfo( XdbeScreenVisualInfo *visual_info) +.fi .SH DESCRIPTION -This function frees the list of XdbeScreenVisualInfo returned by the function -.B XdbeGetVisualInfo(). +This function frees the list of +.B XdbeScreenVisualInfo +returned by the function +.BR XdbeGetVisualInfo (__libmansuffix__). .SH SEE ALSO -DBE, -.I XdbeAllocateBackBufferName(), -.I XdbeBeginIdiom(), -.I XdbeDeallocateBackBufferName(), -.I XdbeEndIdiom(), -.I XdbeGetBackBufferAttributes(), -.I XdbeGetVisualInfo(), -.I XdbeQueryExtension(), -.I XdbeSwapBuffers(). - +.BR DBE (__libmansuffix__), +.BR XdbeAllocateBackBufferName (__libmansuffix__), +.BR XdbeBeginIdiom (__libmansuffix__), +.BR XdbeDeallocateBackBufferName (__libmansuffix__), +.BR XdbeEndIdiom (__libmansuffix__), +.BR XdbeGetBackBufferAttributes (__libmansuffix__), +.BR XdbeGetVisualInfo (__libmansuffix__), +.BR XdbeQueryExtension (__libmansuffix__), +.BR XdbeSwapBuffers (__libmansuffix__). diff --git a/man/XdbeGetBackBufferAttributes.man b/man/XdbeGetBackBufferAttributes.man index ac9d692..09b1699 100644 --- a/man/XdbeGetBackBufferAttributes.man +++ b/man/XdbeGetBackBufferAttributes.man @@ -23,43 +23,44 @@ .\" dealing in this Software without prior written authorization from the .\" Hewlett-Packard Company. .\" -.TH XdbeGetBackBufferAttributes __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH XdbeGetBackBufferAttributes __libmansuffix__ 1996-03-11 __xorgversion__ .SH NAME XdbeGetBackBufferAttributes - returns attributes of a DBE buffer. .SH SYNOPSIS +.nf \&#include <X11/extensions/Xdbe.h> - +.sp XdbeBackBufferAttributes *XdbeGetBackBufferAttributes( Display *dpy, XdbeBackBuffer buffer) +.fi .SH DESCRIPTION This function returns the attributes associated with the specified buffer. - +.PP The -.I XdbeBackBufferAttributes +.B XdbeBackBufferAttributes structure has the following fields: - +.PP .RS Window window window that buffer belongs to .RE - +.PP If buffer is not a valid -.I XdbeBackBuffer, +.B XdbeBackBuffer, window returns None. - +.PP The returned -.I XdbeBackBufferAttributes +.B XdbeBackBufferAttributes structure can be freed with the Xlib function -.B Xfree(). +.BR Xfree (__libmansuffix__). .SH SEE ALSO -DBE, -.I XdbeAllocateBackBufferName(), -.I XdbeBeginIdiom(), -.I XdbeDeallocateBackBufferName(), -.I XdbeEndIdiom(), -.I XdbeFreeVisualInfo(), -.I XdbeGetVisualInfo(), -.I XdbeQueryExtension(), -.I XdbeSwapBuffers(). - +.BR DBE (__libmansuffix__), +.BR XdbeAllocateBackBufferName (__libmansuffix__), +.BR XdbeBeginIdiom (__libmansuffix__), +.BR XdbeDeallocateBackBufferName (__libmansuffix__), +.BR XdbeEndIdiom (__libmansuffix__), +.BR XdbeFreeVisualInfo (__libmansuffix__), +.BR XdbeGetVisualInfo (__libmansuffix__), +.BR XdbeQueryExtension (__libmansuffix__), +.BR XdbeSwapBuffers (__libmansuffix__). diff --git a/man/XdbeGetVisualInfo.man b/man/XdbeGetVisualInfo.man index 87b1203..feaaf5b 100644 --- a/man/XdbeGetVisualInfo.man +++ b/man/XdbeGetVisualInfo.man @@ -23,16 +23,18 @@ .\" dealing in this Software without prior written authorization from the .\" Hewlett-Packard Company. .\" -.TH XdbeGetVisualInfo __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH XdbeGetVisualInfo __libmansuffix__ 1996-03-11 __xorgversion__ .SH NAME XdbeGetVisualInfo - Get dbe Visual Information .SH SYNOPSIS +.nf \&#include <X11/extensions/Xdbe.h> - +.sp XdbeScreenVisualInfo *XdbeGetVisualInfo( Display *dpy, Drawable *screen_specifiers, int *num_screens) +.fi .SH DESCRIPTION This function returns information about which visuals support double buffering. The argument @@ -40,18 +42,20 @@ buffering. The argument specifies how many elements there are in the .I screen_specifiers -list. Each drawable in +list. +Each drawable in .I screen_specifiers designates a -screen for which the supported visuals are being requested. If +screen for which the supported visuals are being requested. +If .I num_screens -is zero, information for all screens is requested. In this case, upon return -from this function, +is zero, information for all screens is requested. +In this case, upon return from this function, .I num_screens -will be set to the number of screens that were -found. If an error occurs, this function returns NULL, else it returns a +will be set to the number of screens that were found. +If an error occurs, this function returns NULL, else it returns a pointer to a list of -.I XdbeScreenVisualInfo +.B XdbeScreenVisualInfo structures of length .I num_screens. The nth @@ -61,65 +65,65 @@ list, unless .I num_screens was passed in with the value zero, in which case the nth element in the returned list corresponds to the nth screen -of the server, starting with screen zero. The -.I XdbeScreenVisualInfo +of the server, starting with screen zero. +The +.B XdbeScreenVisualInfo structure has the following fields: - +.nf int count XdbeVisualInfo *visinfo - +.fi .I count specifies the number of items in .I visinfo. .I visinfo specifies a list of visuals, depths, and performance hints for this screen. - +.PP The -.I XdbeVisualInfo +.B XdbeVisualInfo structure has the following fields: - +.nf VisualID visual int depth int perflevel - +.fi .I visual specifies one visual ID that supports double-buffering. .I depth specifies the depth of the visual. .I perflevel is a performance hint. - +.PP The only operation defined on a .I perflevel is comparison to a .I perflevel -of another visual on the same screen. The visual having the higher +of another visual on the same screen. +The visual having the higher .I perflevel is likely to have better double-buffering graphics performance than the visual having the lower -.I perflevel. -Nothing can be deduced from the following: the magnitude of the difference -of two -.I perflevels, +.IR perflevel . +Nothing can be deduced from the following: +the magnitude of the difference of two +.IR perflevels , a .I perflevel value in isolation, or comparing .I perflevels from different servers. - .SH ERRORS .IP BadDrawable One or more values passed in .I screen_specifiers is not a valid drawable. .SH SEE ALSO -DBE, -.I XdbeAllocateBackBufferName(), -.I XdbeBeginIdiom(), -.I XdbeDeallocateBackBufferName(), -.I XdbeEndIdiom(), -.I XdbeFreeVisualInfo(), -.I XdbeGetBackBufferAttributes(), -.I XdbeQueryExtension(), -.I XdbeSwapBuffers(). - +.BR DBE (__libmansuffix__), +.BR XdbeAllocateBackBufferName (__libmansuffix__), +.BR XdbeBeginIdiom (__libmansuffix__), +.BR XdbeDeallocateBackBufferName (__libmansuffix__), +.BR XdbeEndIdiom (__libmansuffix__), +.BR XdbeFreeVisualInfo (__libmansuffix__), +.BR XdbeGetBackBufferAttributes (__libmansuffix__), +.BR XdbeQueryExtension (__libmansuffix__), +.BR XdbeSwapBuffers (__libmansuffix__). diff --git a/man/XdbeQueryExtension.man b/man/XdbeQueryExtension.man index e465595..0fc3721 100644 --- a/man/XdbeQueryExtension.man +++ b/man/XdbeQueryExtension.man @@ -23,39 +23,43 @@ .\" dealing in this Software without prior written authorization from the .\" Hewlett-Packard Company. .\" -.TH XdbeQueryExtension __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH XdbeQueryExtension __libmansuffix__ 1996-03-11 __xorgversion__ .SH NAME XdbeQueryExtension - returns the version of DBE supported by the server. .SH SYNOPSIS +.nf \&#include <X11/extensions/Xdbe.h> - +.sp Status XdbeQueryExtension( Display *dpy, int *major_version_return, int *minor_version_return) +.fi .SH DESCRIPTION Sets .I major_version_return and .I minor_version_return to the major and minor -DBE protocol version supported by the server. If the DBE library is -compatible with the version returned by the server, this function returns -non-zero. If +DBE protocol version supported by the server. +If the DBE library is compatible with the version returned by the server, +this function returns non-zero. +If .I dpy -does not support the DBE extension, or if there was an error -during communication with the server, or if the server and library protocol -versions are incompatible, this function returns zero. No other Xdbe functions -may be called before this function. If a client violates this rule, the -effects of all subsequent Xdbe calls that it makes are undefined. +does not support the DBE extension, +or if there was an error during communication with the server, +or if the server and library protocol versions are incompatible, +this function returns zero. +No other Xdbe functions may be called before this function. +If a client violates this rule, +the effects of all subsequent Xdbe calls that it makes are undefined. .SH SEE ALSO -DBE, -.I XdbeAllocateBackBufferName(), -.I XdbeBeginIdiom(), -.I XdbeDeallocateBackBufferName(), -.I XdbeEndIdiom(), -.I XdbeFreeVisualInfo(), -.I XdbeGetBackBufferAttributes(), -.I XdbeGetVisualInfo(), -.I XdbeSwapBuffers(). - +.BR DBE (__libmansuffix__), +.BR XdbeAllocateBackBufferName (__libmansuffix__), +.BR XdbeBeginIdiom (__libmansuffix__), +.BR XdbeDeallocateBackBufferName (__libmansuffix__), +.BR XdbeEndIdiom (__libmansuffix__), +.BR XdbeFreeVisualInfo (__libmansuffix__), +.BR XdbeGetBackBufferAttributes (__libmansuffix__), +.BR XdbeGetVisualInfo (__libmansuffix__), +.BR XdbeSwapBuffers (__libmansuffix__). diff --git a/man/XdbeSwapBuffers.man b/man/XdbeSwapBuffers.man index 79d8af7..d92e2b2 100644 --- a/man/XdbeSwapBuffers.man +++ b/man/XdbeSwapBuffers.man @@ -23,59 +23,64 @@ .\" dealing in this Software without prior written authorization from the .\" Hewlett-Packard Company. .\" -.TH XdbeSwapBuffers __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH XdbeSwapBuffers __libmansuffix__ 1996-03-11 __xorgversion__ .SH NAME XdbeSwapBuffers - swaps front and back DBE buffers. .SH SYNOPSIS +.nf \&#include <X11/extensions/Xdbe.h> - +.sp Status XdbeSwapBuffers( Display *dpy, XdbeSwapInfo *swap_info, int num_windows) +.fi .SH DESCRIPTION -This function swaps the front and back buffers for a list of windows. The +This function swaps the front and back buffers for a list of windows. +The argument .I num_windows specifies how many windows are to have their buffers swapped; it is the number of elements in the .I swap_info -array. The argument +array. +The argument .I swap_info specifies the information needed per window to do the swap. - +.PP The .I XdbeSwapInfo structure has the following fields: - +.nf Window swap_window XdbeSwapAction swap_action - +.fi .I swap_window specifies the window for which to swap buffers. .I swap_action specifies the swap action to use for this -.I swap_window. - +.IR swap_window . +.PP .I swap_action determines what will happen to the new back buffer of the .I swap_window it is paired with in the list in addition to making the old back buffer -become visible. The defined actions are as follows: - +become visible. +The defined actions are as follows: .IP XdbeUndefined -The contents of the new back buffer become undefined. This may be the most -efficient action since it allows the implementation to discard the contents of -the buffer if it needs to. +The contents of the new back buffer become undefined. +This may be the most efficient action since it allows the implementation to +discard the contents of the buffer if it needs to. .IP XdbeBackground The unobscured region of the new back buffer will be tiled with the -window background. The background action allows devices to use a fast clear +window background. +The background action allows devices to use a fast clear capability during a swap. .IP XdbeUntouched The unobscured region of the new back buffer will be unmodified by the swap. .IP XdbeCopied The unobscured region of the new back buffer will be the contents of the old -back buffer +back buffer. .SH ERRORS .IP BadMatch A non-double-buffered window was specified or a window was specified twice. @@ -84,13 +89,12 @@ An invalid window was specified. .IP BadValue An invalid swap action was specified. .SH SEE ALSO -DBE, -.I XdbeAllocateBackBufferName(), -.I XdbeBeginIdiom(), -.I XdbeDeallocateBackBufferName(), -.I XdbeEndIdiom(), -.I XdbeFreeVisualInfo(), -.I XdbeGetBackBufferAttributes(), -.I XdbeGetVisualInfo(), -.I XdbeQueryExtension(). - +.BR DBE (__libmansuffix__), +.BR XdbeAllocateBackBufferName (__libmansuffix__), +.BR XdbeBeginIdiom (__libmansuffix__), +.BR XdbeDeallocateBackBufferName (__libmansuffix__), +.BR XdbeEndIdiom (__libmansuffix__), +.BR XdbeFreeVisualInfo (__libmansuffix__), +.BR XdbeGetBackBufferAttributes (__libmansuffix__), +.BR XdbeGetVisualInfo (__libmansuffix__), +.BR XdbeQueryExtension (__libmansuffix__). diff --git a/man/Xevi.man b/man/Xevi.man index 164199f..5b51daf 100644 --- a/man/Xevi.man +++ b/man/Xevi.man @@ -23,22 +23,22 @@ .\" dealing in this Software without prior written authorization from .\" Silicon Graphics, Inc. .\" -.TH XEVI __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH XEVI __libmansuffix__ 1997-12-24 __xorgversion__ .SH NAME XeviQueryExtension, XeviQueryVersion, XeviGetVisualInfo \- X Extended Visual Information functions .SH SYNOPSIS .nf \&#include <X11/extensions/XEVI.h> - +.sp \fBBool\fP \fBXeviQueryExtension\fP (\fBDisplay *\fP\fIdpy\fP); - +.sp \fBBool\fP \fBXeviQueryVersion\fP (\fBDisplay *\fP\fIdpy\fP, \fBint *\fP\fImajor_version_return\fP, \fBint *\fP\fIminor_version_return\fP); - +.sp \fBint \fBXeviGetVisualInfo\fP (\fBDisplay *\fP\fIdpy\fP, \fBVisualID *\fP\fIvisual\fP, \fBint\fP \fIn_visual\fP, \fBExtendedVisualInfo **\fP\fIevi_return\fP, @@ -157,7 +157,6 @@ hardware colormap. For example, if a 12-bit hardware colormap is overloaded to support 8-bit colormaps, the corresponding 8-bit visuals would conflict with the 12-bit visuals. - .SH ERRORS .B XeviGetVisualInfo will return diff --git a/man/Xmbuf.man b/man/Xmbuf.man index 94aaee8..9427030 100644 --- a/man/Xmbuf.man +++ b/man/Xmbuf.man @@ -32,10 +32,6 @@ .\" this document. This documentation is provided "as is" .\" without express or implied warranty. .\" -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. .de EX .nf .ft CW @@ -44,24 +40,26 @@ .ft .fi .. -.TH XMBUF __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH XMBUF __libmansuffix__ 1994-04-17 __xorgversion__ .SH NAME -XmbufQueryExtension, XmbufGetVersion, XmbufCreateBuffers, XmbufDestroyBuffers, XmbufDisplayBuffers, XmbufGetWindowAttributes, XmbufChangeWindowAttributes, XmbufGetBufferAttributes, XmbufChangeBufferAttributes, XmbufGetScreenInfo, XmbufCreateStereoWindow - X multibuffering functions +XmbufQueryExtension, XmbufGetVersion, XmbufCreateBuffers, XmbufDestroyBuffers, +XmbufDisplayBuffers, XmbufGetWindowAttributes, XmbufChangeWindowAttributes, +XmbufGetBufferAttributes, XmbufChangeBufferAttributes, XmbufGetScreenInfo, +XmbufCreateStereoWindow - X multibuffering functions .SH SYNTAX .EX \&#include <X11/extensions/multibuf.h> - +.sp Bool XmbufQueryExtension( Display *dpy, - Display *dpy, int *event_base_return, int *error_base_return); - +.sp Status XmbufGetVersion( Display *dpy, int *major_version_return, int *minor_version_return); - +.sp int XmbufCreateBuffers( Display *dpy, Window window, @@ -69,40 +67,40 @@ int XmbufCreateBuffers( int update_action, int update_hint, Multibuffer *buffers_update); - +.sp void XmbufDestroyBuffers( Display *dpy, Window window); - +.sp void XmbufDisplayBuffers( Display *dpy, int count, Multibuffer *buffers, int min_delay, int max_delay); - +.sp Status XmbufGetWindowAttributes( Display *dpy, Window window, XmbufWindowAttributes *attributes); - +.sp void XmbufChangeWindowAttributes( Display *dpy, Window window, unsigned long valuemask, XmbufSetWindowAttributes *attributes); - +.sp Status XmbufGetBufferAttributes( Display *dpy, Multibuffer buffer, XmbufBufferAttributes *attributes); - +.sp void XmbufChangeBufferAttributes( Display *dpy, Multibuffer buffer, unsigned long valuemask, XmbufSetBufferAttributes *attributes); - +.sp Status XmbufGetScreenInfo( Display *dpy, Drawable drawable, @@ -110,7 +108,7 @@ Status XmbufGetScreenInfo( XmbufBufferInfo **mono_info_return, int *nstereo_return, XmbufBufferInfo **stereo_info_return); - +.sp Window XmbufCreateStereoWindow( Display *dpy, Window parent, @@ -138,7 +136,7 @@ typedef struct { Multibuffer buffer; /\&* buffer of event */ int state; /\&* see Clobbered constants above */ } XmbufClobberNotifyEvent; - +.sp typedef struct { int type; /\&* of event */ unsigned long serial; /\&* # of last request processed by server */ @@ -147,9 +145,8 @@ typedef struct { Multibuffer buffer; /\&* buffer of event */ } XmbufUpdateNotifyEvent; .EE - +.PP \fIPer-window attributes that can be got:\fP - .EX typedef struct { int displayed_index; /\&* which buffer is being displayed */ @@ -160,17 +157,15 @@ typedef struct { Multibuffer *buffers; /\&* Buffers */ } XmbufWindowAttributes; .EE - +.PP \fIPer-window attributes that can be set:\fP - .EX typedef struct { int update_hint; /\&* Frequent, Intermittent, Static */ } XmbufSetWindowAttributes; .EE - +.PP \fIPer-buffer attributes that can be got:\fP - .EX typedef struct { Window window; /\&* which window this belongs to */ @@ -179,17 +174,15 @@ typedef struct { int side; /\&* Mono, Left, Right */ } XmbufBufferAttributes; .EE - +.PP \fIPer-buffer attributes that can be set:\fP - .EX typedef struct { unsigned long event_mask; /\&* events that have been selected */ } XmbufSetBufferAttributes; .EE - +.PP \fIPer-screen buffer info (there will be lists of them):\fP - .EX typedef struct { VisualID visualid; /\&* visual usable at this depth */ @@ -202,160 +195,194 @@ The application programming library for the \fIX11 Double-Buffering, Multi-Buffering, and Stereo Extension\fP contains the interfaces described below. With the exception of -.ZN XmbufQueryExtension , +.BR XmbufQueryExtension , if any of these routines are called with a display that does not support the extension, the ExtensionErrorHandler (which can be set with -.ZN XSetExtensionErrorHandler +.B XSetExtensionErrorHandler and functions the same way as -.ZN XSetErrorHandler ) +.BR XSetErrorHandler ) will be called and the function will then return. .PP -.ZN XmbufQueryExtension +.B XmbufQueryExtension returns -.ZN True -if the multibuffering/stereo -extension is available on the -given display. If the extension exists, the value of the first event +.B True +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 -.ZN MultibufferClobberNotify +.B MultibufferClobberNotify and -.ZN MultibufferUpdateNotify -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 -.ZN MultibufferBadBuffer -to get the actual value) is stored into error_base_return. +.B MultibufferUpdateNotify +to get the actual values) is stored into +.I event_base_return +and the value of the first error code +(which should be added to the error type constant +.B MultibufferBadBuffer +to get the actual value) is stored into +.IR error_base_return . .PP -.ZN XmbufGetVersion +.B XmbufGetVersion 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. .PP -.ZN XmbufCreateBuffers -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. +.B XmbufCreateBuffers +requests that +.I count +buffers be created with the given +.I update_action +and +.I update_hint +and be associated with the indicated +.IR window . +The number of buffers created is returned (zero if an error occurred) +and +.I buffers_update +is filled in with that many Multibuffer identifiers. .PP -.ZN XmbufDestroyBuffers -destroys the buffers associated -with the given window. +.B XmbufDestroyBuffers +destroys the buffers associated with the given +.IR window . .PP -.ZN XmbufDisplayBuffers -displays the indicated buffers their -appropriate windows within -max_delay milliseconds after min_delay milliseconds have passed. +.B XmbufDisplayBuffers +displays the indicated buffers their appropriate windows within +.I max_delay +milliseconds after +.I min_delay +milliseconds have passed. No two buffers may be associated with the same window or else a Match error is generated. .PP -.ZN XmbufGetWindowAttributes -gets the multibuffering attributes that apply -to all buffers associated -with the given window. -The list of buffers returns may be freed with -.ZN XFree . +.B XmbufGetWindowAttributes +gets the multibuffering attributes that apply to all buffers associated +with the given +.IR window . +The list of +.I attributes +returned may be freed with +.BR XFree . Returns non-zero on success and zero if an error occurs. .PP -.ZN XmbufChangeWindowAttributes +.B XmbufChangeWindowAttributes sets the multibuffering attributes that apply to all buffers associated -with the given window. This is currently limited to the update_hint. +with the given window. +This is currently limited to the +.IR update_hint . .PP -.ZN XmbufGetBufferAttributes +.B XmbufGetBufferAttributes gets the attributes for the indicated buffer. -Returns non-zero on -success and zero if an error occurs. +Returns non-zero on success and zero if an error occurs. .PP -.ZN XmbufChangeBufferAttributes -sets the attributes for the indicated buffer. -This is currently limited to the event_mask. +.B XmbufChangeBufferAttributes +sets the +.I attributes +for the indicated +.IR buffer . +This is currently limited to the +.IR event_mask . .PP -.ZN XmbufGetScreenInfo -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 -.ZN XmbufBufferInfo +.B XmbufGetScreenInfo +gets the parameters controlling how mono and stereo windows may be +created on the screen of the given +.IR drawable . +The numbers of sets of visual and depths are returned in +.I nmono_return +and +.IR nstereo_return . +If +.I nmono_return +is greater than zero, then +.I mono_info_return +is set to the address of an array of +.B XmbufBufferInfo 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 -.ZN XFree . -If no errors are -encountered, non-zero will be returned. +various visuals and depths that may be used. +Otherwise, +.I mono_info_return +is set to NULL. +Similarly, +.I stereo_info_return +is set according to +.IR nstereo_return . +The storage returned in +.I mono_info_return +and +.I stereo_info_return +may be released by +.BR XFree . +If no errors are encountered, non-zero will be returned. .PP -.ZN XmbufCreateStereoWindow +.B XmbufCreateStereoWindow creates a stereo window in the same way that -.ZN XCreateWindow -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, -.ZN None +.B XCreateWindow +creates a mono window. +The buffer ids for the left and right buffers are returned in +.I left_return +and +.IR right_return , +respectively. +If an extension error handler that returns is installed, +.B None will be returned if the extension is not available on this display. .SH PREDEFINED VALUES -.sp Update_action field: .RS .nf -.ZN MultibufferUpdateActionUndefined -.ZN MultibufferUpdateActionBackground -.ZN MultibufferUpdateActionUntouched -.ZN MultibufferUpdateActionCopied +.B MultibufferUpdateActionUndefined +.B MultibufferUpdateActionBackground +.B MultibufferUpdateActionUntouched +.B MultibufferUpdateActionCopied .fi .RE .sp Update_hint field: .RS .nf -.ZN MultibufferUpdateHintFrequent -.ZN MultibufferUpdateHintIntermittent -.ZN MultibufferUpdateHintStatic +.B MultibufferUpdateHintFrequent +.B MultibufferUpdateHintIntermittent +.B MultibufferUpdateHintStatic .fi .RE .sp Valuemask fields: .RS .nf -.ZN MultibufferWindowUpdateHint -.ZN MultibufferBufferEventMask +.B MultibufferWindowUpdateHint +.B MultibufferBufferEventMask .fi .RE .sp Mono vs. stereo and left vs. right: .RS .nf -.ZN MultibufferModeMono -.ZN MultibufferModeStereo -.ZN MultibufferSideMono -.ZN MultibufferSideLeft -.ZN MultibufferSideRight +.B MultibufferModeMono +.B MultibufferModeStereo +.B MultibufferSideMono +.B MultibufferSideLeft +.B MultibufferSideRight .fi .RE .sp Clobber state: .RS .nf -.ZN MultibufferUnclobbered -.ZN MultibufferPartiallyClobbered -.ZN MultibufferFullyClobbered +.B MultibufferUnclobbered +.B MultibufferPartiallyClobbered +.B MultibufferFullyClobbered .fi .RE .sp Event stuff: .RS .nf -.ZN MultibufferClobberNotifyMask -.ZN MultibufferUpdateNotifyMask -.ZN MultibufferClobberNotify -.ZN MultibufferUpdateNotify -.ZN MultibufferNumberEvents -.ZN MultibufferBadBuffer -.ZN MultibufferNumberErrors +.B MultibufferClobberNotifyMask +.B MultibufferUpdateNotifyMask +.B MultibufferClobberNotify +.B MultibufferUpdateNotify +.B MultibufferNumberEvents +.B MultibufferBadBuffer +.B MultibufferNumberErrors .fi .RE .SH BUGS |