108 lines
4.2 KiB
C
108 lines
4.2 KiB
C
|
/*****************************************************************************
|
||
|
|
* vlc_text_style.h: text_style_t definition and helpers.
|
||
|
|
*****************************************************************************
|
||
|
|
* Copyright (C) 1999-2010 VLC authors and VideoLAN
|
||
|
|
* $Id: 51677243e472c3e7712f1a0b168a647433f7470b $
|
||
|
|
*
|
||
|
|
* Authors: Derk-Jan Hartman <hartman _AT_ videolan _DOT_ org>
|
||
|
|
* basOS G <noxelia 4t gmail , com>
|
||
|
|
*
|
||
|
|
* This program is free software; you can redistribute it and/or modify it
|
||
|
|
* under the terms of the GNU Lesser General Public License as published by
|
||
|
|
* the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
|
||
|
|
*
|
||
|
|
* You should have received a copy of the GNU Lesser 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 */
|
||
|
|
char * psz_monofontname; /**< The name of the mono font */
|
||
|
|
int i_font_size; /**< The font size in pixels */
|
||
|
|
int i_font_color; /**< The color of the text 0xRRGGBB
|
||
|
|
(native endianness) */
|
||
|
|
unsigned 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
|
||
|
|
|
||
|
|
#define STYLE_DEFAULT_FONT_SIZE 22
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Create a default text style
|
||
|
|
*/
|
||
|
|
VLC_API text_style_t * text_style_New( void );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Copy a text style into another
|
||
|
|
*/
|
||
|
|
VLC_API text_style_t * text_style_Copy( text_style_t *, const text_style_t * );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Duplicate a text style
|
||
|
|
*/
|
||
|
|
VLC_API text_style_t * text_style_Duplicate( const text_style_t * );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Delete a text style created by text_style_New or text_style_Duplicate
|
||
|
|
*/
|
||
|
|
VLC_API void text_style_Delete( text_style_t * );
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif /* VLC_TEXT_STYLE_H */
|
||
|
|
|