From b13aae56fe48c89e3b1dbefaf165cbab0102216b Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Mon, 31 Aug 2009 21:28:58 -0300 Subject: v4l2-spec: convert it to use DocBook XML 4.1.2 From: Mauro Carvalho Chehab DocBook XML 4.1.2 is the docbook dialect spoken at Linux kernel. By using it, we can now consider adding V4L2 API docs at the kernel tree. As a bonus, added support for xmlto, with seems to be better supported nowadays. Another additional bounus is that two new Makefile targets were added: make man - Create V4L2 API man pages make man_install - Install V4L2 API man pages By allowing the addition of V4L2 manpages, it is now easier for developer to quickly check about a V4L2 API or libv4l2 call syntax and expected return values. Priority: normal Signed-off-by: Mauro Carvalho Chehab --- v4l2-spec/vidioc-g-fbuf.sgml | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) (limited to 'v4l2-spec/vidioc-g-fbuf.sgml') diff --git a/v4l2-spec/vidioc-g-fbuf.sgml b/v4l2-spec/vidioc-g-fbuf.sgml index 6781b5334..f70170626 100644 --- a/v4l2-spec/vidioc-g-fbuf.sgml +++ b/v4l2-spec/vidioc-g-fbuf.sgml @@ -118,14 +118,14 @@ can set the parameters for a destructive video overlay. capability Overlay capability flags set by the driver, see -. +. __u32 flags Overlay control flags set by application and -driver, see +driver, see void * @@ -149,7 +149,7 @@ provide a base address. The driver may accept only base addresses which are a multiple of two, four or eight bytes. For Video Output Overlays the driver must return a valid base address, so applications can find the corresponding Linux -framebuffer device (see ). +framebuffer device (see ). &v4l2-pix-format; @@ -157,7 +157,7 @@ framebuffer device (see ). Layout of the frame buffer. The v4l2_pix_format structure is defined in , for clarification the fields and acceptable values +linkend="pixfmt" />, for clarification the fields and acceptable values are listed below: @@ -207,7 +207,7 @@ not including V4L2_PIX_FMT_YUYV and V4L2_PIX_FMT_UYVY) and the V4L2_PIX_FMT_PAL8 format are also permitted. The behavior of the driver when an application requests a compressed -format is undefined. See for information on +format is undefined. See for information on pixel formats. @@ -270,7 +270,7 @@ driver. colorspace This information supplements the pixelformat and must be set by the driver, -see . +see . @@ -371,15 +371,15 @@ Most drivers seem to ignore these flags. For compatibility with the Use chroma-keying. The chroma-key color is determined by the chromakey field of &v4l2-window; and negotiated with the &VIDIOC-S-FMT; ioctl, see + linkend="overlay" /> and - . + . There are no flags to enable clipping using a list of clip rectangles or a bitmap. These methods are negotiated with the &VIDIOC-S-FMT; ioctl, see and . + linkend="overlay" /> and . V4L2_FBUF_FLAG_LOCAL_ALPHA @@ -398,8 +398,8 @@ with video images. The blend function is: output = (framebuffer pixel * alpha + video pixel * (255 - alpha)) / 255. The alpha value is determined by the global_alpha field of &v4l2-window; and negotiated with the &VIDIOC-S-FMT; ioctl, see -and . + linkend="overlay" /> +and . V4L2_FBUF_FLAG_LOCAL_INV_ALPHA -- cgit v1.2.3