head 1.1; branch 1.1.1; access; symbols netbsd-9-5-RELEASE:1.1.1.3 netbsd-11-0-RELEASE:1.1.1.3 netbsd-11-0-RC7:1.1.1.3 netbsd-11-0-RC6:1.1.1.3 netbsd-11-0-RC5:1.1.1.3 netbsd-11-0-RC4:1.1.1.3 netbsd-11-0-RC3:1.1.1.3 netbsd-11-0-RC2:1.1.1.3 netbsd-11-0-RC1:1.1.1.3 netbsd-11:1.1.1.3.0.16 netbsd-11-base:1.1.1.3 libXv-1-0-13:1.1.1.3 netbsd-10-1-RELEASE:1.1.1.3 netbsd-8-3-RELEASE:1.1.1.3 netbsd-9-4-RELEASE:1.1.1.3 netbsd-10-0-RELEASE:1.1.1.3 netbsd-10-0-RC6:1.1.1.3 netbsd-10-0-RC5:1.1.1.3 netbsd-10-0-RC4:1.1.1.3 netbsd-10-0-RC3:1.1.1.3 netbsd-10-0-RC2:1.1.1.3 netbsd-10-0-RC1:1.1.1.3 libXv-1-0-12:1.1.1.3 netbsd-10:1.1.1.3.0.14 netbsd-10-base:1.1.1.3 netbsd-9-3-RELEASE:1.1.1.3 netbsd-9-2-RELEASE:1.1.1.3 netbsd-9-1-RELEASE:1.1.1.3 netbsd-8-2-RELEASE:1.1.1.3 netbsd-9-0-RELEASE:1.1.1.3 netbsd-9-0-RC2:1.1.1.3 netbsd-9-0-RC1:1.1.1.3 netbsd-9:1.1.1.3.0.12 netbsd-9-base:1.1.1.3 netbsd-8-1-RELEASE:1.1.1.3 netbsd-8-1-RC1:1.1.1.3 netbsd-7-2-RELEASE:1.1.1.3 netbsd-8-0-RELEASE:1.1.1.3 netbsd-8-0-RC2:1.1.1.3 netbsd-8-0-RC1:1.1.1.3 netbsd-7-1-2-RELEASE:1.1.1.3 netbsd-7-1-1-RELEASE:1.1.1.3 netbsd-8:1.1.1.3.0.10 netbsd-8-base:1.1.1.3 netbsd-7-1:1.1.1.3.0.8 netbsd-7-1-RELEASE:1.1.1.3 netbsd-7-1-RC2:1.1.1.3 netbsd-7-1-RC1:1.1.1.3 netbsd-7-0-2-RELEASE:1.1.1.3 libXv-1-0-11:1.1.1.3 netbsd-7-0-1-RELEASE:1.1.1.3 netbsd-7-0:1.1.1.3.0.6 netbsd-7-0-RELEASE:1.1.1.3 netbsd-7-0-RC3:1.1.1.3 netbsd-7-0-RC2:1.1.1.3 netbsd-7-0-RC1:1.1.1.3 netbsd-5-2-3-RELEASE:1.1.1.1 netbsd-5-1-5-RELEASE:1.1.1.1 netbsd-6-0-6-RELEASE:1.1.1.2 netbsd-6-1-5-RELEASE:1.1.1.2 netbsd-7:1.1.1.3.0.4 netbsd-7-base:1.1.1.3 netbsd-6-1-4-RELEASE:1.1.1.2 netbsd-6-0-5-RELEASE:1.1.1.2 riastradh-xf86-video-intel-2-7-1-pre-2-21-15:1.1.1.3 libXv-1-0-10:1.1.1.3 riastradh-drm2:1.1.1.3.0.2 riastradh-drm2-base:1.1.1.3 netbsd-6-1-3-RELEASE:1.1.1.2 netbsd-6-0-4-RELEASE:1.1.1.2 netbsd-5-2-2-RELEASE:1.1.1.1 netbsd-5-1-4-RELEASE:1.1.1.1 netbsd-6-1-2-RELEASE:1.1.1.2 netbsd-6-0-3-RELEASE:1.1.1.2 netbsd-5-2-1-RELEASE:1.1.1.1 netbsd-5-1-3-RELEASE:1.1.1.1 netbsd-6-1-1-RELEASE:1.1.1.2 libXv-1-0-8:1.1.1.3 netbsd-6-1:1.1.1.2.0.6 netbsd-6-0-2-RELEASE:1.1.1.2 netbsd-6-1-RELEASE:1.1.1.2 netbsd-6-1-RC4:1.1.1.2 netbsd-6-1-RC3:1.1.1.2 netbsd-6-1-RC2:1.1.1.2 netbsd-6-1-RC1:1.1.1.2 netbsd-5-2:1.1.1.1.0.8 netbsd-6-0-1-RELEASE:1.1.1.2 netbsd-5-2-RELEASE:1.1.1.1 netbsd-5-2-RC1:1.1.1.1 netbsd-6-0:1.1.1.2.0.4 netbsd-6-0-RELEASE:1.1.1.2 netbsd-6-0-RC2:1.1.1.2 netbsd-6-0-RC1:1.1.1.2 netbsd-6:1.1.1.2.0.2 netbsd-6-base:1.1.1.2 netbsd-5-1-2-RELEASE:1.1.1.1 netbsd-5-1-1-RELEASE:1.1.1.1 libXv-1-0-6:1.1.1.2 netbsd-5-1:1.1.1.1.0.6 netbsd-5-1-RELEASE:1.1.1.1 netbsd-5-1-RC4:1.1.1.1 netbsd-5-1-RC3:1.1.1.1 netbsd-5-1-RC2:1.1.1.1 netbsd-5-1-RC1:1.1.1.1 netbsd-5-0-2-RELEASE:1.1.1.1 libXv-1-0-5:1.1.1.2 netbsd-5-0-1-RELEASE:1.1.1.1 netbsd-5-0:1.1.1.1.0.4 netbsd-5-0-RELEASE:1.1.1.1 netbsd-5-0-RC4:1.1.1.1 netbsd-5-0-RC3:1.1.1.1 netbsd-5-0-RC2:1.1.1.1 netbsd-5-0-RC1:1.1.1.1 netbsd-5:1.1.1.1.0.2 netbsd-5-base:1.1.1.1 libXv-1-0-4:1.1.1.1 xorg:1.1.1; locks; strict; comment @.\" @; 1.1 date 2008.07.30.02.57.12; author mrg; state Exp; branches 1.1.1.1; next ; 1.1.1.1 date 2008.07.30.02.57.12; author mrg; state Exp; branches; next 1.1.1.2; 1.1.1.2 date 2009.11.08.10.10.06; author mrg; state Exp; branches; next 1.1.1.3; 1.1.1.3 date 2013.06.01.07.59.53; author mrg; state Exp; branches; next ; commitid ctnTnrnG56ndXSRw; desc @@ 1.1 log @Initial revision @ text @.TH XvGetStill __libmansuffix__ __vendorversion__ .SH Name XvGetStill \- capture a single frame of video from a drawable .\" .SH Syntax .B #include .sp .nf .BI "XvGetStill(Display *" dpy ", XvPortID " port ", Drawable " d ", GC " gc ", .BI " int " vx ", int " vy ", unsigned int " vw ", unsigned int " vh ", .BI " int " dx ", int " dy ", unsigned int " dw ", unsigned int " dh ");" .fi .SH Arguments .\" .IP \fIdpy\fR 15 Specifies the connection to the X server. .IP \fIport\fR 15 Defines the port to which the still is output'd. .IP \fId\fR 15 Defines the drawable from which the still is to be captured. Pixmaps are currently not supported. .IP \fIgc\fR 15 Defines the graphical context. GC components are: .I subwindow-mode, .I clip-x-origin, .I clip-y-origin, and .I clip-mask. .IP \fIvx,vy,vw,vh\fR 15 Define the location and size of the destination video region into which the still is to be written. \fIvx\fP and \fIvy\fP define the .I x and .I y coordinates of the upper-left corner of the video region; .I vw and .I vh define the width and height, in pixels, of the video region. .IP \fIdx,dy,dw,dh\fR 15 Define the location and size of the source drawable from which the still image is to be captured. .I dx and .I dy define the .I x and .I y coordinates of the upper-left corner of the drawable region; .I dw and .I dh define the width and height, in pixels, of the drawable region. .\" .SH Description .\" .PN XvGetStill captures a single frame of video from a drawable. The position and size of the destination (video) rectangle is specified by \fIvx, vy, vw\fR, and \fIvh\fR. The position and size of the source (drawable) rectangle is specified by \fIdx, dy, dw\fR, and \fIdh\fR. .PP Drawable data is clipped to the bounds of the drawable, scaled to the requested video region size (or the closest size supported) and clipped to the bounds of the video encoding. The contents of any region not updated with drawable data is undefined. .PP ./" If the still is successfully captured an XvVideoNotify event with ./" detail XvStill is generated for the drawable. ./" [mhs]: Not in this universe If the port is grabbed by another client, this request is ignored, and an XvVideoNotify event with detail XvBusy is generated for the drawable. .SH Returned Values .IP [Success] 8 Returned if XvGetStill(__libmansuffix__) completed successfully. .IP [XvBadExtension] 8 Returned if the Xv extension is unavailable. .IP [XvBadAlloc] 8 Returned if XvGetStill(__libmansuffix__) failed to allocate memory to process the request. .SH Diagnostics .IP [XvBadPort] 8 Generated if the requested port does not exist. .IP [BadDrawable] 8 Generated if the requested drawable does not exist. .IP [BadGC] 8 Generated if the requested graphics context does not exist. .IP [BadAlloc] 8 Generated if there were insufficient resources to process the request. .\" .SH See Also .\" XvPutStill(__libmansuffix__), XvGetVideo(__libmansuffix__), XvPutVideo(__libmansuffix__), XvVideoNotify(__libmansuffix__) .br @ 1.1.1.1 log @initial import of libXv-1.0.4 @ text @@ 1.1.1.2 log @initial import of libXv-1.0.5 @ text @d1 2 a2 2 .TH XvGetStill __libmansuffix__ __vendorversion__ "libXv Functions" .SH NAME d5 1 a5 1 .SH SYNOPSIS d9 3 a11 3 .BI "int XvGetStill(Display *" dpy ", XvPortID " port ", Drawable " d ", GC " gc "," .BI " int " vx ", int " vy ", unsigned int " vw ", unsigned int " vh "," .BI " int " dx ", int " dy ", unsigned int " dw ", unsigned int " dh ");" d13 1 a13 1 .SH ARGUMENTS d18 1 a18 1 Defines the port to which the still is output. d23 6 a28 6 Defines the graphical context. GC components are: .IR subwindow-mode , .IR clip-x-origin , .IR clip-y-origin , and .IR clip-mask . d30 3 a32 3 Define the location and size of the destination video region into which the still is to be written. \fIvx\fP and \fIvy\fP define the .IR x and d34 2 a35 2 coordinates of the upper-left corner of the video region; .IR vw and d40 9 a48 9 still image is to be captured. .IR dx and .I dy define the .IR x and .I y coordinates of the upper-left corner of the drawable region; .IR dw and .I dh d51 1 a51 1 .SH DESCRIPTION d53 6 a58 14 .PN XvGetStill captures a single frame of video from a drawable. The position and size of the destination (video) rectangle is specified by .IR vx , .IR vy , .IR vw , and .IR vh . The position and size of the source (drawable) rectangle is specified by .IR dx , .IR dy , .IR dw , and .IR dh . d65 3 a67 3 .\" If the still is successfully captured an XvVideoNotify event with .\" detail XvStill is generated for the drawable. .\" [mhs]: Not in this universe d71 1 a71 1 .SH RETURN VALUES d73 1 a73 3 Returned if .BR XvGetStill (__libmansuffix__) completed successfully. d77 3 a79 4 Returned if .BR XvGetStill (__libmansuffix__) failed to allocate memory to process the request. .SH DIAGNOSTICS d89 1 a89 1 .SH SEE ALSO d91 2 a92 4 .BR XvPutStill (__libmansuffix__), .BR XvGetVideo (__libmansuffix__), .BR XvPutVideo (__libmansuffix__), .BR XvVideoNotify (__libmansuffix__) @ 1.1.1.3 log @initial import of libXv-1.0.8 @ text @d55 1 a55 1 position and size of the destination (video) rectangle is specified by d61 1 a61 1 The position and size of the source (drawable) rectangle is specified by @