summaryrefslogtreecommitdiff
path: root/modules/gdnative/doc_classes
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2020-01-26 11:24:14 +0100
committerRémi Verschelde <rverschelde@gmail.com>2020-01-26 11:29:07 +0100
commitbb6c0d3e8bb1982bce3e1c219c1a4a2d187227f0 (patch)
treeee58635301c11a4e5e46d99030e54cff3e4ca9ba /modules/gdnative/doc_classes
parent55cc46a0523df8df85aa6ffec6b58ff86e5ab1af (diff)
doc: Complete documentation for VideoStreams
Also quick clean up of the matching C++ files.
Diffstat (limited to 'modules/gdnative/doc_classes')
-rw-r--r--modules/gdnative/doc_classes/VideoStreamGDNative.xml5
1 files changed, 5 insertions, 0 deletions
diff --git a/modules/gdnative/doc_classes/VideoStreamGDNative.xml b/modules/gdnative/doc_classes/VideoStreamGDNative.xml
index ed7678b7be..c4d9a58fbb 100644
--- a/modules/gdnative/doc_classes/VideoStreamGDNative.xml
+++ b/modules/gdnative/doc_classes/VideoStreamGDNative.xml
@@ -1,8 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VideoStreamGDNative" inherits="VideoStream" category="Core" version="3.2">
<brief_description>
+ [VideoStream] resource for for video formats implemented via GDNative.
</brief_description>
<description>
+ [VideoStream] resource for for video formats implemented via GDNative.
+ It can be used via [url=https://github.com/KidRigger/godot-videodecoder]godot-videodecoder[/url] which uses the [url=https://ffmpeg.org]FFmpeg[/url] library.
</description>
<tutorials>
</tutorials>
@@ -11,6 +14,7 @@
<return type="String">
</return>
<description>
+ Returns the video file handled by this [VideoStreamGDNative].
</description>
</method>
<method name="set_file">
@@ -19,6 +23,7 @@
<argument index="0" name="file" type="String">
</argument>
<description>
+ Sets the video file that this [VideoStreamGDNative] resource handles. The supported extensions depend on the GDNative plugins used to expose video formats.
</description>
</method>
</methods>