XQueryBestSize(XS)       X Version 11 (Release 5)         XQueryBestSize(XS)
                                6 January 1993


 Name

    XQueryBestSize - determine efficient sizes

 Syntax


    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;


 Arguments


    class          Specifies the class that you are interested in.  You can
                   pass TileShape, CursorShape, or StippleShape.

    display        Specifies the connection to the X server.

    width
    height         Specify the width and height.

    whichscreen   Specifies any drawable on the screen.

    widthreturn
    heightreturn  Return the width and height of the object best supported
                   by the display hardware.

 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 whichscreen.  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
    indicates the desired screen.  For TileShape and StippleShape, the draw-
    able indicates the screen and possibly the window class and depth.  An
    InputOnly window cannot be used as the drawable for TileShape or Stip-
    pleShape, or a ``BadMatch'' error results.

    XQueryBestSize can generate ``BadDrawable'', ``BadMatch'', and ``Bad-
    Value'' errors.

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

    XQueryBestTile can generate ``BadDrawable'' and ``BadMatch'' errors.

    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 and depth.  If an InputOnly window is used as the drawable, a
    ``BadMatch'' error results.

    XQueryBestStipple can generate ``BadDrawable'' and ``BadMatch'' errors.

 Diagnostics


    ``BadMatch''   An InputOnly window is used as a Drawable.

    ``BadDrawable''
                   A value for a Drawable argument does not name a defined
                   Window or Pixmap.

    ``BadMatch''   The values do not exist for an InputOnly window.

    ``BadValue''   Some numeric value falls outside the range of values
                   accepted by the request.  Unless a specific range is
                   specified 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.

 See also

    XCreateGC(XS), XSetArcMode(XS), XSetClipOrigin(XS), XSetFillStyle(XS),
    XSetFont(XS), XSetLineAttributes(XS), XSetState(XS), XSetTile(XS)
    Xlib - C Language X Interface