1 files changed, 83 insertions, 0 deletions
diff --git a/doc/classes/EditorResourcePreview.xml b/doc/classes/EditorResourcePreview.xml
new file mode 100644
index 0000000000..e530557a23
--- /dev/null
+++ b/doc/classes/EditorResourcePreview.xml
@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="EditorResourcePreview" inherits="Node" category="Core" version="3.0.alpha.custom_build">
+	<brief_description>
+		Helper to generate previews of reources or files.
+	</brief_description>
+	<description>
+		This object is used to generate previews for resources of files.
+	</description>
+	<tutorials>
+	</tutorials>
+	<demos>
+	</demos>
+	<methods>
+		<method name="add_preview_generator">
+			<return type="void">
+			</return>
+			<argument index="0" name="generator" type="EditorResourcePreviewGenerator">
+			</argument>
+			<description>
+				Create an own, custom preview generator.
+			</description>
+		</method>
+		<method name="check_for_invalidation">
+			<return type="void">
+			</return>
+			<argument index="0" name="path" type="String">
+			</argument>
+			<description>
+				Check if the resource changed, if so it will be invalidated and the corresponding signal emitted.
+			</description>
+		</method>
+		<method name="queue_edited_resource_preview">
+			<return type="void">
+			</return>
+			<argument index="0" name="resource" type="Resource">
+			</argument>
+			<argument index="1" name="receiver" type="Object">
+			</argument>
+			<argument index="2" name="receiver_func" type="String">
+			</argument>
+			<argument index="3" name="userdata" type="Variant">
+			</argument>
+			<description>
+				Queue a resource being edited for preview (using an instance). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texure (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything.
+			</description>
+		</method>
+		<method name="queue_resource_preview">
+			<return type="void">
+			</return>
+			<argument index="0" name="path" type="String">
+			</argument>
+			<argument index="1" name="receiver" type="Object">
+			</argument>
+			<argument index="2" name="receiver_func" type="String">
+			</argument>
+			<argument index="3" name="userdata" type="Variant">
+			</argument>
+			<description>
+				Queue a resource file for preview (using a path). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texure (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything.
+			</description>
+		</method>
+		<method name="remove_preview_generator">
+			<return type="void">
+			</return>
+			<argument index="0" name="generator" type="EditorResourcePreviewGenerator">
+			</argument>
+			<description>
+				Remove a custom preview generator.
+			</description>
+		</method>
+	</methods>
+	<signals>
+		<signal name="preview_invalidated">
+			<argument index="0" name="path" type="String">
+			</argument>
+			<description>
+				If a preview was invalidated (changed) this signal will emit (using the path of the preview)
+			</description>
+		</signal>
+	</signals>
+	<constants>
+	</constants>
+</class>