.. 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/docs/gdscript/doc/classes/Light3D.xml. .. _class_Light3D: Light3D ======= **Inherits:** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`DirectionalLight3D`, :ref:`OmniLight3D`, :ref:`SpotLight3D` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`distance_fade_begin` | ``40.0`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`distance_fade_enabled` | ``false`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`distance_fade_length` | ``10.0`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`distance_fade_shadow` | ``50.0`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`editor_only` | ``false`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`light_angular_distance` | ``0.0`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`BakeMode` | :ref:`light_bake_mode` | ``2`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`light_color` | ``Color(1, 1, 1, 1)`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`light_cull_mask` | ``4294967295`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`light_energy` | ``1.0`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`light_indirect_energy` | ``1.0`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`light_intensity_lumens` | | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`light_intensity_lux` | | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`light_negative` | ``false`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`light_projector` | | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`light_size` | ``0.0`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`light_specular` | ``0.5`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`light_temperature` | | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`light_volumetric_fog_energy` | ``1.0`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`shadow_bias` | ``0.1`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`shadow_blur` | ``1.0`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`shadow_enabled` | ``false`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`shadow_normal_bias` | ``2.0`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`shadow_opacity` | ``1.0`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`shadow_reverse_cull_face` | ``false`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`shadow_transmittance_bias` | ``0.05`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_correlated_color` **(** **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param` **(** :ref:`Param` param, :ref:`float` value **)** | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_Light3D_Param: .. rst-class:: classref-enumeration enum **Param**: .. _class_Light3D_constant_PARAM_ENERGY: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ENERGY** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_INDIRECT_ENERGY: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_INDIRECT_ENERGY** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_VOLUMETRIC_FOG_ENERGY: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_VOLUMETRIC_FOG_ENERGY** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_SPECULAR: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_SPECULAR** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_RANGE: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_RANGE** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_SIZE: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_SIZE** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_ATTENUATION: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ATTENUATION** = ``6`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_SPOT_ANGLE: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_SPOT_ANGLE** = ``7`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_SPOT_ATTENUATION: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_SPOT_ATTENUATION** = ``8`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_SHADOW_MAX_DISTANCE: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_SHADOW_MAX_DISTANCE** = ``9`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_SHADOW_SPLIT_1_OFFSET: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_SHADOW_SPLIT_1_OFFSET** = ``10`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_SHADOW_SPLIT_2_OFFSET: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_SHADOW_SPLIT_2_OFFSET** = ``11`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_SHADOW_SPLIT_3_OFFSET: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_SHADOW_SPLIT_3_OFFSET** = ``12`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_SHADOW_FADE_START: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_SHADOW_FADE_START** = ``13`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_SHADOW_NORMAL_BIAS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_SHADOW_NORMAL_BIAS** = ``14`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_SHADOW_BIAS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_SHADOW_BIAS** = ``15`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_SHADOW_PANCAKE_SIZE: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_SHADOW_PANCAKE_SIZE** = ``16`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_SHADOW_OPACITY: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_SHADOW_OPACITY** = ``17`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_SHADOW_BLUR: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_SHADOW_BLUR** = ``18`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_TRANSMITTANCE_BIAS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_TRANSMITTANCE_BIAS** = ``19`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_INTENSITY: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_INTENSITY** = ``20`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_PARAM_MAX: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_MAX** = ``21`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_Light3D_BakeMode: .. rst-class:: classref-enumeration enum **BakeMode**: .. _class_Light3D_constant_BAKE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`BakeMode` **BAKE_DISABLED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_BAKE_STATIC: .. rst-class:: classref-enumeration-constant :ref:`BakeMode` **BAKE_STATIC** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light3D_constant_BAKE_DYNAMIC: .. rst-class:: classref-enumeration-constant :ref:`BakeMode` **BAKE_DYNAMIC** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Light3D_property_distance_fade_begin: .. rst-class:: classref-property :ref:`float` **distance_fade_begin** = ``40.0`` .. rst-class:: classref-property-setget - void **set_distance_fade_begin** **(** :ref:`float` value **)** - :ref:`float` **get_distance_fade_begin** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_distance_fade_enabled: .. rst-class:: classref-property :ref:`bool` **distance_fade_enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_enable_distance_fade** **(** :ref:`bool` value **)** - :ref:`bool` **is_distance_fade_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_distance_fade_length: .. rst-class:: classref-property :ref:`float` **distance_fade_length** = ``10.0`` .. rst-class:: classref-property-setget - void **set_distance_fade_length** **(** :ref:`float` value **)** - :ref:`float` **get_distance_fade_length** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_distance_fade_shadow: .. rst-class:: classref-property :ref:`float` **distance_fade_shadow** = ``50.0`` .. rst-class:: classref-property-setget - void **set_distance_fade_shadow** **(** :ref:`float` value **)** - :ref:`float` **get_distance_fade_shadow** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_editor_only: .. rst-class:: classref-property :ref:`bool` **editor_only** = ``false`` .. rst-class:: classref-property-setget - void **set_editor_only** **(** :ref:`bool` value **)** - :ref:`bool` **is_editor_only** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_light_angular_distance: .. rst-class:: classref-property :ref:`float` **light_angular_distance** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_light_bake_mode: .. rst-class:: classref-property :ref:`BakeMode` **light_bake_mode** = ``2`` .. rst-class:: classref-property-setget - void **set_bake_mode** **(** :ref:`BakeMode` value **)** - :ref:`BakeMode` **get_bake_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_light_color: .. rst-class:: classref-property :ref:`Color` **light_color** = ``Color(1, 1, 1, 1)`` .. rst-class:: classref-property-setget - void **set_color** **(** :ref:`Color` value **)** - :ref:`Color` **get_color** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_light_cull_mask: .. rst-class:: classref-property :ref:`int` **light_cull_mask** = ``4294967295`` .. rst-class:: classref-property-setget - void **set_cull_mask** **(** :ref:`int` value **)** - :ref:`int` **get_cull_mask** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_light_energy: .. rst-class:: classref-property :ref:`float` **light_energy** = ``1.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_light_indirect_energy: .. rst-class:: classref-property :ref:`float` **light_indirect_energy** = ``1.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_light_intensity_lumens: .. rst-class:: classref-property :ref:`float` **light_intensity_lumens** .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_light_intensity_lux: .. rst-class:: classref-property :ref:`float` **light_intensity_lux** .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_light_negative: .. rst-class:: classref-property :ref:`bool` **light_negative** = ``false`` .. rst-class:: classref-property-setget - void **set_negative** **(** :ref:`bool` value **)** - :ref:`bool` **is_negative** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_light_projector: .. rst-class:: classref-property :ref:`Texture2D` **light_projector** .. rst-class:: classref-property-setget - void **set_projector** **(** :ref:`Texture2D` value **)** - :ref:`Texture2D` **get_projector** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_light_size: .. rst-class:: classref-property :ref:`float` **light_size** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_light_specular: .. rst-class:: classref-property :ref:`float` **light_specular** = ``0.5`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_light_temperature: .. rst-class:: classref-property :ref:`float` **light_temperature** .. rst-class:: classref-property-setget - void **set_temperature** **(** :ref:`float` value **)** - :ref:`float` **get_temperature** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_light_volumetric_fog_energy: .. rst-class:: classref-property :ref:`float` **light_volumetric_fog_energy** = ``1.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_shadow_bias: .. rst-class:: classref-property :ref:`float` **shadow_bias** = ``0.1`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_shadow_blur: .. rst-class:: classref-property :ref:`float` **shadow_blur** = ``1.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_shadow_enabled: .. rst-class:: classref-property :ref:`bool` **shadow_enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_shadow** **(** :ref:`bool` value **)** - :ref:`bool` **has_shadow** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_shadow_normal_bias: .. rst-class:: classref-property :ref:`float` **shadow_normal_bias** = ``2.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_shadow_opacity: .. rst-class:: classref-property :ref:`float` **shadow_opacity** = ``1.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_shadow_reverse_cull_face: .. rst-class:: classref-property :ref:`bool` **shadow_reverse_cull_face** = ``false`` .. rst-class:: classref-property-setget - void **set_shadow_reverse_cull_face** **(** :ref:`bool` value **)** - :ref:`bool` **get_shadow_reverse_cull_face** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_property_shadow_transmittance_bias: .. rst-class:: classref-property :ref:`float` **shadow_transmittance_bias** = ``0.05`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Light3D_method_get_correlated_color: .. rst-class:: classref-method :ref:`Color` **get_correlated_color** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_method_get_param: .. rst-class:: classref-method :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light3D_method_set_param: .. rst-class:: classref-method void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)`