diff options
author | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2006-11-25 18:08:14 +0000 |
---|---|---|
committer | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2006-11-25 18:08:14 +0000 |
commit | 1d13d3921dd70a5ff2f0784c47e7dbd192b778a2 (patch) | |
tree | 9961a7d26f83ba33a7850a82b03660e0d49f71aa /lib/libXv/man | |
parent | 690dcb448242e6a81154e589bb283f1e98f38c67 (diff) |
import from X.Org 7.2RC2
Diffstat (limited to 'lib/libXv/man')
-rw-r--r-- | lib/libXv/man/Makefile.am | 71 | ||||
-rw-r--r-- | lib/libXv/man/Makefile.in | 435 | ||||
-rw-r--r-- | lib/libXv/man/Xv.man | 69 | ||||
-rw-r--r-- | lib/libXv/man/XvFreeAdaptorInfo.man | 24 | ||||
-rw-r--r-- | lib/libXv/man/XvFreeEncodingInfo.man | 24 | ||||
-rw-r--r-- | lib/libXv/man/XvGetPortAttribute.man | 90 | ||||
-rw-r--r-- | lib/libXv/man/XvGetStill.man | 119 | ||||
-rw-r--r-- | lib/libXv/man/XvGetVideo.man | 127 | ||||
-rw-r--r-- | lib/libXv/man/XvGrabPort.man | 64 | ||||
-rw-r--r-- | lib/libXv/man/XvPortNotify.man | 58 | ||||
-rw-r--r-- | lib/libXv/man/XvPutStill.man | 102 | ||||
-rw-r--r-- | lib/libXv/man/XvPutVideo.man | 113 | ||||
-rw-r--r-- | lib/libXv/man/XvQueryAdaptors.man | 94 | ||||
-rw-r--r-- | lib/libXv/man/XvQueryBestSize.man | 62 | ||||
-rw-r--r-- | lib/libXv/man/XvQueryEncodings.man | 88 | ||||
-rw-r--r-- | lib/libXv/man/XvQueryExtension.man | 51 | ||||
-rw-r--r-- | lib/libXv/man/XvSelectPortNotify.man | 47 | ||||
-rw-r--r-- | lib/libXv/man/XvSelectVideoNotify.man | 43 | ||||
-rw-r--r-- | lib/libXv/man/XvSetPortAttribute.man | 94 | ||||
-rw-r--r-- | lib/libXv/man/XvStopVideo.man | 50 | ||||
-rw-r--r-- | lib/libXv/man/XvUngrabPort.man | 45 | ||||
-rw-r--r-- | lib/libXv/man/XvVideoNotify.man | 58 |
22 files changed, 1928 insertions, 0 deletions
diff --git a/lib/libXv/man/Makefile.am b/lib/libXv/man/Makefile.am new file mode 100644 index 000000000..1d9ac52e5 --- /dev/null +++ b/lib/libXv/man/Makefile.am @@ -0,0 +1,71 @@ +# $Id: Makefile.am,v 1.1 2006/11/25 18:04:55 matthieu Exp $ +# +# Copyright 2005 Sun Microsystems, Inc. All rights reserved. +# +# Permission to use, copy, modify, distribute, and sell this software and its +# documentation for any purpose is hereby granted without fee, provided that +# the above copyright notice appear in all copies and that both that +# copyright notice and this permission notice appear in supporting +# documentation. +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +# IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR +# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +# OTHER DEALINGS IN THE SOFTWARE. +# +# Except as contained in this notice, the name of the copyright holders shall +# not be used in advertising or otherwise to promote the sale, use or +# other dealings in this Software without prior written authorization +# from the copyright holders. +# + +libmandir = $(LIB_MAN_DIR) + +libman_PRE = \ + Xv.man \ + XvFreeAdaptorInfo.man \ + XvFreeEncodingInfo.man \ + XvGetPortAttribute.man \ + XvGetStill.man \ + XvGetVideo.man \ + XvGrabPort.man \ + XvPortNotify.man \ + XvPutStill.man \ + XvPutVideo.man \ + XvQueryAdaptors.man \ + XvQueryBestSize.man \ + XvQueryEncodings.man \ + XvQueryExtension.man \ + XvSelectPortNotify.man \ + XvSelectVideoNotify.man \ + XvSetPortAttribute.man \ + XvStopVideo.man \ + XvUngrabPort.man \ + XvVideoNotify.man + +libman_DATA = $(libman_PRE:man=@LIB_MAN_SUFFIX@) + +EXTRA_DIST = $(libman_PRE) + +CLEANFILES = $(libman_DATA) + +SED = sed + +# Strings to replace in man pages +XORGRELSTRING = @PACKAGE_STRING@ + XORGMANNAME = X Version 11 + +MAN_SUBSTS = \ + -e 's/__vendorversion__/"$(XORGRELSTRING)" "$(XORGMANNAME)"/' \ + -e 's/__libmansuffix__/$(LIB_MAN_SUFFIX)/g' + +SUFFIXES = .$(LIB_MAN_SUFFIX) .man + +.man.$(LIB_MAN_SUFFIX): + sed $(MAN_SUBSTS) < $< > $@ diff --git a/lib/libXv/man/Makefile.in b/lib/libXv/man/Makefile.in new file mode 100644 index 000000000..4167a0217 --- /dev/null +++ b/lib/libXv/man/Makefile.in @@ -0,0 +1,435 @@ +# Makefile.in generated by automake 1.9.6 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005 Free Software Foundation, Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +# $Id: Makefile.in,v 1.1 2006/11/25 18:04:55 matthieu Exp $ +# +# Copyright 2005 Sun Microsystems, Inc. All rights reserved. +# +# Permission to use, copy, modify, distribute, and sell this software and its +# documentation for any purpose is hereby granted without fee, provided that +# the above copyright notice appear in all copies and that both that +# copyright notice and this permission notice appear in supporting +# documentation. +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +# IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR +# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +# OTHER DEALINGS IN THE SOFTWARE. +# +# Except as contained in this notice, the name of the copyright holders shall +# not be used in advertising or otherwise to promote the sale, use or +# other dealings in this Software without prior written authorization +# from the copyright holders. +# + +srcdir = @srcdir@ +top_srcdir = @top_srcdir@ +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +top_builddir = .. +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +INSTALL = @INSTALL@ +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +subdir = man +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +SOURCES = +DIST_SOURCES = +am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; +am__vpath_adj = case $$p in \ + $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ + *) f=$$p;; \ + esac; +am__strip_dir = `echo $$p | sed -e 's|^.*/||'`; +am__installdirs = "$(DESTDIR)$(libmandir)" +libmanDATA_INSTALL = $(INSTALL_DATA) +DATA = $(libman_DATA) +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +ADMIN_MAN_DIR = @ADMIN_MAN_DIR@ +ADMIN_MAN_SUFFIX = @ADMIN_MAN_SUFFIX@ +AMDEP_FALSE = @AMDEP_FALSE@ +AMDEP_TRUE = @AMDEP_TRUE@ +AMTAR = @AMTAR@ +APP_MAN_DIR = @APP_MAN_DIR@ +APP_MAN_SUFFIX = @APP_MAN_SUFFIX@ +AR = @AR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CXX = @CXX@ +CXXCPP = @CXXCPP@ +CXXDEPMODE = @CXXDEPMODE@ +CXXFLAGS = @CXXFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DRIVER_MAN_DIR = @DRIVER_MAN_DIR@ +DRIVER_MAN_SUFFIX = @DRIVER_MAN_SUFFIX@ +ECHO = @ECHO@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +F77 = @F77@ +FFLAGS = @FFLAGS@ +FILE_MAN_DIR = @FILE_MAN_DIR@ +FILE_MAN_SUFFIX = @FILE_MAN_SUFFIX@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LDFLAGS = @LDFLAGS@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIB_MAN_DIR = @LIB_MAN_DIR@ +LIB_MAN_SUFFIX = @LIB_MAN_SUFFIX@ +LINT = @LINT@ +LINTLIB = @LINTLIB@ +LINT_FALSE = @LINT_FALSE@ +LINT_FLAGS = @LINT_FLAGS@ +LINT_TRUE = @LINT_TRUE@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +MAINT = @MAINT@ +MAINTAINER_MODE_FALSE = @MAINTAINER_MODE_FALSE@ +MAINTAINER_MODE_TRUE = @MAINTAINER_MODE_TRUE@ +MAKEINFO = @MAKEINFO@ +MAKE_LINT_LIB_FALSE = @MAKE_LINT_LIB_FALSE@ +MAKE_LINT_LIB_TRUE = @MAKE_LINT_LIB_TRUE@ +MALLOC_ZERO_CFLAGS = @MALLOC_ZERO_CFLAGS@ +MISC_MAN_DIR = @MISC_MAN_DIR@ +MISC_MAN_SUFFIX = @MISC_MAN_SUFFIX@ +OBJEXT = @OBJEXT@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKG_CONFIG = @PKG_CONFIG@ +RANLIB = @RANLIB@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +VERSION = @VERSION@ +XMALLOC_ZERO_CFLAGS = @XMALLOC_ZERO_CFLAGS@ +XTMALLOC_ZERO_CFLAGS = @XTMALLOC_ZERO_CFLAGS@ +XV_CFLAGS = @XV_CFLAGS@ +XV_LIBS = @XV_LIBS@ +ac_ct_AR = @ac_ct_AR@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_CXX = @ac_ct_CXX@ +ac_ct_F77 = @ac_ct_F77@ +ac_ct_RANLIB = @ac_ct_RANLIB@ +ac_ct_STRIP = @ac_ct_STRIP@ +ac_pt_PKG_CONFIG = @ac_pt_PKG_CONFIG@ +am__fastdepCC_FALSE = @am__fastdepCC_FALSE@ +am__fastdepCC_TRUE = @am__fastdepCC_TRUE@ +am__fastdepCXX_FALSE = @am__fastdepCXX_FALSE@ +am__fastdepCXX_TRUE = @am__fastdepCXX_TRUE@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +datadir = @datadir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +libmandir = $(LIB_MAN_DIR) +libman_PRE = \ + Xv.man \ + XvFreeAdaptorInfo.man \ + XvFreeEncodingInfo.man \ + XvGetPortAttribute.man \ + XvGetStill.man \ + XvGetVideo.man \ + XvGrabPort.man \ + XvPortNotify.man \ + XvPutStill.man \ + XvPutVideo.man \ + XvQueryAdaptors.man \ + XvQueryBestSize.man \ + XvQueryEncodings.man \ + XvQueryExtension.man \ + XvSelectPortNotify.man \ + XvSelectVideoNotify.man \ + XvSetPortAttribute.man \ + XvStopVideo.man \ + XvUngrabPort.man \ + XvVideoNotify.man + +libman_DATA = $(libman_PRE:man=@LIB_MAN_SUFFIX@) +EXTRA_DIST = $(libman_PRE) +CLEANFILES = $(libman_DATA) +SED = sed + +# Strings to replace in man pages +XORGRELSTRING = @PACKAGE_STRING@ +XORGMANNAME = X Version 11 +MAN_SUBSTS = \ + -e 's/__vendorversion__/"$(XORGRELSTRING)" "$(XORGMANNAME)"/' \ + -e 's/__libmansuffix__/$(LIB_MAN_SUFFIX)/g' + +SUFFIXES = .$(LIB_MAN_SUFFIX) .man +all: all-am + +.SUFFIXES: +.SUFFIXES: .$(LIB_MAN_SUFFIX) .man +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh \ + && exit 0; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu man/Makefile'; \ + cd $(top_srcdir) && \ + $(AUTOMAKE) --gnu man/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs + +distclean-libtool: + -rm -f libtool +uninstall-info-am: +install-libmanDATA: $(libman_DATA) + @$(NORMAL_INSTALL) + test -z "$(libmandir)" || $(mkdir_p) "$(DESTDIR)$(libmandir)" + @list='$(libman_DATA)'; for p in $$list; do \ + if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ + f=$(am__strip_dir) \ + echo " $(libmanDATA_INSTALL) '$$d$$p' '$(DESTDIR)$(libmandir)/$$f'"; \ + $(libmanDATA_INSTALL) "$$d$$p" "$(DESTDIR)$(libmandir)/$$f"; \ + done + +uninstall-libmanDATA: + @$(NORMAL_UNINSTALL) + @list='$(libman_DATA)'; for p in $$list; do \ + f=$(am__strip_dir) \ + echo " rm -f '$(DESTDIR)$(libmandir)/$$f'"; \ + rm -f "$(DESTDIR)$(libmandir)/$$f"; \ + done +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's|.|.|g'`; \ + list='$(DISTFILES)'; for file in $$list; do \ + case $$file in \ + $(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \ + $(top_srcdir)/*) file=`echo "$$file" | sed "s|^$$topsrcdirstrip/|$(top_builddir)/|"`;; \ + esac; \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + dir=`echo "$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test "$$dir" != "$$file" && test "$$dir" != "."; then \ + dir="/$$dir"; \ + $(mkdir_p) "$(distdir)$$dir"; \ + else \ + dir=''; \ + fi; \ + if test -d $$d/$$file; then \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \ + fi; \ + cp -pR $$d/$$file $(distdir)$$dir || exit 1; \ + else \ + test -f $(distdir)/$$file \ + || cp -p $$d/$$file $(distdir)/$$file \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile $(DATA) +installdirs: + for dir in "$(DESTDIR)$(libmandir)"; do \ + test -z "$$dir" || $(mkdir_p) "$$dir"; \ + done +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES) + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic clean-libtool mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-libtool + +dvi: dvi-am + +dvi-am: + +html: html-am + +info: info-am + +info-am: + +install-data-am: install-libmanDATA + +install-exec-am: + +install-info: install-info-am + +install-man: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-info-am uninstall-libmanDATA + +.PHONY: all all-am check check-am clean clean-generic clean-libtool \ + distclean distclean-generic distclean-libtool distdir dvi \ + dvi-am html html-am info info-am install install-am \ + install-data install-data-am install-exec install-exec-am \ + install-info install-info-am install-libmanDATA install-man \ + install-strip installcheck installcheck-am installdirs \ + maintainer-clean maintainer-clean-generic mostlyclean \ + mostlyclean-generic mostlyclean-libtool pdf pdf-am ps ps-am \ + uninstall uninstall-am uninstall-info-am uninstall-libmanDATA + + +.man.$(LIB_MAN_SUFFIX): + sed $(MAN_SUBSTS) < $< > $@ +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/lib/libXv/man/Xv.man b/lib/libXv/man/Xv.man new file mode 100644 index 000000000..4baf06047 --- /dev/null +++ b/lib/libXv/man/Xv.man @@ -0,0 +1,69 @@ +.TH Xv __libmansuffix__ __vendorversion__ +.\" +.\" $XFree86: xc/doc/man/Xv/Xv.man,v 1.5 2000/03/21 23:17:19 dawes Exp $ +.SH Name +Xv \- X Window System video extension +.SH Description +The Xv extension provides support for video adaptors attached to an X +display. It takes the approach that a display may have one or more +video adaptors, each of which has one or more ports through which +independent video streams pass. +.PP +An adaptor may be able to display video in a drawable, capture video +from a drawable, or both. It translates between video encoding (NTSC, +PAL, SECAM, etc...) and drawable format (depth and visual-id pair). An +adaptor may support multiple video encodings and/or multiple drawable +formats. +.PP +Clients use Xv(__libmansuffix__) to gain access and manage sharing of a display's +video resources. Typically, a client will use XvQueryExtension(__libmansuffix__) to +determine the status of the extension, XvQueryAdaptors(__libmansuffix__) to get a +description of what video adaptors exist, and XvQueryEncodings(__libmansuffix__) to +get a description of what video encodings an adaptor supports. +.PP +Once a client has determined what video resources are available, it is +free to put video into a drawable or get video from a drawable, +according the capabilities supported. Clients can select to receive +events when video activity changes in a drawable and when port +attributes have changed. +.SH Summary of Library Functions +The following is a summary of Xv library functions: +.sp 1l +XvGetPortAttribute(__libmansuffix__) \- return current port attribute value +.sp 1l +XvGetStill(__libmansuffix__) \- capture a single frame of video from a drawable +.sp 1l +XvGetVideo(__libmansuffix__) \- capture video from a drawable +.sp 1l +XvGrabPort(__libmansuffix__) \- lock port for exclusive use by client +.sp 1l +XvPortNotify(__libmansuffix__) \- event generated when port attributes change +.sp 1l +XvPutStill(__libmansuffix__) \- write a single frame of video to a drawable +.sp 1l +XvPutVideo(__libmansuffix__) \- write video into a drawable +.sp 1l +XvQueryAdaptors(__libmansuffix__) \- return adaptor information for a screen +.sp 1l +XvQueryBestSize(__libmansuffix__) \- determine the optimum drawable region size +.sp 1l +XvQueryEncodings(__libmansuffix__) \- return list of encodings for an adaptor +.sp 1l +XvQueryExtension(__libmansuffix__) \- return version and revision of extension +.sp 1l +XvSelectPortNotify(__libmansuffix__) \- enable or disable XvPortNotify events +.sp 1l +XvSelectVideoNotify(__libmansuffix__) \- enable or disable XvVideoNotify events +.sp 1l +XvSetPortAttribute(__libmansuffix__) \- set an attribute for a port +.sp 1l +XvStopVideo(__libmansuffix__) \- stop active video +.sp 1l +XvUngrabPort(__libmansuffix__) \- release a grabbed port +.sp 1l +XvVideoNotify(__libmansuffix__) \- event generated for video processing +.sp 1l +.PP +Each of these functions is described in its own Xv man page. +.br + diff --git a/lib/libXv/man/XvFreeAdaptorInfo.man b/lib/libXv/man/XvFreeAdaptorInfo.man new file mode 100644 index 000000000..141f9d5e5 --- /dev/null +++ b/lib/libXv/man/XvFreeAdaptorInfo.man @@ -0,0 +1,24 @@ +.TH XvFreeAdaptorInfo __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvFreeAdaptorInfo.man,v 1.4 1999/03/02 11:49:13 dawes Exp $ +.SH Name +XvFreeAdaptorInfo \- free adaptor information +.\" +.SH Syntax +\fBXvFreeAdaptorInfo(\fIp_adaptor_info\fR) +.sp 1l +\fBXvAdaptorInfo \fI*p_adaptor_info\fR; +.SH Arguments +.\" +.IP \fIp_adaptor_info\fR 8 +Pointer to where the adaptor information is located. +.\" +.SH Description +.\" +XvFreeAdaptorInfo(__libmansuffix__) frees adaptor information that +was returned by XvQueryAdaptors(__libmansuffix__). The data structure +used for adaptor information is defined in the +reference page for XvQueryAdaptors(__libmansuffix__). +.SH See Also +.\" +XvQueryAdaptors(__libmansuffix__), XvFreeEncodingInfo(__libmansuffix__) +.br diff --git a/lib/libXv/man/XvFreeEncodingInfo.man b/lib/libXv/man/XvFreeEncodingInfo.man new file mode 100644 index 000000000..43635e82b --- /dev/null +++ b/lib/libXv/man/XvFreeEncodingInfo.man @@ -0,0 +1,24 @@ +.TH XvFreeEncodingInfo __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvFreeEncodingInfo.man,v 1.4 1999/03/02 11:49:13 dawes Exp $ +.SH Name +XvFreeEncodingInfo \- free encoding information +.\" +.SH Syntax +\fBXvFreeEncodingInfo(\fIp_encoding_info\fR) +.sp 1l +\fBXvEncodingInfo \fI*p_encoding_info\fR; +.SH Arguments +.\" +.IP \fIp_encoding_info\fR 8 +Pointer to where the encoding information is located. +.\" +.SH Description +.\" +XvFreeEncodingInfo(__libmansuffix__) frees encoding information that +was returned by XvQueryEncodings(__libmansuffix__). The data structure +used for encoding information is defined in the +reference page for XvQueryEncodings(__libmansuffix__). +.SH See Also +.\" +XvQueryEncodings(__libmansuffix__) +.br diff --git a/lib/libXv/man/XvGetPortAttribute.man b/lib/libXv/man/XvGetPortAttribute.man new file mode 100644 index 000000000..83b9e38b0 --- /dev/null +++ b/lib/libXv/man/XvGetPortAttribute.man @@ -0,0 +1,90 @@ +.TH XvGetPortAttribute __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvGetPortAttribute.man,v 1.6 2001/01/27 18:20:35 dawes Exp $ +.SH Name +XvGetPortAttribute \- return current port attribute value +.\" +.SH Syntax +.B #include <X11/extensions/Xvlib.h> +.sp 1l +.B XvGetPortAttribute(\fIdpy, port, attribute, p_value\fR) +.sp 1l +\fBDisplay \fI*dpy\fR; +.br +\fBXvPortID \fIport\fR; +.br +\fBAtom \fIattribute\fR; +.br +\fBint \fI*p_value\fR; +.sp 1l +.\" +.SH Arguments +.\" +.IP \fIdpy\fR 8 +Specifies the connection to the X server. +.IP \fIport\fR 8 +Specifies the port, associated with the given display, for +which the attribute values are to be returned. +.IP \fIattribute\fR 8 +An atom that identifies the attribute to be queried by this +request. Control atoms are obtained using the XInternAtom +request with a string from the following table. +.IP \fIp_value\fR 8 +Pointer to the location where the attribute value is written on +return. +.\" +.SH Description +.\" +.PP +XvGetPortAttribute(__libmansuffix__) returns the current value of the requested +port attribute in the integer pointed to by \fIp_value\fR. +The attribute is identified using an Atom that equates to the attribute name. +The XInternAtom request can be used with one of the strings +below to return a matching Atom. +.bp +.PP +.\" .TS +.\" tab(@); +.\" lfHB lfHB lfHB +.\" lfR lfR lfR . +.\" _ +.\" .PP +.\" .sp 4p +.\" Attribute String@Type@Default +.\" .sp 6p +.\" _ +.\" .sp 6p +.\" "XV_ENCODING"@XvEncodingID@Server dependent +.\" "XV_HUE"@[-1000...1000]@0 +.\" "XV_SATURATION"@[-1000...1000]@0 +.\" "XV_BRIGHTNESS"@[-1000...1000]@0 +.\" "XV_CONTRAST"@[-1000...1000]@0 +.\" .sp 6p +.\" .TE +.nf +Attribute String Type Default + +"XV_ENCODING" XvEncodingID Server dependent +"XV_HUE" [-1000...1000] 0 +"XV_SATURATION" [-1000...1000] 0 +"XV_BRIGHTNESS" [-1000...1000] 0 +"XV_CONTRAST" [-1000...1000] 0 +.fi +.SH Returned Values +.IP [Success] 8 +Returned if XvGetPortAttribute(__libmansuffix__) completed successfully. +.IP [XvBadExtension] 8 +Returned if the Xv extension is unavailable. +.IP [XvBadAlloc] 8 +Returned if XvGetPortAttribute(__libmansuffix__) failed to allocate memory to process +the request. +.SH Diagnostics +.IP [XvBadPort] 8 +Generated if the requested port does not exist. +.IP [BadMatch] 8 +Generated if the requested attribute atom does not specify an attribute +supported by the adaptor. +.SH See Also +.\" +XvSetPortAttribute(__libmansuffix__), XvPortNotify(__libmansuffix__) +.br + diff --git a/lib/libXv/man/XvGetStill.man b/lib/libXv/man/XvGetStill.man new file mode 100644 index 000000000..90540eaf8 --- /dev/null +++ b/lib/libXv/man/XvGetStill.man @@ -0,0 +1,119 @@ +.TH XvGetStill __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvGetStill.man,v 1.5 2001/01/27 18:20:36 dawes Exp $ +.SH Name +XvGetStill \- capture a single frame of video from a drawable +.\" +.SH Syntax +.B include "Xvlib.h" +.sp 1l +.B XvGetStill(\fIdpy, port, d, gc, vx, vy, vw, vh, dx, dy, dw, dh\fP) +.sp 1l +.B register +.I Display +.I *dpy; +.br +.B XvPortID +.I port; +.br +.B Drawable +.I d; +.br +.B GC +.I gc; +.br +.B int +.I vx, +.I vy, +.I dx, +.I dy; +.br +.B unsigned int +.I vw, +.I vh; +.br +.B unsigned int +.I dw, +.I dh; +.sp 1l +.\" +.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 + diff --git a/lib/libXv/man/XvGetVideo.man b/lib/libXv/man/XvGetVideo.man new file mode 100644 index 000000000..725ed29ad --- /dev/null +++ b/lib/libXv/man/XvGetVideo.man @@ -0,0 +1,127 @@ +.TH XvGetVideo __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvGetVideo.man,v 1.4 1999/03/02 11:49:14 dawes Exp $ +.SH Name +XvGetVideo \- capture video from a drawable +.\" +.SH Syntax +.B include "Xvlib.h" +.sp 1l +.B XvGetVideo(dpy, port, d, gc, vx, vy, vw, vh, dx, dy, dw, dh) +.sp 1l +.B register +.I Display +.I *dpy; +.br +.B XvPortID +.I port; +.br +.B Drawable +.I d; +.br +.B GC +.I gc; +.br +.B int +.I vx, +.I vy, +.I dx, +.I dy; +.br +unsigned int +.I vw, +.I vh; +.br +unsigned int +.I dw, +.I dh; +.sp 1l +.\" +.SH Arguments +.\" +.IP \fIdpy\fR 15 +Specifies the connection to the X server. +.IP \fIport\fR 15 +Defines the port to which video output is sent. +.IP \fId\fR 15 +Defines the drawable (window) from which video output is to be obtained. +.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 video region 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 of the source drawable from which the +video image is to be taken. +.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. +.br +.SH Description +.PN XvGetVideo +outputs video from a drawable. The position +and size of the destination rectangle is specified by +.I vx, +.I vy, +.I vw, +and +.I vh. +The position and size of the source rectangle is specified by +.I dx, +.I dy, +.I dw, +and +.I dh. +.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 video is successfully initiated, an XvVideoNotify event with +detail XvStarted is generated for the drawable. If the port is +already in use, its video is preempted, and if the new drawable is +different than the old, an XvVideoNotify event with detail XvPreempted +is generated for the old drawable. If the port is grabbed by another +client, this request is ignored, and an XvVideoNotify event with detail +XvBusy is generated for the drawable. +.\" +.br +.SH Returned Values +.IP [Success] 8 +Returned if XvGetVideo(__libmansuffix__) completed successfully. +.IP [XvBadExtension] 8 +Returned if the Xv extension is unavailable. +.IP [XvBadAlloc] 8 +Returned if XvGetVideo(__libmansuffix__) failed to allocate memory to process +the request. +.SH Diagnostics +.IP [XvBadPort] 8 +Generated if the requested port does not exist. +.IP [BadGC] 8 +Generated if the requested graphics context does not exist. +.IP [BadDrawable] 8 +Generated if the requested drawable does not exist. +.IP [BadAlloc] 8 +Generated if there were insufficient resources to process the request. +.SH See Also +.br +.\" +XvGetStill(__libmansuffix__), XvPutVideo(__libmansuffix__), XvVideoNotify(__libmansuffix__) +.br diff --git a/lib/libXv/man/XvGrabPort.man b/lib/libXv/man/XvGrabPort.man new file mode 100644 index 000000000..ffb7972bd --- /dev/null +++ b/lib/libXv/man/XvGrabPort.man @@ -0,0 +1,64 @@ +.TH XvGrabPort __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvGrabPort.man,v 1.4 1999/03/02 11:49:14 dawes Exp $ +.SH Name +XvGrabPort \- lock port for exclusive use by client +.\" +.SH Syntax +.B #include <X11/extensions/Xvlib.h> +.sp 1l +.B XvGrabPort(\fIdpy, port, time)\fR +.sp 1l +.B Display \fI*dpy;\fR +.br +.B XvPortID +.I port; +.br +.B Time +.I time; +.\" +.SH Arguments +.\" +.IP \fIdpy\fR 8 +Specifies the connection to the X server. +.IP \fIport\fR 8 +Defines the port to be grabbed. +.IP \fItime\fR 8 +Specifies the request timestamp. +.\" +.SH Description +.\" +XvGrabPort(__libmansuffix__) grabs a port. Once a client grabs a port, +only that client can make video requests +to that port. +.PP +If the time is before the current port time, the XvGrabPort request is +ignored and XvInvalidTime is returned. If the port is already grabbed by +another client, XvAlreadyGrabbed is returned. Otherwise it returns a +status of \fISuccess\fR. The port time is updated when the following +requests are processed: XvGrabPort(__libmansuffix__), XvUngrabPort(__libmansuffix__), +XvPutVideo(__libmansuffix__), XvPutStill(__libmansuffix__), XvGetVideo(__libmansuffix__), XvGetStill(__libmansuffix__). +.PP +If the port is actively processing video for another client, the +video is preempted, and an XvVideoNotify event with detail XvPreempted +is generated for its drawable. +.\" +.SH Returned Values +.IP [Success] 8 +Returned if XvGrabPort(__libmansuffix__) completed successfully. +.IP [XvInvalidTime] 8 +Returned if requested time is older than the current port time. +.IP [XvAlreadyGrabbed] 8 +Returned if the port is already grabbed by another client. +.IP [XvBadExtension] 8 +Returned if the Xv extension is unavailable. +.IP [XvBadAlloc] 8 +Returned if XvGrabPort(__libmansuffix__) failed to allocate memory to process +the request. +.SH Diagnostics +.IP [XvBadPort] 15 +Generated if the requested port does not exist. +.\" +.SH See Also +.\" +XvUngrabPort(__libmansuffix__) XvVideoNotify(__libmansuffix__) +.br diff --git a/lib/libXv/man/XvPortNotify.man b/lib/libXv/man/XvPortNotify.man new file mode 100644 index 000000000..d487b5ebc --- /dev/null +++ b/lib/libXv/man/XvPortNotify.man @@ -0,0 +1,58 @@ +.TH XvPortNotify __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvPortNotify.man,v 1.4 1999/03/02 11:49:15 dawes Exp $ +.SH Name +XvPortNotify \- event generated when port attributes change +.\" +.SH Syntax +.B #include <X11/extensions/Xvlib.h> +.br +.sp 1l +.EX + + typedef union { + int type; + XvVideoNotifyEvent xvvideo; + XvPortNotifyEvent xvport; + long pad[24]; + } XvEvent; + + typedef struct { + int type; + unsigned long serial; + Bool send_event; + Display *display; + XvPortID port_id; + Time time; + Atom attribute; + long value; + } XvPortNotifyEvent; + +.EE +.\" +.IP \fItype\fR 8 +Specifies the type of event: XvPortNotify. +.IP \fIserial\fR 8 +Number of the last request processed by the server. +.IP \fIsend_event\fR 8 +True if the event was generated by a SendEvent request. +.IP \fIdisplay\fR 8 +A pointer to the display the event was read from. +.IP \fIport_id\fR 8 +The port whose attribute has changed. +.IP \fIattribute\fR 8 +An atom specifying the attribute that changed. +.IP \fIvalue\fR 8 +The new value of the attribute. +.\" +.SH Description +.\" +XvPortNotify events are generated when a port attribute is set using +the XvSetPortAttribute(__libmansuffix__) function. +.\" +.SH See Also +XvSetPortAttribute(__libmansuffix__), XvGetPortAttribute(__libmansuffix__), XvSelectPortNotify(__libmansuffix__) +.\" + + + + diff --git a/lib/libXv/man/XvPutStill.man b/lib/libXv/man/XvPutStill.man new file mode 100644 index 000000000..2231ff613 --- /dev/null +++ b/lib/libXv/man/XvPutStill.man @@ -0,0 +1,102 @@ +.TH XvPutStill __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvPutStill.man,v 1.4 1999/03/02 11:49:15 dawes Exp $ +.SH Name +XvPutStill \- write a single frame of video to a drawable +.\" +.SH Syntax +.B #include <X11/extensions/Xvlib.h> +.sp 1l +\fBXvPutStill(\fIdpy, port, d, gc, vx, vy, vw, vh, dx, dy, dw, dh\fR) +.sp 1l +.B Display +.I *dpy; +.br +.B XvPortID +.I port; +.br +.B Drawable +.I d; +.br +.B GC +.I gc; +.br +.B int +.I vx, +.I vy, +.I dx, +.I dy; +.br +.B unsigned int +.I vw, +.I vh; +.br +.B unsigned int +.I dw, +.I dh; +.sp 1l +.\" +.SH Arguments +.\" +.IP \fIdpy\fR 15 +Specifies the connection to the X server. +.IP \fIport\fR 15 +Defines the port from which to get the still. +.IP \fId\fR 15 +Defines the drawable into which the still is to be written. +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 video region +to be written. \fIvx\fP and \fIvy\fP define the +upper-left pixel of the region. \fIvw\fP and \fIvh\fP +define the width and height, in pixels, of the region. +.IP \fIdx,dy,dw,dh\fR 15 +Define the location and size of the destination region into which the +still image is written. \fIdx\fP and \fIdy\fP define the upper-left +corner of the region. \fIdw\fP and \fIdh\fP +define the width and height, in pixels, of the region. +.\" +.SH Description +.\" +XvPutStill(__libmansuffix__) writes a single frame of video to a drawable. +The position and size of the source (video) rectangle is specified by \fIvx, +vy, vw\fR, and \fIvh\fR. The position and size of the destination (drawable) +rectangle is specified by \fIdx, dy, dw\fR, and \fIdh\fR. +.PP +Video data is clipped to the bounds of the video encoding, scaled to the +requested drawable region size (or the closest size supported) and +clipped to the bounds of the drawable. +.PP +If the port is grabbed by another client, this request is ignored, and +an XvVideoNotify event with detail XvBusy is generated for the +drawable. If the port is not receiving a valid video signal a +VideoNotify event with detail XvHardError is generated for the drawable. +.\" +.SH Returned Values +.IP [Success] 8 +Returned if XvPutStill(__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 +.\" +XvPutVideo(__libmansuffix__), XvGetStill(__libmansuffix__), XvVideoNotify(__libmansuffix__) +.br diff --git a/lib/libXv/man/XvPutVideo.man b/lib/libXv/man/XvPutVideo.man new file mode 100644 index 000000000..c0854e9fc --- /dev/null +++ b/lib/libXv/man/XvPutVideo.man @@ -0,0 +1,113 @@ +.TH XvPutVideo __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvPutVideo.man,v 1.4 1999/03/02 11:49:15 dawes Exp $ +.SH Name +XvPutVideo \- write video into a drawable +.\" +.SH Syntax +.B #include <X11/extensions/Xvlib.h> +.sp 1l +\fBXvPutVideo(\fIdpy, port, d, gc, vx, vy, vw, vh, dx, dy, dw, dh\fR) +.sp 1l +.B Display +.I *dpy; +.br +.B XvPortID +.I port; +.br +.B Drawable +.I d; +.br +.B GC +.I gc; +.br +.B int +.I vx, +.I vy, +.I dx, +.I dy; +.br +.B unsigned int +.I vw, +.I vh; +.br +.B unsigned int +.I dw, +.I dh; +.sp 1l +.\" +.SH Arguments +.\" +.IP \fIdpy\fR 15 +Specifies the connection to the X server. +.IP \fIport\fR 15 +Defines the port from which to get video. +.IP \fId\fR 15 +Defines the drawable (window) into which video is to be written. +.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 size and location of the source (video) region +to be written. \fIvx\fP and \fIvy\fP define the +upper-left pixel of the region. \fIvw\fP and \fIvh\fP +define the width and height, in pixels, of the region. +.IP \fIdx,dy,dw,dh\fR 15 +Define the location and size of the destination (drawable) region +into which the video image is written. +.I dx +and +.I dy +define the upper-left pixel of the region. +.I dw +and +.I dh +define the width and height, in pixels, of the region. +.\" +.SH Description +.\" +XvPutVideo writes video into a drawable. +The position and size of the source (video) +rectangle is specified by \fIvx, vy, vw\fR, and \fIvh\fR. +The position and size of the destination (drawable) +rectangle is specified by \fIdx, dy, dw\fR, and \fIdh\fR. +.PP +Video data is clipped to the bounds of the video encoding, scaled to the +requested drawable region size (or the closest size supported) and +clipped to the bounds of the drawable. +.PP +If video is successfully initiated, an XvVideoNotify event with detail +XvStarted is generated for the drawable. If the port is already in +use, its video is preempted, and if the new drawable is different than +the old, an XvVideoNotify event with detail XvPreempted is generated +for the old drawable. If the port is grabbed by another client, this +request is ignored, and an XvVideoNotify event with detail XvBusy is +generated for the drawable. If the port is not receiving a valid video +signal or if the video signal is interrupted while video is active a +VideoNotify event with detail XvHardError is generated for the drawable. +.\" +.SH Returned Values +.IP [Success] 8 +Returned if XvPutVideo(__libmansuffix__) completed successfully. +.IP [XvBadExtension] 8 +Returned if the Xv extension is unavailable. +.IP [XvBadAlloc] 8 +Returned if there were insufficient resources 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__), XvVideoNotify(__libmansuffix__) +.br diff --git a/lib/libXv/man/XvQueryAdaptors.man b/lib/libXv/man/XvQueryAdaptors.man new file mode 100644 index 000000000..b9ff5b7a3 --- /dev/null +++ b/lib/libXv/man/XvQueryAdaptors.man @@ -0,0 +1,94 @@ +.TH XvQueryAdaptors __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvQueryAdaptors.man,v 1.5 2001/01/27 18:20:36 dawes Exp $ +.SH Name +XvQueryAdaptors \- return adaptor information for a screen +.\" +.SH Syntax +.B #include <X11/extensions/Xvlib.h> +.br +.sp 1l +.B XvQueryAdaptors(\fIdpy, win, p_num_adaptors, pp_adaptor_info\fR) +.sp 1l +\fBDisplay \fI*dpy;\fR +.br +\fBDrawable \fI draw;\fR +.br +\fBint \fI*p_num_adaptors\fR; +.br +\fBXvAdaptorInfo \fI**pp_adaptor_info\fR; +.br +.\" +.SH Arguments +.\" +.IP \fIdpy\fR 8 +Specifies the connection to the X server. +.IP \fIdraw\fR 8 +Specifies a drawable of the screen for which the adaptor +information is desired. +.IP \fIp_num_adaptors\fR 8 +A pointer to where the number of adaptors for the specified screen +is returned. +.IP \fIpp_adaptor_info\fR 8 +A pointer to where the list of returned adaptor information is +returned. +.\" +.SH Description +.\" +XvQueryAdaptors(__libmansuffix__) returns an video adaptor information for +the screen of the specified drawable. The XvAdaptorInfo structure +has the following organization: +.EX + + typedef struct { + XvPortID base_id; + unsigned long num_ports; + char type; + char *name; + unsigned long num_formats; + XvFormat *formats; + unsigned long num_adaptors; + } XvAdaptorInfo; + +.EE +.IP \fIbase_id\fR 8 +The resource ID of the first adaptor port. +.IP \fInum_ports\fR 8 +The number of ports supported by the adaptor. +.IP \fItype\fR 8 +A bit mask with the value XvInputMask asserted if the adaptor supports video +input, and value XvOutputMask asserted if the adaptor supports video output. +.IP \fIname\fR 8 +A vendor specific name that identifies the adaptor. +.IP \fInum_formats\fR 8 +The number of depth/visual id formats supported by the adaptor. +.IP \fIformats\fR 8 +A pointer to an array of XvFormat structures. +.PP +The XvFormat structure has the following organization: +.EX + + typedef struct { + char depth; + unsigned long visual_id; + } XvFormat; + +.EE +.IP \fIdepth\fR 8 +A drawable depth supported by the adaptor. +.IP \fIvisual_id\fR 8 +A visual-id supported for the given depth by the adaptor. +.\" +.SH Returned Values +.IP [Success] 8 +Returned if XvQueryAdaptors(__libmansuffix__) completed successfully. +.IP [XvBadExtension] 8 +Returned if the Xv extension is unavailable. +.IP [XvBadAlloc] 8 +Returned if XvQueryAdaptors(__libmansuffix__) failed to allocate memory to process +the request. +.SH Diagnostics +.IP [Drawable] 8 +Returned if the requested drawable does not exist. +.SH See Also +XvFreeAdaptorInfo(__libmansuffix__) +.\" diff --git a/lib/libXv/man/XvQueryBestSize.man b/lib/libXv/man/XvQueryBestSize.man new file mode 100644 index 000000000..7bec9315b --- /dev/null +++ b/lib/libXv/man/XvQueryBestSize.man @@ -0,0 +1,62 @@ +.TH XvQueryBestSize __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvQueryBestSize.man,v 1.4 1999/03/02 11:49:16 dawes Exp $ +.SH Name +XvQueryBestSize \- determine the optimum drawable region size +.\" +.SH Syntax +.B #include <X11/extensions/Xvlib.h> +.sp 1l +\fBXvQueryBestSize\fP(\fIdpy, port, motion, vw, vh, dw, dh, p_dw, p_dh\fR) +.sp 1l +.B Display \fI*dpy\fR; +.br +.B XvPortID \fIport\fR; +.br +.B Bool \fImotion\fR; +.br +.B unsigned +.B int \fIvw, vh\fR; +.br +\fBunsigned int \fIdw, dh;\fR +.br +\fBunsigned int \fI*p_dw, *p_dh;\fR +.\" +.SH Arguments +.\" +.IP \fIdpy\fR 15 +Specifies the connection to the X server. +.IP \fIport\fR 15 +Defines the port associated with the display and adaptor for which +the optimum size is to be calculated. +.IP \fImotion\fR 15 +Specifies \fITrue\fP if the destination size needs to support +full motion, and \fIFalse\fP if the destination size need only +support still images. +.IP \fIvw,vh\fR 15 +Specifies the size of the source video region desired. +.IP \fIdw,dh\fR 15 +Specifies the size of the destination drawable region desired. +.IP \fIp_dw,p_dh\fR 15 +Pointers to where the closest destination sizes supported by the server are +returned. +.\" +.SH Description +.\" +Some ports may be able to scale incoming or outgoing video. +XvQueryBestSize(__libmansuffix__) returns the size of the closest destination +region that is supported by the adaptor. The returned size is +guaranteed to be smaller than the requested size if a smaller +size is supported. +.\" +.SH Returned Values +.IP [Success] 8 +Returned if XvQueryBestSize(__libmansuffix__) completed successfully. +.IP [XvBadExtension] 8 +Returned if the Xv extension is unavailable. +.IP [XvBadAlloc] 8 +Returned if XvQueryBestSize(__libmansuffix__) failed to allocate memory to process +the request. +.SH Diagnostics +.IP [XvBadPort] 8 +Generated if the requested port does not exist. +.br diff --git a/lib/libXv/man/XvQueryEncodings.man b/lib/libXv/man/XvQueryEncodings.man new file mode 100644 index 000000000..ae3782568 --- /dev/null +++ b/lib/libXv/man/XvQueryEncodings.man @@ -0,0 +1,88 @@ +.TH XvQueryEncodings __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvQueryEncodings.man,v 1.5 2000/03/21 23:17:20 dawes Exp $ +.SH Name +XvQueryEncodings \- return list of encodings for an adaptor +.\" +.SH Syntax +.B #include <X11/extensions/Xvlib.h> +.sp 1l +\fBXvQueryEncodings(\fIdpy, port, p_num_encodings, pp_encoding_info)\fR +.sp 1l +\fBregister Display \fI*dpy\fR; +.br +\fBXvPortID \fIport\fR; +.br +\fBunsigned long \fI*p_num_encodings\fR; +.br +\fBXvEncodingInfo \fI**pp_encoding_info\fR; +.\" +.SH Arguments +.IP \fI*dpy\fR 15 +Specifies the connection to the X server. +.IP \fIport\fR 15 +Specifies the port whose adaptor is to be queried for its +list of encodings. +.IP \fIp_num_encodings\fR 15 +A pointer to where the number of encodings supported +by the adaptor is written. +.IP \fIpp_encoding_info\fR 15 +A pointer to where the list of returned +encoding information is returned. +XvEncodingInfo has the following structure: +.EX + + typedef struct { + XvEncodingID encoding_id; + char *name; + unsigned long width; + unsigned long height; + XvRational rate; + unsigned long num_encodings; + } XvEncodingInfo; + +.EE +.IP \fIencoding_id\fR 15 +Specifies the encoding-id of the encoding. The encoding-id is used to +identify an encoding when a port's encoding attribute is changed. +.IP \fIname\fR 15 +A pointer to a formatted string that identifies the encoding. The string +has the format "\fItiming-signaltype\fR". For example "ntsc-composite". +.IP \fIwidth,height\fR 15 +The width and height, in pixels, of the decoded video image. +.IP \fIrate\fR 15 +The field rate of the decoded video. +.PP +The XvRational structure is used to specify a fractional number. +It has the following structure: +.EX + + typedef struct { + int numerator; + int denominator; + } XvRational; + +.EE +The \fInumerator\fP and \fIdenominator\fP fields specify the +appropriate parts of a fractional number. +.\" +.SH Description +XvQueryEncodings(__libmansuffix__) returns encoding information about an adaptor. Each +encoding is described by the XvEncodingInfo structure described above. The +encodings are identified by an encoding-id, which can be used to set or get +the encoding attribute of a port. +.SH Returned Values +.IP [Success] 8 +Returned if XvQueryEncodings(__libmansuffix__) completed successfully. +.IP [XvBadExtension] 8 +Returned if the Xv extension is unavailable. +.IP [XvBadAlloc] 8 +Returned if XvQueryEncodings(__libmansuffix__) failed to allocate memory to process +the request. +.SH Diagnostics +.IP [XvBadPort] 8 +Generated if the requested port does not exist. +.\" +.SH See Also +.\" +XvFreeEncodingInfo(__libmansuffix__) +.br diff --git a/lib/libXv/man/XvQueryExtension.man b/lib/libXv/man/XvQueryExtension.man new file mode 100644 index 000000000..9ba283bc2 --- /dev/null +++ b/lib/libXv/man/XvQueryExtension.man @@ -0,0 +1,51 @@ +.TH XvQueryExtension __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvQueryExtension.man,v 1.5 2001/01/27 18:20:36 dawes Exp $ +.SH Name +XvQueryExtension \- return version and release of extension +.\" +.SH Syntax +.B #include <X11/extensions/Xvlib.h> +.sp 1l +\fBXvQueryExtension(\fIdpy, p_version, p_release, +.br + p_request_base, p_event_base, p_error_base\fR) +.sp 1l +\fBDisplay \fI*dpy\fR; +.br +\fBunsigned int \fI*p_version, *p_release\fR; +.br +\fBunsigned int \fI*p_request_base, *p_event_base, *p_error_base\fR; +.\" +.SH Arguments +.\" +.IP \fIp_version\fR 15 +Pointer to where the current version number of the \fIXv\fP video extension +is written. +.IP \fIp_release\fR 15 +Pointer to where the release number of the \fIXv\fP video extension +is written. +.IP \fIp_request_base\fR 15 +Pointer to where the extension major request number is returned +.IP \fIp_event_base\fR 15 +Pointer to where the extension event base is returned +.IP \fIp_error_base\fR 15 +Pointer to where the extension error base is returned +.\" +.SH Description +.\" +.PP +XvQueryExtension(__libmansuffix__) returns the version and release +numbers for the Xv video extension currently loaded +on the system. The extension major request number, event base, and error +base are also returned. +.\" +.SH Returned Values +.IP [Success] 8 +Returned if XvQueryExtension(__libmansuffix__) completed successfully. +.IP [XvBadExtension] 8 +Returned if the Xv video extension is not available for +the named display. +.IP [XvBadAlloc] 8 +Returned if XvQueryExtension(__libmansuffix__) failed to allocate memory to process +the request. +.br diff --git a/lib/libXv/man/XvSelectPortNotify.man b/lib/libXv/man/XvSelectPortNotify.man new file mode 100644 index 000000000..f146b7d30 --- /dev/null +++ b/lib/libXv/man/XvSelectPortNotify.man @@ -0,0 +1,47 @@ +.TH XvSelectPortNotify __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvSelectPortNotify.man,v 1.5 2001/01/27 18:20:36 dawes Exp $ +.SH Name +XvSelectPortNotify \- enable or disable XvPortNotify(__libmansuffix__) events +.\" +.SH Syntax +.B #include <X11/extensions/Xvlib.h> +.sp 1l +\fBXvSelectPortNotify(\fIdpy, port, onoff\fR) +.sp 1l +\fBDisplay \fI*dpy\fR; +.br +\fBXvPortID \fIport\fR; +.br +\fBBool \fIonoff\fR; +.\" +.SH Arguments +.\" +.IP \fIdpy\fR 8 +Specifies the connection to the X server. +.IP \fIport\fR 8 +Specifies the port for which PortNotify events are to be generated +when its attributes are changed using XvSetPortAttribute(__libmansuffix__). +.IP \fIonoff\fR 8 +Specifies whether notification is to be enabled or disabled. +.\" +.SH Description +.\" +XvSelectPortNotify(__libmansuffix__) enables or disables PortNotify event +delivery to the requesting client. XvPortNotify(__libmansuffix__) events are +generated when port attributes are changed using XvSetPortAttribute(__libmansuffix__). +.\" +.SH Returned Values +.IP [Success] 8 +Returned if XvSelectPortNotify(__libmansuffix__) completed successfully. +.IP [XvBadExtension] 8 +Returned if the Xv extension is unavailable. +.IP [XvBadAlloc] 8 +Returned if XvSelectPortNotify(__libmansuffix__) failed to allocate memory to process +the request. +.SH Diagnostics +.IP [XvBadPort] 8 +Generated if the requested port does not exist. +.SH See Also +.\" +XvSetPortNotify(__libmansuffix__), XvSetPortAttribute(__libmansuffix__), XvPortNotify(__libmansuffix__) +.br diff --git a/lib/libXv/man/XvSelectVideoNotify.man b/lib/libXv/man/XvSelectVideoNotify.man new file mode 100644 index 000000000..d8e2dc439 --- /dev/null +++ b/lib/libXv/man/XvSelectVideoNotify.man @@ -0,0 +1,43 @@ +.TH XvSelectVideoNotify __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvSelectVideoNotify.man,v 1.5 2001/01/27 18:20:36 dawes Exp $ +.SH Name +XvSelectVideoNotify \- enable or disable VideoNotify events +.\" +.SH Syntax +\fB#include\fI <X11/extensions/Xvlib.h>\fR +.sp 1l +\fBXvSelectVideoNotify(\fIdpy, drawable, onoff\fR) +.sp 1l +\fBregister Display \fI*dpy\fR; +.br +\fBDrawable \fIdrawable\fR; +.br +\fBBool \fIonoff\fR; +.SH Arguments +.\" +.IP \fIdpy\fR 15 +Specifies the connection to the X server. +.IP \fIdrawable\fR 15 +Defines the drawable in which video activity is to be reported. +.IP \fIonoff\fR 15 +Selects whether video notification is enabled or disabled. +.\" +.SH Description +XvSelectVideoNotify(__libmansuffix__) enables or disables events to be reported for +video activity in a drawable. +.\" +.SH Returned Values +.IP [Success] 8 +Returned if XvSelectVideoNotify(__libmansuffix__) completed successfully. +.IP [XvBadExtension] 8 +Returned if the Xv extension is unavailable. +.IP [XvBadAlloc] 8 +Returned if XvSelectVideoNotify(__libmansuffix__) failed to allocate memory to process +the request. +.SH Diagnostics +.IP [BadDrawable] 8 +Generated if the requested drawable does not exist. +.SH See Also +.\" +XvVideoNotify +.br diff --git a/lib/libXv/man/XvSetPortAttribute.man b/lib/libXv/man/XvSetPortAttribute.man new file mode 100644 index 000000000..db4bf5ff7 --- /dev/null +++ b/lib/libXv/man/XvSetPortAttribute.man @@ -0,0 +1,94 @@ +.TH XvSetPortAttribute __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvSetPortAttribute.man,v 1.6 2001/01/27 18:20:36 dawes Exp $ +.SH Name +XvSetPortAttribute \- sets an attribute of a video port +.\" +.SH Syntax +\fB#include <X11/extensions/Xvlib.h>\fR +.sp 1l +\fBXvSetPortAttribute(\fIdpy, port, attribute, value\fR) +.sp 1l +\fBDisplay \fI*dpy\fR; +.br +\fBXvPortID \fIport\fR; +.br +\fBAtom \fIattribute\fR; +.br +\fBint \fIvalue\fR; +.SH Arguments +.\" +.IP \fIdpy\fR 15 +Specifies the connection to the X server. +.IP \fIport\fR 15 +Specifies the port for which the attribute is to be used. +.IP \fIattribute\fR 15 +Identifies the port attribute to be set by this request. +Can be one of the table entries under the column "String," below. +.IP \fIvalue\fR 15 +Identifies the value to which \fIattribute\fP is to be set. +Can be one of the table entries under the column "Type," below. +.\" +.SH Description +XvSetPortAttribute(__libmansuffix__) permits a client to set the port attribute +to specified values. This request supports the following values: +.bp +.PP +.\" .TS +.\" tab(@); +.\" lfHB lfHB lfHB +.\" lfR lfR lfR . +.\" _ +.\" .PP +.\" .sp 4p +.\" Attribute String@Type@Default +.\" .sp 6p +.\" _ +.\" .sp 6p +.\" "XV_ENCODING"@XvEncodingID@Server dependent +.\" "XV_HUE"@[-1000...1000]@0 +.\" "XV_SATURATION"@[-1000...1000]@0 +.\" "XV_BRIGHTNESS"@[-1000...1000]@0 +.\" "XV_CONTRAST"@[-1000...1000]@0 +.\" .sp 6p +.\" .TE +.nf +Attribute String Type Default + +"XV_ENCODING" XvEncodingID Server dependent +"XV_HUE" [-1000...1000] 0 +"XV_SATURATION" [-1000...1000] 0 +"XV_BRIGHTNESS" [-1000...1000] 0 +"XV_CONTRAST" [-1000...1000] 0 +.fi +.PP +The supplied encoding must be one of the encodings listed for the +adaptor, otherwise an Encoding error results. +.PP +If the adaptor does not support the exact hue, saturation, +brightness, and contrast levels supplied, the closest levels +supported are assumed. Use XvGetPortAttribute(__libmansuffix__) +to query the resulting levels. +.PP +When an XvSetPortAttribute(__libmansuffix__) request is processed, a +PortControlNotify(__libmansuffix__) event is generated for all clients +that have requested for port changes using XvSelectPortNotify(__libmansuffix__). +.SH Returned Values +.IP [Success] 8 +Returned if XvSetPortAttribute(__libmansuffix__) completed successfully. +.IP [XvBadExtension] 8 +Returned if the Xv extension is unavailable. +.IP [XvBadAlloc] 8 +Returned if XvSelectVideoNotify(__libmansuffix__) failed to allocate memory to process +the request. +.SH Diagnostics +.IP [XvBadPort] 8 +Generated if the requested port does not exist. +.IP [XvBadEncoding] 8 +Generated if an encoding is specified that does not exist. +.IP [BadMatch] 8 +Generated if the requested attribute atom does not specify an attribute +supported by the adaptor. +.SH See Also +.\" +XvGetPortAttribute(__libmansuffix__), XvSelectPortNotify(__libmansuffix__), XvPortNotify(__libmansuffix__) +.br diff --git a/lib/libXv/man/XvStopVideo.man b/lib/libXv/man/XvStopVideo.man new file mode 100644 index 000000000..e2222e338 --- /dev/null +++ b/lib/libXv/man/XvStopVideo.man @@ -0,0 +1,50 @@ +.TH XvStopVideo __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvStopVideo.man,v 1.5 2001/01/27 18:20:36 dawes Exp $ +.SH Name +XvStopVideo \- stop active video +.\" +.SH Syntax +\fB#include <X11/extensions/Xvlib.h> +.sp 1l +\fBXvStopVideo(\fIdpy, port, draw\fR) +.sp 1l +\fBDisplay \fI*dpy\fR; +.br +\fBXvPortID \fIport\fR; +.br +\fBDrawable \fIdraw\fR; +.\" +.SH Arguments +.\" +.\" +.IP \fIdpy\fR 15 +Specifies the connection to the X server. +.IP \fIport\fR 15 +Specifies the port for which video is to be stopped. +.IP \fIdraw\fR 15 +Specifies the drawable associated with the named port. +.SH Description +.\" +XvStopVideo(__libmansuffix__) stops active video for the specified port and +drawable. If the port is not processing video, or if it is processing +video in a different drawable, the request is ignored. When video is +stopped a XvVideoNotify(__libmansuffix__) event with detail XvStopped is generated +for the associated drawable. +.\" +.SH Returned Values +.IP [Success] 8 +Returned if XvStopVideo(__libmansuffix__) completed successfully. +.IP [XvBadExtension] 8 +Returned if the Xv extension is unavailable. +.IP [XvBadAlloc] 8 +Returned if XvStopVideo(__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. +.\" +.SH See Also +XvGetVideo(__libmansuffix__), XvPutVideo(__libmansuffix__), XvVideoNotifyEvent(__libmansuffix__) +.br diff --git a/lib/libXv/man/XvUngrabPort.man b/lib/libXv/man/XvUngrabPort.man new file mode 100644 index 000000000..d2f073b8f --- /dev/null +++ b/lib/libXv/man/XvUngrabPort.man @@ -0,0 +1,45 @@ +.TH XvUngrabPort __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvUngrabPort.man,v 1.5 2001/01/27 18:20:36 dawes Exp $ +.SH Name +XvUngrabPort \- release port grabbed for video operation +.\" +.SH Syntax +\fB#include <X11/extensions/Xvlib.h> +.sp 1l +XvUngrabPort(\fIdpy, port, time\fR) +.sp 1l +\fBDisplay \fI*dpy\fR; +.br +\fBXvPortID \fIport\fR; +.br +\fBTime \fItime\fR; +.SH Arguments +.\" +.IP \fIdpy\fR 15 +Specifies the connection to the X server. +.IP \fIport\fR 15 +Specifies the port to be released. If the port had not been +previously grabbed, the request is ignored. +.IP \fItime\fR 15 +Specifies the request timestamp. +.\" +.SH Description +XvUngrabPort(__libmansuffix__) releases a grabbed port. If \fItime\fR specifies a +time before the last XvGrabPort(__libmansuffix__) was executed, the +request is ignored. +.\" +.SH Returned Values +.IP [Success] 8 +Returned if XvUngrabPort(__libmansuffix__) completed successfully. +.IP [XvBadExtension] 8 +Returned if the Xv extension is unavailable. +.IP [XvBadAlloc] 8 +Returned if XvUngrabPort(__libmansuffix__) failed to allocate memory to process +the request. +.SH Diagnostics +.IP [XvBadPort] 8 +Generated if the requested port does not exist. +.SH See Also +.\" +XvGrabPort(__libmansuffix__) +.br diff --git a/lib/libXv/man/XvVideoNotify.man b/lib/libXv/man/XvVideoNotify.man new file mode 100644 index 000000000..3cb07c873 --- /dev/null +++ b/lib/libXv/man/XvVideoNotify.man @@ -0,0 +1,58 @@ +.TH XvVideoNotify __libmansuffix__ __vendorversion__ +.\" $XFree86: xc/doc/man/Xv/XvVideoNotify.man,v 1.5 2001/01/27 18:20:36 dawes Exp $ +.SH Name +XvVideoNotify \- event generated for video processing +.\" +.SH Syntax +.B #include <X11/extensions/Xvlib.h> +.br +.sp 1l +.EX + + typedef union { + int type; + XvVideoNotifyEvent xvvideo; + XvPortNotifyEvent xvport; + long pad[24]; + } XvEvent; + + typedef struct { + int type; + unsigned long serial; + Bool send_event; + Display *display; + Drawable drawable; + unsigned long reason; + XvPortID port_id; + Time time; + } XvVideoNotifyEvent; + +.EE +.\" +.IP \fItype\fR 8 +Specifies the type of event: XvVideoNotify(__libmansuffix__). +.IP \fIserial\fR 8 +Number of the last request processed by the server. +.IP \fIsend_event\fR 8 +True if the event was generated by a SendEvent request. +.IP \fIdisplay\fR 8 +A pointer to the display the event was read from. +.IP \fIdrawable\fR 8 +The drawable for which the event was generated. +.IP \fIreason\fR 8 +The reason the event was generated: \fBXvStarted\fR, \fBXvStopped\fR, +\fBXvPreempted\fR, \fBXvBusy\fR, \fBXvHardError\fR. +.IP \fIport_id\fR 8 +The port processing the video for which the event was generated. +.\" +.SH Description +.\" +XvVideoNotify(__libmansuffix__) events are generated when video +is started, stopped, preempted by another video +request, ignored because the port is grabbed by another client, or interrupted +because of a hard transmission or reception error. +.\" +.SH See Also +XvPutVideo(__libmansuffix__), XvPutStill(__libmansuffix__), XvGetVideo(__libmansuffix__), XvGetStill(__libmansuffix__), +XvStopVideo(__libmansuffix__), XvSelectVideoNotify(__libmansuffix__) +.\" |