.. 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/CompositorEffect.xml. .. _class_CompositorEffect: CompositorEffect ================ **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` .. 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:`bool` | :ref:`access_resolved_color` | +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`access_resolved_depth` | +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`EffectCallbackType` | :ref:`effect_callback_type` | +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`enabled` | +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`needs_motion_vectors` | +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`needs_normal_roughness` | +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`needs_separate_specular` | +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_render_callback` **(** :ref:`int` effect_callback_type, :ref:`RenderData` render_data **)** |virtual| | +------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_CompositorEffect_EffectCallbackType: .. rst-class:: classref-enumeration enum **EffectCallbackType**: .. _class_CompositorEffect_constant_EFFECT_CALLBACK_TYPE_PRE_OPAQUE: .. rst-class:: classref-enumeration-constant :ref:`EffectCallbackType` **EFFECT_CALLBACK_TYPE_PRE_OPAQUE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_CompositorEffect_constant_EFFECT_CALLBACK_TYPE_POST_OPAQUE: .. rst-class:: classref-enumeration-constant :ref:`EffectCallbackType` **EFFECT_CALLBACK_TYPE_POST_OPAQUE** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_CompositorEffect_constant_EFFECT_CALLBACK_TYPE_POST_SKY: .. rst-class:: classref-enumeration-constant :ref:`EffectCallbackType` **EFFECT_CALLBACK_TYPE_POST_SKY** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_CompositorEffect_constant_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT: .. rst-class:: classref-enumeration-constant :ref:`EffectCallbackType` **EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_CompositorEffect_constant_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT: .. rst-class:: classref-enumeration-constant :ref:`EffectCallbackType` **EFFECT_CALLBACK_TYPE_POST_TRANSPARENT** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_CompositorEffect_constant_EFFECT_CALLBACK_TYPE_MAX: .. rst-class:: classref-enumeration-constant :ref:`EffectCallbackType` **EFFECT_CALLBACK_TYPE_MAX** = ``5`` .. 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_CompositorEffect_property_access_resolved_color: .. rst-class:: classref-property :ref:`bool` **access_resolved_color** .. rst-class:: classref-property-setget - void **set_access_resolved_color** **(** :ref:`bool` value **)** - :ref:`bool` **get_access_resolved_color** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CompositorEffect_property_access_resolved_depth: .. rst-class:: classref-property :ref:`bool` **access_resolved_depth** .. rst-class:: classref-property-setget - void **set_access_resolved_depth** **(** :ref:`bool` value **)** - :ref:`bool` **get_access_resolved_depth** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CompositorEffect_property_effect_callback_type: .. rst-class:: classref-property :ref:`EffectCallbackType` **effect_callback_type** .. rst-class:: classref-property-setget - void **set_effect_callback_type** **(** :ref:`EffectCallbackType` value **)** - :ref:`EffectCallbackType` **get_effect_callback_type** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CompositorEffect_property_enabled: .. rst-class:: classref-property :ref:`bool` **enabled** .. rst-class:: classref-property-setget - void **set_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **get_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CompositorEffect_property_needs_motion_vectors: .. rst-class:: classref-property :ref:`bool` **needs_motion_vectors** .. rst-class:: classref-property-setget - void **set_needs_motion_vectors** **(** :ref:`bool` value **)** - :ref:`bool` **get_needs_motion_vectors** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CompositorEffect_property_needs_normal_roughness: .. rst-class:: classref-property :ref:`bool` **needs_normal_roughness** .. rst-class:: classref-property-setget - void **set_needs_normal_roughness** **(** :ref:`bool` value **)** - :ref:`bool` **get_needs_normal_roughness** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CompositorEffect_property_needs_separate_specular: .. rst-class:: classref-property :ref:`bool` **needs_separate_specular** .. rst-class:: classref-property-setget - void **set_needs_separate_specular** **(** :ref:`bool` value **)** - :ref:`bool` **get_needs_separate_specular** **(** **)** .. 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_CompositorEffect_private_method__render_callback: .. rst-class:: classref-method void **_render_callback** **(** :ref:`int` effect_callback_type, :ref:`RenderData` render_data **)** |virtual| .. 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.)`