summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2020-11-22 17:43:07 +0100
committerHugo Locurcio <hugo.locurcio@hugo.pro>2020-11-22 17:43:07 +0100
commit1a616726cf1e47f0d94296099890bd3997b44f4d (patch)
treeb3a5ebde8580608f417c8054e63e9cc34948f0de
parent5ab727b460febd1af6621e078f0eb3a8ea42ef75 (diff)
Document that WebM videos don't support the alpha channel
-rw-r--r--modules/webm/doc_classes/VideoStreamWebm.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/modules/webm/doc_classes/VideoStreamWebm.xml b/modules/webm/doc_classes/VideoStreamWebm.xml
index 2edbc08cc8..f3e13ba31a 100644
--- a/modules/webm/doc_classes/VideoStreamWebm.xml
+++ b/modules/webm/doc_classes/VideoStreamWebm.xml
@@ -5,6 +5,7 @@
</brief_description>
<description>
[VideoStream] resource handling the [url=https://www.webmproject.org/]WebM[/url] video format with [code].webm[/code] extension. Both the VP8 and VP9 codecs are supported. The VP8 and VP9 codecs are more efficient than [VideoStreamTheora], but they require more CPU resources to decode (especially VP9). Both the VP8 and VP9 codecs are decoded on the CPU.
+ [b]Note:[/b] Alpha channel (also known as transparency) is not supported. The video will always appear to have a black background, even if it originally contains an alpha channel.
[b]Note:[/b] There are known bugs and performance issues with WebM video playback in Godot. If you run into problems, try using the Ogg Theora format instead: [VideoStreamTheora]
</description>
<tutorials>