: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/RenderSceneData.xml. .. _class_RenderSceneData: RenderSceneData =============== **Inherits:** :ref:`Object` **Inherited By:** :ref:`RenderSceneDataExtension`, :ref:`RenderSceneDataRD` Abstract render data object, holds scene data related to rendering a single frame of a viewport. .. rst-class:: classref-introduction-group Description ----------- Abstract scene data object, exists for the duration of rendering a single viewport. \ **Note:** This is an internal rendering server object, do not instantiate this from script. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`Projection` | :ref:`get_cam_projection`\ (\ ) |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`get_cam_transform`\ (\ ) |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_uniform_buffer`\ (\ ) |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_view_count`\ (\ ) |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_view_eye_offset`\ (\ view\: :ref:`int`\ ) |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`Projection` | :ref:`get_view_projection`\ (\ view\: :ref:`int`\ ) |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_RenderSceneData_method_get_cam_projection: .. rst-class:: classref-method :ref:`Projection` **get_cam_projection**\ (\ ) |const| :ref:`🔗` Returns the camera projection used to render this frame. \ **Note:** If more than one view is rendered, this will return a combined projection. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneData_method_get_cam_transform: .. rst-class:: classref-method :ref:`Transform3D` **get_cam_transform**\ (\ ) |const| :ref:`🔗` Returns the camera transform used to render this frame. \ **Note:** If more than one view is rendered, this will return a centered transform. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneData_method_get_uniform_buffer: .. rst-class:: classref-method :ref:`RID` **get_uniform_buffer**\ (\ ) |const| :ref:`🔗` Return the :ref:`RID` of the uniform buffer containing the scene data as a UBO. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneData_method_get_view_count: .. rst-class:: classref-method :ref:`int` **get_view_count**\ (\ ) |const| :ref:`🔗` Returns the number of views being rendered. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneData_method_get_view_eye_offset: .. rst-class:: classref-method :ref:`Vector3` **get_view_eye_offset**\ (\ view\: :ref:`int`\ ) |const| :ref:`🔗` Returns the eye offset per view used to render this frame. This is the offset between our camera transform and the eye transform. .. rst-class:: classref-item-separator ---- .. _class_RenderSceneData_method_get_view_projection: .. rst-class:: classref-method :ref:`Projection` **get_view_projection**\ (\ view\: :ref:`int`\ ) |const| :ref:`🔗` Returns the view projection per view used to render this frame. \ **Note:** If a single view is rendered, this returns the camera projection. If more than one view is rendered, this will return a projection for the given view including the eye offset. .. |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.)`