Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
XvPutImage(3)			libXv Functions			 XvPutImage(3)

NAME
       XvPutImage, XvShmPutImage - display an XvImage

SYNOPSIS
       #include	<X11/extensions/Xvlib.h>

       int XvPutImage (Display *dpy, XvPortID port,
		       Drawable	d, GC gc, XvImage *image,
		       int src_x, int src_y,
		       unsigned	int src_w, unsigned int	src_h,
		       int dest_x, int dest_y,
		       unsigned	int dest_w, unsigned int dest_h);

       int XvShmPutImage (Display *dpy,	XvPortID port,
			  Drawable d, GC gc, XvImage *image,
			  int src_x, int src_y,
			  unsigned int src_w, unsigned int src_h,
			  int dest_x, int dest_y,
			  unsigned int dest_w, unsigned	int dest_h,
			  Bool send_event);

ARGUMENTS
       dpy     Specifies the connection	to the X server.

       port    The port	id of a	port on	an XvImage capable adaptor.

       d

       gc      the graphics context specifying the clip	mask to	use, if	any.

       image   A pointer to the	XvImage	to be displayed.

       src_?   The portion of the XvImage to be	displayed.

       dest_?  The portion of the destination drawable to be filled by the im-
	       age.

       send_event
	       Indicates whether or not	an XShmCompletionEvent should be sent.
	       If  sent, the event's major_code	and minor_code fields will in-
	       dicate the Xv extension's major code and	XvShmPutImage's	 minor
	       code.

DESCRIPTION
       XvPutImage(3)  is similar to XPutImage(3).  XvShmPutImage(3) is similar
       to XShmPutImage(3).  The	library	will allocate  the  XvImage  structure
       and  fill  out all fields except	for data.  Width and height may	be en-
       larged in some YUV formats.  The	size of	the data buffer	that needs  to
       be  allocated will be given in the data_size field in the XvImage.  Im-
       age data	is not allocated by this function.   The  client  may  pass  a
       pointer	to  the	preallocated memory as data or may allocate the	memory
       and fill	in the XvImage structure's  data  field	 after	the  data_size
       field  has been filled out by the server.  The XvImage structure	may be
       freed by	XFree(3).

DIAGNOSTICS
       [XvBadPort]
	       Generated if the	requested port does not	exist.

       [XvBadAlloc]
	       Generated if the	X server was unable to allocate	resources  re-
	       quired to complete the operation.

       [BadMatch]
	       Generated  if  incompatible  arguments were supplied, such as a
	       port that isn't capable of displaying XvImages.

       [BadShmSegCode]
	       Generated if an invalid shared memory segment is	specified.

SEE ALSO
       XvListImageFormats(3),  XvCreateImage(3),  XvShmCreateImage(3)  XPutIm-
       age(3), XShmPutImage(3)

X Version 11			 libXv 1.0.11			 XvPutImage(3)

NAME | SYNOPSIS | ARGUMENTS | DESCRIPTION | DIAGNOSTICS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=XvPutImage&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help