:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraAttributes.xml. .. _class_CameraAttributes: CameraAttributes ================ **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` **Inherited By:** :ref:`CameraAttributesPhysical`, :ref:`CameraAttributesPractical` Parent class for camera settings. .. rst-class:: classref-introduction-group Description ----------- Controls camera-specific attributes such as depth of field and exposure override. When used in a :ref:`WorldEnvironment` it provides default settings for exposure, auto-exposure, and depth of field that will be used by all cameras without their own **CameraAttributes**, including the editor camera. When used in a :ref:`Camera3D` it will override any **CameraAttributes** set in the :ref:`WorldEnvironment`. When used in :ref:`VoxelGI` or :ref:`LightmapGI`, only the exposure settings will be used. See also :ref:`Environment` for general 3D environment settings. This is a pure virtual class that is inherited by :ref:`CameraAttributesPhysical` and :ref:`CameraAttributesPractical`. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------+-------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`auto_exposure_enabled` | ``false`` | +---------------------------+-------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`auto_exposure_scale` | ``0.4`` | +---------------------------+-------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`auto_exposure_speed` | ``0.5`` | +---------------------------+-------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`exposure_multiplier` | ``1.0`` | +---------------------------+-------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`exposure_sensitivity` | ``100.0`` | +---------------------------+-------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_CameraAttributes_property_auto_exposure_enabled: .. rst-class:: classref-property :ref:`bool` **auto_exposure_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_auto_exposure_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_auto_exposure_enabled**\ (\ ) If ``true``, enables the tonemapping auto exposure mode of the scene renderer. If ``true``, the renderer will automatically determine the exposure setting to adapt to the scene's illumination and the observed light. .. rst-class:: classref-item-separator ---- .. _class_CameraAttributes_property_auto_exposure_scale: .. rst-class:: classref-property :ref:`float` **auto_exposure_scale** = ``0.4`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_auto_exposure_scale**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_auto_exposure_scale**\ (\ ) The scale of the auto exposure effect. Affects the intensity of auto exposure. .. rst-class:: classref-item-separator ---- .. _class_CameraAttributes_property_auto_exposure_speed: .. rst-class:: classref-property :ref:`float` **auto_exposure_speed** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_auto_exposure_speed**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_auto_exposure_speed**\ (\ ) The speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure. .. rst-class:: classref-item-separator ---- .. _class_CameraAttributes_property_exposure_multiplier: .. rst-class:: classref-property :ref:`float` **exposure_multiplier** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_exposure_multiplier**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_exposure_multiplier**\ (\ ) Multiplier for the exposure amount. A higher value results in a brighter image. .. rst-class:: classref-item-separator ---- .. _class_CameraAttributes_property_exposure_sensitivity: .. rst-class:: classref-property :ref:`float` **exposure_sensitivity** = ``100.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_exposure_sensitivity**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_exposure_sensitivity**\ (\ ) Sensitivity of camera sensors, measured in ISO. A higher sensitivity results in a brighter image. If :ref:`auto_exposure_enabled` is ``true``, this can be used as a method of exposure compensation, doubling the value will increase the exposure value (measured in EV100) by 1 stop. \ **Note:** Only available when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` is enabled. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`