Debian Codegraph @

doc/reference.texinfo

raw
1
2 @c Automatically generated file. DO NOT EDIT! it is generated according to the
3 @c aalib.h header file.
4
5 @node Reference, Index, Designing new driver, Top
6 @appendix Reference
7 @menu
8
9 * aa_attrs:: returns pointer to the text output buffer used by AA-lib.
10 * aa_autoinitkbd:: easy to use AA-lib keyboard initialization function.
11 * aa_autoinitmouse:: easy to use AA-lib mouse initialization function.
12 * aa_autoinit:: easy to use AA-lib initialization function.
13 * aa_close:: close the AA-lib context.
14 * aa_createedit:: Simple interactive line editor provided as helper function.
15 * aa_currentfont:: returns specification of the fonts used by AA-lib rendering routines.
16 * aa_defparams:: default hardware paramters requested by AA-lib programs.
17 * aa_defrenderparams:: default rendering parameters.
18 * aa_displayrecommended::List of recommended drivers.
19 * aa_dithernames:: Names of dithering methods supported by AA-lib.
20 * aa_drivers:: NULL-terminated array of output drivers available in AA-lib.
21 * aa_editkey:: Notify the line editor about keypress.
22 * aa_edit:: Simple interactive line editor.
23 * aa_fastrender:: simple and fast AA-lib rendering function.
24 * aa_fonts:: Null-terminated array of available fonts.
25 * aa_formats:: NULL terminated array of save formats supported by AA-lib.
26 * aa_getevent:: keyboard functions
27 * aa_getkey:: return next keypress event from queue.
28 * aa_getmouse:: Get mouse position as specified by last mouse event read by aa_getevent.
29 * aa_gotoxy:: move the hardware cursor (if any) to specified position.
30 * aa_help:: AA-lib help string for the default command line parser.
31 * aa_hidecursor:: hide the hardware cursor.
32 * aa_hidemouse:: hide the mouse cursor.
33 * aa_image:: returns pointer to the framebuffer emulated by AA-lib.
34 * aa_imgheight:: returns height of the emulated image in pixels.
35 * aa_imgwidth:: returns width of the emulated image in pixels.
36 * aa_initkbd:: initialize the AA-lib keyboard driver.
37 * aa_initmouse:: initialize the AA-lib mouse driver.
38 * aa_init:: open the output display for AA-lib.
39 * aa_kbddrivers:: NULL-terminated array of keyboard drivers available in AA_lib.
40 * aa_kbdrecommended:: List of recommended drivers.
41 * aa_mmheight:: returns height of the output screen in millimeters.
42 * aa_mmwidth:: returns width of the output screen in millimeters.
43 * aa_mousedrivers:: NULL terminated array of mouse drivers supported by AA-lib.
44 * aa_mouserecommended:: List of recommended drivers.
45 * aa_parseoptions:: parse the standard command line options used by AA-lib.
46 * aa_printf:: print text to AA-lib output buffers.
47 * aa_putpixel:: put pixel to emulated framebuffer
48 * aa_puts:: output string to AA-lib output buffers.
49 * aa_recommendhidisplay::insert the given driver on beggining of the list of recommended display drivers.
50 * aa_recommendhikbd:: insert the given driver on beggining of the list of recommended keyboard drivers.
51 * aa_recommendhimouse:: insert the given driver on beggining of the list of recommended mouse drivers.
52 * aa_recommendhi:: insert the given driver on beggining of the list of recommended drivers.
53 * aa_recommendlowdisplay::Add the given driver to the end of list of display recommended drivers.
54 * aa_recommendlowkbd:: Add the given driver to the end of list of keyboard recommended drivers.
55 * aa_recommendlowmouse:: Add the given driver to the end of list of mouse recommended drivers.
56 * aa_recommendlow:: Add the given driver to the end of list of recommended drivers.
57 * aa_registerfont:: add new font specification to aa_fonts array.
58 * aa_render:: convert image buffer to ASCII-art.
59 * aa_resizehandler:: Set user handler to be called on resize event.
60 * aa_resize:: resize functions
61 * aa_scrheight:: returns height of the output screen in characters.
62 * aa_scrwidth:: returns width of the output screen in characters.
63 * aa_setfont:: set font specification to be used by rendering functions.
64 * aa_setsupported:: alter the "supported" field of hardware_params structure used by AA-lib
65 * aa_showcursor:: show the hardware cursor.
66 * aa_showmouse:: show the mouse cursor.
67 * aa_text:: returns pointer to the text output buffer used by AA-lib.
68 * aa_uninitkbd:: uninitialize the keyboard driver.
69 * aa_uninitmouse:: uninitialize the mouse driver.
70 * mem_d:: AA-lib memory driver.
71 * save_d:: AA-lib driver used to save ascii-art image into file in used specified format.
72
73
74 @end menu
75
76
77
78
79
80 @node aa_attrs, aa_autoinitkbd, , Reference
81 @findex aa_attrs
82 @appendixsec aa_attrs
83 @noindent
84
85 @noindent
86 @example
87 #include <aalib.h>
88 @sp 1
89 char *aa_attrs(aa_context *a);
90 @end example
91 @heading Parameters
92 @noindent
93 @quotation
94 @table @code
95 @item aa_context *a
96 Specifies the AA-lib context to operate on.
97 @end table
98 @end quotation
99 @heading Description
100 @noindent
101 The attribute output buffer is simple array of characters specifying
102 the attributes.
103 The array is organizated in the aa_scrheight (a) rows of
104 aa_scrwidth(a) characters.
105 @heading Return value
106 @noindent
107 Pointer the text output buffer used by AA-lib.
108
109
110
111
112 @node aa_autoinitkbd, aa_autoinitmouse, aa_attrs, Reference
113 @findex aa_autoinitkbd
114 @appendixsec aa_autoinitkbd
115 @noindent
116
117 @noindent
118 @example
119 #include <aalib.h>
120 @sp 1
121 int aa_autoinitkbd
122 (
123 struct aa_context *context,
124 int mode
125 );
126 @end example
127 @heading Parameters
128 @noindent
129 @quotation
130 @table @code
131 @item struct aa_context *context
132 Specifies the AA-lib context to operate on.
133 @item int mode
134 Mask of extra features you request. Can contain
135 AA_SENDRELEASE if you are interested in release events
136 too.
137 @end table
138 @end quotation
139 @heading Description
140 @noindent
141 Attempts to find available keyboard driver supporting the specified
142 mode. First attempts to initialize the recommended drivers
143 and then in order drivers available in the aa_kbddrivers array
144 (all regular output drivers compiled into AA-lib).
145
146 Every AA-lib program ought to have call to aa_parseoptions before
147 first call to aa_init.
148 @heading Return value
149 @noindent
150 1 when succesfull or 0 on failure.
151
152
153
154
155 @node aa_autoinitmouse, aa_autoinit, aa_autoinitkbd, Reference
156 @findex aa_autoinitmouse
157 @appendixsec aa_autoinitmouse
158 @noindent
159
160 @noindent
161 @example
162 #include <aalib.h>
163 @sp 1
164 int aa_autoinitmouse
165 (
166 struct aa_context *c,
167 int mode
168 );
169 @end example
170 @heading Parameters
171 @noindent
172 @quotation
173 @table @code
174 @item struct aa_context *c
175 Specifies the AA-lib context to operate on.
176 @item int mode
177 Mask of extra features you request. No such features
178 are available in the current AA-lib version.
179 @end table
180 @end quotation
181 @heading Description
182 @noindent
183 Attempts to find available mouse driver supporting the specified
184 mode. First attempts to initialize the recommended drivers
185 and then in order drivers available in the aa_kbddrivers array
186 (all regular output drivers compiled into AA-lib).
187 @heading Return value
188 @noindent
189 1 when succesfull or 0 on failure.
190
191
192
193
194 @node aa_autoinit, aa_close, aa_autoinitmouse, Reference
195 @findex aa_autoinit
196 @appendixsec aa_autoinit
197 @noindent
198
199 @noindent
200 @example
201 #include <aalib.h>
202 @sp 1
203 aa_context *aa_autoinit(const struct aa_hardware_params *params);
204 @end example
205 @heading Parameters
206 @noindent
207 @quotation
208 @table @code
209 @item const struct aa_hardware_params *params
210 Hardware parameters you want. Use aa_defparams
211 for default values.
212 @end table
213 @end quotation
214 @heading Description
215 @noindent
216 Attempts to find available output driver supporting the specified
217 parameters. First attempts to initialize the recommended drivers
218 and then in order drivers available in the aa_drivers array
219 (all regular output drivers compiled into AA-lib).
220 @heading Return value
221 @noindent
222 Pointer to initialized context structure when succesfull or
223 NULL on failure.
224
225
226
227
228 @node aa_close, aa_createedit, aa_autoinit, Reference
229 @findex aa_close
230 @appendixsec aa_close
231 @noindent
232
233 @noindent
234 @example
235 #include <aalib.h>
236 @sp 1
237 void aa_close(aa_context *c);
238 @end example
239 @heading Parameters
240 @noindent
241 @quotation
242 @table @code
243 @item aa_context *c
244 Specifies the AA-lib context to operate on.
245 @end table
246 @end quotation
247 @heading Description
248 @noindent
249 Uninitialize all activated drivers and frees the memory used by context
250 structures.
251
252
253
254
255 @node aa_createedit, aa_currentfont, aa_close, Reference
256 @findex aa_createedit
257 @appendixsec aa_createedit
258 @noindent
259
260 @noindent
261 @example
262 #include <aalib.h>
263 @sp 1
264 struct aa_edit *aa_createedit
265 (
266 aa_context *c,
267 int x,
268 int y,
269 int size,
270 char *s,
271 int maxsize
272 );
273 @end example
274 @heading Parameters
275 @noindent
276 @quotation
277 @table @code
278 @item aa_context *c
279 Specifies the AA-lib context to operate on.
280 @item int x
281 X coordinate of the edited text.
282 @item int y
283 Y coordinate of the edited text.
284 @item int size
285 Length of the editor window.
286 @item char *s
287 Buffer to edit (containing default value).
288 @item int maxsize
289 Size of the buffer.
290 @end table
291 @end quotation
292 @heading Description
293 @noindent
294 You might use this function to input strings in AA-lib programs.
295 This function initializes the aa_edit structure used by event-based
296 editor. You might then call the aa_editkey function when key is pressed.
297 @heading Return value
298 @noindent
299 Pointer to edit context when succesfull and NULL on failure.
300
301
302
303
304 @node aa_currentfont, aa_defparams, aa_createedit, Reference
305 @findex aa_currentfont
306 @appendixsec aa_currentfont
307 @noindent
308
309 @noindent
310 @example
311 #include <aalib.h>
312 @sp 1
313 const struct aa_font *aa_currentfont(aa_context *a);
314 @end example
315 @heading Parameters
316 @noindent
317 @quotation
318 @table @code
319 @item aa_context *a
320 Specifies the AA-lib context to operate on.
321 @end table
322 @end quotation
323 @heading Description
324 @noindent
325 Returns specification of the fonts used by AA-lib rendering routines.
326
327
328
329
330 @node aa_defparams, aa_defrenderparams, aa_currentfont, Reference
331 @findex aa_defparams
332 @appendixsec aa_defparams
333 @noindent
334
335 @noindent
336 @example
337 #include <aalib.h>
338 @sp 1
339 extern struct aa_hardware_params aa_defparams;
340 @end example
341 @heading Description
342 @noindent
343 Pa
344 Default hardware paramters requested by AA-lib programs. Passed to aa_init
345 function familly.
346
347
348
349
350 @node aa_defrenderparams, aa_displayrecommended, aa_defparams, Reference
351 @findex aa_defrenderparams
352 @appendixsec aa_defrenderparams
353 @noindent
354
355 @noindent
356 @example
357 #include <aalib.h>
358 @sp 1
359 extern struct aa_renderparams aa_defrenderparams;
360 @end example
361 @heading Description
362 @noindent
363 Default rendering parameters. Passed to aa_render function familly.
364
365
366
367
368 @node aa_displayrecommended, aa_dithernames, aa_defrenderparams, Reference
369 @findex aa_displayrecommended
370 @appendixsec aa_displayrecommended
371 @noindent
372
373 @noindent
374 @example
375 #include <aalib.h>
376 @sp 1
377 extern aa_linkedlist *aa_displayrecommended;
378 @end example
379 @heading Description
380 @noindent
381 List of recommended drivers is used by aa_autoinit familly of functions
382 and altered by aa_recommend familly of functions.
383
384
385
386
387 @node aa_dithernames, aa_drivers, aa_displayrecommended, Reference
388 @findex aa_dithernames
389 @appendixsec aa_dithernames
390 @noindent
391
392 @noindent
393 @example
394 #include <aalib.h>
395 @sp 1
396 extern const char *const aa_dithernames[];
397 @end example
398 @heading Description
399 @noindent
400 NULL terminated array containing the names of supported dithering methods
401 as ascii strings.
402
403
404
405
406 @node aa_drivers, aa_editkey, aa_dithernames, Reference
407 @findex aa_drivers
408 @appendixsec aa_drivers
409 @noindent
410
411 @noindent
412 @example
413 #include <aalib.h>
414 @sp 1
415 extern const struct aa_driver *const aa_drivers[];
416 @end example
417 @heading Description
418 @noindent
419 NULL-terminated array of output drivers available in AA-lib.
420
421
422
423
424 @node aa_editkey, aa_edit, aa_drivers, Reference
425 @findex aa_editkey
426 @appendixsec aa_editkey
427 @noindent
428
429 @noindent
430 @example
431 #include <aalib.h>
432 @sp 1
433 void aa_editkey
434 (
435 struct aa_edit *e,
436 int c
437 );
438 @end example
439 @heading Parameters
440 @noindent
441 @quotation
442 @table @code
443 @item struct aa_edit *e
444 Editor context to use (see aa_createedit).
445 @item int c
446 Key pressed.
447 @end table
448 @end quotation
449 @heading Description
450 @noindent
451 Notify the line editor about keypress.
452
453
454
455
456 @node aa_edit, aa_fastrender, aa_editkey, Reference
457 @findex aa_edit
458 @appendixsec aa_edit
459 @noindent
460
461 @noindent
462 @example
463 #include <aalib.h>
464 @sp 1
465 void aa_edit
466 (
467 aa_context *c,
468 int x,
469 int y,
470 int size,
471 char *s,
472 int maxsize
473 );
474 @end example
475 @heading Parameters
476 @noindent
477 @quotation
478 @table @code
479 @item aa_context *c
480 Specifies the AA-lib context to operate on.
481 @item int x
482 X coordinate of the edited text.
483 @item int y
484 Y coordinate of the edited text.
485 @item int size
486 Length of the editor window.
487 @item char *s
488 Buffer to edit (containing default value).
489 @item int maxsize
490 Size of the buffer.
491 @end table
492 @end quotation
493 @heading Description
494 @noindent
495 This function produces the simple interactive line editor that can
496 be used by AA-lib programs to input strings.
497
498
499
500
501 @node aa_fastrender, aa_fonts, aa_edit, Reference
502 @findex aa_fastrender
503 @appendixsec aa_fastrender
504 @noindent
505
506 @noindent
507 @example
508 #include <aalib.h>
509 @sp 1
510 void aa_fastrender
511 (
512 aa_context *c,
513 int x1,
514 int y1,
515 int x2,
516 int y2
517 );
518 @end example
519 @heading Parameters
520 @noindent
521 @quotation
522 @table @code
523 @item aa_context *c
524 Specifies the AA-lib context to operate on.
525 @item int x1
526 Column of top left coner of rendered area
527 (in characters!).
528 @item int y1
529 Row of top left coner of rendered area.
530 @item int x2
531 Column of bottom right coner of rendered area.
532 @item int y2
533 Row of bottom right coner of rendered area.
534 @end table
535 @end quotation
536 @heading Description
537 @noindent
538 This function does the trick of converting the emulated framebuffer
539 into high quality ASCII-art. It is slightly faster and less flexible
540 the aa_render function.
541
542 Note that to see the effect you need to call aa_flush too.
543
544 First call to this function may take a while, because the rendering
545 tables are produced.
546
547
548
549
550 @node aa_fonts, aa_formats, aa_fastrender, Reference
551 @findex aa_fonts
552 @appendixsec aa_fonts
553 @noindent
554
555 @noindent
556 @example
557 #include <aalib.h>
558 @sp 1
559 extern const struct aa_font *aa_fonts[];
560 @end example
561 @heading Description
562 @noindent
563 Null-terminated array of available fonts.
564
565
566
567
568 @node aa_formats, aa_getevent, aa_fonts, Reference
569 @findex aa_formats
570 @appendixsec aa_formats
571 @noindent
572
573 @noindent
574 @example
575 #include <aalib.h>
576 @sp 1
577 extern const struct aa_format *const aa_formats[];
578 @end example
579 @heading Description
580 @noindent
581 NULL terminated array of save formats supported by AA-lib.
582
583
584
585
586 @node aa_getevent, aa_getkey, aa_formats, Reference
587 @findex aa_getevent
588 @appendixsec aa_getevent
589 @noindent
590
591 @noindent
592 @example
593 #include <aalib.h>
594 @sp 1
595 int aa_getevent
596 (
597 aa_context *c,
598 int wait
599 );
600 @end example
601 @heading Parameters
602 @noindent
603 @quotation
604 @table @code
605 @item aa_context *c
606 Specifies the AA-lib context to operate on.
607 @item int wait
608 1 if you wish to wait for the even when queue is empty.
609 @end table
610 @end quotation
611 @heading Description
612 @noindent
613 Return next event from queue.
614 Return next even from queue. Optionally wait for even when queue is
615 empty.
616 @heading Return value
617 @noindent
618 Next event from queue (values lower than 256 are used to report
619 ascii values of pressed keys and higher values have special meanings)
620 See the AA-lib texinfo documentation for more details.
621 0 is returned when queue is empty and wait is set to 0.
622
623
624
625
626 @node aa_getkey, aa_getmouse, aa_getevent, Reference
627 @findex aa_getkey
628 @appendixsec aa_getkey
629 @noindent
630
631 @noindent
632 @example
633 #include <aalib.h>
634 @sp 1
635 int aa_getkey
636 (
637 aa_context *c,
638 int wait
639 );
640 @end example
641 @heading Parameters
642 @noindent
643 @quotation
644 @table @code
645 @item aa_context *c
646 Specifies the AA-lib context to operate on.
647 @item int wait
648 1 if you wish to wait for the even when queue is empty.
649 @end table
650 @end quotation
651 @heading Description
652 @noindent
653 Return next keypress event from queue.
654 @heading Return value
655 @noindent
656 Next keypress event from queue (values lower than 256 are used
657 to report ascii values of pressed keys and higher values are used to
658 represent some special keys like arrows)
659 See the AA-lib texinfo documentation for more details.
660
661
662
663
664 @node aa_getmouse, aa_gotoxy, aa_getkey, Reference
665 @findex aa_getmouse
666 @appendixsec aa_getmouse
667 @noindent
668
669 @noindent
670 @example
671 #include <aalib.h>
672 @sp 1
673 void aa_getmouse
674 (
675 aa_context *c,
676 int *x,
677 int *y,
678 int *b
679 );
680 @end example
681 @heading Parameters
682 @noindent
683 @quotation
684 @table @code
685 @item aa_context *c
686 Specifies the AA-lib context to operate on.
687 @item int *x
688 Used to return X coordinate of mouse in characters.
689 @item int *y
690 Used to return Y coordinate of mouse in characters.
691 @item int *b
692 Used to return button mask of mouse.
693 (Values used are AA_BUTTON1, AA_BUTTON2 and AA_BUTTON3).
694 @end table
695 @end quotation
696 @heading Description
697 @noindent
698 Get mouse position as specified by last mouse event read by aa_getevent.
699
700
701
702
703 @node aa_gotoxy, aa_help, aa_getmouse, Reference
704 @findex aa_gotoxy
705 @appendixsec aa_gotoxy
706 @noindent
707
708 @noindent
709 @example
710 #include <aalib.h>
711 @sp 1
712 void aa_gotoxy
713 (
714 aa_context *c,
715 int x,
716 int y
717 );
718 @end example
719 @heading Parameters
720 @noindent
721 @quotation
722 @table @code
723 @item aa_context *c
724 Specifies the AA-lib context to operate on.
725 @item int x
726 X coordinate of new position.
727 @item int y
728 Y coordinate of the position.
729 @end table
730 @end quotation
731 @heading Description
732 @noindent
733 Move the hardware cursor (if any) to specified position.
734 To see the effect you need to call aa_flush too.
735
736
737
738
739 @node aa_help, aa_hidecursor, aa_gotoxy, Reference
740 @findex aa_help
741 @appendixsec aa_help
742 @noindent
743
744 @noindent
745 @example
746 #include <aalib.h>
747 @sp 1
748 extern const char *const aa_help;
749 @end example
750 @heading Description
751 @noindent
752 AA-lib help string for the default command line parser.
753
754
755
756
757 @node aa_hidecursor, aa_hidemouse, aa_help, Reference
758 @findex aa_hidecursor
759 @appendixsec aa_hidecursor
760 @noindent
761
762 @noindent
763 @example
764 #include <aalib.h>
765 @sp 1
766 void aa_hidecursor(aa_context *c);
767 @end example
768 @heading Parameters
769 @noindent
770 @quotation
771 @table @code
772 @item aa_context *c
773 Specifies the AA-lib context to operate on.
774 @end table
775 @end quotation
776 @heading Description
777 @noindent
778 Hide the hardware cursor.
779 This function may be ignored by some drivers.
780
781
782
783
784 @node aa_hidemouse, aa_image, aa_hidecursor, Reference
785 @findex aa_hidemouse
786 @appendixsec aa_hidemouse
787 @noindent
788
789 @noindent
790 @example
791 #include <aalib.h>
792 @sp 1
793 void aa_hidemouse(aa_context *c);
794 @end example
795 @heading Parameters
796 @noindent
797 @quotation
798 @table @code
799 @item aa_context *c
800 Not Documented.
801 @end table
802 @end quotation
803 @heading Description
804 @noindent
805 Hide the mouse cursor.
806 This function may be ignored by some drivers.
807
808
809
810
811 @node aa_image, aa_imgheight, aa_hidemouse, Reference
812 @findex aa_image
813 @appendixsec aa_image
814 @noindent
815
816 @noindent
817 @example
818 #include <aalib.h>
819 @sp 1
820 char *aa_image(aa_context *a);
821 @end example
822 @heading Parameters
823 @noindent
824 @quotation
825 @table @code
826 @item aa_context *a
827 Specifies the AA-lib context to operate on.
828 @end table
829 @end quotation
830 @heading Description
831 @noindent
832 The framebuffer is simple array of characters specifying
833 the brightness value (or palette index depending on the aa_render
834 call). The array is organizated in the aa_imgheight (a) rows of
835 aa_imgwidth(a) characters.
836 @heading Return value
837 @noindent
838 Pointer to framebuffer emulated by AA-lib.
839
840
841
842
843 @node aa_imgheight, aa_imgwidth, aa_image, Reference
844 @findex aa_imgheight
845 @appendixsec aa_imgheight
846 @noindent
847
848 @noindent
849 @example
850 #include <aalib.h>
851 @sp 1
852 int aa_imgheight(aa_context *a);
853 @end example
854 @heading Parameters
855 @noindent
856 @quotation
857 @table @code
858 @item aa_context *a
859 Specifies the AA-lib context to operate on.
860 @end table
861 @end quotation
862 @heading Description
863 @noindent
864 Returns height of the emulated image in pixels.
865
866
867
868
869 @node aa_imgwidth, aa_initkbd, aa_imgheight, Reference
870 @findex aa_imgwidth
871 @appendixsec aa_imgwidth
872 @noindent
873
874 @noindent
875 @example
876 #include <aalib.h>
877 @sp 1
878 int aa_imgwidth(aa_context *a);
879 @end example
880 @heading Parameters
881 @noindent
882 @quotation
883 @table @code
884 @item aa_context *a
885 Specifies the AA-lib context to operate on.
886 @end table
887 @end quotation
888 @heading Description
889 @noindent
890 Returns width of the emulated image in pixels.
891
892
893
894
895 @node aa_initkbd, aa_initmouse, aa_imgwidth, Reference
896 @findex aa_initkbd
897 @appendixsec aa_initkbd
898 @noindent
899
900 @noindent
901 @example
902 #include <aalib.h>
903 @sp 1
904 int aa_initkbd
905 (
906 struct aa_context *context,
907 const struct aa_kbddriver *drv,
908 int mode
909 );
910 @end example
911 @heading Parameters
912 @noindent
913 @quotation
914 @table @code
915 @item struct aa_context *context
916 Specifies the AA-lib context to operate on.
917 @item const struct aa_kbddriver *drv
918 Driver you wish to use.
919 @item int mode
920 Mask of extra features you request. Can contain
921 AA_SENDRELEASE if you are interested in release events
922 too.
923 @end table
924 @end quotation
925 @heading Description
926 @noindent
927 This is the most primitive AA-lib keyboard initialization function.
928 Allows better control over the process than the easier to use
929 aa_autoinitkbd function.
930 @heading Return value
931 @noindent
932 1 on success and 0 on fail.
933
934
935
936
937 @node aa_initmouse, aa_init, aa_initkbd, Reference
938 @findex aa_initmouse
939 @appendixsec aa_initmouse
940 @noindent
941
942 @noindent
943 @example
944 #include <aalib.h>
945 @sp 1
946 int aa_initmouse
947 (
948 struct aa_context *c,
949 const struct aa_mousedriver *d,
950 int mode
951 );
952 @end example
953 @heading Parameters
954 @noindent
955 @quotation
956 @table @code
957 @item struct aa_context *c
958 Specifies the AA-lib context to operate on.
959 @item const struct aa_mousedriver *d
960 Driver you wish to use.
961 @item int mode
962 Mask of extra features you request. No such features
963 are available in the current AA-lib version.
964 @end table
965 @end quotation
966 @heading Description
967 @noindent
968 This is the most primitive AA-lib keyboard initialization function.
969 Allows better control over the process than the easier to use
970 aa_autoinitmouse function.
971 @heading Return value
972 @noindent
973 1 on success and 0 on fail.
974
975
976
977
978 @node aa_init, aa_kbddrivers, aa_initmouse, Reference
979 @findex aa_init
980 @appendixsec aa_init
981 @noindent
982
983 @noindent
984 @example
985 #include <aalib.h>
986 @sp 1
987 aa_context *aa_init
988 (
989 const struct aa_driver *driver,
990 const struct aa_hardware_params *defparams,
991 const void *driverdata
992 );
993 @end example
994 @heading Parameters
995 @noindent
996 @quotation
997 @table @code
998 @item const struct aa_driver *driver
999 Driver you want to use. Available drivers are listed
1000 in the NULL terminated aa_drivers array.
1001 @item const struct aa_hardware_params *defparams
1002 Hardware parameters you want. Use aa_defparams
1003 for default values.
1004 @item const void *driverdata
1005 This pointer is passed dirrectly to driver used
1006 to specify additional driver dependent parameters.
1007 @end table
1008 @end quotation
1009 @heading Description
1010 @noindent
1011 This is the most primitive AA-lib initialization function.
1012 Allows better control over the process than the easier to use
1013 aa_autoinit function.
1014
1015 Every AA-lib program ought to have call to aa_parseoptions before
1016 first call to aa_init.
1017 @heading Return value
1018 @noindent
1019 Pointer to new AA-lib context or NULL if failed.
1020
1021
1022
1023
1024 @node aa_kbddrivers, aa_kbdrecommended, aa_init, Reference
1025 @findex aa_kbddrivers
1026 @appendixsec aa_kbddrivers
1027 @noindent
1028
1029 @noindent
1030 @example
1031 #include <aalib.h>
1032 @sp 1
1033 extern const struct aa_kbddriver *const aa_kbddrivers[];
1034 @end example
1035 @heading Description
1036 @noindent
1037 NULL-terminated array of keyboard drivers available in AA_lib.
1038
1039
1040
1041
1042 @node aa_kbdrecommended, aa_mmheight, aa_kbddrivers, Reference
1043 @findex aa_kbdrecommended
1044 @appendixsec aa_kbdrecommended
1045 @noindent
1046
1047 @noindent
1048 @example
1049 #include <aalib.h>
1050 @sp 1
1051 extern aa_linkedlist *aa_kbdrecommended;
1052 @end example
1053 @heading Description
1054 @noindent
1055 List of recommended drivers is used by aa_autoinit familly of functions
1056 and altered by aa_recommend familly of functions.
1057
1058
1059
1060
1061 @node aa_mmheight, aa_mmwidth, aa_kbdrecommended, Reference
1062 @findex aa_mmheight
1063 @appendixsec aa_mmheight
1064 @noindent
1065
1066 @noindent
1067 @example
1068 #include <aalib.h>
1069 @sp 1
1070 int aa_mmheight(aa_context *a);
1071 @end example
1072 @heading Parameters
1073 @noindent
1074 @quotation
1075 @table @code
1076 @item aa_context *a
1077 Specifies the AA-lib context to operate on.
1078 @end table
1079 @end quotation
1080 @heading Description
1081 @noindent
1082 Returns height of the output screen in millimeters.
1083
1084
1085
1086
1087 @node aa_mmwidth, aa_mousedrivers, aa_mmheight, Reference
1088 @findex aa_mmwidth
1089 @appendixsec aa_mmwidth
1090 @noindent
1091
1092 @noindent
1093 @example
1094 #include <aalib.h>
1095 @sp 1
1096 int aa_mmwidth(aa_context *a);
1097 @end example
1098 @heading Parameters
1099 @noindent
1100 @quotation
1101 @table @code
1102 @item aa_context *a
1103 Specifies the AA-lib context to operate on.
1104 @end table
1105 @end quotation
1106 @heading Description
1107 @noindent
1108 Returns width of the output screen in millimeters.
1109
1110
1111
1112
1113 @node aa_mousedrivers, aa_mouserecommended, aa_mmwidth, Reference
1114 @findex aa_mousedrivers
1115 @appendixsec aa_mousedrivers
1116 @noindent
1117
1118 @noindent
1119 @example
1120 #include <aalib.h>
1121 @sp 1
1122 extern const struct aa_mousedriver *const aa_mousedrivers[];
1123 @end example
1124 @heading Description
1125 @noindent
1126 NULL terminated array of mouse drivers supported by AA-lib.
1127
1128
1129
1130
1131 @node aa_mouserecommended, aa_parseoptions, aa_mousedrivers, Reference
1132 @findex aa_mouserecommended
1133 @appendixsec aa_mouserecommended
1134 @noindent
1135
1136 @noindent
1137 @example
1138 #include <aalib.h>
1139 @sp 1
1140 extern aa_linkedlist *aa_mouserecommended;
1141 @end example
1142 @heading Description
1143 @noindent
1144 List of recommended drivers is used by aa_autoinit familly of functions
1145 and altered by aa_recommend familly of functions.
1146
1147
1148
1149
1150 @node aa_parseoptions, aa_printf, aa_mouserecommended, Reference
1151 @findex aa_parseoptions
1152 @appendixsec aa_parseoptions
1153 @noindent
1154
1155 @noindent
1156 @example
1157 #include <aalib.h>
1158 @sp 1
1159 int aa_parseoptions
1160 (
1161 struct aa_hardware_params *p,
1162 aa_renderparams *r,
1163 int *argc,
1164 char **argv
1165 );
1166 @end example
1167 @heading Parameters
1168 @noindent
1169 @quotation
1170 @table @code
1171 @item struct aa_hardware_params *p
1172 Hardware parameters structure to alter. It is expected
1173 that this structure only with necessary modifications
1174 will be later used to initialize the AA-lib context.
1175 @item aa_renderparams *r
1176 Rendering prameters structure to alter. It is expected
1177 that this structure only with necessary modifications
1178 will be later used to render images.
1179 @item int *argc
1180 Pointer to argc parameter passed to function "main".
1181 @item char **argv
1182 Pointer to argv parameter passed to function "main".
1183 @end table
1184 @end quotation
1185 @heading Description
1186 @noindent
1187 Use this function to parse the standard command line options used by
1188 AA-lib. Every AA-lib program ought to call this function to let user
1189 specify some extra parameters. The function alters the aa_hardware_params
1190 and aa_renderparams structures and removes known options from the
1191 argc/argv lists. It also parse the AAOPTS environment variable.
1192 When called with NULL for the argc/argv parameters, it parses AAOPTS
1193 only. At least this call ought to be in every AA-lib program.
1194 @heading Return value
1195 @noindent
1196 1 when sucesfull and 0 on failure. The program then can
1197 print the help text available in aa_help variable.
1198
1199
1200
1201
1202 @node aa_printf, aa_putpixel, aa_parseoptions, Reference
1203 @findex aa_printf
1204 @appendixsec aa_printf
1205 @noindent
1206
1207 @noindent
1208 @example
1209 #include <aalib.h>
1210 @sp 1
1211 int aa_printf
1212 (
1213 aa_context *c,
1214 int x,
1215 int y,
1216 enum aa_attribute attr,
1217 const char *fmt,
1218 ...
1219 );
1220 @end example
1221 @heading Parameters
1222 @noindent
1223 @quotation
1224 @table @code
1225 @item aa_context *c
1226 Specifies the AA-lib context to operate on.
1227 @item int x
1228 X coordinate of the first character.
1229 @item int y
1230 Y coordinate of the first character.
1231 @item enum aa_attribute attr
1232 Attribute to use.
1233 @sp 1
1234 Possible values for an @code{enum aa_attribute} are as follows:
1235 @quotation
1236 @table @code
1237 @item AA_NORMAL
1238 Normal characters.
1239 @item AA_DIM
1240 Dark characters.
1241 @item AA_BOLD
1242 Bright characters.
1243 @item AA_BOLDFONT
1244 Characters rendered in bold font.
1245 @item AA_REVERSE
1246 Reversed (black on whilte) characters.
1247 @item AA_SPECIAL
1248 Render characters in a way easilly visible on the
1249 screen. The exact rendering is driver dependent,
1250 but this mode ought to be used to output texts you
1251 want to make easilly visible in the image.
1252 @end table
1253 @end quotation
1254 @item const char *fmt
1255 Text to output in standard printf format.
1256 @item ...
1257 Not Documented.
1258 @end table
1259 @end quotation
1260 @heading Description
1261 @noindent
1262 Print given text to AA-lib output buffers. To see the effect you need to
1263 call aa_flush too.
1264
1265
1266
1267
1268 @node aa_putpixel, aa_puts, aa_printf, Reference
1269 @findex aa_putpixel
1270 @appendixsec aa_putpixel
1271 @noindent
1272
1273 @noindent
1274 @example
1275 #include <aalib.h>
1276 @sp 1
1277 void aa_putpixel
1278 (
1279 aa_context *c,
1280 int x,
1281 int y,
1282 int color
1283 );
1284 @end example
1285 @heading Parameters
1286 @noindent
1287 @quotation
1288 @table @code
1289 @item aa_context *c
1290 Specifies the AA-lib context to operate on.
1291 @item int x
1292 X coordinate.
1293 @item int y
1294 Y coordinate.
1295 @item int color
1296 Palette index or brightness value (0..255).
1297 @end table
1298 @end quotation
1299 @heading Description
1300 @noindent
1301 Put pixel to emulated framebuffer.
1302
1303
1304
1305
1306 @node aa_puts, aa_recommendhidisplay, aa_putpixel, Reference
1307 @findex aa_puts
1308 @appendixsec aa_puts
1309 @noindent
1310
1311 @noindent
1312 @example
1313 #include <aalib.h>
1314 @sp 1
1315 void aa_puts
1316 (
1317 aa_context *c,
1318 int x,
1319 int y,
1320 enum aa_attribute attr,
1321 const char *s
1322 );
1323 @end example
1324 @heading Parameters
1325 @noindent
1326 @quotation
1327 @table @code
1328 @item aa_context *c
1329 Specifies the AA-lib context to operate on.
1330 @item int x
1331 X coordinate of the first character.
1332 @item int y
1333 Y coordinate of the first character.
1334 @item enum aa_attribute attr
1335 Attribute to use.
1336 @sp 1
1337 Possible values for an @code{enum aa_attribute} are as follows:
1338 @quotation
1339 @table @code
1340 @item AA_NORMAL
1341 Normal characters.
1342 @item AA_DIM
1343 Dark characters.
1344 @item AA_BOLD
1345 Bright characters.
1346 @item AA_BOLDFONT
1347 Characters rendered in bold font.
1348 @item AA_REVERSE
1349 Reversed (black on whilte) characters.
1350 @item AA_SPECIAL
1351 Render characters in a way easilly visible on the
1352 screen. The exact rendering is driver dependent,
1353 but this mode ought to be used to output texts you
1354 want to make easilly visible in the image.
1355 @end table
1356 @end quotation
1357 @item const char *s
1358 String to output.
1359 @end table
1360 @end quotation
1361 @heading Description
1362 @noindent
1363 Output given string to AA-lib output buffers. To see the effect you need to
1364 call aa_flush too.
1365
1366
1367
1368
1369 @node aa_recommendhidisplay, aa_recommendhikbd, aa_puts, Reference
1370 @findex aa_recommendhidisplay
1371 @appendixsec aa_recommendhidisplay
1372 @noindent
1373
1374 @noindent
1375 @example
1376 #include <aalib.h>
1377 @sp 1
1378 void aa_recommendhidisplay(const char *name);
1379 @end example
1380 @heading Parameters
1381 @noindent
1382 @quotation
1383 @table @code
1384 @item const char *name
1385 Name of the driver (ought to match the "shortname"
1386 field of the driver definition structure).
1387 @end table
1388 @end quotation
1389 @heading Description
1390 @noindent
1391 Insert the given driver on beggining of the list of recommended display drivers.
1392
1393
1394
1395
1396 @node aa_recommendhikbd, aa_recommendhimouse, aa_recommendhidisplay, Reference
1397 @findex aa_recommendhikbd
1398 @appendixsec aa_recommendhikbd
1399 @noindent
1400
1401 @noindent
1402 @example
1403 #include <aalib.h>
1404 @sp 1
1405 void aa_recommendhikbd(const char *name);
1406 @end example
1407 @heading Parameters
1408 @noindent
1409 @quotation
1410 @table @code
1411 @item const char *name
1412 Name of the driver (ought to match the "shortname"
1413 field of the driver definition structure).
1414 @end table
1415 @end quotation
1416 @heading Description
1417 @noindent
1418 Insert the given driver on beggining of the list of recommended keyboard drivers.
1419
1420
1421
1422
1423 @node aa_recommendhimouse, aa_recommendhi, aa_recommendhikbd, Reference
1424 @findex aa_recommendhimouse
1425 @appendixsec aa_recommendhimouse
1426 @noindent
1427
1428 @noindent
1429 @example
1430 #include <aalib.h>
1431 @sp 1
1432 void aa_recommendhimouse(const char *name);
1433 @end example
1434 @heading Parameters
1435 @noindent
1436 @quotation
1437 @table @code
1438 @item const char *name
1439 Name of the driver (ought to match the "shortname"
1440 field of the driver definition structure).
1441 @end table
1442 @end quotation
1443 @heading Description
1444 @noindent
1445 Insert the given driver on beggining of the list of recommended mouse drivers.
1446
1447
1448
1449
1450 @node aa_recommendhi, aa_recommendlowdisplay, aa_recommendhimouse, Reference
1451 @findex aa_recommendhi
1452 @appendixsec aa_recommendhi
1453 @noindent
1454
1455 @noindent
1456 @example
1457 #include <aalib.h>
1458 @sp 1
1459 void aa_recommendhi
1460 (
1461 aa_linkedlist **l,
1462 const char *name
1463 );
1464 @end example
1465 @heading Parameters
1466 @noindent
1467 @quotation
1468 @table @code
1469 @item aa_linkedlist **l
1470 List to operate on (aa_displayrecommended,
1471 aa_kbdrecommended or aa_mouserecommended).
1472 @item const char *name
1473 Name of the driver (ought to match the "shortname"
1474 field of the driver definition structure).
1475 @end table
1476 @end quotation
1477 @heading Description
1478 @noindent
1479 Insert the given driver on beggining of the list of recommended drivers.
1480
1481
1482
1483
1484 @node aa_recommendlowdisplay, aa_recommendlowkbd, aa_recommendhi, Reference
1485 @findex aa_recommendlowdisplay
1486 @appendixsec aa_recommendlowdisplay
1487 @noindent
1488
1489 @noindent
1490 @example
1491 #include <aalib.h>
1492 @sp 1
1493 void aa_recommendlowdisplay(const char *name);
1494 @end example
1495 @heading Parameters
1496 @noindent
1497 @quotation
1498 @table @code
1499 @item const char *name
1500 Name of the driver (ought to match the "shortname"
1501 field of the driver definition structure).
1502 @end table
1503 @end quotation
1504 @heading Description
1505 @noindent
1506 Add the given driver to the end of list of display recommended drivers.
1507
1508
1509
1510
1511 @node aa_recommendlowkbd, aa_recommendlowmouse, aa_recommendlowdisplay, Reference
1512 @findex aa_recommendlowkbd
1513 @appendixsec aa_recommendlowkbd
1514 @noindent
1515
1516 @noindent
1517 @example
1518 #include <aalib.h>
1519 @sp 1
1520 void aa_recommendlowkbd(const char *name);
1521 @end example
1522 @heading Parameters
1523 @noindent
1524 @quotation
1525 @table @code
1526 @item const char *name
1527 Name of the driver (ought to match the "shortname"
1528 field of the driver definition structure).
1529 @end table
1530 @end quotation
1531 @heading Description
1532 @noindent
1533 Add the given driver to the end of list of keyboard recommended drivers.
1534
1535
1536
1537
1538 @node aa_recommendlowmouse, aa_recommendlow, aa_recommendlowkbd, Reference
1539 @findex aa_recommendlowmouse
1540 @appendixsec aa_recommendlowmouse
1541 @noindent
1542
1543 @noindent
1544 @example
1545 #include <aalib.h>
1546 @sp 1
1547 void aa_recommendlowmouse(const char *name);
1548 @end example
1549 @heading Parameters
1550 @noindent
1551 @quotation
1552 @table @code
1553 @item const char *name
1554 Name of the driver (ought to match the "shortname"
1555 field of the driver definition structure).
1556 @end table
1557 @end quotation
1558 @heading Description
1559 @noindent
1560 Add the given driver to the end of list of mouse recommended drivers.
1561
1562
1563
1564
1565 @node aa_recommendlow, aa_registerfont, aa_recommendlowmouse, Reference
1566 @findex aa_recommendlow
1567 @appendixsec aa_recommendlow
1568 @noindent
1569
1570 @noindent
1571 @example
1572 #include <aalib.h>
1573 @sp 1
1574 void aa_recommendlow
1575 (
1576 aa_linkedlist **l,
1577 const char *name
1578 );
1579 @end example
1580 @heading Parameters
1581 @noindent
1582 @quotation
1583 @table @code
1584 @item aa_linkedlist **l
1585 List to operate on (aa_displayrecommended,
1586 aa_kbdrecommended or aa_mouserecommended).
1587 @item const char *name
1588 Name of the driver (ought to match the "shortname"
1589 field of the driver definition structure).
1590 @end table
1591 @end quotation
1592 @heading Description
1593 @noindent
1594 Add the given driver to the end of list of recommended drivers.
1595
1596
1597
1598
1599 @node aa_registerfont, aa_render, aa_recommendlow, Reference
1600 @findex aa_registerfont
1601 @appendixsec aa_registerfont
1602 @noindent
1603
1604 @noindent
1605 @example
1606 #include <aalib.h>
1607 @sp 1
1608 int aa_registerfont(const struct aa_font *f);
1609 @end example
1610 @heading Parameters
1611 @noindent
1612 @quotation
1613 @table @code
1614 @item const struct aa_font *f
1615 Font specification structure.
1616 @end table
1617 @end quotation
1618 @heading Description
1619 @noindent
1620 Add new font specification to aa_fonts array.
1621 @heading Return value
1622 @noindent
1623 1 when succesfull or 0 on failure.
1624
1625
1626
1627
1628 @node aa_render, aa_resizehandler, aa_registerfont, Reference
1629 @findex aa_render
1630 @appendixsec aa_render
1631 @noindent
1632
1633 @noindent
1634 @example
1635 #include <aalib.h>
1636 @sp 1
1637 void aa_render
1638 (
1639 aa_context *c,
1640 const aa_renderparams *p,
1641 int x1,
1642 int y1,
1643 int x2,
1644 int y2
1645 );
1646 @end example
1647 @heading Parameters
1648 @noindent
1649 @quotation
1650 @table @code
1651 @item aa_context *c
1652 Specifies the AA-lib context to operate on.
1653 @item const aa_renderparams *p
1654 Rendering parametters used to specify brightness, gamma
1655 correction and other usefull stuff. Use aa_defrenderparams
1656 for default values.
1657 @item int x1
1658 Column of top left coner of rendered area
1659 (in characters!).
1660 @item int y1
1661 Row of top left coner of rendered area.
1662 @item int x2
1663 Column of bottom right coner of rendered area.
1664 @item int y2
1665 Row of bottom right coner of rendered area.
1666 @end table
1667 @end quotation
1668 @heading Description
1669 @noindent
1670 This function does the trick of converting the emulated framebuffer
1671 into high quality ASCII-art. If you want to be really fast, you might
1672 use aa_fastrender. If you want to emulate palette, use aa_renderpalette.
1673
1674 Note that to see the effect you need to call aa_flush too.
1675
1676 First call to this function may take a while, because the rendering
1677 tables are produced.
1678
1679
1680
1681
1682 @node aa_resizehandler, aa_resize, aa_render, Reference
1683 @findex aa_resizehandler
1684 @appendixsec aa_resizehandler
1685 @noindent
1686
1687 @noindent
1688 @example
1689 #include <aalib.h>
1690 @sp 1
1691 void aa_resizehandler
1692 (
1693 aa_context *c,
1694 void (*handler)(aa_context *)
1695 );
1696 @end example
1697 @heading Parameters
1698 @noindent
1699 @quotation
1700 @table @code
1701 @item aa_context *c
1702 Specifies the AA-lib context to operate on.
1703 @item void (*handler)(aa_context *)
1704 Function to be called when resize happends.
1705 @end table
1706 @end quotation
1707 @heading Description
1708 @noindent
1709 Set user handler to be called on resize event.
1710
1711
1712
1713
1714 @node aa_resize, aa_scrheight, aa_resizehandler, Reference
1715 @findex aa_resize
1716 @appendixsec aa_resize
1717 @noindent
1718
1719 @noindent
1720 @example
1721 #include <aalib.h>
1722 @sp 1
1723 int aa_resize(aa_context *c);
1724 @end example
1725 @heading Parameters
1726 @noindent
1727 @quotation
1728 @table @code
1729 @item aa_context *c
1730 Specifies the AA-lib context to operate on.
1731 @end table
1732 @end quotation
1733 @heading Description
1734 @noindent
1735 Do resize action. This function ought to be called when application
1736 takes into account the AA_RESIZE event. The context is reinitialized
1737 and set to new sizes.
1738 @heading Return value
1739 @noindent
1740 0 when no resizing is done and 1 when resizing was succesfull.
1741
1742
1743
1744
1745 @node aa_scrheight, aa_scrwidth, aa_resize, Reference
1746 @findex aa_scrheight
1747 @appendixsec aa_scrheight
1748 @noindent
1749
1750 @noindent
1751 @example
1752 #include <aalib.h>
1753 @sp 1
1754 int aa_scrheight(aa_context *a);
1755 @end example
1756 @heading Parameters
1757 @noindent
1758 @quotation
1759 @table @code
1760 @item aa_context *a
1761 Specifies the AA-lib context to operate on.
1762 @end table
1763 @end quotation
1764 @heading Description
1765 @noindent
1766 Returns height of the output screen in characters.
1767
1768
1769
1770
1771 @node aa_scrwidth, aa_setfont, aa_scrheight, Reference
1772 @findex aa_scrwidth
1773 @appendixsec aa_scrwidth
1774 @noindent
1775
1776 @noindent
1777 @example
1778 #include <aalib.h>
1779 @sp 1
1780 int aa_scrwidth(aa_context *a);
1781 @end example
1782 @heading Parameters
1783 @noindent
1784 @quotation
1785 @table @code
1786 @item aa_context *a
1787 Specifies the AA-lib context to operate on.
1788 @end table
1789 @end quotation
1790 @heading Description
1791 @noindent
1792 Returns width of the output screen in characters.
1793
1794
1795
1796
1797 @node aa_setfont, aa_setsupported, aa_scrwidth, Reference
1798 @findex aa_setfont
1799 @appendixsec aa_setfont
1800 @noindent
1801
1802 @noindent
1803 @example
1804 #include <aalib.h>
1805 @sp 1
1806 void aa_setfont
1807 (
1808 aa_context *c,
1809 const struct aa_font *font
1810 );
1811 @end example
1812 @heading Parameters
1813 @noindent
1814 @quotation
1815 @table @code
1816 @item aa_context *c
1817 Specifies the AA-lib context to operate on.
1818 @item const struct aa_font *font
1819 Font specification structure.
1820 @end table
1821 @end quotation
1822 @heading Description
1823 @noindent
1824 Set font specification to be used by rendering functions.
1825
1826
1827
1828
1829 @node aa_setsupported, aa_showcursor, aa_setfont, Reference
1830 @findex aa_setsupported
1831 @appendixsec aa_setsupported
1832 @noindent
1833
1834 @noindent
1835 @example
1836 #include <aalib.h>
1837 @sp 1
1838 void aa_setsupported
1839 (
1840 aa_context *c,
1841 int supported
1842 );
1843 @end example
1844 @heading Parameters
1845 @noindent
1846 @quotation
1847 @table @code
1848 @item aa_context *c
1849 Specifies the AA-lib context to operate on.
1850 @item int supported
1851 New mask of requested features. Can contain
1852 AA_EXTENDED to enable use of all 256 characters
1853 and AA_EIGHT to enable use of the character numbered
1854 higher than 127.
1855 @end table
1856 @end quotation
1857 @heading Description
1858 @noindent
1859 This function can be used to alter "supported" field of hardware-params
1860 structure used by AA-lib.
1861
1862
1863
1864
1865 @node aa_showcursor, aa_showmouse, aa_setsupported, Reference
1866 @findex aa_showcursor
1867 @appendixsec aa_showcursor
1868 @noindent
1869
1870 @noindent
1871 @example
1872 #include <aalib.h>
1873 @sp 1
1874 void aa_showcursor(aa_context *c);
1875 @end example
1876 @heading Parameters
1877 @noindent
1878 @quotation
1879 @table @code
1880 @item aa_context *c
1881 Specifies the AA-lib context to operate on.
1882 @end table
1883 @end quotation
1884 @heading Description
1885 @noindent
1886 Show the hardware cursor.
1887 This function may not be ignored by some drivers.
1888
1889
1890
1891
1892 @node aa_showmouse, aa_text, aa_showcursor, Reference
1893 @findex aa_showmouse
1894 @appendixsec aa_showmouse
1895 @noindent
1896
1897 @noindent
1898 @example
1899 #include <aalib.h>
1900 @sp 1
1901 void aa_showmouse(aa_context *c);
1902 @end example
1903 @heading Parameters
1904 @noindent
1905 @quotation
1906 @table @code
1907 @item aa_context *c
1908 Not Documented.
1909 @end table
1910 @end quotation
1911 @heading Description
1912 @noindent
1913 Show the mouse cursor.
1914 This function may be ignored by some drivers.
1915
1916
1917
1918
1919 @node aa_text, aa_uninitkbd, aa_showmouse, Reference
1920 @findex aa_text
1921 @appendixsec aa_text
1922 @noindent
1923
1924 @noindent
1925 @example
1926 #include <aalib.h>
1927 @sp 1
1928 char *aa_text(aa_context *a);
1929 @end example
1930 @heading Parameters
1931 @noindent
1932 @quotation
1933 @table @code
1934 @item aa_context *a
1935 Specifies the AA-lib context to operate on.
1936 @end table
1937 @end quotation
1938 @heading Description
1939 @noindent
1940 The text output buffer is simple array of characters specifying
1941 the ascii-value of the characters.
1942 The array is organizated in the aa_scrheight (a) rows of
1943 aa_scrwidth(a) characters.
1944 @heading Return value
1945 @noindent
1946 Pointer the text output buffer used by AA-lib.
1947
1948
1949
1950
1951 @node aa_uninitkbd, aa_uninitmouse, aa_text, Reference
1952 @findex aa_uninitkbd
1953 @appendixsec aa_uninitkbd
1954 @noindent
1955
1956 @noindent
1957 @example
1958 #include <aalib.h>
1959 @sp 1
1960 void aa_uninitkbd(aa_context *context);
1961 @end example
1962 @heading Parameters
1963 @noindent
1964 @quotation
1965 @table @code
1966 @item aa_context *context
1967 Specifies the AA-lib context to operate on.
1968 @end table
1969 @end quotation
1970 @heading Description
1971 @noindent
1972 Calls "uninitialize" function of the keyboard driver. It ought to undo
1973 all actions done by "initialize" function.
1974
1975
1976
1977
1978 @node aa_uninitmouse, mem_d, aa_uninitkbd, Reference
1979 @findex aa_uninitmouse
1980 @appendixsec aa_uninitmouse
1981 @noindent
1982
1983 @noindent
1984 @example
1985 #include <aalib.h>
1986 @sp 1
1987 void aa_uninitmouse(aa_context *context);
1988 @end example
1989 @heading Parameters
1990 @noindent
1991 @quotation
1992 @table @code
1993 @item aa_context *context
1994 Specifies the AA-lib context to operate on.
1995 @end table
1996 @end quotation
1997 @heading Description
1998 @noindent
1999 Calls "uninitialize" function of the mouse driver. It ought to undo
2000 all actions done by "initialize" function.
2001
2002
2003
2004
2005 @node mem_d, save_d, aa_uninitmouse, Reference
2006 @findex mem_d
2007 @appendixsec mem_d
2008 @noindent
2009
2010 @noindent
2011 @example
2012 #include <aalib.h>
2013 @sp 1
2014 extern const struct aa_driver mem_d;
2015 @end example
2016 @heading Description
2017 @noindent
2018 Used to render ascii-art images into memory.
2019 You might use this driver to render images into memory and then use your
2020 own routines to handle them in case you want to avoid AA-lib's output
2021 mechanizms.
2022
2023
2024
2025
2026 @node save_d, , mem_d, Reference
2027 @findex save_d
2028 @appendixsec save_d
2029 @noindent
2030
2031 @noindent
2032 @example
2033 #include <aalib.h>
2034 @sp 1
2035 extern const struct aa_driver save_d;
2036 @end example
2037 @heading Description
2038 @noindent
2039 Initialize this driver using aa_init function and specify the driver
2040 dependent parameters in aa_savedata structure to save image into file.
2041 See the texinfo documentation for details.