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

NAME

6       XvPutStill - write a single frame of video to a drawable
7

SYNOPSIS

9       #include <X11/extensions/Xvlib.h>
10
11       int XvPutStill(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 from which to get the still.
19
20       d              Defines the drawable into which the still is to be writ‐
21                      ten.  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 video region  to  be
28                      written.   vx  and vy define the upper-left pixel of the
29                      region. vw and vh define the width and height,  in  pix‐
30                      els, of the region.
31
32       dx,dy,dw,dh    Define  the  location and size of the destination region
33                      into which the still image is written.  dx and dy define
34                      the  upper-left  corner  of the region. dw and dh define
35                      the width and height, in pixels, of the region.
36

DESCRIPTION

38       XvPutStill(3) writes a single frame of video to a drawable.  The  posi‐
39       tion  and  size of the source (video) rectangle is specified by vx, vy,
40       vw, and vh.  The position and size of the destination  (drawable)  rec‐
41       tangle is specified by dx, dy, dw, and dh.
42
43       Video  data  is  clipped to the bounds of the video encoding, scaled to
44       the requested drawable region size (or the closest size supported)  and
45       clipped to the bounds of the drawable.
46
47       If  the port is grabbed by another client, this request is ignored, and
48       an XvVideoNotify event with detail XvBusy is generated  for  the  draw‐
49       able.   If the port is not receiving a valid video signal a VideoNotify
50       event with detail XvHardError is generated for the drawable.
51

RETURN VALUES

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

DIAGNOSTICS

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

SEE ALSO

77       XvPutVideo(3), XvGetStill(3), XvVideoNotify(3)
78
79
80
81X Version 11                     libXv 1.0.11                    XvPutStill(3)
Impressum