summaryrefslogtreecommitdiffstats
path: root/doc/classes/RenderData.xml
diff options
context:
space:
mode:
authorBastiaan Olij <mux213@gmail.com>2023-08-03 22:10:03 +1000
committerBastiaan Olij <mux213@gmail.com>2024-02-18 21:54:21 +1100
commit5a98845655900a7884bf5a73c5406318f1106d77 (patch)
tree38befda91eaef9ccf35fd909486a5ea0f3b09705 /doc/classes/RenderData.xml
parent5f05e2b9b1a3fedcdd7ecb2ab976a2687fd6f19a (diff)
downloadredot-engine-5a98845655900a7884bf5a73c5406318f1106d77.tar.gz
Implement hooks into renderer
Diffstat (limited to 'doc/classes/RenderData.xml')
-rw-r--r--doc/classes/RenderData.xml38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/classes/RenderData.xml b/doc/classes/RenderData.xml
new file mode 100644
index 0000000000..065505e6c6
--- /dev/null
+++ b/doc/classes/RenderData.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="RenderData" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+ <brief_description>
+ Abstract render data object, holds frame data related to rendering a single frame of a viewport.
+ </brief_description>
+ <description>
+ Abstract render data object, exists for the duration of rendering a single viewport.
+ [b]Note:[/b] This is an internal rendering server object, do not instantiate this from script.
+ </description>
+ <tutorials>
+ </tutorials>
+ <methods>
+ <method name="get_camera_attributes" qualifiers="const">
+ <return type="RID" />
+ <description>
+ Returns the [RID] of the camera attributes object in the [RenderingServer] being used to render this viewport.
+ </description>
+ </method>
+ <method name="get_environment" qualifiers="const">
+ <return type="RID" />
+ <description>
+ Returns the [RID] of the environments object in the [RenderingServer] being used to render this viewport.
+ </description>
+ </method>
+ <method name="get_render_scene_buffers" qualifiers="const">
+ <return type="RenderSceneBuffers" />
+ <description>
+ Returns the [RenderSceneBuffers] object managing the scene buffers for rendering this viewport.
+ </description>
+ </method>
+ <method name="get_render_scene_data" qualifiers="const">
+ <return type="RenderSceneData" />
+ <description>
+ Returns the [RenderSceneData] object managing this frames scene data.
+ </description>
+ </method>
+ </methods>
+</class>