.. _interfaces_stream_filter:

======
Filter
======

Examples of using a Filter are described in :ref:`interfaces_stream_using_filter`.

Filter objects in C++ are referenced by the following shared pointer typedef:

.. doxygentypedef:: rogue::interfaces::stream::FilterPtr

The class description is shown below:

.. doxygenclass:: rogue::interfaces::stream::Filter
   :members: