: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/RenderSceneBuffersRD.xml. .. _class_RenderSceneBuffersRD: RenderSceneBuffersRD ==================== **Inherits:** :ref:`RenderSceneBuffers` **<** :ref:`RefCounted` **<** :ref:`Object` Render scene buffer implementation for the RenderingDevice based renderers. .. rst-class:: classref-introduction-group Description ----------- This object manages all 3D rendering buffers for the rendering device based renderers. An instance of this object is created for every viewport that has 3D rendering enabled. All buffers are organized in **contexts**. The default context is called **render_buffers** and can contain amongst others the color buffer, depth buffer, velocity buffers, VRS density map and MSAA variants of these buffers. Buffers are only guaranteed to exist during rendering of the viewport. \ **Note:** This is an internal rendering server object, do not instantiate this from script. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_context`\ (\ context\: :ref:`StringName`\ ) | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`create_texture`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, data_format\: :ref:`DataFormat`, usage_bits\: :ref:`int`, texture_samples\: :ref:`TextureSamples`, size\: :ref:`Vector2i`, layers\: :ref:`int`, mipmaps\: :ref:`int`, unique\: :ref:`bool`, discardable\: :ref:`bool`\ ) | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`create_texture_from_format`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, format\: :ref:`RDTextureFormat`, view\: :ref:`RDTextureView`, unique\: :ref:`bool`\ ) | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`create_texture_view`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, view_name\: :ref:`StringName`, view\: :ref:`RDTextureView`\ ) | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_color_layer`\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_color_texture`\ (\ msaa\: :ref:`bool` = false\ ) | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_depth_layer`\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_depth_texture`\ (\ msaa\: :ref:`bool` = false\ ) | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_fsr_sharpness`\ (\ ) |const| | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`get_internal_size`\ (\ ) |const| | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ViewportMSAA` | :ref:`get_msaa_3d`\ (\ ) |const| | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_render_target`\ (\ ) |const| | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ViewportScaling3DMode` | :ref:`get_scaling_3d_mode`\ (\ ) |const| | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ViewportScreenSpaceAA` | :ref:`get_screen_space_aa`\ (\ ) |const| | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`get_target_size`\ (\ ) |const| | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_texture`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RDTextureFormat` | :ref:`get_texture_format`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TextureSamples` | :ref:`get_texture_samples`\ (\ ) |const| | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_texture_slice`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, layer\: :ref:`int`, mipmap\: :ref:`int`, layers\: :ref:`int`, mipmaps\: :ref:`int`\ ) | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`get_texture_slice_size`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, mipmap\: :ref:`int`\ ) | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_texture_slice_view`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, layer\: :ref:`int`, mipmap\: :ref:`int`, layers\: :ref:`int`, mipmaps\: :ref:`int`, view\: :ref:`RDTextureView`\ ) | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_use_debanding`\ (\ ) |const| | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_use_taa`\ (\ ) |const| | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_velocity_layer`\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_velocity_texture`\ (\ msaa\: :ref:`bool` = false\ ) | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_view_count`\ (\ ) |const| | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_texture`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| | +--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_RenderSceneBuffersRD_method_clear_context: .. rst-class:: classref-method |void| **clear_context**\ (\ context\: :ref:`StringName`\ ) :ref:`🔗` Frees all buffers related to this context. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_create_texture: .. rst-class:: classref-method :ref:`RID` **create_texture**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, data_format\: :ref:`DataFormat`, usage_bits\: :ref:`int`, texture_samples\: :ref:`TextureSamples`, size\: :ref:`Vector2i`, layers\: :ref:`int`, mipmaps\: :ref:`int`, unique\: :ref:`bool`, discardable\: :ref:`bool`\ ) :ref:`🔗` Create a new texture with the given definition and cache this under the given name. Will return the existing texture if it already exists. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_create_texture_from_format: .. rst-class:: classref-method :ref:`RID` **create_texture_from_format**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, format\: :ref:`RDTextureFormat`, view\: :ref:`RDTextureView`, unique\: :ref:`bool`\ ) :ref:`🔗` Create a new texture using the given format and view and cache this under the given name. Will return the existing texture if it already exists. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_create_texture_view: .. rst-class:: classref-method :ref:`RID` **create_texture_view**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, view_name\: :ref:`StringName`, view\: :ref:`RDTextureView`\ ) :ref:`🔗` Create a new texture view for an existing texture and cache this under the given ``view_name``. Will return the existing texture view if it already exists. Will error if the source texture doesn't exist. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_color_layer: .. rst-class:: classref-method :ref:`RID` **get_color_layer**\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) :ref:`🔗` Returns the specified layer from the color texture we are rendering 3D content to. If ``msaa`` is ``true`` and MSAA is enabled, this returns the MSAA variant of the buffer. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_color_texture: .. rst-class:: classref-method :ref:`RID` **get_color_texture**\ (\ msaa\: :ref:`bool` = false\ ) :ref:`🔗` Returns the color texture we are rendering 3D content to. If multiview is used this will be a texture array with all views. If ``msaa`` is ``true`` and MSAA is enabled, this returns the MSAA variant of the buffer. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_depth_layer: .. rst-class:: classref-method :ref:`RID` **get_depth_layer**\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) :ref:`🔗` Returns the specified layer from the depth texture we are rendering 3D content to. If ``msaa`` is ``true`` and MSAA is enabled, this returns the MSAA variant of the buffer. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_depth_texture: .. rst-class:: classref-method :ref:`RID` **get_depth_texture**\ (\ msaa\: :ref:`bool` = false\ ) :ref:`🔗` Returns the depth texture we are rendering 3D content to. If multiview is used this will be a texture array with all views. If ``msaa`` is ``true`` and MSAA is enabled, this returns the MSAA variant of the buffer. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_fsr_sharpness: .. rst-class:: classref-method :ref:`float` **get_fsr_sharpness**\ (\ ) |const| :ref:`🔗` Returns the FSR sharpness value used while rendering the 3D content (if :ref:`get_scaling_3d_mode()` is an FSR mode). .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_internal_size: .. rst-class:: classref-method :ref:`Vector2i` **get_internal_size**\ (\ ) |const| :ref:`🔗` Returns the internal size of the render buffer (size before upscaling) with which textures are created by default. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_msaa_3d: .. rst-class:: classref-method :ref:`ViewportMSAA` **get_msaa_3d**\ (\ ) |const| :ref:`🔗` Returns the applied 3D MSAA mode for this viewport. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_render_target: .. rst-class:: classref-method :ref:`RID` **get_render_target**\ (\ ) |const| :ref:`🔗` Returns the render target associated with this buffers object. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_scaling_3d_mode: .. rst-class:: classref-method :ref:`ViewportScaling3DMode` **get_scaling_3d_mode**\ (\ ) |const| :ref:`🔗` Returns the scaling mode used for upscaling. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_screen_space_aa: .. rst-class:: classref-method :ref:`ViewportScreenSpaceAA` **get_screen_space_aa**\ (\ ) |const| :ref:`🔗` Returns the screen-space antialiasing method applied. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_target_size: .. rst-class:: classref-method :ref:`Vector2i` **get_target_size**\ (\ ) |const| :ref:`🔗` Returns the target size of the render buffer (size after upscaling). .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_texture: .. rst-class:: classref-method :ref:`RID` **get_texture**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns a cached texture with this name. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_texture_format: .. rst-class:: classref-method :ref:`RDTextureFormat` **get_texture_format**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the texture format information with which a cached texture was created. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_texture_samples: .. rst-class:: classref-method :ref:`TextureSamples` **get_texture_samples**\ (\ ) |const| :ref:`🔗` Returns the number of MSAA samples used. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_texture_slice: .. rst-class:: classref-method :ref:`RID` **get_texture_slice**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, layer\: :ref:`int`, mipmap\: :ref:`int`, layers\: :ref:`int`, mipmaps\: :ref:`int`\ ) :ref:`🔗` Returns a specific slice (layer or mipmap) for a cached texture. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_texture_slice_size: .. rst-class:: classref-method :ref:`Vector2i` **get_texture_slice_size**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, mipmap\: :ref:`int`\ ) :ref:`🔗` Returns the texture size of a given slice of a cached texture. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_texture_slice_view: .. rst-class:: classref-method :ref:`RID` **get_texture_slice_view**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, layer\: :ref:`int`, mipmap\: :ref:`int`, layers\: :ref:`int`, mipmaps\: :ref:`int`, view\: :ref:`RDTextureView`\ ) :ref:`🔗` Returns a specific view of a slice (layer or mipmap) for a cached texture. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_use_debanding: .. rst-class:: classref-method :ref:`bool` **get_use_debanding**\ (\ ) |const| :ref:`🔗` Returns ``true`` if debanding is enabled. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_use_taa: .. rst-class:: classref-method :ref:`bool` **get_use_taa**\ (\ ) |const| :ref:`🔗` Returns ``true`` if TAA is enabled. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_velocity_layer: .. rst-class:: classref-method :ref:`RID` **get_velocity_layer**\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) :ref:`🔗` Returns the specified layer from the velocity texture we are rendering 3D content to. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_velocity_texture: .. rst-class:: classref-method :ref:`RID` **get_velocity_texture**\ (\ msaa\: :ref:`bool` = false\ ) :ref:`🔗` Returns the velocity texture we are rendering 3D content to. If multiview is used this will be a texture array with all views. If ``msaa`` is **true** and MSAA is enabled, this returns the MSAA variant of the buffer. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_get_view_count: .. rst-class:: classref-method :ref:`int` **get_view_count**\ (\ ) |const| :ref:`🔗` Returns the view count for the associated viewport. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneBuffersRD_method_has_texture: .. rst-class:: classref-method :ref:`bool` **has_texture**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if a cached texture exists for this name. .. |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.)`