1XvGetStill(3)                   libXv Functions                  XvGetStill(3)
2
3
4

NAME

6       XvGetStill - capture a single frame of video from a drawable
7

SYNOPSIS

9       #include <X11/extensions/Xvlib.h>
10
11       int XvGetStill(Display *dpy, XvPortID port, Drawable d, GC gc,
12                      int vx, int vy, unsigned int vw, unsigned int vh,
13                      int dx, int dy, unsigned int dw, unsigned int dh);
14

ARGUMENTS

16       dpy            Specifies the connection to the X server.
17
18       port           Defines the port to which the still is output.
19
20       d              Defines  the drawable from which the still is to be cap‐
21                      tured.  Pixmaps are currently not supported.
22
23       gc             Defines the graphical context.  GC components are:  sub‐
24                      window-mode,  clip-x-origin,  clip-y-origin,  and  clip-
25                      mask.
26
27       vx,vy,vw,vh    Define the location and size of  the  destination  video
28                      region into which the still is to be written.  vx and vy
29                      define the xand y coordinates of the  upper-left  corner
30                      of  the  video  region;  vwand  vh  define the width and
31                      height, in pixels, of the video region.
32
33       dx,dy,dw,dh    Define the location and size of the source drawable from
34                      which  the  still  image  is  to  be captured.  dxand dy
35                      define the xand y coordinates of the  upper-left  corner
36                      of  the  drawable  region; dwand dh define the width and
37                      height, in pixels, of the drawable region.
38

DESCRIPTION

40       captures a single frame of video from a  drawable.   The  position  and
41       size  of  the destination (video) rectangle is specified by vx, vy, vw,
42       and vh.  The position and size of the source  (drawable)  rectangle  is
43       specified by dx, dy, dw, and dh.
44
45       Drawable  data  is clipped to the bounds of the drawable, scaled to the
46       requested video region size (or the closest size supported) and clipped
47       to  the  bounds  of the video encoding.  The contents of any region not
48       updated with drawable data is undefined.
49
50       If the port is grabbed by another client, this request is ignored,  and
51       an  XvVideoNotify  event  with detail XvBusy is generated for the draw‐
52       able.
53

RETURN VALUES

55       [Success]
56               Returned if XvGetStill(3) completed successfully.
57
58       [XvBadExtension]
59               Returned if the Xv extension is unavailable.
60
61       [XvBadAlloc]
62               Returned if XvGetStill(3) failed to allocate memory to  process
63               the request.
64

DIAGNOSTICS

66       [XvBadPort]
67               Generated if the requested port does not exist.
68
69       [BadDrawable]
70               Generated if the requested drawable does not exist.
71
72       [BadGC] Generated if the requested graphics context does not exist.
73
74       [BadAlloc]
75               Generated  if  there were insufficient resources to process the
76               request.
77

SEE ALSO

79       XvPutStill(3), XvGetVideo(3), XvPutVideo(3), XvVideoNotify(3)
80
81
82
83
84X Version 11                     libXv 1.0.11                    XvGetStill(3)
Impressum