annotate libass/ass_bitmap.h @ 30372:902fc3933489

big new year patch for documentations
author Gabrov
date Sun, 24 Jan 2010 03:15:18 +0000
parents 48d020c5ceca
children e64df5862cea
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20008
fa122b7c71c6 Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents: 19966
diff changeset
1 /*
26723
0f892cd714b2 Use standard license header.
diego
parents: 26138
diff changeset
2 * Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
0f892cd714b2 Use standard license header.
diego
parents: 26138
diff changeset
3 *
26738
588ce97b44f2 Speak of libass instead of MPlayer in the libass license headers.
diego
parents: 26723
diff changeset
4 * This file is part of libass.
26723
0f892cd714b2 Use standard license header.
diego
parents: 26138
diff changeset
5 *
26738
588ce97b44f2 Speak of libass instead of MPlayer in the libass license headers.
diego
parents: 26723
diff changeset
6 * libass is free software; you can redistribute it and/or modify
26723
0f892cd714b2 Use standard license header.
diego
parents: 26138
diff changeset
7 * it under the terms of the GNU General Public License as published by
0f892cd714b2 Use standard license header.
diego
parents: 26138
diff changeset
8 * the Free Software Foundation; either version 2 of the License, or
0f892cd714b2 Use standard license header.
diego
parents: 26138
diff changeset
9 * (at your option) any later version.
0f892cd714b2 Use standard license header.
diego
parents: 26138
diff changeset
10 *
26738
588ce97b44f2 Speak of libass instead of MPlayer in the libass license headers.
diego
parents: 26723
diff changeset
11 * libass is distributed in the hope that it will be useful,
26723
0f892cd714b2 Use standard license header.
diego
parents: 26138
diff changeset
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
0f892cd714b2 Use standard license header.
diego
parents: 26138
diff changeset
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
0f892cd714b2 Use standard license header.
diego
parents: 26138
diff changeset
14 * GNU General Public License for more details.
0f892cd714b2 Use standard license header.
diego
parents: 26138
diff changeset
15 *
0f892cd714b2 Use standard license header.
diego
parents: 26138
diff changeset
16 * You should have received a copy of the GNU General Public License along
26738
588ce97b44f2 Speak of libass instead of MPlayer in the libass license headers.
diego
parents: 26723
diff changeset
17 * with libass; if not, write to the Free Software Foundation, Inc.,
26723
0f892cd714b2 Use standard license header.
diego
parents: 26138
diff changeset
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
0f892cd714b2 Use standard license header.
diego
parents: 26138
diff changeset
19 */
20008
fa122b7c71c6 Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents: 19966
diff changeset
20
25897
aaebaf255b23 Consistently give all libass multiple inclusion guards a LIBASS_ prefix.
diego
parents: 25535
diff changeset
21 #ifndef LIBASS_BITMAP_H
aaebaf255b23 Consistently give all libass multiple inclusion guards a LIBASS_ prefix.
diego
parents: 25535
diff changeset
22 #define LIBASS_BITMAP_H
19846
bcc792bfa431 Store bitmap glyphs in a separate struct, instead of FreeType's internal buffer.
eugeni
parents:
diff changeset
23
26138
74055622161d Add missing header #includes to fix 'make checkheaders'.
diego
parents: 25897
diff changeset
24 #include <ft2build.h>
74055622161d Add missing header #includes to fix 'make checkheaders'.
diego
parents: 25897
diff changeset
25 #include FT_GLYPH_H
74055622161d Add missing header #includes to fix 'make checkheaders'.
diego
parents: 25897
diff changeset
26
30200
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
27 #include "ass.h"
19848
07be98a5dd5f Add \be (blur edges) support to libass.
eugeni
parents: 19846
diff changeset
28
30200
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
29 typedef struct ass_synth_priv ASS_SynthPriv;
19848
07be98a5dd5f Add \be (blur edges) support to libass.
eugeni
parents: 19846
diff changeset
30
30200
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
31 ASS_SynthPriv *ass_synth_init(double);
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
32 void ass_synth_done(ASS_SynthPriv *priv);
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
33
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
34 typedef struct {
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
35 int left, top;
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
36 int w, h; // width, height
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
37 unsigned char *buffer; // w x h buffer
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
38 } Bitmap;
19846
bcc792bfa431 Store bitmap glyphs in a separate struct, instead of FreeType's internal buffer.
eugeni
parents:
diff changeset
39
19966
27187c1ac20b Cosmetics: add some comments.
eugeni
parents: 19965
diff changeset
40 /**
27187c1ac20b Cosmetics: add some comments.
eugeni
parents: 19965
diff changeset
41 * \brief perform glyph rendering
27187c1ac20b Cosmetics: add some comments.
eugeni
parents: 19965
diff changeset
42 * \param glyph original glyph
27187c1ac20b Cosmetics: add some comments.
eugeni
parents: 19965
diff changeset
43 * \param outline_glyph "border" glyph, produced from original by FreeType's glyph stroker
27187c1ac20b Cosmetics: add some comments.
eugeni
parents: 19965
diff changeset
44 * \param bm_g out: pointer to the bitmap of original glyph is returned here
27187c1ac20b Cosmetics: add some comments.
eugeni
parents: 19965
diff changeset
45 * \param bm_o out: pointer to the bitmap of outline (border) glyph is returned here
27187c1ac20b Cosmetics: add some comments.
eugeni
parents: 19965
diff changeset
46 * \param bm_g out: pointer to the bitmap of glyph shadow is returned here
27187c1ac20b Cosmetics: add some comments.
eugeni
parents: 19965
diff changeset
47 * \param be 1 = produces blurred bitmaps, 0 = normal bitmaps
27187c1ac20b Cosmetics: add some comments.
eugeni
parents: 19965
diff changeset
48 */
30200
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
49 int glyph_to_bitmap(ASS_Library *library, ASS_SynthPriv *priv_blur,
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
50 FT_Glyph glyph, FT_Glyph outline_glyph,
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
51 Bitmap **bm_g, Bitmap **bm_o, Bitmap **bm_s,
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
52 int be, double blur_radius, FT_Vector shadow_offset,
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
53 int border_style);
19966
27187c1ac20b Cosmetics: add some comments.
eugeni
parents: 19965
diff changeset
54
30200
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
55 void ass_free_bitmap(Bitmap *bm);
19846
bcc792bfa431 Store bitmap glyphs in a separate struct, instead of FreeType's internal buffer.
eugeni
parents:
diff changeset
56
30200
48d020c5ceca Update internal libass copy to commit 8db4a5
greg
parents: 28799
diff changeset
57 #endif /* LIBASS_BITMAP_H */