man/XvQueryBestSize.man

   1 .TH XvQueryBestSize __libmansuffix__ __vendorversion__ "libXv Functions"
   2 .SH NAME
   3 XvQueryBestSize \- determine the optimum drawable region size
   4 .\"
   5 .SH SYNOPSIS
   6 .B #include <X11/extensions/Xvlib.h>
   7 .sp
   8 .nf
   9 .BI "int XvQueryBestSize(Display *" dpy ", XvPort " port ", Bool " motion ","
  10 .BI "                    unsigned int " vw ", unsigned int " vh ","
  11 .BI "                    unsigned int " dw ", unsigned int " dh ","
  12 .BI "                    unsigned int *" p_dw ", unsigned int *" p_dh ");"
  13 .fi
  14 .SH ARGUMENTS
  15 .\"
  16 .IP \fIdpy\fR 15
  17 Specifies the connection to the X server.
  18 .IP \fIport\fR 15
  19 Defines the port associated with the display and adaptor for which
  20 the optimum size is to be calculated.
  21 .IP \fImotion\fR 15
  22 Specifies \fITrue\fP if the destination size needs to support
  23 full motion, and \fIFalse\fP if the destination size need only
  24 support still images.
  25 .IP \fIvw,vh\fR 15
  26 Specifies the size of the source video region desired.
  27 .IP \fIdw,dh\fR 15
  28 Specifies the size of the destination drawable region desired.
  29 .IP \fIp_dw,p_dh\fR 15
  30 Pointers to where the closest destination sizes supported by the server are
  31 returned.
  32 .\"
  33 .SH DESCRIPTION
  34 .\"
  35 Some ports may be able to scale incoming or outgoing video.
  36 .BR XvQueryBestSize (__libmansuffix__)
  37 returns the size of the closest destination region that is supported
  38 by the adaptor.  The returned size is guaranteed to be smaller than
  39 the requested size if a smaller size is supported.
  40 .\"
  41 .SH RETURN VALUES
  42 .IP [Success] 8
  43 Returned if
  44 .BR XvQueryBestSize (__libmansuffix__)
  45 completed successfully.
  46 .IP [XvBadExtension] 8
  47 Returned if the Xv extension is unavailable.
  48 .IP [XvBadAlloc] 8
  49 Returned if
  50 .BR XvQueryBestSize (__libmansuffix__)
  51 failed to allocate memory to process the request.
  52 .SH DIAGNOSTICS
  53 .IP [XvBadPort] 8
  54 Generated if the requested port does not exist.
  55 .br