add a note about the formats which wxAnimation is capable of loading

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58084 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/animate.h b/interface/wx/animate.h
index 967055b7bf7d2b5b325475de8a61edb4d08da4e7..4dc9dd75679287eaed4628830034f218bd1c2d0d 100644 (file)
--- a/interface/wx/animate.h
+++ b/interface/wx/animate.h
@@ -181,6 +181,12 @@ public:
     An animation is a sequence of frames of the same size.
     Sound is not supported by wxAnimation.
 
+    Note that on wxGTK wxAnimation is capable of loading the formats supported
+    by the internally-used @c gdk-pixbuf library (typically this means only
+    or @c wxANIMATION_TYPE_GIF).
+    On other platforms wxAnimation is always capable of loading both GIF and ANI
+    formats (i.e. both @c wxANIMATION_TYPE_GIF and @c wxANIMATION_TYPE_ANI).
+
     @library{wxadv}
     @category{gdi}