1XvGetStill(3)              Library Functions Manual              XvGetStill(3)
2
3
4

Name

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

Syntax

9       include Xvlib.h
10
11       XvGetStill(dpy, port, d, gc, vx, vy, vw, vh, dx, dy, dw, dh)
12
13       register Display *dpy;
14       XvPortID port;
15       Drawable d;
16       GC gc;
17       int vx, vy, dx, dy;
18       unsigned int vw, vh;
19       unsigned int dw, dh;
20
21

Arguments

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

Description

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

Returned Values

62       [Success]
63               Returned if XvGetStill(3) completed successfully.
64
65       [XvBadExtension]
66               Returned if the Xv extension is unavailable.
67
68       [XvBadAlloc]
69               Returned if XvGetStill(3) failed to allocate memory to  process
70               the request.
71

Diagnostics

73       [XvBadPort]
74               Generated if the requested port does not exist.
75
76       [BadDrawable]
77               Generated if the requested drawable does not exist.
78
79       [BadGC] Generated if the requested graphics context does not exist.
80
81       [BadAlloc]
82               Generated  if  there were insufficient resources to process the
83               request.
84

See Also

86       XvPutStill(3), XvGetVideo(3), XvPutVideo(3), XvVideoNotify(3)
87
88
89
90
91X Version 11                      libXv 1.0.3                    XvGetStill(3)
Impressum