* Something I forgot

[vlc] / include / osd.h

diff --git a/include/osd.h b/include/osd.h
index 955e3161651d29e142d8bac114ffcd0742d967b4..e9d2745269c55dedd68bb9435728af7aa09158d5 100644 (file)
--- a/include/osd.h
+++ b/include/osd.h
@@ -2,7 +2,7 @@
  * osd.h : Constants for use with osd modules
  *****************************************************************************
  * Copyright (C) 2003 VideoLAN
- * $Id: osd.h,v 1.3 2003/08/10 10:22:52 gbazin Exp $
+ * $Id: osd.h,v 1.7 2004/02/15 18:22:26 sigmunau Exp $
  *
  * Authors: Sigmund Augdal <sigmunau@idi.ntnu.no>
  *
@@ -21,10 +21,20 @@
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  *****************************************************************************/
 
+/**
+ * \file
+ * Stucts and function prototypes to place text on the video
+ */
+
 #define OSD_ALIGN_LEFT 0x1
 #define OSD_ALIGN_RIGHT 0x2
 #define OSD_ALIGN_TOP 0x4
 #define OSD_ALIGN_BOTTOM 0x8
+
+/**
+ * Text style information.
+ * This struct is currently ignored
+ */
 struct text_style_t
 {
     int i_size;
@@ -35,5 +45,14 @@ struct text_style_t
 };
 static const text_style_t default_text_style = { 22, 0xffffff, VLC_FALSE, VLC_FALSE, VLC_FALSE };
 
-VLC_EXPORT( void, vout_ShowTextRelative, ( vout_thread_t *, char *, text_style_t *, int, int, int, mtime_t ) );
+VLC_EXPORT( subpicture_t *, vout_ShowTextRelative, ( vout_thread_t *, char *, text_style_t *, int, int, int, mtime_t ) );
 VLC_EXPORT( void,  vout_ShowTextAbsolute, ( vout_thread_t *, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
+VLC_EXPORT( void,  __vout_OSDMessage, ( vlc_object_t *, char *, ... ) );
+/**
+ * Same as __vlc_OSDMessage() but with automatic casting
+ */
+#if defined(HAVE_VARIADIC_MACROS)
+#    define vout_OSDMessage( obj, fmt, args...) __vout_OSDMessage( VLC_OBJECT(obj), fmt, ## args )
+#else
+#    define vout_OSDMessage __vout_OSDMessage
+#endif