Merge branch 'locking/atomics' into locking/core, to pick up WIP commits
[sfrench/cifs-2.6.git] / Documentation / media / uapi / v4l / dev-effect.rst
1 .. Permission is granted to copy, distribute and/or modify this
2 .. document under the terms of the GNU Free Documentation License,
3 .. Version 1.1 or any later version published by the Free Software
4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
5 .. and no Back-Cover Texts. A copy of the license is included at
6 .. Documentation/media/uapi/fdl-appendix.rst.
7 ..
8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10 .. _effect:
11
12 ************************
13 Effect Devices Interface
14 ************************
15
16 .. note::
17     This interface has been be suspended from the V4L2 API.
18     The implementation for such effects should be done
19     via mem2mem devices.
20
21 A V4L2 video effect device can do image effects, filtering, or combine
22 two or more images or image streams. For example video transitions or
23 wipes. Applications send data to be processed and receive the result
24 data either with :ref:`read() <func-read>` and
25 :ref:`write() <func-write>` functions, or through the streaming I/O
26 mechanism.
27
28 [to do]