File: v-sim-text.html

package info (click to toggle)
v-sim 3.6.0-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 15,860 kB
  • sloc: ansic: 75,222; sh: 10,239; makefile: 580; python: 572; cpp: 353; xml: 130
file content (147 lines) | stat: -rw-r--r-- 7,366 bytes parent folder | download 
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>text</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="V_Sim API - Reference Manual">
<link rel="up" href="ch03.html" title="OpenGL tools">
<link rel="prev" href="v-sim-light.html" title="light">
<link rel="next" href="v-sim-view.html" title="view">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="v-sim-light.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">V_Sim API - Reference Manual</th>
<td><a accesskey="n" href="v-sim-view.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#v-sim-text.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#v-sim-text.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="text">
<a name="v-sim-text"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-text.top_of_page"></a>text</span></h2>
<p>text — Enables capabilities to write some text on rendering screen.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-text.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum                <a class="link" href="v-sim-text.html#OpenGLTextSize" title="enum OpenGLTextSize">OpenGLTextSize</a>;
<span class="returnvalue">void</span>                <a class="link" href="v-sim-text.html#openGLText-drawChars" title="openGLText_drawChars ()">openGLText_drawChars</a>                (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s</code></em>,
                                                         <em class="parameter"><code><a class="link" href="v-sim-text.html#OpenGLTextSize" title="enum OpenGLTextSize"><span class="type">OpenGLTextSize</span></a> size</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="v-sim-text.html#openGLText-initFontList" title="openGLText_initFontList ()">openGLText_initFontList</a>             ();
<span class="returnvalue">void</span>                <a class="link" href="v-sim-text.html#openGLText-rebuildFontList" title="openGLText_rebuildFontList ()">openGLText_rebuildFontList</a>          ();
<span class="returnvalue">void</span>                <a class="link" href="v-sim-text.html#openGLText-onNewContext" title="openGLText_onNewContext ()">openGLText_onNewContext</a>             ();
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-text.description"></a><h2>Description</h2>
<p>
</p>
<p>For the moment, this module is very basic and the only fonts
available is the helvetica 12 one. This module is currently broken
under Windows.</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-text.details"></a><h2>Details</h2>
<div class="refsect2" title="enum OpenGLTextSize">
<a name="OpenGLTextSize"></a><h3>enum OpenGLTextSize</h3>
<pre class="programlisting">typedef enum
  {
    TEXT_NORMAL,
    TEXT_SMALL
  } OpenGLTextSize;
</pre>
<p>
Different text size available in V_Sim.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="TEXT-NORMAL:CAPS"></a><span class="term"><code class="literal">TEXT_NORMAL</code></span></p></td>
<td>normal size (14) ;
</td>
</tr>
<tr>
<td><p><a name="TEXT-SMALL:CAPS"></a><span class="term"><code class="literal">TEXT_SMALL</code></span></p></td>
<td>small text (12).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="openGLText_drawChars ()">
<a name="openGLText-drawChars"></a><h3>openGLText_drawChars ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                openGLText_drawChars                (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s</code></em>,
                                                         <em class="parameter"><code><a class="link" href="v-sim-text.html#OpenGLTextSize" title="enum OpenGLTextSize"><span class="type">OpenGLTextSize</span></a> size</code></em>);</pre>
<p>
Draw the given string on the current raster position with default
font.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>s</code></em> :</span></p></td>
<td>a string.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td>the size of the text to render.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="openGLText_initFontList ()">
<a name="openGLText-initFontList"></a><h3>openGLText_initFontList ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                openGLText_initFontList             ();</pre>
<p>
Initialise the font drawing with default font (depending on system).
It must be called before <a class="link" href="v-sim-text.html#openGLText-drawChars" title="openGLText_drawChars ()"><code class="function">openGLText_drawChars()</code></a> and not in a <code class="function">glNewList()</code>.
Can be called several times, fonts are initialized once only. Use
<a class="link" href="v-sim-text.html#openGLText-rebuildFontList" title="openGLText_rebuildFontList ()"><code class="function">openGLText_rebuildFontList()</code></a> to force to build a new font list.
</p>
</div>
<hr>
<div class="refsect2" title="openGLText_rebuildFontList ()">
<a name="openGLText-rebuildFontList"></a><h3>openGLText_rebuildFontList ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                openGLText_rebuildFontList          ();</pre>
<p>
Force to buid a new font list (for example new context has changed.
</p>
</div>
<hr>
<div class="refsect2" title="openGLText_onNewContext ()">
<a name="openGLText-onNewContext"></a><h3>openGLText_onNewContext ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                openGLText_onNewContext             ();</pre>
<p>
Set the flag for text list build to FALSE. It will force to rebuild
the text lists at next call of <a class="link" href="v-sim-text.html#openGLText-initFontList" title="openGLText_initFontList ()"><code class="function">openGLText_initFontList()</code></a>.
</p>
<p class="since">Since 3.6</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.14</div>
</body>
</html>