Use of the function cOsd::GetBitmap() outside of derived classes is now deprecated

2 files changed, 7 insertions, 1 deletions

diff --git a/HISTORY b/HISTORY
index ed153e38..65c06ae7 100644
--- a/HISTORY
+++ b/HISTORY
@@ -8361,3 +8361,7 @@ Video Disk Recorder Revision History
 - Added handling for DTS audio tracks to cPatPmtParser::ParsePmt() (thanks to
   Thomas Reufer).
 - Added support for PGS subtitles (thanks to Thomas Reufer).
+- Use of the function cOsd::GetBitmap() outside of derived classes is now deprecated,
+  and it may be made 'protected' in a future version, since it doesn't work with
+  TrueColor OSDs. Plugin authors may want to modify their code so that it
+  works without this function.
diff --git a/osd.h b/osd.h
index 8c262451..5195f8d6 100644
--- a/osd.h
+++ b/osd.h
@@ -4,7 +4,7 @@
  * See the main source file 'vdr.c' for copyright information and
  * how to reach the author.
  *
- * $Id: osd.h 3.3 2015/01/04 15:51:03 kls Exp $
+ * $Id: osd.h 3.4 2015/01/14 10:50:55 kls Exp $
  */
 
 #ifndef __OSD_H
@@ -817,6 +817,8 @@ public:
        ///< If this is a true color OSD, a pointer to a dummy bitmap with 8bpp
        ///< is returned. This is done so that skins that call this function
        ///< in order to preset the bitmap's palette won't crash.
+       ///< Use of this function outside of derived classes is deprecated and it
+       ///< may be made 'protected' in a future version.
   virtual cPixmap *CreatePixmap(int Layer, const cRect &ViewPort, const cRect &DrawPort = cRect::Null);
        ///< Creates a new true color pixmap on this OSD (see cPixmap for details).
        ///< The caller must not delete the returned object, it will be deleted when