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

NAME

6       XvPutImage, XvShmPutImage - display an XvImage
7

SYNOPSIS

9       #include <X11/extensions/Xvlib.h>
10
11       int XvPutImage (Display *dpy, XvPortID port,
12                       Drawable d, GC gc, XvImage *image,
13                       int src_x, int src_y,
14                       unsigned int src_w, unsigned int src_h,
15                       int dest_x, int dest_y,
16                       unsigned int dest_w, unsigned int dest_h);
17
18       int XvShmPutImage (Display *dpy, XvPortID port,
19                          Drawable d, GC gc, XvImage *image,
20                          int src_x, int src_y,
21                          unsigned int src_w, unsigned int src_h,
22                          int dest_x, int dest_y,
23                          unsigned int dest_w, unsigned int dest_h,
24                          Bool send_event);
25

ARGUMENTS

27       dpy     Specifies the connection to the X server.
28
29       port    The port id of a port on an XvImage capable adaptor.
30
31       d
32
33       gc      the graphics context specifying the clip mask to use, if any.
34
35       image   A pointer to the XvImage to be displayed.
36
37       src_?   The portion of the XvImage to be displayed.
38
39       dest_?  The  portion  of  the  destination drawable to be filled by the
40               image.
41
42       send_event
43               Indicates whether or not an XShmCompletionEvent should be sent.
44               If  sent,  the  event's  major_code  and minor_code fields will
45               indicate the Xv  extension's  major  code  and  XvShmPutImage's
46               minor code.
47

DESCRIPTION

49       XvPutImage(3)  is similar to XPutImage(3).  XvShmPutImage(3) is similar
50       to XShmPutImage(3).  The library will allocate  the  XvImage  structure
51       and  fill  out  all  fields  except  for data.  Width and height may be
52       enlarged in some YUV formats.  The size of the data buffer  that  needs
53       to  be  allocated  will be given in the data_size field in the XvImage.
54       Image data is not allocated by this function.  The client  may  pass  a
55       pointer  to  the preallocated memory as data or may allocate the memory
56       and fill in the XvImage structure's  data  field  after  the  data_size
57       field  has been filled out by the server.  The XvImage structure may be
58       freed by XFree(3).
59

DIAGNOSTICS

61       [XvBadPort]
62               Generated if the requested port does not exist.
63
64       [XvBadAlloc]
65               Generated if the X server  was  unable  to  allocate  resources
66               required to complete the operation.
67
68       [BadMatch]
69               Generated  if  incompatible  arguments were supplied, such as a
70               port that isn't capable of displaying XvImages.
71
72       [BadShmSegCode]
73               Generated if an invalid shared memory segment is specified.
74

SEE ALSO

76       XvListImageFormats(3),  XvCreateImage(3),  XvShmCreateImage(3)  XPutIm‐
77       age(3), XShmPutImage(3)
78
79
80
81X Version 11                     libXv 1.0.11                    XvPutImage(3)
Impressum