OpenCores
URL https://opencores.org/ocsvn/or1k/or1k/trunk

Subversion Repositories or1k

[/] [or1k/] [trunk/] [mw/] [doc/] [nano-X/] [html/] [nano-x-general.html] - Blame information for rev 1765

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 673 markom 
<HTML
2 
><HEAD
3 
><TITLE
4 
>general</TITLE
5 
><META
6 
NAME="GENERATOR"
7 
CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK
8 
REL="HOME"
9 
TITLE="Nano-X API Reference Manual"
10 
HREF="index.html"><LINK
11 
REL="UP"
12 
TITLE="libnano-X"
13 
HREF="libnano-x.html"><LINK
14 
REL="PREVIOUS"
15 
TITLE="libnano-X"
16 
HREF="libnano-x.html"><LINK
17 
REL="NEXT"
18 
TITLE="window"
19 
HREF="nano-x-window.html"></HEAD
20 
><BODY
21 
BGCOLOR="#FFFFFF"
22 
TEXT="#000000"
23 
><DIV
24 
CLASS="NAVHEADER"
25 
><TABLE
26 
WIDTH="100%"
27 
BORDER="0"
28 
BGCOLOR="#000000"
29 
CELLPADDING="1"
30 
CELLSPACING="0"
31 
><TR
32 
><TH
33 
COLSPAN="4"
34 
ALIGN="center"
35 
><FONT
36 
COLOR="#FFFFFF"
37 
SIZE="5"
38 
>Nano-X API Reference Manual</FONT
39 
></TH
40 
></TR
41 
><TR
42 
><TD
43 
WIDTH="25%"
44 
BGCOLOR="#C00000"
45 
ALIGN="left"
46 
><A
47 
HREF="libnano-x.html"
48 
><FONT
49 
COLOR="#FFFFFF"
50 
SIZE="3"
51 
><B
52 
>&#60;&#60;&#60; Previous Page</B
53 
></FONT
54 
></A
55 
></TD
56 
><TD
57 
WIDTH="25%"
58 
BGCOLOR="#0000C0"
59 
ALIGN="center"
60 
><FONT
61 
COLOR="#FFFFFF"
62 
SIZE="3"
63 
><B
64 
><A
65 
HREF="index.html"
66 
><FONT
67 
COLOR="#FFFFFF"
68 
SIZE="3"
69 
><B
70 
>Home</B
71 
></FONT
72 
></A
73 
></B
74 
></FONT
75 
></TD
76 
><TD
77 
WIDTH="25%"
78 
BGCOLOR="#00C000"
79 
ALIGN="center"
80 
><FONT
81 
COLOR="#FFFFFF"
82 
SIZE="3"
83 
><B
84 
><A
85 
HREF="libnano-x.html"
86 
><FONT
87 
COLOR="#FFFFFF"
88 
SIZE="3"
89 
><B
90 
>Up</B
91 
></FONT
92 
></A
93 
></B
94 
></FONT
95 
></TD
96 
><TD
97 
WIDTH="25%"
98 
BGCOLOR="#C00000"
99 
ALIGN="right"
100 
><A
101 
HREF="nano-x-window.html"
102 
><FONT
103 
COLOR="#FFFFFF"
104 
SIZE="3"
105 
><B
106 
>Next Page &#62;&#62;&#62;</B
107 
></FONT
108 
></A
109 
></TD
110 
></TR
111 
></TABLE
112 
></DIV
113 
><H1
114 
>general</H1
115 
><DIV
116 
CLASS="REFNAMEDIV"
117 
><A
118 
NAME="AEN11"
119 
></A
120 
><H2
121 
>Name</H2
122 
>general &#8212; </DIV
123 
><DIV
124 
CLASS="REFSYNOPSISDIV"
125 
><A
126 
NAME="AEN14"
127 
></A
128 
><H2
129 
>Synopsis</H2
130 
><TABLE
131 
BORDER="0"
132 
BGCOLOR="#D6E8FF"
133 
WIDTH="100%"
134 
CELLPADDING="6"
135 
><TR
136 
><TD
137 
><PRE
138 
CLASS="SYNOPSIS"
139 
>&#13;
140 
 
