b99b95dc4a220f8f9a0a67cc0bc4d9d9eb559f92
[sdlgit/SDL-Site.git] / pages / SDL-Pango.html-inc
1 <div class="pod">
2 <!-- INDEX START -->
3 <h3 id="TOP">Index</h3>
4
5 <ul><li><a href="#NAME">NAME</a></li>
6 <li><a href="#CATEGORY">CATEGORY</a></li>
7 <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
8 <li><a href="#CONSTANTS">CONSTANTS</a></li>
9 <li><a href="#METHODS">METHODS</a>
10 <ul><li><a href="#init">init</a></li>
11 <li><a href="#was_init">was_init</a></li>
12 <li><a href="#set_default_color">set_default_color</a></li>
13 <li><a href="#set_minimum_size">set_minimum_size</a></li>
14 <li><a href="#set_text">set_text</a></li>
15 <li><a href="#set_markup">set_markup</a></li>
16 <li><a href="#get_layout_width">get_layout_width</a></li>
17 <li><a href="#get_layout_height">get_layout_height</a></li>
18 <li><a href="#set_base_direction">set_base_direction</a></li>
19 <li><a href="#set_dpi">set_dpi</a></li>
20 <li><a href="#set_language">set_language</a></li>
21 <li><a href="#draw">draw</a></li>
22 <li><a href="#set_surface_create_args">set_surface_create_args</a></li>
23 <li><a href="#create_surface_draw">create_surface_draw</a></li>
24 </ul>
25 </li>
26 <li><a href="#AUTHOR">AUTHOR</a></li>
27 <li><a href="#SEE_ALSO">SEE ALSO</a>
28 </li>
29 </ul><hr />
30 <!-- INDEX END -->
31
32 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
33 <div id="NAME_CONTENT">
34 <p>SDL::Pango - Text rendering engine</p>
35
36 </div>
37 <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
38 <div id="CATEGORY_CONTENT">
39 <p>TODO, Pango</p>
40
41 </div>
42 <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
43 <div id="SYNOPSIS_CONTENT">
44 <pre> use SDL;
45  use SDL::Color;
46  use SDL::Surface;
47  use SDL::Overlay;
48  use SDL::Rect;
49  use SDL::Video;
50  use SDL::PixelFormat;
51  use SDL::Pango;
52  use SDL::Pango::Context;
53
54  SDL::Pango::init();
55
56  my $context = new SDL::Pango::Context;
57  SDL::Pango::set_default_color($context, 0xA7C344FF, 0);
58  SDL::Pango::set_markup($context, 'Hallo &lt;b&gt;W&lt;span foreground=&quot;red&quot;&gt;o&lt;/span&gt;&lt;i&gt;r&lt;/i&gt;&lt;u&gt;l&lt;/u&gt;d&lt;/b&gt;!', -1);
59
60  SDL::init(SDL_INIT_VIDEO);
61
62  my $display = SDL::Video::set_video_mode(640, 480, 32, SDL_SWSURFACE);
63  my $bg      = SDL::Video::map_RGB($display-&gt;format, 0x12, 0x22, 0x45);
64  SDL::Video::fill_rect($display, SDL::Rect-&gt;new(0, 0, 640, 480), $bg);
65
66  my $surface = SDL::Pango::create_surface_draw($context);
67  SDL::Video::blit_surface($surface, SDL::Rect-&gt;new(0, 0, 640, 480), $display, SDL::Rect-&gt;new(0, 0, 640, 480));
68
69  SDL::Video::update_rect($display, 0, 0, 0, 0);
70  SDL::delay(2000);
71
72 </pre>
73
74 </div>
75 <h1 id="CONSTANTS">CONSTANTS</h1><p><a href="#TOP" class="toplink">Top</a></p>
76 <div id="CONSTANTS_CONTENT">
77 <p>The constants are not exported by default. You can export them into your namespace by doing:</p>
78 <pre> use SDL::Pango ':constants';
79
80 </pre>
81 <p>or access them directly:</p>
82 <pre> SDL::Pango::SDLPANGO_DIRECTION_NEUTRAL;
83
84 </pre>
85 <p>Available constants:</p>
86 <dl>
87         <dt>SDLPANGO_DIRECTION_LTR</dt>
88         <dd>
89                 <p>Left to right</p>
90         </dd>
91         <dt>SDLPANGO_DIRECTION_RTL</dt>
92         <dd>
93                 <p>Right to left</p>
94         </dd>
95         <dt>SDLPANGO_DIRECTION_WEAK_LTR</dt>
96         <dd>
97                 <p>Left to right (weak)</p>
98         </dd>
99         <dt>SDLPANGO_DIRECTION_WEAK_RTL</dt>
100         <dd>
101                 <p>Right to left (weak)</p>
102         </dd>
103         <dt>SDLPANGO_DIRECTION_NEUTRAL</dt>
104         <dd>
105                 <p>Neutral</p>
106         </dd>
107 </dl>
108
109 </div>
110 <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
111 <div id="METHODS_CONTENT">
112
113 </div>
114 <h2 id="init">init</h2>
115 <div id="init_CONTENT">
116 <pre> SDL::Pango::init();
117
118 </pre>
119
120 </div>
121 <h2 id="was_init">was_init</h2>
122 <div id="was_init_CONTENT">
123 <pre> my $was_init = SDL::Pango::was_init();
124
125 </pre>
126
127 </div>
128 <h2 id="set_default_color">set_default_color</h2>
129 <div id="set_default_color_CONTENT">
130 <pre> SDL::Pango::set_default_color($context, 0xA7C344FF, 0);
131  SDL::Pango::set_default_color($context, 0xA7, 0xC3, 0x44, 0xFF, 0, 0, 0, 0x00);
132
133 </pre>
134
135 </div>
136 <h2 id="set_minimum_size">set_minimum_size</h2>
137 <div id="set_minimum_size_CONTENT">
138 <pre> SDL::Pango::set_minimum_size($context, 640, 0);
139
140 </pre>
141
142 </div>
143 <h2 id="set_text">set_text</h2>
144 <div id="set_text_CONTENT">
145 <pre> SDL::Pango::set_text($context, $text, 20);
146
147 </pre>
148
149 </div>
150 <h2 id="set_markup">set_markup</h2>
151 <div id="set_markup_CONTENT">
152 <pre> SDL::Pango::set_markup($context, $text, -1);
153
154 </pre>
155
156 </div>
157 <h2 id="get_layout_width">get_layout_width</h2>
158 <div id="get_layout_width_CONTENT">
159 <pre> my $w = SDL::Pango::get_layout_width($context);
160
161 </pre>
162
163 </div>
164 <h2 id="get_layout_height">get_layout_height</h2>
165 <div id="get_layout_height_CONTENT">
166 <pre> my $h = SDL::Pango::get_layout_height($context);
167
168 </pre>
169
170 </div>
171 <h2 id="set_base_direction">set_base_direction</h2>
172 <div id="set_base_direction_CONTENT">
173 <pre> SDL::Pango::set_base_direction($context, SDLPANGO_DIRECTION_LTR);
174
175 </pre>
176
177 </div>
178 <h2 id="set_dpi">set_dpi</h2>
179 <div id="set_dpi_CONTENT">
180 <pre> SDL::Pango::set_dpi($context, 48, 48);
181
182 </pre>
183
184 </div>
185 <h2 id="set_language">set_language</h2>
186 <div id="set_language_CONTENT">
187 <pre> SDL::Pango::set_language($context, &quot;en&quot;);
188
189 </pre>
190
191 </div>
192 <h2 id="draw">draw</h2>
193 <div id="draw_CONTENT">
194 <pre> SDL::Pango::draw($context, $display, (640 - $w) / 2, (480 - $h) / 2);
195
196 </pre>
197
198 </div>
199 <h2 id="set_surface_create_args">set_surface_create_args</h2>
200 <div id="set_surface_create_args_CONTENT">
201 <pre> SDL::Pango::set_surface_create_args($context, SDL_SWSURFACE, 32, 255&lt;&lt;24, 255&lt;&lt;16, 255&lt;&lt;8, 255);
202
203 </pre>
204
205 </div>
206 <h2 id="create_surface_draw">create_surface_draw</h2>
207 <div id="create_surface_draw_CONTENT">
208 <pre> my $surface = SDL::Pango::create_surface_draw($context);
209
210 </pre>
211
212 </div>
213 <h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
214 <div id="AUTHOR_CONTENT">
215 <p>Tobias Leich [FROGGS]</p>
216
217 </div>
218 <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
219 <div id="SEE_ALSO_CONTENT">
220 <p><a href="SDL-Pango-Context.html">SDL::Pango::Context</a>, <a href="SDL-Video.html">SDL::Video</a>, <a href="SDL-Surface.html">SDL::Surface</a>, <a href="SDL-TTF.html">SDL::TTF</a></p>
221
222 </div>
223 </div>