diff options
author | Mauro Carvalho Chehab <mchehab@redhat.com> | 2009-08-31 21:28:58 -0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2009-08-31 21:28:58 -0300 |
commit | b13aae56fe48c89e3b1dbefaf165cbab0102216b (patch) | |
tree | 1fa560699f394247610a9a8ebc0cc4b9d5ce45df /v4l2-spec/vidioc-g-fbuf.sgml | |
parent | 939633eb8afe2f03adab25337d2f57f0b8ed642d (diff) | |
download | mediapointer-dvb-s2-b13aae56fe48c89e3b1dbefaf165cbab0102216b.tar.gz mediapointer-dvb-s2-b13aae56fe48c89e3b1dbefaf165cbab0102216b.tar.bz2 |
v4l2-spec: convert it to use DocBook XML 4.1.2
From: Mauro Carvalho Chehab <mchehab@redhat.com>
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 <mchehab@redhat.com>
Diffstat (limited to 'v4l2-spec/vidioc-g-fbuf.sgml')
-rw-r--r-- | v4l2-spec/vidioc-g-fbuf.sgml | 22 |
1 files changed, 11 insertions, 11 deletions
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.</para> <entry><structfield>capability</structfield></entry> <entry></entry> <entry>Overlay capability flags set by the driver, see -<xref linkend="framebuffer-cap">.</entry> +<xref linkend="framebuffer-cap" />.</entry> </row> <row> <entry>__u32</entry> <entry><structfield>flags</structfield></entry> <entry></entry> <entry>Overlay control flags set by application and -driver, see <xref linkend="framebuffer-flags"></entry> +driver, see <xref linkend="framebuffer-flags" /></entry> </row> <row> <entry>void *</entry> @@ -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 <wordasword>Video Output Overlays</wordasword> the driver must return a valid base address, so applications can find the corresponding Linux -framebuffer device (see <xref linkend="osd">).</entry> +framebuffer device (see <xref linkend="osd" />).</entry> </row> <row> <entry>&v4l2-pix-format;</entry> @@ -157,7 +157,7 @@ framebuffer device (see <xref linkend="osd">).</entry> <entry></entry> <entry>Layout of the frame buffer. The <structname>v4l2_pix_format</structname> structure is defined in <xref -linkend="pixfmt">, for clarification the fields and acceptable values +linkend="pixfmt" />, for clarification the fields and acceptable values are listed below:</entry> </row> <row> @@ -207,7 +207,7 @@ not including <constant>V4L2_PIX_FMT_YUYV</constant> and <constant>V4L2_PIX_FMT_UYVY</constant>) and the <constant>V4L2_PIX_FMT_PAL8</constant> format are also permitted. The behavior of the driver when an application requests a compressed -format is undefined. See <xref linkend="pixfmt"> for information on +format is undefined. See <xref linkend="pixfmt" /> for information on pixel formats.</entry> </row> <row> @@ -270,7 +270,7 @@ driver.</para></entry> <entry><structfield>colorspace</structfield></entry> <entry>This information supplements the <structfield>pixelformat</structfield> and must be set by the driver, -see <xref linkend="colorspaces">.</entry> +see <xref linkend="colorspaces" />.</entry> </row> <row> <entry></entry> @@ -371,15 +371,15 @@ Most drivers seem to ignore these flags. For compatibility with the <entry>Use chroma-keying. The chroma-key color is determined by the <structfield>chromakey</structfield> field of &v4l2-window; and negotiated with the &VIDIOC-S-FMT; ioctl, see <xref - linkend="overlay"> + linkend="overlay" /> and - <xref linkend="osd">.</entry> + <xref linkend="osd" />.</entry> </row> <row> <entry spanname="hspan">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 <xref - linkend="overlay"> and <xref linkend="osd">.</entry> + linkend="overlay" /> and <xref linkend="osd" />.</entry> </row> <row> <entry><constant>V4L2_FBUF_FLAG_LOCAL_ALPHA</constant></entry> @@ -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 <structfield>global_alpha</structfield> field of &v4l2-window; and negotiated with the &VIDIOC-S-FMT; ioctl, see <xref - linkend="overlay"> -and <xref linkend="osd">.</entry> + linkend="overlay" /> +and <xref linkend="osd" />.</entry> </row> <row> <entry><constant>V4L2_FBUF_FLAG_LOCAL_INV_ALPHA</constant></entry> |