godot-docs/classes/class_cameraeffects.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CameraEffects.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_CameraEffects:

CameraEffects
=============

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`



Properties
----------

+---------------------------+----------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`dof_blur_amount<class_CameraEffects_property_dof_blur_amount>`                   | ``0.1``   |
+---------------------------+----------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`dof_blur_far_distance<class_CameraEffects_property_dof_blur_far_distance>`       | ``10.0``  |
+---------------------------+----------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>`   | :ref:`dof_blur_far_enabled<class_CameraEffects_property_dof_blur_far_enabled>`         | ``false`` |
+---------------------------+----------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`dof_blur_far_transition<class_CameraEffects_property_dof_blur_far_transition>`   | ``5.0``   |
+---------------------------+----------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`dof_blur_near_distance<class_CameraEffects_property_dof_blur_near_distance>`     | ``2.0``   |
+---------------------------+----------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>`   | :ref:`dof_blur_near_enabled<class_CameraEffects_property_dof_blur_near_enabled>`       | ``false`` |
+---------------------------+----------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`dof_blur_near_transition<class_CameraEffects_property_dof_blur_near_transition>` | ``1.0``   |
+---------------------------+----------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`override_exposure<class_CameraEffects_property_override_exposure>`               | ``1.0``   |
+---------------------------+----------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>`   | :ref:`override_exposure_enable<class_CameraEffects_property_override_exposure_enable>` | ``false`` |
+---------------------------+----------------------------------------------------------------------------------------+-----------+

Property Descriptions
---------------------

.. _class_CameraEffects_property_dof_blur_amount:

- :ref:`float<class_float>` **dof_blur_amount**

+-----------+----------------------------+
| *Default* | ``0.1``                    |
+-----------+----------------------------+
| *Setter*  | set_dof_blur_amount(value) |
+-----------+----------------------------+
| *Getter*  | get_dof_blur_amount()      |
+-----------+----------------------------+

----

.. _class_CameraEffects_property_dof_blur_far_distance:

- :ref:`float<class_float>` **dof_blur_far_distance**

+-----------+----------------------------------+
| *Default* | ``10.0``                         |
+-----------+----------------------------------+
| *Setter*  | set_dof_blur_far_distance(value) |
+-----------+----------------------------------+
| *Getter*  | get_dof_blur_far_distance()      |
+-----------+----------------------------------+

----

.. _class_CameraEffects_property_dof_blur_far_enabled:

- :ref:`bool<class_bool>` **dof_blur_far_enabled**

+-----------+---------------------------------+
| *Default* | ``false``                       |
+-----------+---------------------------------+
| *Setter*  | set_dof_blur_far_enabled(value) |
+-----------+---------------------------------+
| *Getter*  | is_dof_blur_far_enabled()       |
+-----------+---------------------------------+

----

.. _class_CameraEffects_property_dof_blur_far_transition:

- :ref:`float<class_float>` **dof_blur_far_transition**

+-----------+------------------------------------+
| *Default* | ``5.0``                            |
+-----------+------------------------------------+
| *Setter*  | set_dof_blur_far_transition(value) |
+-----------+------------------------------------+
| *Getter*  | get_dof_blur_far_transition()      |
+-----------+------------------------------------+

----

.. _class_CameraEffects_property_dof_blur_near_distance:

- :ref:`float<class_float>` **dof_blur_near_distance**

+-----------+-----------------------------------+
| *Default* | ``2.0``                           |
+-----------+-----------------------------------+
| *Setter*  | set_dof_blur_near_distance(value) |
+-----------+-----------------------------------+
| *Getter*  | get_dof_blur_near_distance()      |
+-----------+-----------------------------------+

----

.. _class_CameraEffects_property_dof_blur_near_enabled:

- :ref:`bool<class_bool>` **dof_blur_near_enabled**

+-----------+----------------------------------+
| *Default* | ``false``                        |
+-----------+----------------------------------+
| *Setter*  | set_dof_blur_near_enabled(value) |
+-----------+----------------------------------+
| *Getter*  | is_dof_blur_near_enabled()       |
+-----------+----------------------------------+

----

.. _class_CameraEffects_property_dof_blur_near_transition:

- :ref:`float<class_float>` **dof_blur_near_transition**

+-----------+-------------------------------------+
| *Default* | ``1.0``                             |
+-----------+-------------------------------------+
| *Setter*  | set_dof_blur_near_transition(value) |
+-----------+-------------------------------------+
| *Getter*  | get_dof_blur_near_transition()      |
+-----------+-------------------------------------+

----

.. _class_CameraEffects_property_override_exposure:

- :ref:`float<class_float>` **override_exposure**

+-----------+------------------------------+
| *Default* | ``1.0``                      |
+-----------+------------------------------+
| *Setter*  | set_override_exposure(value) |
+-----------+------------------------------+
| *Getter*  | get_override_exposure()      |
+-----------+------------------------------+

----

.. _class_CameraEffects_property_override_exposure_enable:

- :ref:`bool<class_bool>` **override_exposure_enable**

+-----------+--------------------------------------+
| *Default* | ``false``                            |
+-----------+--------------------------------------+
| *Setter*  | set_override_exposure_enabled(value) |
+-----------+--------------------------------------+
| *Getter*  | is_override_exposure_enabled()       |
+-----------+--------------------------------------+