141 
void        <A
142 
HREF="nano-x-general.html#GRFLUSH"
143 
>GrFlush</A
144 
>                         (void);
145 
int         <A
146 
HREF="nano-x-general.html#GROPEN"
147 
>GrOpen</A
148 
>                          (void);
149 
void        <A
150 
HREF="nano-x-general.html#GRCLOSE"
151 
>GrClose</A
152 
>                         (void);
153 
void        <A
154 
HREF="nano-x-general.html#GRMAINLOOP"
155 
>GrMainLoop</A
156 
>                      (<GTKDOCLINK
157 
HREF="GR-FNCALLBACKEVENT-CAPS"
158 
>GR_FNCALLBACKEVENT</GTKDOCLINK
159 
> fncb);
160 
void        <A
161 
HREF="nano-x-general.html#GRGETSCREENINFO"
162 
>GrGetScreenInfo</A
163 
>                 (<GTKDOCLINK
164 
HREF="GR-SCREEN-INFO-CAPS"
165 
>GR_SCREEN_INFO</GTKDOCLINK
166 
> *sip);
167 
<GTKDOCLINK
168 
HREF="GR-FNCALLBACKEVENT-CAPS"
169 
>GR_FNCALLBACKEVENT</GTKDOCLINK
170 
> <A
171 
HREF="nano-x-general.html#GRSETERRORHANDLER"
172 
>GrSetErrorHandler</A
173 
>        (<GTKDOCLINK
174 
HREF="GR-FNCALLBACKEVENT-CAPS"
175 
>GR_FNCALLBACKEVENT</GTKDOCLINK
176 
> fncb);
177 
void        <A
178 
HREF="nano-x-general.html#GRDEFAULTERRORHANDLER"
179 
>GrDefaultErrorHandler</A
180 
>           (<GTKDOCLINK
181 
HREF="GR-EVENT-CAPS"
182 
>GR_EVENT</GTKDOCLINK
183 
> *ep);</PRE
184 
></TD
185 
></TR
186 
></TABLE
187 
></DIV
188 
><DIV
189 
CLASS="REFSECT1"
190 
><A
191 
NAME="AEN29"
192 
></A
193 
><H2
194 
>Description</H2
195 
><P
196 
></P
197 
></DIV
198 
><DIV
199 
CLASS="REFSECT1"
200 
><A
201 
NAME="AEN32"
202 
></A
203 
><H2
204 
>Details</H2
205 
><DIV
206 
CLASS="REFSECT2"
207 
><A
208 
NAME="AEN34"
209 
></A
210 
><H3
211 
><A
212 
NAME="GRFLUSH"
213 
></A
214 
>GrFlush ()</H3
215 
><TABLE
216 
BORDER="0"
217 
BGCOLOR="#D6E8FF"
218 
WIDTH="100%"
219 
CELLPADDING="6"
220 
><TR
221 
><TD
222 
><PRE
223 
CLASS="PROGRAMLISTING"
224 
>void        GrFlush                         (void);</PRE
225 
></TD
226 
></TR
227 
></TABLE
228 
><P
229 
>Flush the message buffer of any messages it may contain.</P
230 
><P
231 
></P
232 
></DIV
233 
><HR><DIV
234 
CLASS="REFSECT2"
235 
><A
236 
NAME="AEN40"
237 
></A
238 
><H3
239 
><A
240 
NAME="GROPEN"
241 
></A
242 
>GrOpen ()</H3
243 
><TABLE
244 
BORDER="0"
245 
BGCOLOR="#D6E8FF"
246 
WIDTH="100%"
247 
CELLPADDING="6"
248 
><TR
249 
><TD
250 
><PRE
251 
CLASS="PROGRAMLISTING"
252 
>int         GrOpen                          (void);</PRE
253 
></TD
254 
></TR
255 
></TABLE
256 
><P
257 
>Open a connection to the graphics server.</P
258 
><P
259 
></P
260 
><DIV
261 
CLASS="INFORMALTABLE"
262 
><P
263 
></P
264 
><TABLE
265 
BORDER="0"
266 
WIDTH="100%"
267 
BGCOLOR="#FFD0D0"
268 
CELLSPACING="0"
269 
CELLPADDING="4"
270 
CLASS="CALSTABLE"
271 
><TR
272 
><TD
273 
WIDTH="20%"
274 
ALIGN="RIGHT"
275 
VALIGN="TOP"
276 
><I
277 
CLASS="EMPHASIS"
278 
>Returns</I
279 
> :</TD
280 
><TD
281 
WIDTH="80%"
282 
ALIGN="LEFT"
283 
VALIGN="TOP"
284 
> the fd of the connection to the server or -1 on failure</TD
285 
></TR
286 
></TABLE
287 
><P
288 
></P
289 
></DIV
290 
></DIV
291 
><HR><DIV
292 
CLASS="REFSECT2"
293 
><A
294 
NAME="AEN55"
295 
></A
296 
><H3
297 
><A
298 
NAME="GRCLOSE"
299 
></A
300 
>GrClose ()</H3
301 
><TABLE
302 
BORDER="0"
303 
BGCOLOR="#D6E8FF"
304 
WIDTH="100%"
305 
CELLPADDING="6"
306 
><TR
307 
><TD
308 
><PRE
309 
CLASS="PROGRAMLISTING"
310 
>void        GrClose                         (void);</PRE
311 
></TD
312 
></TR
313 
></TABLE
314 
><P
315 
>Close the graphics device, flushing any waiting messages.</P
316 
><P
317 
></P
318 
></DIV
319 
><HR><DIV
320 
CLASS="REFSECT2"
321 
><A
322 
NAME="AEN61"
323 
></A
324 
><H3
325 
><A
326 
NAME="GRMAINLOOP"
327 
></A
328 
>GrMainLoop ()</H3
329 
><TABLE
330 
BORDER="0"
331 
BGCOLOR="#D6E8FF"
332 
WIDTH="100%"
333 
CELLPADDING="6"
334 
><TR
335 
><TD
336 
><PRE
337 
CLASS="PROGRAMLISTING"
338 
>void        GrMainLoop                      (<GTKDOCLINK
339 
HREF="GR-FNCALLBACKEVENT-CAPS"
340 
>GR_FNCALLBACKEVENT</GTKDOCLINK
341 
> fncb);</PRE
342 
></TD
343 
></TR
344 
></TABLE
345 
><P
346 
>A convenience function which calls the specified callback function whenever
347 
an event arrives or there is data to be read on a file descriptor previously
348 
specified by <A
349 
HREF="nano-x-misc.html#GRREGISTERINPUT"
350 
>GrRegisterInput</A
351 
>(). Currently never returns.</P
352 
><P
353 
></P
354 
><DIV
355 
CLASS="INFORMALTABLE"
356 
><P
357 
></P
358 
><TABLE
359 
BORDER="0"
360 
WIDTH="100%"
361 
BGCOLOR="#FFD0D0"
362 
CELLSPACING="0"
363 
CELLPADDING="4"
364 
CLASS="CALSTABLE"
365 
><TR
366 
><TD
367 
WIDTH="20%"
368 
ALIGN="RIGHT"
369 
VALIGN="TOP"
370 
><TT
371 
CLASS="PARAMETER"
372 
><I
373 
>fncb</I
374 
></TT
375 
>&nbsp;:</TD
376 
><TD
377 
WIDTH="80%"
378 
ALIGN="LEFT"
379 
VALIGN="TOP"
380 
>&nbsp;</TD
381 
></TR
382 
></TABLE
383 
><P
384 
></P
385 
></DIV
386 
></DIV
387 
><HR><DIV
388 
CLASS="REFSECT2"
389 
><A
390 
NAME="AEN78"
391 
></A
392 
><H3
393 
><A
394 
NAME="GRGETSCREENINFO"
395 
></A
396 
>GrGetScreenInfo ()</H3
397 
><TABLE
398 
BORDER="0"
399 
BGCOLOR="#D6E8FF"
400 
WIDTH="100%"
401 
CELLPADDING="6"
402 
><TR
403 
><TD
404 
><PRE
405 
CLASS="PROGRAMLISTING"
406 
>void        GrGetScreenInfo                 (<GTKDOCLINK
407 
HREF="GR-SCREEN-INFO-CAPS"
408 
>GR_SCREEN_INFO</GTKDOCLINK
409 
> *sip);</PRE
410 
></TD
411 
></TR
412 
></TABLE
413 
><P
414 
>Fills in the specified GR_SCREEN_INFO structure.</P
415 
><P
416 
></P
417 
><DIV
418 
CLASS="INFORMALTABLE"
419 
><P
420 
></P
421 
><TABLE
422 
BORDER="0"
423 
WIDTH="100%"
424 
BGCOLOR="#FFD0D0"
425 
CELLSPACING="0"
426 
CELLPADDING="4"
427 
CLASS="CALSTABLE"
428 
><TR
429 
><TD
430 
WIDTH="20%"
431 
ALIGN="RIGHT"
432 
VALIGN="TOP"
433 
><TT
434 
CLASS="PARAMETER"
435 
><I
436 
>sip</I
437 
></TT
438 
>&nbsp;:</TD
439 
><TD
440 
WIDTH="80%"
441 
ALIGN="LEFT"
442 
VALIGN="TOP"
443 
> pointer to a GR_SCREEN_INFO structure</TD
444 
></TR
445 
></TABLE
446 
><P
447 
></P
448 
></DIV
449 
></DIV
450 
><HR><DIV
451 
CLASS="REFSECT2"
452 
><A
453 
NAME="AEN94"
454 
></A
455 
><H3
456 
><A
457 
NAME="GRSETERRORHANDLER"
458 
></A
459 
>GrSetErrorHandler ()</H3
460 
><TABLE
461 
BORDER="0"
462 
BGCOLOR="#D6E8FF"
463 
WIDTH="100%"
464 
CELLPADDING="6"
465 
><TR
466 
><TD
467 
><PRE
468 
CLASS="PROGRAMLISTING"
469 
><GTKDOCLINK
470 
HREF="GR-FNCALLBACKEVENT-CAPS"
471 
>GR_FNCALLBACKEVENT</GTKDOCLINK
472 
> GrSetErrorHandler        (<GTKDOCLINK
473 
HREF="GR-FNCALLBACKEVENT-CAPS"
474 
>GR_FNCALLBACKEVENT</GTKDOCLINK
475 
> fncb);</PRE
476 
></TD
477 
></TR
478 
></TABLE
479 
><P
480 
>Sets an error handling routine that will be called on any errors from
481 
the server (assuming the client has asked to receive them). If zero is
482 
used as the argument, errors will be returned as regular events instead.</P
483 
><P
484 
></P
485 
><DIV
486 
CLASS="INFORMALTABLE"
487 
><P
488 
></P
489 
><TABLE
490 
BORDER="0"
491 
WIDTH="100%"
492 
BGCOLOR="#FFD0D0"
493 
CELLSPACING="0"
494 
CELLPADDING="4"
495 
CLASS="CALSTABLE"
496 
><TR
497 
><TD
498 
WIDTH="20%"
499 
ALIGN="RIGHT"
500 
VALIGN="TOP"
501 
><TT
502 
CLASS="PARAMETER"
503 
><I
504 
>fncb</I
505 
></TT
506 
>&nbsp;:</TD
507 
><TD
508 
WIDTH="80%"
509 
ALIGN="LEFT"
510 
VALIGN="TOP"
511 
> the function to call to handle error events</TD
512 
></TR
513 
><TR
514 
><TD
515 
WIDTH="20%"
516 
ALIGN="RIGHT"
517 
VALIGN="TOP"
518 
><I
519 
CLASS="EMPHASIS"
520 
>Returns</I
521 
> :</TD
522 
><TD
523 
WIDTH="80%"
524 
ALIGN="LEFT"
525 
VALIGN="TOP"
526 
> the address of the previous error handler</TD
527 
></TR
528 
></TABLE
529 
><P
530 
></P
531 
></DIV
532 
></DIV
533 
><HR><DIV
534 
CLASS="REFSECT2"
535 
><A
536 
NAME="AEN115"
537 
></A
538 
><H3
539 
><A
540 
NAME="GRDEFAULTERRORHANDLER"
541 
></A
542 
>GrDefaultErrorHandler ()</H3
543 
><TABLE
544 
BORDER="0"
545 
BGCOLOR="#D6E8FF"
546 
WIDTH="100%"
547 
CELLPADDING="6"
548 
><TR
549 
><TD
550 
><PRE
551 
CLASS="PROGRAMLISTING"
552 
>void        GrDefaultErrorHandler           (<GTKDOCLINK
553 
HREF="GR-EVENT-CAPS"
554 
>GR_EVENT</GTKDOCLINK
555 
> *ep);</PRE
556 
></TD
557 
></TR
558 
></TABLE
559 
><P
560 
>The default error handler which is called when the server reports an error
561 
event and the client hasn't set up a handler of it's own.</P
562 
><P
563 
>Generates a human readable error message on stderr describing what error
564 
occurred and what function it occured in, then exits.</P
565 
><P
566 
></P
567 
><DIV
568 
CLASS="INFORMALTABLE"
569 
><P
570 
></P
571 
><TABLE
572 
BORDER="0"
573 
WIDTH="100%"
574 
BGCOLOR="#FFD0D0"
575 
CELLSPACING="0"
576 
CELLPADDING="4"
577 
CLASS="CALSTABLE"
578 
><TR
579 
><TD
580 
WIDTH="20%"
581 
ALIGN="RIGHT"
582 
VALIGN="TOP"
583 
><TT
584 
CLASS="PARAMETER"
585 
><I
586 
>ep</I
587 
></TT
588 
>&nbsp;:</TD
589 
><TD
590 
WIDTH="80%"
591 
ALIGN="LEFT"
592 
VALIGN="TOP"
593 
> the error event structure</TD
594 
></TR
595 
></TABLE
596 
><P
597 
></P
598 
></DIV
599 
></DIV
600 
></DIV
601 
><DIV
602 
CLASS="NAVFOOTER"
603 
><BR
604 
CLEAR="all"><BR><TABLE
605 
WIDTH="100%"
606 
BORDER="0"
607 
BGCOLOR="#000000"
608 
CELLPADDING="1"
609 
CELLSPACING="0"
610 
><TR
611 
><TD
612 
WIDTH="25%"
613 
BGCOLOR="#C00000"
614 
ALIGN="left"
615 
><A
616 
HREF="libnano-x.html"
617 
><FONT
618 
COLOR="#FFFFFF"
619 
SIZE="3"
620 
><B
621 
>&#60;&#60;&#60; Previous Page</B
622 
></FONT
623 
></A
624 
></TD
625 
><TD
626 
WIDTH="25%"
627 
BGCOLOR="#0000C0"
628 
ALIGN="center"
629 
><FONT
630 
COLOR="#FFFFFF"
631 
SIZE="3"
632 
><B
633 
><A
634 
HREF="index.html"
635 
><FONT
636 
COLOR="#FFFFFF"
637 
SIZE="3"
638 
><B
639 
>Home</B
640 
></FONT
641 
></A
642 
></B
643 
></FONT
644 
></TD
645 
><TD
646 
WIDTH="25%"
647 
BGCOLOR="#00C000"
648 
ALIGN="center"
649 
><FONT
650 
COLOR="#FFFFFF"
651 
SIZE="3"
652 
><B
653 
><A
654 
HREF="libnano-x.html"
655 
><FONT
656 
COLOR="#FFFFFF"
657 
SIZE="3"
658 
><B
659 
>Up</B
660 
></FONT
661 
></A
662 
></B
663 
></FONT
664 
></TD
665 
><TD
666 
WIDTH="25%"
667 
BGCOLOR="#C00000"
668 
ALIGN="right"
669 
><A
670 
HREF="nano-x-window.html"
671 
><FONT
672 
COLOR="#FFFFFF"
673 
SIZE="3"
674 
><B
675 
>Next Page &#62;&#62;&#62;</B
676 
></FONT
677 
></A
678 
></TD
679 
></TR
680 
><TR
681 
><TD
682 
COLSPAN="2"
683 
ALIGN="left"
684 
><FONT
685 
COLOR="#FFFFFF"
686 
SIZE="3"
687 
><B
688 
>libnano-X</B
689 
></FONT
690 
></TD
691 
><TD
692 
COLSPAN="2"
693 
ALIGN="right"
694 
><FONT
695 
COLOR="#FFFFFF"
696 
SIZE="3"
697 
><B
698 
>window</B
699 
></FONT
700 
></TD
701 
></TR
702 
></TABLE
703 
></DIV
704 
></BODY
705 
></HTML
706 
>

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.