===========
Postprocess
===========

.. py:currentmodule:: p3dsdk

.. py:class:: Postprocess


   .. py:method:: id
      :property:

      The id of the postprocess.

      :type: str, read-only

   .. py:method:: name
      :property:

      The name of the postprocess.

      :type: str
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: group
      :property:

      The group of the postprocess.

      :type: PostprocessGroup
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: apply_to_background
      :property:

      Whether the postprocess is applied to the background.

      :type: bool
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: apply_to_overlays
      :property:

      Whether the postprocess is applied to overlays.

      :type: bool
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.


   .. py:method:: list_effects()

      List the postprocessing effects of this postprocess, in top to bottom order.


      :returns: The list of effects in the postprocess.
      :rtype: list(PostprocessingEffect)


   .. py:method:: duplicate()

      Duplicate this postprocess.


      :returns: The duplicated postprocess.
      :rtype: Postprocess

      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: remove(force = False)

      Delete this postprocess

      .. note::
         By default, only not used postprocess can be deleted (:py:obj:`InUseError` is raised otherwise), use ``force`` to force deletion of used postprocesses.

      :param force: Force the deletion of the postprocess even if it is in use.
      :type force: bool


      :raises InUseError: If ``force`` is :py:obj:`False` and the postprocess is used.
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: create_blur_postprocessing()

      Create a new blur postprocessing effect.


      :returns: The newly created postprocessing effect.
      :rtype: PostprocessingEffectBlur

      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: create_bloom_postprocessing()

      Create a new bloom postprocessing effect.


      :returns: The newly created postprocessing effect.
      :rtype: PostprocessingEffectBloom

      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: create_sharpen_postprocessing()

      Create a new sharpen postprocessing effect.


      :returns: The newly created postprocessing effect.
      :rtype: PostprocessingEffectSharpen

      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: create_add_multiply_postprocessing()

      Create a new add/multiply postprocessing effect.


      :returns: The newly created postprocessing effect.
      :rtype: PostprocessingEffectAddMultiply

      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.