Merge remote-tracking branch 'md/for-next'
[deliverable/linux.git] / Documentation / media / uapi / dvb / video-set-highlight.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_SET_HIGHLIGHT:
4
586027ce 5===================
47d23e36
MCC
6VIDEO_SET_HIGHLIGHT
7===================
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12VIDEO_SET_HIGHLIGHT
47d23e36 13
cf8076c3 14.. attention:: This ioctl is deprecated.
15e7d615
MCC
15
16Synopsis
47d23e36
MCC
17--------
18
848d1031 19.. c:function:: int ioctl(fd, VIDEO_SET_HIGHLIGHT, struct video_highlight *vhilite)
cf8076c3 20 :name: VIDEO_SET_HIGHLIGHT
47d23e36 21
47d23e36 22
15e7d615 23Arguments
586027ce 24---------
47d23e36
MCC
25
26.. flat-table::
27 :header-rows: 0
28 :stub-columns: 0
29
30
31 - .. row 1
32
33 - int fd
34
35 - File descriptor returned by a previous call to open().
36
37 - .. row 2
38
39 - int request
40
41 - Equals VIDEO_SET_HIGHLIGHT for this command.
42
43 - .. row 3
44
45 - video_highlight_t \*vhilite
46
47 - SPU Highlight information according to section ??.
48
49
15e7d615 50Description
586027ce
MCC
51-----------
52
53This ioctl sets the SPU highlight information for the menu access of a
54DVD.
55
848d1031
MCC
56.. c:type:: video_highlight
57
58.. code-block:: c
59
60 typedef
61 struct video_highlight {
62 int active; /* 1=show highlight, 0=hide highlight */
63 __u8 contrast1; /* 7- 4 Pattern pixel contrast */
64 /* 3- 0 Background pixel contrast */
65 __u8 contrast2; /* 7- 4 Emphasis pixel-2 contrast */
66 /* 3- 0 Emphasis pixel-1 contrast */
67 __u8 color1; /* 7- 4 Pattern pixel color */
68 /* 3- 0 Background pixel color */
69 __u8 color2; /* 7- 4 Emphasis pixel-2 color */
70 /* 3- 0 Emphasis pixel-1 color */
71 __u32 ypos; /* 23-22 auto action mode */
72 /* 21-12 start y */
73 /* 9- 0 end y */
74 __u32 xpos; /* 23-22 button color number */
75 /* 21-12 start x */
76 /* 9- 0 end x */
77 } video_highlight_t;
78
79
586027ce 80
15e7d615 81Return Value
47d23e36
MCC
82------------
83
84On success 0 is returned, on error -1 and the ``errno`` variable is set
85appropriately. The generic error codes are described at the
86:ref:`Generic Error Codes <gen-errors>` chapter.
This page took 0.048941 seconds and 5 git commands to generate.