comment

2003-06-11 01:49:01 +00:00
parent 61e8c60d1e
commit 0892c963fb
1 changed files with 13 additions and 0 deletions
@@ -11,6 +11,19 @@

 #include "Banner.h"

+/* Call CacheSongBanner to cache a song banner by path.  (Actually, this could be
+ * a course banner, too.)  Currently, this will waste time if the banner is already
+ * cached, but since we only do this during the initial cache phase of song loads
+ * this is OK for now.
+ *
+ * Call LoadAllBanners to load all precached song banners.
+ *
+ * Call LoadCachedSongBanner to load a banner into a texture and retrieve an ID
+ * for it.  You can check if the banner was actually preloaded by calling
+ * TEXTUREMAN->IsTextureRegistered() on the ID; it might not be if the banner cache
+ * is missing or disabled.
+ */
+ 
 BannerCache *BANNERCACHE;