man/XvGetStill.man

   1 .TH XvGetStill __libmansuffix__  __vendorversion__ "libXv Functions"
   2 .SH NAME
   3 XvGetStill \- capture a single frame of video from a drawable
   4 .\"
   5 .SH SYNOPSIS
   6 .B #include <X11/extensions/Xvlib.h>
   7 .sp
   8 .nf
   9 .BI "int XvGetStill(Display *" dpy ", XvPortID " port ", Drawable " d ", GC " gc ","
  10 .BI "               int " vx ", int " vy ", unsigned int " vw ", unsigned int " vh ","
  11 .BI "               int " dx ", int " dy ", unsigned int " dw ", unsigned int " dh ");"
  12 .fi
  13 .SH ARGUMENTS
  14 .\"
  15 .IP \fIdpy\fR 15
  16 Specifies the connection to the X server.
  17 .IP \fIport\fR 15
  18 Defines the port to which the still is output.
  19 .IP \fId\fR 15
  20 Defines the drawable from which the still is to be captured.
  21 Pixmaps are currently not supported.
  22 .IP \fIgc\fR 15
  23 Defines the graphical context.  GC components are:
  24 .IR subwindow-mode ,
  25 .IR clip-x-origin ,
  26 .IR clip-y-origin ,
  27 and
  28 .IR clip-mask .
  29 .IP \fIvx,vy,vw,vh\fR 15
  30 Define the location and size of the destination video region
  31 into which the still is to be written.  \fIvx\fP and \fIvy\fP define the
  32 .IR x and
  33 .I y
  34 coordinates of the upper-left corner of the video region;
  35 .IR vw and
  36 .I vh
  37 define the width and height, in pixels, of the video region.
  38 .IP \fIdx,dy,dw,dh\fR 15
  39 Define the location and size of the source drawable from which the
  40 still image is to be captured.
  41 .IR dx and
  42 .I dy
  43 define the
  44 .IR x and
  45 .I y
  46 coordinates of the upper-left corner of the drawable region;
  47 .IR dw and
  48 .I dh
  49 define the width and height, in pixels, of the drawable region.
  50 .\"
  51 .SH DESCRIPTION
  52 .\"
  53 .PN XvGetStill
  54 captures a single frame of video from a drawable.  The
  55 position and size of the destination (video) rectangle is specified by
  56 .IR vx ,
  57 .IR vy ,
  58 .IR vw ,
  59 and
  60 .IR vh .
  61 The position and size of the source (drawable) rectangle is specified by
  62 .IR dx ,
  63 .IR dy ,
  64 .IR dw ,
  65 and
  66 .IR dh .
  67 .PP
  68 Drawable data is clipped to the bounds of the drawable, scaled to the
  69 requested video region size (or the closest size supported) and
  70 clipped to the bounds of the video encoding.  The contents of any region
  71 not updated with drawable data is undefined.
  72 .PP
  73 .\" If the still is successfully captured an XvVideoNotify event with
  74 .\" detail XvStill is generated for the drawable.
  75 .\" [mhs]: Not in this universe
  76 If the port is grabbed
  77 by another client, this request is ignored, and an XvVideoNotify event
  78 with detail XvBusy is generated for the drawable.
  79 .SH RETURN VALUES
  80 .IP [Success] 8
  81 Returned if
  82 .BR XvGetStill (__libmansuffix__)
  83 completed successfully.
  84 .IP [XvBadExtension] 8
  85 Returned if the Xv extension is unavailable.
  86 .IP [XvBadAlloc] 8
  87 Returned if
  88 .BR XvGetStill (__libmansuffix__)
  89 failed to allocate memory to process the request.
  90 .SH DIAGNOSTICS
  91 .IP [XvBadPort] 8
  92 Generated if the requested port does not exist.
  93 .IP [BadDrawable] 8
  94 Generated if the requested drawable does not exist.
  95 .IP [BadGC] 8
  96 Generated if the requested graphics context does not exist.
  97 .IP [BadAlloc] 8
  98 Generated if there were insufficient resources to process the request.
  99 .\"
 100 .SH SEE ALSO
 101 .\"
 102 .BR XvPutStill (__libmansuffix__),
 103 .BR XvGetVideo (__libmansuffix__),
 104 .BR XvPutVideo (__libmansuffix__),
 105 .BR XvVideoNotify (__libmansuffix__)
 106