Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/hid
[cascardo/linux.git] / Documentation / media / uapi / dvb / video-set-display-format.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _VIDEO_SET_DISPLAY_FORMAT:
4
5 ========================
6 VIDEO_SET_DISPLAY_FORMAT
7 ========================
8
9 Name
10 ----
11
12 VIDEO_SET_DISPLAY_FORMAT
13
14 .. attention:: This ioctl is deprecated.
15
16 Synopsis
17 --------
18
19 .. c:function:: int ioctl(fd, VIDEO_SET_DISPLAY_FORMAT)
20     :name: VIDEO_SET_DISPLAY_FORMAT
21
22
23 Arguments
24 ---------
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_DISPLAY_FORMAT for this command.
42
43     -  .. row 3
44
45        -  video_display_format_t format
46
47        -  Selects the video format to be used.
48
49
50 Description
51 -----------
52
53 This ioctl call asks the Video Device to select the video format to be
54 applied by the MPEG chip on the video.
55
56
57 Return Value
58 ------------
59
60 On success 0 is returned, on error -1 and the ``errno`` variable is set
61 appropriately. The generic error codes are described at the
62 :ref:`Generic Error Codes <gen-errors>` chapter.