vlc_text_style.h 4.01 KB
 Laurent Aimar committed May 04, 2010 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 /***************************************************************************** * vlc_text_style.h: text_style_t definition and helpers. ***************************************************************************** * Copyright (C) 1999-2010 the VideoLAN team * $Id$ * * Authors: Derk-Jan Hartman * basOS G * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ #ifndef VLC_TEXT_STYLE_H #define VLC_TEXT_STYLE_H 1 #ifdef __cplusplus extern "C" { #endif /** * Text style * * A text style is used to specify the formatting of text. * A font renderer can use the supplied information to render the * text specified. */ typedef struct { char * psz_fontname; /**< The name of the font */ int i_font_size; /**< The font size in pixels */ int i_font_color; /**< The color of the text 0xRRGGBB (native endianness) */ int i_font_alpha; /**< The transparency of the text. 0x00 is fully opaque, 0xFF fully transparent */ int i_style_flags; /**< Formatting style flags */ int i_outline_color; /**< The color of the outline 0xRRGGBB */ int i_outline_alpha; /**< The transparency of the outline. 0x00 is fully opaque, 0xFF fully transparent */ int i_shadow_color; /**< The color of the shadow 0xRRGGBB */ int i_shadow_alpha; /**< The transparency of the shadow. 0x00 is fully opaque, 0xFF fully transparent */ int i_background_color;/**< The color of the background 0xRRGGBB */ int i_background_alpha;/**< The transparency of the background. 0x00 is fully opaque, 0xFF fully transparent */ int i_karaoke_background_color;/**< Background color for karaoke 0xRRGGBB */ int i_karaoke_background_alpha;/**< The transparency of the karaoke bg. 0x00 is fully opaque, 0xFF fully transparent */ int i_outline_width; /**< The width of the outline in pixels */ int i_shadow_width; /**< The width of the shadow in pixels */ int i_spacing; /**< The spaceing between glyphs in pixels */ } text_style_t; /* Style flags for \ref text_style_t */ #define STYLE_BOLD 1 #define STYLE_ITALIC 2 #define STYLE_OUTLINE 4 #define STYLE_SHADOW 8 #define STYLE_BACKGROUND 16 #define STYLE_UNDERLINE 32 #define STYLE_STRIKEOUT 64 /** * Create a default text style */  Rémi Denis-Courmont committed May 07, 2011 82 VLC_API text_style_t * text_style_New( void );  Laurent Aimar committed May 04, 2010 83 84 85 86  /** * Copy a text style into another */  Rémi Denis-Courmont committed May 07, 2011 87 VLC_API text_style_t * text_style_Copy( text_style_t *, const text_style_t * );  Laurent Aimar committed May 04, 2010 88 89 90 91  /** * Duplicate a text style */  Rémi Denis-Courmont committed May 07, 2011 92 VLC_API text_style_t * text_style_Duplicate( const text_style_t * );  Laurent Aimar committed May 04, 2010 93 94 95 96  /** * Delete a text style created by text_style_New or text_style_Duplicate */  Rémi Denis-Courmont committed May 07, 2011 97 VLC_API void text_style_Delete( text_style_t * );  Laurent Aimar committed May 04, 2010 98 99 100 101 102 103 104  #ifdef __cplusplus } #endif #endif /* VLC_TEXT_STYLE_H */