[deliverable/linux.git] / Documentation / media / uapi / v4l / dev-effect.rst

.. -*- coding: utf-8; mode: rst -*-

.. _effect:

************************
Effect Devices Interface
************************

.. note::
    This interface has been be suspended from the V4L2 API.
    The implementation for such effects should be done
    via mem2mem devices.

A V4L2 video effect device can do image effects, filtering, or combine
two or more images or image streams. For example video transitions or
wipes. Applications send data to be processed and receive the result
data either with :ref:`read() <func-read>` and
:ref:`write() <func-write>` functions, or through the streaming I/O
mechanism.

[to do]
Commit	Line	Data
5377d91f MH	1	.. -- coding: utf-8; mode: rst --
	2
	3	.. _effect:
	4
	5	************************
	6	Effect Devices Interface
	7	************************
	8
706f8a99 MCC	9	.. note::
	10	This interface has been be suspended from the V4L2 API.
	11	The implementation for such effects should be done
	12	via mem2mem devices.
5377d91f MH	13
	14	A V4L2 video effect device can do image effects, filtering, or combine
	15	two or more images or image streams. For example video transitions or
	16	wipes. Applications send data to be processed and receive the result
	17	data either with :ref:`read() <func-read>` and
	18	:ref:`write() <func-write>` functions, or through the streaming I/O
	19	mechanism.
	20
	21	[to do]