: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/RenderSceneBuffersConfiguration.xml. .. _class_RenderSceneBuffersConfiguration: RenderSceneBuffersConfiguration =============================== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Configuration object used to setup a :ref:`RenderSceneBuffers` object. .. rst-class:: classref-introduction-group Description ----------- This configuration object is created and populated by the render engine on a viewport change and used to (re)configure a :ref:`RenderSceneBuffers` object. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+--------------------+ | :ref:`ViewportAnisotropicFiltering` | :ref:`anisotropic_filtering_level` | ``2`` | +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+--------------------+ | :ref:`float` | :ref:`fsr_sharpness` | ``0.0`` | +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+--------------------+ | :ref:`Vector2i` | :ref:`internal_size` | ``Vector2i(0, 0)`` | +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+--------------------+ | :ref:`ViewportMSAA` | :ref:`msaa_3d` | ``0`` | +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+--------------------+ | :ref:`RID` | :ref:`render_target` | ``RID()`` | +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+--------------------+ | :ref:`ViewportScaling3DMode` | :ref:`scaling_3d_mode` | ``255`` | +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+--------------------+ | :ref:`ViewportScreenSpaceAA` | :ref:`screen_space_aa` | ``0`` | +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+--------------------+ | :ref:`Vector2i` | :ref:`target_size` | ``Vector2i(0, 0)`` | +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+--------------------+ | :ref:`float` | :ref:`texture_mipmap_bias` | ``0.0`` | +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+--------------------+ | :ref:`int` | :ref:`view_count` | ``1`` | +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+--------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_RenderSceneBuffersConfiguration_property_anisotropic_filtering_level: .. rst-class:: classref-property :ref:`ViewportAnisotropicFiltering` **anisotropic_filtering_level** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_anisotropic_filtering_level**\ (\ value\: :ref:`ViewportAnisotropicFiltering`\ ) - :ref:`ViewportAnisotropicFiltering` **get_anisotropic_filtering_level**\ (\ ) Level of the anisotropic filter. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersConfiguration_property_fsr_sharpness: .. rst-class:: classref-property :ref:`float` **fsr_sharpness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_fsr_sharpness**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_fsr_sharpness**\ (\ ) FSR Sharpness applicable if FSR upscaling is used. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersConfiguration_property_internal_size: .. rst-class:: classref-property :ref:`Vector2i` **internal_size** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_internal_size**\ (\ value\: :ref:`Vector2i`\ ) - :ref:`Vector2i` **get_internal_size**\ (\ ) The size of the 3D render buffer used for rendering. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersConfiguration_property_msaa_3d: .. rst-class:: classref-property :ref:`ViewportMSAA` **msaa_3d** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_msaa_3d**\ (\ value\: :ref:`ViewportMSAA`\ ) - :ref:`ViewportMSAA` **get_msaa_3d**\ (\ ) The MSAA mode we're using for 3D rendering. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersConfiguration_property_render_target: .. rst-class:: classref-property :ref:`RID` **render_target** = ``RID()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_render_target**\ (\ value\: :ref:`RID`\ ) - :ref:`RID` **get_render_target**\ (\ ) The render target associated with these buffer. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersConfiguration_property_scaling_3d_mode: .. rst-class:: classref-property :ref:`ViewportScaling3DMode` **scaling_3d_mode** = ``255`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_scaling_3d_mode**\ (\ value\: :ref:`ViewportScaling3DMode`\ ) - :ref:`ViewportScaling3DMode` **get_scaling_3d_mode**\ (\ ) The requested scaling mode with which we upscale/downscale if :ref:`internal_size` and :ref:`target_size` are not equal. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersConfiguration_property_screen_space_aa: .. rst-class:: classref-property :ref:`ViewportScreenSpaceAA` **screen_space_aa** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_screen_space_aa**\ (\ value\: :ref:`ViewportScreenSpaceAA`\ ) - :ref:`ViewportScreenSpaceAA` **get_screen_space_aa**\ (\ ) The requested screen space AA applied in post processing. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersConfiguration_property_target_size: .. rst-class:: classref-property :ref:`Vector2i` **target_size** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_target_size**\ (\ value\: :ref:`Vector2i`\ ) - :ref:`Vector2i` **get_target_size**\ (\ ) The target (upscale) size if scaling is used. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersConfiguration_property_texture_mipmap_bias: .. rst-class:: classref-property :ref:`float` **texture_mipmap_bias** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_texture_mipmap_bias**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_texture_mipmap_bias**\ (\ ) Bias applied to mipmaps. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersConfiguration_property_view_count: .. rst-class:: classref-property :ref:`int` **view_count** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_view_count**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_view_count**\ (\ ) The number of views we're rendering. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)`