XQueryBestSize(3X)                             XQueryBestSize(3X)



NAME
     XQueryBestSize,    XQueryBestTile,    XQueryBestStipple    -
     determine efficient sizes

SYNOPSIS
     Status XQueryBestSize (display, class, which-screen, width,
     height, width-return, height-return)
     Display *display;
     int class;
     Drawable which-screen;
     unsigned int width, height;
     unsigned int *width-return, *height-return;

     Status XQueryBestTile (display, which-screen, width, height,
     width-return, height-return)
     Display *display;
     Drawable which-screen;
     unsigned int width, height;
     unsigned int *width-return, *height-return;

     Status XQueryBestStipple (display, which-screen,
     width, height, width-return, height-return)
     Display *display;
     Drawable which-screen;
     unsigned int width, height;
     unsigned int *width-return, *height-return;

DESCRIPTION
     The XQueryBestSize function returns the best or closest size
     to the specified size.  For CursorShape, this is the largest
     size that can be fully displayed on the screen specified by
     which-screen.  For TileShape, this is the size that can be
     tiled fastest.  For StippleShape, this is the size that can
     be stippled fastest.  For CursorShape, the drawable indi-
     cates the desired screen.  For TileShape and StippleShape,
     the drawable indicates the screen and possibly the window
     class and depth.  An
     InputOnly window cannot be used as the drawable for
     TileShape or StippleShape, or a BadMatch error results.

     The XQueryBestTile function returns the best or closest
     size, that is, the size that can be tiled fastest on the
     screen specified by which-screen. The drawable indicates the
     screen and possibly the window class depth.  If an InputOnly
     window is used as a drawable, a BadMatch error results.

     The XQueryBestStipple function returns the best or closest
     size, that is, the size that can be stippled fastest on the
     screen specified by which-screen. The drawable indicates the
     screen and possibly the window class depth.  If an InputOnly
     window is used as a drawable, a BadMatch error results.




November, 1990                                                  1

XQueryBestSize(3X)                             XQueryBestSize(3X)



   Arguments
     These functions accept the following arguments:

     class   Specifies the class in which you are interested.
             You can pass one of the following constants:
             TileShape, CursorShape, or StippleShape.

     display Specifies the connection to the X server.

     width, height
             Specify the width and height.

     which-screen
             Specifies any drawable on a screen.

     width-return, height-return
             Return the width and height of the object best sup-
             ported by the display hardware.

ERRORS
     BadMatch
             An InputOnly window is used as a drawable; or, the
             values do not exist for an InputOnly window.

     BadDrawable
             A value for a Drawable argument does not name a de-
             fined window or pixel map.

     BadValue
             A numeric value falls outside the range of values
             accepted by the request.  Unless a range is speci-
             fied for an argument, the full range defined by the
             argument's type is accepted.  Any argument defined
             as a set of alternatives can generate this error.

     The XQueryBestSize function can generate BadDrawable, Bad-
     Match, and BadValue errors.

     The XQueryBestTile and XQueryBestStipple functions can gen-
     erate BadDrawable and BadMatch errors.

SEE ALSO
     XCreateGC(3X), XSetArcMode(3X),
     XSetClipOrigin(3X), XSetFillStyle(3X),
     XSetFont(3X), XSetLineAttributes(3X),
     XSetState(3X), XSetTile(3X)

     Xlib - C Language Interface








2                                                  November, 1990