mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
classref: Sync with current master branch (f87858a8f)
This commit is contained in:
Yuri Sizov
@@ -14,6 +14,8 @@ CameraAttributesPractical
|
||||
|
||||
Camera settings in an easy to use format.
|
||||
|
||||
.. rst-class:: classref-introduction-group
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
@@ -21,171 +23,189 @@ Controls camera-specific attributes such as auto-exposure, depth of field, and e
|
||||
|
||||
When used in a :ref:`WorldEnvironment<class_WorldEnvironment>` it provides default settings for exposure, auto-exposure, and depth of field that will be used by all cameras without their own :ref:`CameraAttributes<class_CameraAttributes>`, including the editor camera. When used in a :ref:`Camera3D<class_Camera3D>` it will override any :ref:`CameraAttributes<class_CameraAttributes>` set in the :ref:`WorldEnvironment<class_WorldEnvironment>`. When used in :ref:`VoxelGI<class_VoxelGI>` or :ref:`LightmapGI<class_LightmapGI>`, only the exposure settings will be used.
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`auto_exposure_max_sensitivity<class_CameraAttributesPractical_property_auto_exposure_max_sensitivity>` | ``800.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`auto_exposure_min_sensitivity<class_CameraAttributesPractical_property_auto_exposure_min_sensitivity>` | ``0.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`dof_blur_amount<class_CameraAttributesPractical_property_dof_blur_amount>` | ``0.1`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`dof_blur_far_distance<class_CameraAttributesPractical_property_dof_blur_far_distance>` | ``10.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`dof_blur_far_enabled<class_CameraAttributesPractical_property_dof_blur_far_enabled>` | ``false`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`dof_blur_far_transition<class_CameraAttributesPractical_property_dof_blur_far_transition>` | ``5.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`dof_blur_near_distance<class_CameraAttributesPractical_property_dof_blur_near_distance>` | ``2.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`dof_blur_near_enabled<class_CameraAttributesPractical_property_dof_blur_near_enabled>` | ``false`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`dof_blur_near_transition<class_CameraAttributesPractical_property_dof_blur_near_transition>` | ``1.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`auto_exposure_max_sensitivity<class_CameraAttributesPractical_property_auto_exposure_max_sensitivity>` | ``800.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`auto_exposure_min_sensitivity<class_CameraAttributesPractical_property_auto_exposure_min_sensitivity>` | ``0.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`dof_blur_amount<class_CameraAttributesPractical_property_dof_blur_amount>` | ``0.1`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`dof_blur_far_distance<class_CameraAttributesPractical_property_dof_blur_far_distance>` | ``10.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`dof_blur_far_enabled<class_CameraAttributesPractical_property_dof_blur_far_enabled>` | ``false`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`dof_blur_far_transition<class_CameraAttributesPractical_property_dof_blur_far_transition>` | ``5.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`dof_blur_near_distance<class_CameraAttributesPractical_property_dof_blur_near_distance>` | ``2.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`dof_blur_near_enabled<class_CameraAttributesPractical_property_dof_blur_near_enabled>` | ``false`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`dof_blur_near_transition<class_CameraAttributesPractical_property_dof_blur_near_transition>` | ``1.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CameraAttributesPractical_property_auto_exposure_max_sensitivity:
|
||||
|
||||
- :ref:`float<class_float>` **auto_exposure_max_sensitivity**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+------------------------------------------+
|
||||
| *Default* | ``800.0`` |
|
||||
+-----------+------------------------------------------+
|
||||
| *Setter* | set_auto_exposure_max_sensitivity(value) |
|
||||
+-----------+------------------------------------------+
|
||||
| *Getter* | get_auto_exposure_max_sensitivity() |
|
||||
+-----------+------------------------------------------+
|
||||
:ref:`float<class_float>` **auto_exposure_max_sensitivity** = ``800.0``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_auto_exposure_max_sensitivity** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_auto_exposure_max_sensitivity** **(** **)**
|
||||
|
||||
The maximum sensitivity (in ISO) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing below a certain brightness, resulting in a cut off point where the scene will remain bright.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraAttributesPractical_property_auto_exposure_min_sensitivity:
|
||||
|
||||
- :ref:`float<class_float>` **auto_exposure_min_sensitivity**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+------------------------------------------+
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------------------------------+
|
||||
| *Setter* | set_auto_exposure_min_sensitivity(value) |
|
||||
+-----------+------------------------------------------+
|
||||
| *Getter* | get_auto_exposure_min_sensitivity() |
|
||||
+-----------+------------------------------------------+
|
||||
:ref:`float<class_float>` **auto_exposure_min_sensitivity** = ``0.0``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_auto_exposure_min_sensitivity** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_auto_exposure_min_sensitivity** **(** **)**
|
||||
|
||||
The minimum sensitivity (in ISO) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing above a certain brightness, resulting in a cut off point where the scene will remain dark.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraAttributesPractical_property_dof_blur_amount:
|
||||
|
||||
- :ref:`float<class_float>` **dof_blur_amount**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | ``0.1`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_dof_blur_amount(value) |
|
||||
+-----------+----------------------------+
|
||||
| *Getter* | get_dof_blur_amount() |
|
||||
+-----------+----------------------------+
|
||||
:ref:`float<class_float>` **dof_blur_amount** = ``0.1``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_dof_blur_amount** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_dof_blur_amount** **(** **)**
|
||||
|
||||
Sets the maximum amount of blur. When using physically-based blur amounts, will instead act as a multiplier. High values lead to an increased amount of bluriness, but can be much more expensive to calculate. It is best to keep this as low as possible for a given art style.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraAttributesPractical_property_dof_blur_far_distance:
|
||||
|
||||
- :ref:`float<class_float>` **dof_blur_far_distance**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | ``10.0`` |
|
||||
+-----------+----------------------------------+
|
||||
| *Setter* | set_dof_blur_far_distance(value) |
|
||||
+-----------+----------------------------------+
|
||||
| *Getter* | get_dof_blur_far_distance() |
|
||||
+-----------+----------------------------------+
|
||||
:ref:`float<class_float>` **dof_blur_far_distance** = ``10.0``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_dof_blur_far_distance** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_dof_blur_far_distance** **(** **)**
|
||||
|
||||
Objects further from the :ref:`Camera3D<class_Camera3D>` by this amount will be blurred by the depth of field effect. Measured in meters.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraAttributesPractical_property_dof_blur_far_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **dof_blur_far_enabled**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+---------------------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------------------+
|
||||
| *Setter* | set_dof_blur_far_enabled(value) |
|
||||
+-----------+---------------------------------+
|
||||
| *Getter* | is_dof_blur_far_enabled() |
|
||||
+-----------+---------------------------------+
|
||||
:ref:`bool<class_bool>` **dof_blur_far_enabled** = ``false``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_dof_blur_far_enabled** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_dof_blur_far_enabled** **(** **)**
|
||||
|
||||
Enables depth of field blur for objects further than :ref:`dof_blur_far_distance<class_CameraAttributesPractical_property_dof_blur_far_distance>`. Strength of blur is controlled by :ref:`dof_blur_amount<class_CameraAttributesPractical_property_dof_blur_amount>` and modulated by :ref:`dof_blur_far_transition<class_CameraAttributesPractical_property_dof_blur_far_transition>`.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraAttributesPractical_property_dof_blur_far_transition:
|
||||
|
||||
- :ref:`float<class_float>` **dof_blur_far_transition**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+------------------------------------+
|
||||
| *Default* | ``5.0`` |
|
||||
+-----------+------------------------------------+
|
||||
| *Setter* | set_dof_blur_far_transition(value) |
|
||||
+-----------+------------------------------------+
|
||||
| *Getter* | get_dof_blur_far_transition() |
|
||||
+-----------+------------------------------------+
|
||||
:ref:`float<class_float>` **dof_blur_far_transition** = ``5.0``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_dof_blur_far_transition** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_dof_blur_far_transition** **(** **)**
|
||||
|
||||
When positive, distance over which (starting from :ref:`dof_blur_far_distance<class_CameraAttributesPractical_property_dof_blur_far_distance>`) blur effect will scale from 0 to :ref:`dof_blur_amount<class_CameraAttributesPractical_property_dof_blur_amount>`. When negative, uses physically-based scaling so depth of field effect will scale from 0 at :ref:`dof_blur_far_distance<class_CameraAttributesPractical_property_dof_blur_far_distance>` and will increase in a physically accurate way as objects get further from the :ref:`Camera3D<class_Camera3D>`.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraAttributesPractical_property_dof_blur_near_distance:
|
||||
|
||||
- :ref:`float<class_float>` **dof_blur_near_distance**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+-----------------------------------+
|
||||
| *Default* | ``2.0`` |
|
||||
+-----------+-----------------------------------+
|
||||
| *Setter* | set_dof_blur_near_distance(value) |
|
||||
+-----------+-----------------------------------+
|
||||
| *Getter* | get_dof_blur_near_distance() |
|
||||
+-----------+-----------------------------------+
|
||||
:ref:`float<class_float>` **dof_blur_near_distance** = ``2.0``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_dof_blur_near_distance** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_dof_blur_near_distance** **(** **)**
|
||||
|
||||
Objects closer from the :ref:`Camera3D<class_Camera3D>` by this amount will be blurred by the depth of field effect. Measured in meters.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraAttributesPractical_property_dof_blur_near_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **dof_blur_near_enabled**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+----------------------------------+
|
||||
| *Setter* | set_dof_blur_near_enabled(value) |
|
||||
+-----------+----------------------------------+
|
||||
| *Getter* | is_dof_blur_near_enabled() |
|
||||
+-----------+----------------------------------+
|
||||
:ref:`bool<class_bool>` **dof_blur_near_enabled** = ``false``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_dof_blur_near_enabled** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_dof_blur_near_enabled** **(** **)**
|
||||
|
||||
Enables depth of field blur for objects closer than :ref:`dof_blur_near_distance<class_CameraAttributesPractical_property_dof_blur_near_distance>`. Strength of blur is controlled by :ref:`dof_blur_amount<class_CameraAttributesPractical_property_dof_blur_amount>` and modulated by :ref:`dof_blur_near_transition<class_CameraAttributesPractical_property_dof_blur_near_transition>`.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_CameraAttributesPractical_property_dof_blur_near_transition:
|
||||
|
||||
- :ref:`float<class_float>` **dof_blur_near_transition**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+-------------------------------------+
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------------------------+
|
||||
| *Setter* | set_dof_blur_near_transition(value) |
|
||||
+-----------+-------------------------------------+
|
||||
| *Getter* | get_dof_blur_near_transition() |
|
||||
+-----------+-------------------------------------+
|
||||
:ref:`float<class_float>` **dof_blur_near_transition** = ``1.0``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_dof_blur_near_transition** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_dof_blur_near_transition** **(** **)**
|
||||
|
||||
When positive, distance over which blur effect will scale from 0 to :ref:`dof_blur_amount<class_CameraAttributesPractical_property_dof_blur_amount>`, ending at :ref:`dof_blur_near_distance<class_CameraAttributesPractical_property_dof_blur_near_distance>`. When negative, uses physically-based scaling so depth of field effect will scale from 0 at :ref:`dof_blur_near_distance<class_CameraAttributesPractical_property_dof_blur_near_distance>` and will increase in a physically accurate way as objects get closer to the :ref:`Camera3D<class_Camera3D>`.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user