Documentation/media/uapi/v4l/vidioc-overlay.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_OVERLAY:
   4
   5 ********************
   6 ioctl VIDIOC_OVERLAY
   7 ********************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_OVERLAY - Start or stop video overlay
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. c:function:: int ioctl( int fd, VIDIOC_OVERLAY, const int *argp )
  19     :name: VIDIOC_OVERLAY
  20
  21
  22 Arguments
  23 =========
  24
  25 ``fd``
  26     File descriptor returned by :ref:`open() <func-open>`.
  27
  28 ``argp``
  29     Pointer to an integer.
  30
  31
  32 Description
  33 ===========
  34
  35 This ioctl is part of the :ref:`video overlay <overlay>` I/O method.
  36 Applications call :ref:`VIDIOC_OVERLAY` to start or stop the overlay. It
  37 takes a pointer to an integer which must be set to zero by the
  38 application to stop overlay, to one to start.
  39
  40 Drivers do not support :ref:`VIDIOC_STREAMON` or
  41 :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` with
  42 ``V4L2_BUF_TYPE_VIDEO_OVERLAY``.
  43
  44
  45 Return Value
  46 ============
  47
  48 On success 0 is returned, on error -1 and the ``errno`` variable is set
  49 appropriately. The generic error codes are described at the
  50 :ref:`Generic Error Codes <gen-errors>` chapter.
  51
  52 EINVAL
  53     The overlay parameters have not been set up. See :ref:`overlay`
  54     for the necessary steps.