Bienvenue sur le wiki de Nuit debout, nous sommes le 2986 mars.
Villes/Montluçon/sciences/FastGraph
De NuitDebout
< Villes | Montluçon | sciences
Révision de 11 août 2016 à 20:20 par Esprit libre (discussion | contributions)
Fastgraph (r)
Reference Manual � Copyright (c) 1991-1995 by Ted Gruber Software, Inc.
All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted by any means, electronic, mechanical, photocopying, recording, or otherwise, without express written permission from Ted Gruber Software. The software described in this publication is furnished under a license agreement and may be used or copied only in accordance with the terms of that agreement.
This publication and its associated software are sold without warranties, either expressed or implied, regarding their merchantability or fitness for any particular application or purpose. The information in this publication is subject to change without notice and does not represent a commitment on the part of Ted Gruber Software. In no event shall Ted Gruber Software be liable for any loss of profit or any other commercial damage, including but not limited to special, incidental, consequential, or other damages resulting from the use of or the inability to use this product, even if Ted Gruber Software has been notified of the possibility of such damages.
First Printing, August 1994
Fastgraph version 4.0
All brand and product names mentioned in this publication are trademarks or
registered trademarks of their respective holders. �
T a b l e o f C o n t e n t s
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Fastgraph Routines by Category . . . . . . . . . . . . . . . . . . . . . 1
Alphabetical List of Fastgraph Routines . . . . . . . . . . . . . . . . . 2
fg_allocate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
fg_alloccms . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
fg_allocems . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
fg_allocxms . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
fg_automode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
fg_bestmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
fg_box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
fg_boxdepth . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
fg_boxw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
fg_boxx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
fg_boxxw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
fg_button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
fg_capslock . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
fg_chgattr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
fg_chgtext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
fg_circle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
fg_circlef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
fg_circlefw . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
fg_circlew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
fg_clipmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
fg_clipmask . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
fg_clpimage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
fg_clprect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
fg_clprectw . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
fg_colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
fg_copypage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
fg_cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
fg_dash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
fg_dashrel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
fg_dashrw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
fg_dashw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
fg_defcolor . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
fg_defpages . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
fg_dispfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
fg_display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
fg_displayp . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
fg_draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
fg_drawmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
fg_drawmask . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
fg_drawrel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
fg_drawrelx . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
fg_drawrw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
fg_drawrxw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
fg_draww . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
fg_drawx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
fg_drawxw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
fg_drect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
iii �
fg_drectw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
fg_drwimage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
fg_egacheck . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
fg_ellipse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
fg_ellipsef . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
fg_ellipsew . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
fg_ellipsfw . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
fg_erase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
fg_fadein . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
fg_fadeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
fg_fillpage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
fg_findpage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
fg_flicdone . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
fg_flichead . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
fg_flicmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
fg_flicopen . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
fg_flicplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
fg_flicsize . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
fg_flicskip . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
fg_flipmask . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
fg_flood . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
fg_floodw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
fg_flpimage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
fg_fontsize . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
fg_freepage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
fg_getaddr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
fg_getattr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
fg_getbanks . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
fg_getblock . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
fg_getchar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
fg_getclip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
fg_getclock . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
fg_getcolor . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
fg_getdacs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
fg_getentry . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
fg_gethpage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
fg_getimage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
fg_getindex . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
fg_getkey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
fg_getlines . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
fg_getmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
fg_getmaxx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
fg_getmaxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
fg_getmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
fg_getpage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
fg_getpixel . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
fg_getrgb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
fg_getview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
fg_getvpage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
fg_getworld . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
fg_getxbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
fg_getxjoy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
fg_getxjust . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
fg_getxpos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
fg_getybox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
fg_getyjoy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
iv �
fg_getyjust . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
fg_getypos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
fg_gifhead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
fg_gifmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
fg_gifpal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
fg_gifrange . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
fg_hush . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
fg_hushnext . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
fg_imagebuf . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
fg_imagesiz . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
fg_initems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
fg_initjoy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
fg_initpm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
fg_initw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
fg_initxms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
fg_inside . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
fg_intjoy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
fg_intkey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
fg_invert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
fg_justify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
fg_kbinit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
fg_kblast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
fg_kbreset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
fg_kbtest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
fg_loadpcx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
fg_locate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
fg_makegif . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
fg_makepcx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
fg_makeppr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
fg_makespr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
fg_maprgb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
fg_measure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
fg_memavail . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
fg_memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
fg_mouse256 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
fg_mousebut . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
fg_mousecur . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
fg_mousefin . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
fg_mouseini . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
fg_mouselim . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
fg_mousemov . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
fg_mousepos . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
fg_mouseptr . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
fg_mousespd . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
fg_mousevis . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
fg_move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
fg_moverel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
fg_moverw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
fg_movew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
fg_music . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
fg_musicb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
fg_numlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
fg_pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
fg_pagesize . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
fg_paint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
fg_paintw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
v �
fg_palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
fg_palettes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
fg_pan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
fg_panw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
fg_pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
fg_pcxhead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
fg_pcxmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
fg_pcxpal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
fg_pcxrange . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
fg_playing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
fg_point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
fg_pointw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
fg_pointx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
fg_pointxw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
fg_polyedge . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
fg_polyfill . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
fg_polygon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
fg_polygonw . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
fg_polyline . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
fg_polyoff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
fg_print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
fg_printc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
fg_putblock . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
fg_putimage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
fg_quiet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
fg_rect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
fg_rectw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
fg_reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
fg_resize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
fg_restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
fg_restorew . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
fg_resume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
fg_revimage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
fg_revmask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
fg_save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
fg_savew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
fg_scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
fg_scrlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
fg_scroll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
fg_setangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
fg_setattr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
fg_setbanks . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
fg_setcaps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
fg_setclip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
fg_setclipw . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
fg_setcolor . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
fg_setdacs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
fg_setentry . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
fg_setfunc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
fg_sethpage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
fg_setlines . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
fg_setmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
fg_setnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
fg_setpage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
fg_setratio . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
fg_setrgb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
vi �
fg_setsize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
fg_setsizew . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
fg_setview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
fg_setvpage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
fg_setworld . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
fg_shear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
fg_showflic . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
fg_showgif . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
fg_showpcx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
fg_showppr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
fg_showspr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
fg_sound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
fg_sounds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
fg_split . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
fg_stall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
fg_suspend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
fg_svgainit . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
fg_svgastat . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
fg_svgaver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
fg_swchar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
fg_swlength . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
fg_swtext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
fg_tcdefine . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
fg_tcmask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
fg_tcxfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
fg_testmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
fg_text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
fg_textc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
fg_transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
fg_unpack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
fg_vbaddr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
fg_vballoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
fg_vbclose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
fg_vbcopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
fg_vbcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
fg_vbdefine . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
fg_vbfree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
fg_vbhandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
fg_vbinit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
fg_vbopen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
fg_vbpaste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
fg_vbtccopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
fg_vbtcxfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
fg_vbundef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
fg_version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
fg_vgastate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
fg_voice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
fg_voices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
fg_waitfor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
fg_waitkey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
fg_waitvr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
fg_where . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
fg_xalpha . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
fg_xconvert . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
fg_xscreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
fg_xview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
vii �
fg_xworld . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
fg_yalpha . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
fg_yconvert . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
fg_yscreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
fg_yview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
fg_yworld . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
viii �
Introduction
The Fastgraph Reference Manual is a companion publication to the
Fastgraph User's Guide. Whereas the latter publication is essentially a detailed tutorial about Fastgraph, the Fastgraph Reference Manual is intended as a reference for programmers familiar with the product.
This manual has two major parts. The first part lists the Fastgraph
routines by category; each category corresponds to a chapter in the Fastgraph User's Guide. The second part, which occupies the larger portion of this manual, gives descriptions of each Fastgraph routine in alphabetical order.
Fastgraph Routines by Category
This section lists the Fastgraph routines by category. These categories
parallel the chapters in the Fastgraph User's Guide. The lists in this section are provided as a general overview of Fastgraph's capabilities. You can find detailed information about each Fastgraph routine in the next section of this manual, and of course in the Fastgraph User's Guide.
Video Initialization Routines: fg_automode, fg_bestmode, fg_cursor, fg_egacheck, fg_getlines, fg_getmode, fg_initpm, fg_memory, fg_reset, fg_setlines, fg_setmode, fg_svgainit, fg_svgastat, fg_testmode.
Coordinate Routines: fg_getmaxx, fg_getmaxy, fg_getview, fg_getworld, fg_initw, fg_setview, fg_setworld, fg_xalpha, fg_xconvert, fg_xscreen, fg_xview, fg_xworld, fg_yalpha, fg_yconvert, fg_yscreen, fg_yview, fg_yworld.
Color-Related Routines: fg_colors, fg_defcolor, fg_getcolor, fg_getdacs, fg_getindex, fg_getrgb, fg_maprgb, fg_palette, fg_palettes, fg_setattr, fg_setcolor, fg_setdacs, fg_setrgb.
Fundamental Graphics Routines: fg_box, fg_boxdepth, fg_boxw, fg_boxx, fg_boxxw, fg_circle, fg_circlef, fg_circlefw, fg_circlew, fg_clprect, fg_clprectw, fg_dash, fg_dashrel, fg_dashrw, fg_dashw, fg_draw, fg_drawrel, fg_drawrelx, fg_drawrw, fg_drawrxw, fg_draww, fg_drawx, fg_drawxw, fg_drect, fg_drectw, fg_ellipse, fg_ellipsef, fg_ellipsew, fg_ellipsfw, fg_erase, fg_fillpage, fg_flood, fg_floodw, fg_getclip, fg_getpixel, fg_getxbox, fg_getxpos, fg_getybox, fg_getypos, fg_inside, fg_move, fg_moverel, fg_moverw, fg_movew, fg_paint, fg_paintw, fg_point, fg_pointw, fg_pointx, fg_pointxw, fg_polyedge, fg_polyfill, fg_polygon, fg_polygonw, fg_polyline, fg_polyoff, fg_rect, fg_rectw, fg_setclip, fg_setclipw.
Character Display Routines: fg_chgattr, fg_chgtext, fg_fontsize, fg_getattr, fg_getchar, fg_getxjust, fg_getyjust, fg_justify, fg_locate, fg_print, fg_printc, fg_setangle, fg_setattr, fg_setcolor, fg_setratio, fg_setsize, fg_setsizew, fg_swchar, fg_swlength, fg_swtext, fg_text, fg_textc, fg_where, fg_xalpha, fg_xconvert, fg_yalpha, fg_yconvert.
Video Page and Virtual Buffer Routines: fg_allocate, fg_alloccms, fg_allocems, fg_allocxms, fg_copypage, fg_defpages, fg_findpage, fg_freepage, fg_getaddr, fg_getentry, fg_gethpage, fg_getpage, fg_getvpage, fg_initems, fg_initxms, fg_pagesize, fg_resize, fg_setentry, fg_sethpage, fg_setpage, fg_setvpage, fg_vbaddr, fg_vballoc, fg_vbclose, fg_vbcopy, fg_vbcut,
1 �
fg_vbdefine, fg_vbfree, fg_vbhandle, fg_vbinit, fg_vbopen, fg_vbpaste, fg_vbtccopy, fg_vbtcxfer, fg_vbundef.
Image File Routines: fg_dispfile, fg_flicdone, fg_flichead, fg_flicmode, fg_flicopen, fg_flicplay, fg_flicsize, fg_flicskip, fg_gifhead, fg_gifmode, fg_gifpal, fg_gifrange, fg_imagebuf, fg_loadpcx, fg_makegif, fg_makepcx, fg_makeppr, fg_makespr, fg_pattern, fg_pcxhead, fg_pcxmode, fg_pcxpal, fg_pcxrange, fg_showflic, fg_showgif, fg_showpcx, fg_showppr, fg_showspr.
Bitmapped Image Routines: fg_clipmap, fg_clipmask, fg_clpimage, fg_display, fg_displayp, fg_drawmap, fg_drawmask, fg_drwimage, fg_flipmask, fg_flpimage, fg_getimage, fg_getmap, fg_imagesiz, fg_invert, fg_pack, fg_putimage, fg_revimage, fg_revmask, fg_scale, fg_shear, fg_unpack.
Block Transfer Routines: fg_copypage, fg_getblock, fg_putblock, fg_restore, fg_restorew, fg_save, fg_savew, fg_tcdefine, fg_tcmask, fg_tcxfer, fg_transfer, fg_vbcopy, fg_vbcut, fg_vbpaste, fg_vbtccopy, fg_vbtcxfer.
Special Effects Routines: fg_fadein, fg_fadeout, fg_pan, fg_panw, fg_resize, fg_scroll, fg_split.
Input Routines: fg_button, fg_capslock, fg_getkey, fg_getxjoy, fg_getyjoy, fg_initjoy, fg_intjoy, fg_intkey, fg_kbinit, fg_kblast, fg_kbreset, fg_kbtest, fg_mouse256, fg_mousebut, fg_mousecur, fg_mousefin, fg_mouseini, fg_mouselim, fg_mousemov, fg_mousepos, fg_mouseptr, fg_mousespd, fg_mousevis, fg_numlock, fg_scrlock, fg_setcaps, fg_setnum, fg_waitkey.
Sound Routines: fg_hush, fg_hushnext, fg_music, fg_musicb, fg_playing, fg_quiet, fg_resume, fg_sound, fg_sounds, fg_suspend, fg_voice, fg_voices.
Timing Routines: fg_getclock, fg_measure, fg_stall, fg_waitfor.
Miscellaneous Routines: fg_getbanks, fg_memavail, fg_setbanks, fg_setfunc, fg_svgaver, fg_version, fg_vgastate, fg_waitvr.
Alphabetical List of Fastgraph Routines
This section presents a detailed description of each Fastgraph routine.
Once you're familiar with Fastgraph, you'll probably refer to these descriptions more often than any other section of the Fastgraph manuals.
The information presented for each routine includes the following:
* function prototypes or declarations
for each supported language
* a description of the routine itself
* the number of parameters, their
purpose, and their data types
* the meaning and data type of the
routine's return value (if any)
* information about important
restrictions pertaining to the
routine
2 �
* references to similar routines, or
other routines that affect the
routine
* example programs in the Fastgraph
User's Guide that use the routine
A prototype specifies the data types of a routine's parameters and return
value. The description of each Fastgraph routine includes prototypes for C/C++, BASIC, FORTRAN, and Pascal (in that order). For example, the prototypes for fg_allocate are:
int fg_allocate (int page_number);
function FGallocate% (page_number%)
int function fg_allocate (int page_number)
function fg_allocate (page_number : integer) : integer;
The C/C++, BASIC, and Pascal prototypes use the declaration syntax for those languages. FORTRAN does not use function prototypes, so we'll create our own prototype syntax using the data type abbreviations of Microsoft's FORTRAN PowerStation compiler. In the FORTRAN prototypes, each parameter is preceded by one of the data type indicators shown here:
indicator FORTRAN data type
char CHARACTER*(*)
int INTEGER
int1 INTEGER*1
int2 INTEGER*2
int4 INTEGER*4
dbl REAL*8
The int data type is equivalent to INTEGER*2 in 16-bit environments (Microsoft FORTRAN) and equivalent to INTEGER*4 in 32-bit environments (Microsoft FORTRAN PowerStation). Furthermore, if the routine has a return value, the prototype begins with the return value's data type indicator followed by the word function. If the routine has no return value, the prototype begins with the word subroutine.
3 �
fg_allocate
Prototype
int fg_allocate (int page_number); function FGallocate% (page_number%) int function fg_allocate (int page_number) function fg_allocate (page_number : integer) : integer;
Description
The fg_allocate routine creates a virtual video page. The amount of memory required depends on the current video mode.
Parameters
page_number is the number by which the virtual page will be referenced. It must be between 1 and 63.
Return value
A status code indicating the success or failure of the virtual page creation, as shown here:
0 = virtual page created
1 = specified page is a physical or logical page
7 = virtual page created, but memory control blocks were destroyed
8 = insufficient memory to create the virtual page
Restrictions
This routine has no effect if page_number references a physical video page, a logical video page, or if used in a video mode that does not support virtual video pages.
See also
fg_findpage, fg_freepage, fg_pagesize
Examples
8-3, 8-4, 8-5, 8-6, 8-9, 11-1, 11-2, 11-3, 11-4, 12-4, 12-5, 13-2, 13-5, 17-1
4 �
fg_alloccms
Prototype
int fg_alloccms (int page_number); function FGalloccms% (page_number%) int function fg_alloccms (int page_number) function fg_alloccms (page_number : integer) : integer;
Description
The fg_alloccms routine creates a logical page in conventional memory. The amount of memory required depends on the current video mode and video buffer dimensions.
Parameters
page_number is the number by which the logical page will be referenced. It must be between 1 and 63.
Return value
0 = logical page created in conventional memory -2 = invalid page number -3 = page already created, or page exists as a physical or virtual page -4 = insufficient conventional memory to create the page
Restrictions
This routine has no effect if page_number references a physical or virtual video page.
The only function you can perform with logical pages is copying one entire page to another (with fg_copypage).
See also
fg_allocems, fg_allocxms, fg_copypage, fg_findpage, fg_freepage, fg_pagesize
Examples
8-10, 8-12
5 �
fg_allocems
Prototype
int fg_allocems (int page_number); function FGallocems% (page_number%) int function fg_allocems (int page_number) function fg_allocems (page_number : integer) : integer;
Description
The fg_allocems routine creates a logical page in expanded memory (EMS). The amount of memory required depends on the current video mode and video buffer dimensions.
Parameters
page_number is the number by which the logical page will be referenced. It must be between 1 and 63.
Return value
0 = logical page created in expanded memory -1 = Expanded Memory Manager not initialized -2 = invalid page number -3 = page already created, or page exists as a physical or virtual page -4 = insufficient expanded memory to create the page
Restrictions
This routine has no effect if page_number references a physical or virtual video page.
Before using this routine, you must use fg_initems to initialize the Expanded Memory Manager.
The only function you can perform with EMS logical pages is copying one entire page to another (with fg_copypage).
See also
fg_alloccms, fg_allocxms, fg_copypage, fg_findpage, fg_freepage, fg_initems, fg_pagesize
Examples
8-10
6 �
fg_allocxms
Prototype
int fg_allocxms (int page_number); function FGallocxms% (page_number%) int function fg_allocxms (int page_number) function fg_allocxms (page_number : integer) : integer;
Description
The fg_allocxms routine creates a logical page in extended memory (XMS). The amount of memory required depends on the current video mode and video buffer dimensions.
Parameters
page_number is the number by which the logical page will be referenced. It must be between 1 and 63.
Return value
0 = logical page created in extended memory -1 = XMS driver not present -2 = invalid page number -3 = page already created, or page exists as a physical or virtual page -4 = insufficient extended memory to create the page
Restrictions
This routine has no effect if page_number references a physical or virtual video page.
Before using this routine, you must use fg_initxms to initialize the XMS driver.
The only function you can perform with XMS logical pages is copying one entire page to another (with fg_copypage).
See also
fg_alloccms, fg_allocems, fg_copypage, fg_findpage, fg_freepage, fg_initxms, fg_pagesize
Examples
8-10
7 �
fg_automode
Prototype
int fg_automode (void); function FGautomode% () int function fg_automode () function fg_automode : integer;
Description
The fg_automode routine determines the graphics video mode that offers the most features for the user's display and adapter configuration.
Parameters
none
Return value
The return value is the proposed video mode number. The current display and adapter configuration determine the mode number, as shown here:
display
adapter mono RGB ECD VGA
MDA 7 0 7 7
HGC 11 0 0 11
CGA 0 4 0 0
EGA 15 13 16 0
VGA 17 17 17 18
MCGA 17 17 17 19
Tandy 7 9 0 0
PCjr 7 9 0 0
The return value can either be passed directly to fg_setmode, or it can help determine suitable video modes for your program.
Restrictions
For compatibility with previous versions of Fastgraph, this function does not consider XVGA or SVGA graphics modes when proposing a video mode.
See also
fg_bestmode, fg_setmode, fg_testmode
Examples
3-6, 4-4
8 �
fg_bestmode
Prototype
int fg_bestmode (int horizontal, int vertical, int pages); function FGbestmode% (horizontal%, vertical%, pages%) int function fg_bestmode (int horizontal, int vertical, int pages) function fg_bestmode (horizontal, vertical, pages : integer) : integer;
Description
The fg_bestmode routine determines the video mode having the requested resolution and the most features for the user's display and adapter configuration. It is similar to fg_automode, but it excludes video modes that do not offer the specified resolution and video page requirements. The video pages can include physical pages, virtual pages, or both. In modes that support virtual pages, fg_bestmode does not check if the virtual pages have been created, only that there is enough conventional memory available to do so.
Parameters
horizontal specifies the required horizontal resolution in pixels.
vertical specifies the required vertical resolution in pixels.
pages specifies the required number of physical or virtual video pages.
Return value
If fg_bestmode finds a video mode that offers the specified resolution and video page requirements, it returns the corresponding video mode number. If not, it returns -1.
Restrictions
SVGA graphics modes (24 to 29) are available only after successfully initializing the SVGA kernel with fg_svgainit.
The fg_bestmode routine does not consider extended video pages when testing if the requested number of video pages is available.
See also
fg_automode, fg_setmode, fg_svgainit, fg_testmode
Examples
3-4, 3-7
9 �
fg_box
Prototype
void fg_box (int minx, int maxx, int miny, int maxy); sub FGbox (minx%, maxx%, miny%, maxy%) subroutine fg_box (int minx, int maxx, int miny, int maxy) procedure fg_box (minx, maxx, miny, maxy : integer);
Description
The fg_box routine draws an unfilled rectangle in screen space, with respect to the clipping region. The width of the rectangle's edges is one pixel unless changed with fg_boxdepth.
Parameters
minx is the x coordinate of the rectangle's left edge.
maxx is the x coordinate of the rectangle's right edge. It must be greater than or equal to the value of minx.
miny is the y coordinate of the rectangle's top edge.
maxy is the y coordinate of the rectangle's bottom edge. It must be greater than or equal to the value of miny.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_boxdepth, fg_boxw, fg_boxx, fg_rect
Examples
6-12, 8-12, 8-17, 10-17, 10-18, 13-7, 13-8, 13-9
10 �
fg_boxdepth
Prototype
void fg_boxdepth (int xdepth, int ydepth); sub FGboxdepth (xdepth%, ydepth%) subroutine fg_boxdepth (int xdepth, int ydepth) procedure fg_boxdepth (xdepth, ydepth : integer);
Description
The fg_boxdepth routine defines the depth of rectangles drawn with the box display routines. The fg_setmode routine initializes the box depth to one pixel in each direction.
Parameters
xdepth is the width in pixels of the rectangle's left and right sides. It must be greater than zero.
ydepth is the height in pixels of the rectangle's top and bottom sides. It must be greater than zero.
Return value
none
Restrictions
none
See also
fg_box, fg_boxw, fg_boxx, fg_boxxw
Examples
6-11, 10-17, 10-18
11 �
fg_boxw
Prototype
void fg_boxw (double xmin, double xmax, double ymin, double ymax); sub FGboxw (xmin#, xmax#, ymin#, ymax#) subroutine fg_boxw (dbl xmin, dbl xmax, dbl ymin, dbl ymax) procedure fg_boxw (xmin, xmax, ymin, ymax : real);
Description
The fg_boxw routine draws an unfilled rectangle in world space, with respect to the clipping region. The width of the rectangle's edges is one pixel unless changed with fg_boxdepth.
Parameters
xmin is the world space x coordinate of the rectangle's left edge.
xmax is the world space x coordinate of the rectangle's right edge. It must be greater than or equal to the value of xmin.
ymin is the world space y coordinate of the rectangle's bottom edge.
ymax is the world space y coordinate of the rectangle's top edge. It must be greater than or equal to the value of ymin.
Return value
none
Restrictions
This routine has no effect in text video modes and is not available in Fastgraph/Light.
See also
fg_box, fg_boxdepth, fg_boxxw
12 �
fg_boxx
Prototype
void fg_boxx (int minx, int maxx, int miny, int maxy); sub FGboxx (minx%, maxx%, miny%, maxy%) subroutine fg_boxx (int minx, int maxx, int miny, int maxy) procedure fg_boxx (minx, maxx, miny, maxy : integer);
Description
The fg_boxx routine draws an unfilled rectangle in "exclusive or" mode in screen space, with respect to the clipping region. The width of the rectangle's edges is one pixel unless changed with fg_boxdepth.
Parameters
minx is the x coordinate of the rectangle's left edge.
maxx is the x coordinate of the rectangle's right edge. It must be greater than or equal to the value of minx.
miny is the y coordinate of the rectangle's top edge.
maxy is the y coordinate of the rectangle's bottom edge. It must be greater than or equal to the value of miny.
Return value
none
Restrictions
This routine has no effect in text video modes.
In 16-color EGA, VGA, or SVGA graphics modes, the EGA/VGA function register is reset to its default replacement mode on return.
See also
fg_box, fg_boxdepth, fg_boxxw
Examples
6-13
13 �
fg_boxxw
Prototype
void fg_boxxw (double xmin, double xmax, double ymin, double ymax); sub FGboxxw (xmin#, xmax#, ymin#, ymax#) subroutine fg_boxxw (dbl xmin, dbl xmax, dbl ymin, dbl ymax) procedure fg_boxxw (xmin, xmax, ymin, ymax : real);
Description
The fg_boxxw routine draws an unfilled rectangle in "exclusive or" mode in world space, with respect to the clipping region. The width of the rectangle's edges is one pixel unless changed with fg_boxdepth.
Parameters
xmin is the world space x coordinate of the rectangle's left edge.
xmax is the world space x coordinate of the rectangle's right edge. It must be greater than or equal to the value of xmin.
ymin is the world space y coordinate of the rectangle's bottom edge.
ymax is the world space y coordinate of the rectangle's top edge. It must be greater than or equal to the value of ymin.
Return value
none
Restrictions
This routine has no effect in text video modes and is not available in Fastgraph/Light.
In 16-color EGA, VGA, or SVGA graphics modes, the EGA/VGA function register is reset to its default replacement mode on return.
See also
fg_boxdepth, fg_boxw, fg_boxx
14 �
fg_button
Prototype
int fg_button (int n); function FGbutton% (n%) int function fg_button (int n) function fg_button (n : integer) : integer;
Description
The fg_button routine returns information about the state of either joystick's button status.
Parameters
n specifies the joystick number, either 1 or 2.
Return value
A status code indicating the current button status for the requested joystick, as shown here:
0 = neither button pressed
1 = top button pressed
2 = bottom button pressed
3 = top and bottom buttons pressed
Restrictions
none
See also
fg_getxjoy, fg_getyjoy, fg_initjoy, fg_intjoy
Examples
14-12
15 �
fg_capslock
Prototype
int fg_capslock (void); function FGcapslock% () int function fg_capslock () function fg_capslock : integer;
Description
The fg_capslock routine determines the state of the CapsLock key.
Parameters
none
Return value
If the return value is 0, it means the CapsLock key is off. If it is 1, it means the CapsLock key is on.
Restrictions
none
See also
fg_numlock, fg_scrlock, fg_setcaps, fg_setnum
Examples
14-4
16 �
fg_chgattr
Prototype
void fg_chgattr (int n); sub FGchgattr (n%) subroutine fg_chgattr (int n) procedure fg_chgattr (n : integer);
Description
The fg_chgattr routine applies the current text attribute to a given number of characters, starting at the text cursor position. This routine leaves the text cursor one column to the right of the last character changed (or the first column of the next row if the last character is at the end of a row).
Parameters
n is the number of characters for which to change the text attribute.
Return value
none
Restrictions
This routine has no effect in graphics video modes.
See also
fg_chgtext, fg_locate, fg_text
Examples
7-3
17 �
fg_chgtext
Prototype
void fg_chgtext (char *string, int n); sub FGchgtext (string$, n%) subroutine fg_chgtext (char string, int n) procedure fg_chgtext (string : string; n : integer);
Description
The fg_chgtext routine displays a string of hardware characters, starting at the text cursor position, using the existing text attributes. This routine leaves the text cursor one column to the right of the last character changed (or the first column of the next row if the last character is at the end of a row).
Parameters
string is the arbitrary-length sequence of characters to display.
n is the number of characters in string.
Return value
none
Restrictions
This routine has no effect in graphics video modes.
See also
fg_chgattr, fg_locate, fg_text
Examples
7-3
18 �
fg_circle
Prototype
void fg_circle (int radius); sub FGcircle (radius%) subroutine fg_circle (int radius) procedure fg_circle (radius : integer);
Description
The fg_circle routine draws an unfilled circle in screen space. The circle is centered at the current graphics cursor position.
Parameters
radius defines the circle's radius in horizontal screen space units. Its value must be greater than zero.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_circlef, fg_circlew, fg_ellipse
Examples
6-10
19 �
fg_circlef
Prototype
void fg_circlef (int radius); sub FGcirclef (radius%) subroutine fg_circlef (int radius) procedure fg_circlef (radius : integer);
Description
The fg_circlef routine draws a filled circle in screen space. The circle is centered at the current graphics cursor position and is filled with pixels of the current color.
Parameters
radius defines the circle's radius in horizontal screen space units. Its value must be greater than zero.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_circle, fg_circlefw, fg_ellipsef
20 �
fg_circlefw
Prototype
void fg_circlefw (double radius); sub FGcirclefw (radius#) subroutine fg_circlefw (dbl radius) procedure fg_circlefw (radius : real);
Description
The fg_circlefw routine draws a filled circle in world space. The circle is centered at the current graphics cursor position and is filled with pixels of the current color.
Parameters
radius defines the circle's radius in horizontal world space units. Its value must be greater than zero.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_circlef, fg_circlew, fg_ellipsfw
21 �
fg_circlew
Prototype
void fg_circlew (double radius); sub FGcirclew (radius#) subroutine fg_circlew (dbl radius) procedure fg_circlew (radius : real);
Description
The fg_circlew routine draws an unfilled circle in world space. The circle is centered at the current graphics cursor position.
Parameters
radius defines the circle's radius in horizontal world space units. Its value must be greater than zero.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_circle, fg_circlefw, fg_ellipsew
Examples
6-9
22 �
fg_clipmap
Prototype
fg_clipmap (char *map_array, int width, int height); sub FGclipmap (map_array$, width%, height%) subroutine fg_clipmap (int1 map_array, int width, int height) procedure fg_clipmap (var map_array; width, height : integer);
Description
The fg_clipmap routine displays an image stored as a mode-independent bitmap. The image will be displayed so that its lower left corner is at the graphics cursor position. Only that part of the image that falls within the current clipping limits will be displayed. Refer to the Fastgraph User's Guide for complete information about mode-independent bitmaps.
Parameters
map_array is the name of the array containing the bitmap.
width is the width in bytes of the bitmap.
height is the height in bytes (pixel rows) of the bitmap.
Return value
none
Restrictions
In 16-bit modes, the size of map_array is limited to 64K bytes.
See also
fg_drawmap, fg_getmap, fg_invert
23 �
fg_clipmask
Prototype
void fg_clipmask (char *map_array, int runs, int width); sub FGclipmask (map_array$, runs%, width%) subroutine fg_clipmask (int1 map_array, int runs, int width) procedure fg_clipmask (var map_array : byte; runs, width : integer);
Description
The fg_clipmask routine displays a clipped image stored as a masking map. The image will be positioned so that its lower left corner is at the graphics cursor position. Refer to the description of fg_drawmask for more information about masking maps.
Parameters
map_array is the name of the array containing the masking map.
runs is the number of pixel runs in the masking map.
width is the width in pixels of the masking map.
Return value
none
Restrictions
In 16-bit modes, the size of map_array is limited to 64K bytes.
This routine has no effect in text video modes.
See also
fg_drawmask, fg_flipmask, fg_revmask, fg_setclip
Examples
10-23
24 �
fg_clpimage
Prototype
void fg_clpimage (char *map_array, int width, int height); sub FGclpimage (map_array$, width%, height%) subroutine fg_clpimage (int1 map_array, int width, int height) procedure fg_clpimage (var map_array : byte; width, height : integer);
Description
The fg_clpimage routine displays a clipped image stored as a mode-specific bitmap. The image will be positioned so that its lower left corner is at the graphics cursor position. Only that part of the image that falls within the current clipping limits will be displayed. Refer to the Fastgraph User's Guide for complete information about mode-specific bitmaps.
Parameters
map_array is the name of the array containing the bitmap.
width is the width in bytes of the bitmap.
height is the height in bytes (pixel rows) of the bitmap.
Return value
none
Restrictions
In 16-bit modes, the size of map_array is limited to 64K bytes.
This routine has no effect in text video modes.
See also
fg_drwimage, fg_flpimage, fg_getimage, fg_invert, fg_pack, fg_putimage, fg_revimage, fg_setclip, fg_unpack
Examples
10-8, 10-9
25 �
fg_clprect
Prototype
void fg_clprect (int minx, int maxx, int miny, int maxy); sub FGclprect (minx%, maxx%, miny%, maxy%) subroutine fg_clprect (int minx, int maxx, int miny, int maxy) procedure fg_clprect (minx, maxx, miny, maxy : integer);
Description
The fg_clprect routine draws a solid (filled) rectangle in screen space, with respect to the clipping region.
Parameters
minx is the screen space x coordinate of the rectangle's left edge.
maxx is the screen space x coordinate of the rectangle's right edge. It must be greater than or equal to the value of minx.
miny is the screen space y coordinate of the rectangle's top edge.
maxy is the screen space y coordinate of the rectangle's bottom edge. It must be greater than or equal to the value of miny.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_clprectw, fg_rect, fg_rectw, fg_setclip
Examples
12-1, 12-2, 12-3, 12-4, 12-6
26 �
fg_clprectw
Prototype
void fg_clprectw (double xmin, double xmax, double ymin, double ymax); sub FGclprectw (xmin#, xmax#, ymin#, ymax#) subroutine fg_clprectw (dbl xmin, dbl xmax, dbl ymin, dbl ymax) procedure fg_clprectw (xmin, xmax, ymin, ymax : real);
Description
The fg_clprectw routine draws a solid (filled) rectangle in world space, with respect to the clipping region.
Parameters
xmin is the world space x coordinate of the rectangle's left edge.
xmax is the world space x coordinate of the rectangle's right edge. It must be greater than or equal to the value of xmin.
ymin is the world space y coordinate of the rectangle's bottom edge.
ymax is the world space y coordinate of the rectangle's top edge. It must be greater than or equal to the value of ymin.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_clprect, fg_rect, fg_rectw, fg_setclipw
27 �
fg_colors
Prototype
int fg_colors (void); function FGcolors% () int function fg_colors () function fg_colors : integer;
Description
The fg_colors routine returns the number of simultaneously available colors in the current video mode. In text video modes, the number of colors will be zero.
Parameters
none
Return value
The number of available colors, between 0 and 256.
Restrictions
none
See also
fg_setcolor
Examples
6-1
28 �
fg_copypage
Prototype
void fg_copypage (int source_page, int dest_page); sub FGcopypage (source_page%, dest_page%) subroutine fg_copypage (int source_page, int dest_page) procedure fg_copypage (source_page, dest_page : integer);
Description
The fg_copypage routine transfers the contents of one video page to another. The pages may be physical, virtual, or logical video pages. Assuming maxx and maxy represent the maximum x and y coordinates of a video page, the call
fg_copypage(source,dest);
is equivalent to
fg_transfer(0,maxx,0,maxy,0,maxy,source,dest);
Parameters
source_page is the source video page number. It must be between 0 and 63.
dest_page is the destination video page number. It must be between 0 and 63.
Return value
none
Restrictions
If source_page and dest_page both reference logical pages, the pages must exist in the same type of memory. For example, you cannot copy a logical page in extended memory to a logical page in conventional memory.
The fg_copypage routine always applies to video pages or logical pages, even when a virtual buffer is active.
See also
fg_alloccms, fg_allocems, fg_allocxms, fg_initems, fg_initxms, fg_transfer, fg_vbcopy
Examples
8-8, 8-10, 8-12, 8-13, 11-1
29 �
fg_cursor
Prototype
void fg_cursor (int state); sub FGcursor (state%) subroutine fg_cursor (int state) procedure fg_cursor (state : integer);
Description
The fg_cursor routine determines the ROM BIOS cursor visibility in text video modes. After calling fg_setmode, the cursor is made visible by default.
Parameters
The state parameter defines the cursor visibility. If it is 0, the cursor becomes invisible; if it is 1, the cursor becomes visible.
Return value
none
Restrictions
This routine has no effect in graphics video modes.
Examples
3-1, 3-2, 3-3, 3-4, 3-5, 5-16, 7-1, 7-2, 7-3, 7-4, 8-3, 8-5, 8-7, 8-12, 8-17, 10-7, 10-13, 11-2, 11-4, 13-4
30 �
fg_dash
Prototype
void fg_dash (int ix, int iy, int pattern); sub FGdash (ix%, iy%, pattern%) subroutine fg_dash (int ix, int iy, int pattern) procedure fg_dash (ix, iy, pattern : integer);
Description
The fg_dash routine draws a dashed line from the graphics cursor position to an absolute screen space position. It also makes the destination position the new graphics cursor position.
Parameters
ix is the screen space x coordinate of the destination position.
iy is the screen space y coordinate of the destination position.
pattern represents a 16-bit cyclic dash pattern. Bits that are 1 will result in a pixel being drawn; bits that are 0 will result in a pixel being skipped.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_dashrel, fg_dashrw, fg_dashw, fg_move
Examples
6-6
31 �
fg_dashrel
Prototype
void fg_dashrel (int ix, int iy, int pattern); sub FGdashrel (ix%, iy%, pattern%) subroutine fg_dashrel (int ix, int iy, int pattern) procedure fg_dashrel (ix, iy, pattern : integer);
Description
The fg_dashrel routine draws a dashed line from the graphics cursor position to a screen space position relative to it. It also makes the destination position the new graphics cursor position.
Parameters
ix is the screen space x offset of the destination position.
iy is the screen space y offset of the destination position.
pattern represents a 16-bit cyclic dash pattern. Bits that are 1 will result in a pixel being drawn; bits that are 0 will result in a pixel being skipped.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_dash, fg_dashrw, fg_dashw, fg_moverel
32 �
fg_dashrw
Prototype
void fg_dashrw (double x, double y, int pattern); sub FGdashrw (x#, y#, pattern%) subroutine fg_dashrw (dbl x, dbl y, int pattern) procedure fg_dashrw (x, y : real; pattern : integer);
Description
The fg_dashrw routine draws a dashed line from the graphics cursor position to a world space position relative to it. It also makes the destination position the new graphics cursor position.
Parameters
x is the world space x offset of the destination position.
y is the world space y offset of the destination position.
pattern represents a 16-bit cyclic dash pattern. Bits that are 1 will result in a pixel being drawn; bits that are 0 will result in a pixel being skipped.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_dash, fg_dashrel, fg_dashw, fg_moverw
33 �
fg_dashw
Prototype
void fg_dashw (double x, double y, int pattern); sub FGdashw (x#, y#, pattern%) subroutine fg_dashw (dbl x, dbl y, int pattern) procedure fg_dashw (x, y : real; pattern : integer);
Description
The fg_dashw routine draws a dashed line from the graphics cursor position to an absolute world space position. It also makes the destination position the new graphics cursor position.
Parameters
x is the world space x coordinate of the destination position.
y is the world space y coordinate of the destination position.
pattern represents a 16-bit cyclic dash pattern. Bits that are 1 will result in a pixel being drawn; bits that are 0 will result in a pixel being skipped.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_dash, fg_dashrel, fg_dashrw, fg_movew
34 �
fg_defcolor
Prototype
void fg_defcolor (int index, int value); sub FGdefcolor (index%, value%) subroutine fg_defcolor (int index, int value) procedure fg_defcolor (index, value : integer);
Description
The fg_defcolor routine assigns a color value to a virtual color index.
Parameters
index is the virtual color index to define, between 0 and 255.
value is the color value to assign to the specified color index. It must be between 0 and the maximum color value for the current video mode.
Return value
none
Restrictions
This routine has no effect in text video modes or in 256-color graphics video modes.
See also
fg_getindex, fg_palette, fg_setcolor
Examples
5-15, 5-16
35 �
fg_defpages
Prototype
void fg_defpages (int source_page, int dest_page); sub FGdefpages (source_page%, dest_page%) subroutine fg_defpages (int source_page, int dest_page) procedure fg_defpages (source_page, dest_page : integer);
Description
The fg_defpages routine defines the SVGA banks for the source and destination page numbers when using Fastgraph's block transfer routines with extended video pages.
Parameters
source_page is the video page from which to retrieve the block.
dest_page is the video page to which the block will be copied.
Return value
none
Restrictions
This routine is meaningful only in standard EGA, VGA, and XVGA graphics modes (modes 13 to 18 and 20 to 23) for SVGA chipsets that support extended video pages.
See also
fg_copypage, fg_restore, fg_save, fg_svgainit, fg_svgastat, fg_tcxfer, fg_transfer
Examples
8-8
36 �
fg_dispfile
Prototype
void fg_dispfile (char *filename, int width, int format); sub FGdispfile (filename$, width%, format%) subroutine fg_dispfile (char filename, int width, int format) procedure fg_dispfile (filename : string; width, format : integer);
Description
The fg_dispfile routine displays an image stored in a standard or packed pixel run file. The image will be positioned so that its lower left corner is at the graphics cursor position on the active video page or virtual buffer. Refer to the descriptions of fg_display and fg_displayp for more information about the two pixel run formats.
Parameters
filename is the name of the PPR or SPR file. A device and path name may be included as part of the file name. The file name must be terminated by a null character (that is, a zero byte).
width is the width of the image in pixels. It must be greater than zero.
format specifies the image format. The value of format must be 0 if the image is in standard pixel run format, and 1 if the image is in packed pixel run format.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_display, fg_displayp, fg_imagebuf, fg_pattern, fg_showppr, fg_showspr
Examples
9-10
37 �
fg_display
Prototype
void fg_display (char *map_array, int runs, int width); sub FGdisplay (map_array$, runs%, width%) subroutine fg_display (int1 map_array, int runs, int width) procedure fg_display (var map_array : byte; runs, width : integer);
Description
The fg_display routine displays an image stored in Fastgraph's standard pixel run format, where the image resides in an array. The image will be positioned so that its lower left corner is at the graphics cursor position.
Parameters
map_array is the name of the array containing the pixel run map. The pixel runs are represented by (color,count) pairs, as shown here:
[0] color for run 1
[1] count for run 1
[2] color for run 2
[3] count for run 2
.
.
.
[2n-2] color for run n
[2n-1] count for run n
Each "color" element is a value between 0 and 255 specifying the color index for that pixel run. Each "count" element is a value between 0 and 255 specifying the length in pixels of that pixel run.
runs is the number of pixel runs to display from the pixel run map. It is normally one-half the size of the map_array array.
width is the width of the image in pixels. It must be greater than zero.
Return value
none
Restrictions
In 16-bit modes, the size of map_array is limited to 64K bytes.
This routine has no effect in text video modes.
38 �
fg_display (continued)
See also
fg_dispfile, fg_displayp, fg_pattern, fg_showspr
Examples
10-20, 10-22
39 �
fg_displayp
Prototype
void fg_displayp (char *map_array, int runs, int width); sub FGdisplayp (map_array$, runs%, width%) subroutine fg_displayp (int1 map_array, int runs, int width) procedure fg_displayp (var map_array : byte; runs, width : integer);
Description
The fg_displayp routine displays an image stored in Fastgraph's packed pixel run format, where the image resides in an array. The image will be positioned so that its lower left corner is at the graphics cursor position.
Parameters
map_array is the name of the array containing the pixel run map. The pixel
runs are represented by (color,count) pairs, as shown here:
7 4 3 0
[0] color for run 1 color for run 2
[1] count for run 1
[2] count for run 2
[3] color for run 3 color for run 4
[4] count for run 3
[5] count for run 4
.
.
.
[3n/2-3] color for run n-1 color for run n
[3n/2-2] count for run n-1
[3n/2-1] count for run n
Each "color" element is a value between 0 and 15 specifying the color index for that pixel run. Each "count" element is a value between 0 and 255 specifying the length in pixels of that pixel run.
runs is the number of pixel runs to display from the pixel run map. It is normally two-thirds the size of the map_array array.
width is the width of the image in pixels. It must be greater than zero.
40 �
fg_displayp (continued)
Return value
none
Restrictions
In 16-bit modes, the size of map_array is limited to 64K bytes.
This routine has no effect in text video modes.
See also
fg_dispfile, fg_display, fg_pattern, fg_showppr
Examples
10-21, 10-22
41 �
fg_draw
Prototype
void fg_draw (int ix, int iy); sub FGdraw (ix%, iy%) subroutine fg_draw (int ix, int iy) procedure fg_draw (ix, iy : integer);
Description
The fg_draw routine draws a solid line from the graphics cursor position to an absolute screen space position. It also makes the destination position the new graphics cursor position.
Parameters
ix is the screen space x coordinate of the destination position.
iy is the screen space y coordinate of the destination position.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_drawrel, fg_draww, fg_drawx, fg_move
Examples
6-2, 6-5, 13-5, 13-6
42 �
fg_drawmap
Prototype
void fg_drawmap (char *map_array, int width, int height); sub FGdrawmap (map_array$, width%, height%) subroutine fg_drawmap (int1 map_array, int width, int height) procedure fg_drawmap (var map_array : byte; width, height : integer);
Description
The fg_drawmap routine displays an image stored as a mode-independent bitmap. The image will be positioned so that its lower left corner is at the graphics cursor position. Refer to the Fastgraph User's Guide for complete information about mode-independent bitmaps.
Parameters
map_array is the name of the array containing the bitmap. Each byte of map_array represents eight pixels. Bits that are set (1) result in the corresponding pixel being displayed in the current color. Bits that are reset (0) leave the corresponding pixel unchanged.
width is the width in bytes of the bitmap.
height is the height in bytes (pixel rows) of the bitmap.
Return value
none
Restrictions
In 16-bit modes, the size of map_array is limited to 64K bytes.
See also
fg_clipmap, fg_drwimage, fg_getmap, fg_invert
Examples
10-1, 10-2, 10-10, 10-11
43 �
fg_drawmask
Prototype
void fg_drawmask (char *map_array, int runs, int width); sub FGdrawmask (map_array$, runs%, width%) subroutine fg_drawmask (int1 map_array, int runs, int width) procedure fg_drawmask (var map_array : byte; runs, width : integer);
Description
The fg_drawmask routine displays an image stored as a masking map. The image will be positioned so that its lower left corner is at the graphics cursor position. Refer to the Fastgraph User's Guide for a complete discussion of masking maps.
Parameters
map_array is the name of the array containing the masking map. The masking map is a series of alternating "protect" and "zero" pixel runs, as shown here:
[1] length of 1st protect run
[2] length of 1st zero run
[3] length of 2nd protect run
[4] length of 2nd zero run
.
.
.
[n-2] length of final protect run
[n-1] length of final zero run
The "protect" runs protect video memory, while the "zero" runs zero video memory (that is, set the pixels to the background color). The length of each run must be between 0 and 255.
runs is the number of pixel runs in the masking map.
width is the width in pixels of the masking map.
Return value
none
44 �
fg_drawmask (continued)
Restrictions
In 16-bit modes, the size of map_array is limited to 64K bytes.
This routine has no effect in text video modes.
See also
fg_clipmask, fg_flipmask, fg_revmask
Examples
10-23, 10-24
45 �
fg_drawrel
Prototype
void fg_drawrel (int ix, int iy); sub FGdrawrel (ix%, iy%) subroutine fg_drawrel (int ix, int iy) procedure fg_drawrel (ix, iy : integer);
Description
The fg_drawrel routine draws a solid line from the graphics cursor position to a screen space position relative to it. It also makes the destination position the new graphics cursor position.
Parameters
ix is the screen space x offset of the destination position.
iy is the screen space y offset of the destination position.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_draw, fg_drawrelx, fg_drawrw, fg_moverel
Examples
6-3, 6-17
46 �
fg_drawrelx
Prototype
void fg_drawrelx (int ix, int iy); sub FGdrawrelx (ix%, iy%) subroutine fg_drawrelx (int ix, int iy) procedure fg_drawrelx (ix, iy : integer);
Description
The fg_drawrelx routine draws a solid line in "exclusive or" mode from the graphics cursor position to a screen space position relative to it. The destination position becomes the new graphics cursor position.
Parameters
ix is the screen space x offset of the destination position.
iy is the screen space y offset of the destination position.
Return value
none
Restrictions
This routine has no effect in text video modes.
In 16-color EGA, VGA, or SVGA graphics modes, the EGA/VGA function register is reset to its default replacement mode on return.
See also
fg_drawrel, fg_drawrxw, fg_drawx, fg_moverel
47 �
fg_drawrw
Prototype
void fg_drawrw (double x, double y); sub FGdrawrw (x#, y#) subroutine fg_drawrw (dbl x, dbl y) procedure fg_drawrw (x, y : real);
Description
The fg_drawrw routine draws a solid line from the graphics cursor position to a world space position relative to it. It also makes the destination position the new graphics cursor position.
Parameters
x is the world space x offset of the destination position.
y is the world space y offset of the destination position.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_drawrel, fg_drawrxw, fg_draww, fg_moverw
48 �
fg_drawrxw
Prototype
void fg_drawrxw (double x, double y); sub FGdrawrxw (x#, y#) subroutine fg_drawrxw (dbl x, dbl y) procedure fg_drawrxw (x, y : real);
Description
The fg_drawrxw routine draws a solid line in "exclusive or" mode from the graphics cursor position to a world space position relative to it. It also makes the destination position the new graphics cursor position.
Parameters
x is the world space x offset of the destination position.
y is the world space y offset of the destination position.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
In 16-color EGA, VGA, or SVGA graphics modes, the EGA/VGA function register is reset to its default replacement mode on return.
See also
fg_drawrelx, fg_drawrw, fg_drawxw, fg_moverw
49 �
fg_draww
Prototype
void fg_draww (double x, double y); sub FGdraww (x#, y#) subroutine fg_draww (dbl x, dbl y) procedure fg_draww (x, y : real);
Description
The fg_draww routine draws a solid line from the graphics cursor position to an absolute world space position. It also makes the destination position the new graphics cursor position.
Parameters
x is the world space x coordinate of the destination position.
y is the world space y coordinate of the destination position.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_draw, fg_drawrw, fg_drawxw, fg_movew
Examples
4-4, 6-4
50 �
fg_drawx
Prototype
void fg_drawx (int ix, int iy); sub FGdrawx (ix%, iy%) subroutine fg_drawx (int ix, int iy) procedure fg_drawx (ix, iy : integer);
Description
The fg_drawx routine draws a solid line in "exclusive or" mode from the graphics cursor position to an absolute screen space position. It also makes the destination position the new graphics cursor position.
Parameters
ix is the screen space x coordinate of the destination position.
iy is the screen space y coordinate of the destination position.
Return value
none
Restrictions
This routine has no effect in text video modes.
In 16-color EGA, VGA, or SVGA graphics modes, the EGA/VGA function register is reset to its default replacement mode on return.
See also
fg_draw, fg_drawrelx, fg_drawxw, fg_move
51 �
fg_drawxw
Prototype
void fg_drawxw (double x, double y); sub FGdrawxw (x#, y#) subroutine fg_drawxw (dbl x, dbl y) procedure fg_drawxw (x, y : real);
Description
The fg_drawxw routine draws a solid line in "exclusive or" mode from the graphics cursor position to an absolute world space position. It also makes the destination position the new graphics cursor position.
Parameters
x is the world space x coordinate of the destination position.
y is the world space y coordinate of the destination position.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
In 16-color EGA, VGA, or SVGA graphics modes, the EGA/VGA function register is reset to its default replacement mode on return.
See also
fg_drawrxw, fg_draww, fg_drawx, fg_movew
52 �
fg_drect
Prototype
void fg_drect (int minx, int maxx, int miny, int maxy, char *matrix); sub FGdrect (minx%, maxx%, miny%, maxy%, matrix$) subroutine fg_drect (int minx, int maxx, int miny, int maxy, int1 matrix) procedure fg_drect (minx, maxx, miny, maxy : integer; var matrix : byte);
Description
The fg_drect routine draws a dithered rectangle in screen space, without regard to the clipping region.
Parameters
minx is the screen space x coordinate of the rectangle's left edge.
maxx is the screen space x coordinate of the rectangle's right edge. It must be greater than or equal to the value of minx.
miny is the screen space y coordinate of the rectangle's top edge.
maxy is the screen space y coordinate of the rectangle's bottom edge. It must be greater than or equal to the value of miny.
matrix is a four-element array (an eight-element array in 256-color graphics modes) that defines the dithering matrix. The format of the dithering matrix is dependent on the video mode; refer to the Fastgraph User's Guide for more information.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_drectw, fg_rect
Examples
6-14, 6-15, 6-16
53 �
fg_drectw
Prototype
void fg_drectw (double xmin, double xmax, double ymin, double ymax,
char *matrix);
sub FGdrectw (xmin#, xmax#, ymin#, ymax#, matrix$)
subroutine fg_drectw (dbl xmin, dbl xmax, dbl ymin, dbl ymax, int1 matrix)
procedure fg_drectw (xmin, xmax, ymin, ymax : real; var matrix : byte);
Description
The fg_drectw routine draws a dithered rectangle in world space, without regard to the clipping region.
Parameters
xmin is the world space x coordinate of the rectangle's left edge.
xmax is the world space x coordinate of the rectangle's right edge. It must be greater than or equal to the value of xmin.
ymin is the world space y coordinate of the rectangle's bottom edge.
ymax is the world space y coordinate of the rectangle's top edge. It must be greater than or equal to the value of ymin.
matrix is a four-element array (an eight-element array in 256-color graphics modes) that defines the dithering matrix. The format of the dithering matrix is dependent on the video mode; refer to the Fastgraph User's Guide for more information.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_drect, fg_rectw
54 �
fg_drwimage
Prototype
void fg_drwimage (char *map_array, int width, int height); sub FGdrwimage (map_array$, width%, height%) subroutine fg_drwimage (int1 map_array, int width, int height) procedure fg_drwimage (var map_array : byte; width, height : integer);
Description
The fg_drwimage routine displays an image stored as a mode-specific bitmap. The image will be positioned so that its lower left corner is at the graphics cursor position (or the text cursor position in text video modes). Refer to the Fastgraph User's Guide for complete information about mode- specific bitmaps.
Parameters
map_array is the name of the array containing the bitmap.
width is the width in bytes of the bitmap.
height is the height in bytes (pixel rows) of the bitmap.
Return value
none
Restrictions
In 16-bit modes, the size of map_array is limited to 64K bytes.
See also
fg_clpimage, fg_flpimage, fg_getimage, fg_invert, fg_pack, fg_putimage, fg_revimage, fg_unpack
Examples
10-3, 10-4, 10-5, 10-6, 10-7, 10-8, 10-9, 10-12, 10-13, 10-14, 10-15, 10-16, 10-24
55 �
fg_egacheck
Prototype
int fg_egacheck (void); function FGegacheck% () int function fg_egacheck () function fg_egacheck : integer;
Description
The fg_egacheck routine returns information about the active EGA adapter and display (or the EGA emulation capabilities of a VGA). It is useful in checking if the adapter has enough memory to run a program. This function remains in Fastgraph for compatibility purposes; it has been superseded by fg_testmode.
Parameters
none
Return value
The fg_egacheck routine returns a value of 0 if an EGA is not found, or if an EGA without an Enhanced Color Display (ECD) is detected. Otherwise, fg_egacheck returns a positive integer indicating the number of 64K-byte increments of video memory on the EGA, as summarized below.
1 = EGA with 64K video memory
2 = EGA with 128K video memory
3 = EGA with 192K video memory
4 = EGA with 256K video memory
Restrictions
none
See also
fg_testmode
56 �
fg_ellipse
Prototype
void fg_ellipse (int horiz, int vert); sub FGellipse (horiz%, vert%) subroutine fg_ellipse (int horiz, int vert) procedure fg_ellipse (horiz, vert : integer);
Description
The fg_ellipse routine draws an unfilled ellipse in screen space. The ellipse is centered at the current graphics cursor position, and its size is determined by the specified lengths of its semi-axes.
Parameters
horiz is the length of the ellipse's horizontal semi-axis (the absolute screen space distance from the center of the ellipse to its horizontal extremity).
vert is the length of the ellipse's vertical semi-axis (the absolute screen space distance from the center of the ellipse to its vertical extremity).
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_circle, fg_ellipsef, fg_ellipsew
Examples
6-10, 12-4, 12-5, 12-6
57 �
fg_ellipsef
Prototype
void fg_ellipsef (int horiz, int vert); sub FGellipsef (horiz%, vert%) subroutine fg_ellipsef (int horiz, int vert) procedure fg_ellipsef (horiz, vert : integer);
Description
The fg_ellipsef routine draws a filled ellipse in screen space. The ellipse is centered at the current graphics cursor position, and its size is determined by the specified lengths of its semi-axes. The ellipse is filled with pixels of the current color.
Parameters
horiz is the length of the ellipse's horizontal semi-axis (the absolute screen space distance from the center of the ellipse to its horizontal extremity).
vert is the length of the ellipse's vertical semi-axis (the absolute screen space distance from the center of the ellipse to its vertical extremity).
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_circlef, fg_ellipse, fg_ellipsfw
58 �
fg_ellipsew
Prototype
void fg_ellipsew (double horiz, double vert); sub FGellipsew (horiz#, vert#) subroutine fg_ellipsew (dbl horiz, dbl vert) procedure fg_ellipsew (horiz, vert : real);
Description
The fg_ellipsew routine draws an unfilled ellipse in world space. The ellipse is centered at the current graphics cursor position, and its size is determined by the specified lengths of its semi-axes.
Parameters
horiz defines the horizontal semi-axis of the ellipse (the absolute world space distance from the center of the ellipse to its horizontal extremity).
vert defines the vertical semi-axis of the ellipse (the absolute world space distance from the center of the ellipse to its vertical extremity).
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_circlew, fg_ellipse, fg_ellipsfw
Examples
6-9
59 �
fg_ellipsfw
Prototype
void fg_ellipsfw (double horiz, double vert); sub FGellipsfw (horiz#, vert#) subroutine fg_ellipsfw (dbl horiz, dbl vert) procedure fg_ellipsfw (horiz, vert : real);
Description
The fg_ellipsfw routine draws a filled ellipse in world space. The ellipse is centered at the current graphics cursor position, and its size is determined by the specified lengths of its semi-axes. The ellipse is filled with pixels of the current color.
Parameters
horiz defines the horizontal semi-axis of the ellipse (the absolute world space distance from the center of the ellipse to its horizontal extremity).
vert defines the vertical semi-axis of the ellipse (the absolute world space distance from the center of the ellipse to its vertical extremity).
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_circlefw, fg_ellipsew
60 �
fg_erase
Prototype
void fg_erase (void); sub FGerase () subroutine fg_erase () procedure fg_erase;
Description
The fg_erase routine clears the active video page or virtual buffer. In text modes, fg_erase stores a space character (ASCII 32) with a gray foreground attribute in each character cell. In graphics modes, fg_erase sets each pixel to zero.
Parameters
none
Return value
none
Restrictions
none
See also
fg_fillpage, fg_reset
Examples
4-4, 8-10, 8-11, 8-13, 9-10, 10-22, 11-1
61 �
fg_fadein
Prototype
void fg_fadein (int delay); sub FGfadein (delay%) subroutine fg_fadein (int delay) procedure fg_fadein (delay : integer);
Description
The fg_fadein routine replaces the visual page contents with the hidden page contents. The replacement is done randomly in small sections, thus giving a "fade in" effect.
Parameters
delay controls the speed at which the replacement takes place. A value of zero means to perform the replacement as quickly as possible, while 1 is slightly slower, 2 is slower yet, and so forth.
Return value
none
Restrictions
This routine has no effect in text video modes.
The fg_fadein routine always applies to video pages, even when a virtual buffer is active.
See also
fg_fadeout, fg_sethpage
Examples
13-2
62 �
fg_fadeout
Prototype
void fg_fadeout (int delay); sub FGfadeout (delay%) subroutine fg_fadeout (int delay) procedure fg_fadeout (delay : integer);
Description
The fg_fadeout routine replaces the visual page contents with pixels of the current color. The replacement is done randomly in small sections, thus giving a "fade out" effect.
Parameters
delay controls the speed at which the replacement takes place. A value of zero means to perform the replacement as quickly as possible, while 1 is slightly slower, 2 is slower yet, and so forth.
Return value
none
Restrictions
This routine has no effect in text video modes.
The fg_fadeout routine always applies to video pages, even when a virtual buffer is active.
See also
fg_fadein, fg_setcolor
Examples
13-1
63 �
fg_fillpage
Prototype
void fg_fillpage (void); sub FGfillpage () subroutine fg_fillpage () procedure fg_fillpage;
Description
The fg_fillpage routine fills the active video page or virtual buffer. In text modes, it stores a solid block character (ASCII 219) with the current display attribute in each character cell. In graphics modes, fg_fillpage fills the active video page or virtual buffer with pixels of the current color.
Parameters
none
Return value
none
Restrictions
none
See also
fg_erase, fg_setcolor, fg_setattr
Examples
7-6, 7-8, 8-8, 8-12, 8-16, 8-17, 10-8, 10-9, 10-15, 10-16, 13-8, 13-9
64 �
fg_findpage
Prototype
int fg_findpage (void) function FGfindpage% () int function fg_findpage () function fg_findpage : integer;
Description
The fg_findpage routine finds an available video page number for a virtual or logical page.
Parameters
none
Return value
If successful, fg_findpage returns an available video page number (between 1 and 63), which may then be passed to fg_allocate, fg_alloccms, fg_allocems, or fg_allocxms. If unsuccessful, the return value is zero.
Restrictions
none
See also
fg_allocate, fg_alloccms, fg_allocems, fg_allocxms
Examples
8-9, 8-10, 8-12
65 �
fg_flicdone
Prototype
void fg_flicdone (char *context); sub FGflicdone (context$) subroutine fg_flicdone (int1 context) procedure fg_flicdone (var context);
Description
The fg_flicdone routine closes the flic file associated with the specified context descriptor.
Parameters
context is the name of a 16-byte buffer containing the flic file context descriptor.
Return value
none
Restrictions
none
See also
fg_flicopen
Examples
9-8
66 �
fg_flichead
Prototype
int fg_flichead (char *flic_file, char *flic_header); function FGflichead% (flic_file$, flic_header$) int function fg_flichead (char flic_file, int1 flic_header) function fg_flichead (flic_file : string; var flic_header) : integer;
Description
The fg_flichead routine reads an FLI or FLC file header.
Parameters
flic_file is the name of the FLI/FLC file, terminated by a zero byte.
flic_header is the name of the buffer to receive the 128-byte FLI/FLC file header. In BASIC, it must be a fixed-length 128-byte string.
Return value
0 = Success -1 = The specified file does not exist -2 = The specified file is not an FLI or FLC file
Restrictions
none
See also
fg_flicmode, fg_flicplay, fg_flicsize, fg_showflic
Examples
9-7
67 �
fg_flicmode
Prototype
int fg_flicmode (char *flic_header); function FGflicmode% (flic_header$) int function fg_flicmode (int1 flic_header) function fg_flicmode (var flic_header) : integer;
Description
The fg_flicmode routine determines the optimal video mode for the FLI or FLC image associated with the specified flic file header. The optimal mode is the 256-color graphics mode having the lowest resolution larger than or equal to the image dimensions.
Parameters
flic_header is the name of the buffer containing the 128-byte FLI/FLC file header.
Return value
>0 = The optimal video mode for displaying the FLI/FLC image -1 = The flic_header buffer does not contain a valid flic file header
Restrictions
none
See also
fg_flichead, fg_showflic
Examples
9-7
68 �
fg_flicopen
Prototype
int fg_flicopen (char *flic_file, char *context); function FGflicopen% (flic_file$, context$) int function fg_flicopen (char flic_file, int1 context) function fg_flicopen (flic_file : string; var context) : integer;
Description
The fg_flicopen routine opens an FLI or FLC file (collectively called flic files) for subsequent processing by Fastgraph's other low-level flic file support routines. If successful, the file pointer will be positioned at the beginning of the first frame.
Parameters
flic_file is the name of the flic file. A device and path name may be included as part of the file name. The file name must be terminated by a zero byte.
context is the name of a 16-byte buffer that will receive the flic file context descriptor. The descriptor values will only be meaningful if the return value is zero.
Return value
0 = FLI/FLC file opened successfully -1 = The specified file does not exist -2 = The specified file is not an FLI or FLC file
Restrictions
none
See also
fg_flicdone, fg_flicplay, fg_flicskip, fg_showflic
Examples
9-8
69 �
fg_flicplay
Prototype
int fg_flicplay (char *context, int frames, int flags); function FGflicplay% (context$, frames%, flags%) int function fg_flicplay (int1 context, int frames, int flags) function fg_flicplay (var context; frames, flags : integer) : integer;
Description
The fg_flicplay routine displays the next one or more individual frames in a flic file that was previously opened with fg_flicopen.
Parameters
context is the name of a 16-byte buffer containing the flic file context descriptor.
frames is the number of frames to display from the flic file, starting from the current file position.
flags is a bit mask that controls how the image is displayed.
Bit 0
0 = delay between frames as indicated in flic header
1 = no delay between frames
Bit 1
0 = display image relative to screen origin
1 = display image relative current graphics position
Bit 2
0 = display image from the specified flic file
1 = display image from the fg_imagebuf buffer
Bits 3-15 are reserved for future use and should be zero.
Return value
The number of frames displayed. This value may be less than frames if the end-of-file is reached before displaying the requested number of frames.
Restrictions
Flic files are only meaningful in 256-color graphics modes. This routine has no effect in other video modes.
See also
fg_flicopen, fg_flicskip, fg_showflic
Examples
9-8
70 �
fg_flicsize
Prototype
void fg_flicsize (char *flic_header, int *width, int *height); sub FGflicsize (flic_header$, width%, height%) subroutine fg_flicsize (int1 flic_header, int width, int height) procedure fg_flicsize (var flic_header; var width, height : integer);
Description
The fg_flicsize routine returns the dimensions for the flic image associated with the specified flic file header.
Parameters
flic_header is the name of the buffer containing the 128-byte FLI/FLC file header.
width receives the width in pixels of the flic image. If flic_header does not contain a valid FLI/FLC file header, width will be set to -1.
height receives the height in pixels of the flic image. If flic_header does not contain a valid FLI/FLC file header, height will be set to -1.
Return value
none
Restrictions
none
See also
fg_flichead, fg_showflic
Examples
9-7
71 �
fg_flicskip
Prototype
int fg_flicskip (char *context, int frames); function FGflicskip% (context$, frames%) int function fg_flicskip (int1 context, int frames) function fg_flicskip (var context; frames : integer) : integer;
Description
The fg_flicskip routine advances one or more frames in a flic file that was previously opened with fg_flicopen. If the last frame played by fg_flicplay displayed the frame from the fg_imagebuf buffer, the frame position will be adjusted in the fg_imagebuf buffer. Otherwise, the flic file position itself will be adjusted.
Parameters
context is the name of a 16-byte buffer containing the flic file context descriptor.
frames is the number of frames to skip in the flic file, starting from the current file position. If frames is negative, the flic file position will be set to the first frame.
Return value
The number of frames skipped. This value may be less than frames if the end-of-file is reached before skipping the requested number of frames. If frames is negative, the return value will be zero.
Restrictions
none
See also
fg_flicopen, fg_flicplay
72 �
fg_flipmask
Prototype
void fg_flipmask (char *map_array, int runs, int width); sub FGflipmask (map_array$, runs%, width%) subroutine fg_flipmask (int1 map_array, int runs, int width) procedure fg_flipmask (var map_array : byte; runs, width : integer);
Description
The fg_flipmask routine displays a reversed clipped image stored as a masking map. The image will be positioned so that its lower left corner is at the graphics cursor position. Refer to the description of fg_drawmask for more information about masking maps.
Parameters
map_array is the name of the array containing the masking map.
runs is the number of pixel runs in the masking map.
width is the width in pixels of the masking map.
Return value
none
Restrictions
In 16-bit modes, the size of map_array is limited to 64K bytes.
This routine has no effect in text video modes.
See also
fg_clipmask, fg_drawmask, fg_revmask, fg_setclip
Examples
10-23
73 �
fg_flood
Prototype
void fg_flood (int ix, int iy); sub FGflood (ix%, iy%) subroutine fg_flood (int ix, int iy) procedure fg_flood (ix, iy : integer);
Description
The fg_flood routine fills an arbitrary closed region with the current color value, with respect to the current clipping limits. The region is defined by specifying a screen space point within its interior.
Parameters
ix is the screen space x coordinate of the interior point.
iy is the screen space y coordinate of the interior point.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_floodw, fg_paint
74 �
fg_floodw
Prototype
void fg_floodw (double x, double y); sub FGfloodw (x#, y#) subroutine fg_floodw (dbl x, dbl y) procedure fg_floodw (x, y : real);
Description
The fg_floodw routine fills an arbitrary closed region with the current color value, with respect to the current clipping limits. The region is defined by specifying a world space point within its interior.
Parameters
x is the world space x coordinate of the interior point.
y is the world space y coordinate of the interior point.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_flood, fg_paintw
75 �
fg_flpimage
Prototype
void fg_flpimage (char *map_array, int width, int height); sub FGflpimage (map_array$, width%, height%) subroutine fg_flpimage (int1 map_array, int width, int height) procedure fg_flpimage (var map_array : byte; width, height : integer);
Description
The fg_flpimage routine displays a reversed clipped image stored as a mode- specific bitmap. The image will be positioned so that its lower left corner is at the graphics cursor position. Only that part of the image that falls within the current clipping limits will be displayed. Refer to the Fastgraph User's Guide for complete information about mode-specific bitmaps.
Parameters
map_array is the name of the array containing the bitmap.
width is the width in bytes of the bitmap.
height is the height in bytes (pixel rows) of the bitmap.
Return value
none
Restrictions
In 16-bit modes, the size of map_array is limited to 64K bytes.
This routine has no effect in text video modes.
See also
fg_clpimage, fg_drwimage, fg_getimage, fg_invert, fg_pack, fg_putimage, fg_revimage, fg_setclip, fg_unpack
Examples
10-8, 10-9
76 �
fg_fontsize
Prototype
void fg_fontsize (int char_height); sub FGfontsize (char_height%) subroutine fg_fontsize (int char_height) procedure fg_fontsize (char_height : integer);
Description
The fg_fontsize routine enables the 8x8, 8x14, or 8x16 ROM BIOS character font for strings displayed with fg_print and fg_text. Refer to Chapter 7 of the Fastgraph User's Guide for information about the default character sizes and number of text rows available in each video mode.
Parameters
char_height is the desired character height in pixels. Its value must be 8, 14, or 16.
Return value
none
Restrictions
If char_height is not a valid value, fg_fontsize does nothing.
This routine is meaningful only in VGA and SVGA graphics video modes.
See also
fg_print, fg_text
Examples
7-8
77 �
fg_freepage
Prototype
int fg_freepage (int page_number); function FGfreepage% (page_number%) int function fg_freepage (int page_number) function fg_freepage (page_number : integer) : integer;
Description
The fg_freepage routine releases a virtual or logical video page created with fg_allocate, fg_alloccms, fg_allocems, or fg_allocxms.
Parameters
page_number is the number of the virtual or logical page to release. It must be between 1 and 63.
Return value
A status code indicating the success or failure of the virtual page release, as shown here:
0 = virtual or logical page successfully released
1 = page number is invalid
7 = virtual page released, but memory control blocks destroyed
9 = attempt to release a physical page, or a virtual or logical page
that was never created
Restrictions
This routine has no effect if page_number references a physical video page, or a virtual page that was never created.
See also
fg_allocate, fg_alloccms, fg_allocems, fg_allocxms
Examples
8-3, 8-4, 8-5, 8-6, 8-9, 8-10, 8-12, 11-1, 11-2, 11-3, 11-4, 12-4, 12-5, 13-2, 13-5, 17-1
78 �
fg_getaddr
Prototype
int fg_getaddr (void); function FGgetaddr% () int function fg_getaddr () function fg_getaddr : integer;
Description
The fg_getaddr routine returns the segment address (in real mode) or segment selector (in protected mode) for the active video page.
Parameters
none
Return value
The segment address of the active video page.
Restrictions
none
See also
fg_setpage
Examples
8-9
79 �
fg_getattr
Prototype
int fg_getattr (int row, int column); function FGgetattr% (row%, column%) int function fg_getattr (int row, int column) function fg_getattr (row, column : integer) : integer;
Description
The fg_getattr routine returns the character attribute stored at the specified position on the active video page.
Parameters
row is the row number of the character cell to examine, between 0 and 24 (unless you've called fg_setlines to increase the number of lines per page).
column is the column number of the character cell to examine, between 0 and 39 for 40-column modes, or between 0 and 79 for 80-column modes.
Return value
The character attribute stored at the specified position.
Restrictions
This routine has no effect in graphics video modes.
See also
fg_getchar, fg_getimage
Examples
7-4
80 �
fg_getbanks
Prototype
void fg_getbanks (int *read_bank, int *write_bank); sub FGgetbanks (read_bank%, write_bank%) subroutine fg_getbanks (int read_bank, int write_bank) procedure fg_getbanks (var read_bank, write_bank : integer);
Description
The fg_getbanks routine returns the current SVGA read and write bank numbers.
Parameters
read_bank receives the SVGA bank number used in read operations.
write_bank Receives the SVGA bank number used in write operations.
Return value
none
Restrictions
The read and write bank numbers will be correct only if they were set through Fastgraph's SVGA kernel, or with fg_setbanks.
For SVGA chipsets without separate read/write banks, or when using a VESA driver that does not support separate banks, the values returned for read_bank and write_bank will be identical.
See also
fg_setbanks, fg_svgainit
81 �
fg_getblock
Prototype
void fg_getblock (char [far] *buffer, int minx, int maxx, int miny,
int maxy);
sub FGgetblock (buffer$, minx%, maxx%, miny%, maxy%)
subroutine fg_getblock (int1 [far] buffer, int minx, int maxx, int miny,
int maxy)
procedure fg_getblock (buffer : pointer; minx, maxx, miny, maxy : integer);
Description
The fg_getblock routine retrieves a block (for later display with fg_putblock) from the specified position on the active video page or virtual buffer. In text modes, the block extremes are defined in character space; in graphics modes, they are defined in screen space. Use fg_imagesiz to determine the array size required to store the block.
Parameters
buffer is the name of the array to receive the block. It is passed by far reference in 16-bit modes except when using BASIC.
minx is the screen space x coordinate of the block's left edge. In graphics modes, its value is reduced to a byte boundary if necessary.
maxx is the x coordinate of the block's right edge. It must be greater than or equal to the value of minx. In graphics modes, its value is extended to a byte boundary if necessary.
miny is the y coordinate of the block's top edge.
maxy is the y coordinate of the block's bottom edge. It must be greater than or equal to the value of miny.
Return value
none
Restrictions
In 16-bit modes, the size of buffer is limited to 64K bytes.
In real mode Pascal programs, buffer must be allocated dynamically with the GetMem procedure. This is the only way to pass something by far reference in Pascal.
See also
fg_imagesiz, fg_putblock
Examples
11-10
82 �
fg_getchar
Prototype
int fg_getchar (int row, int column); function FGgetchar% (row%, column%) int function fg_getchar (int row, int column) function fg_getchar (row, column : integer) : integer;
Description
The fg_getchar routine returns the character value stored at the specified position on the active video page.
Parameters
row is the row number of the character cell to examine, between 0 and 24 (unless you've called fg_setlines to increase the number of lines per page).
column is the column number of the character cell to examine, between 0 and 39 for 40-column modes, or between 0 and 79 for 80-column modes.
Return value
The character value stored at the specified position.
Restrictions
This routine has no effect in graphics video modes.
See also
fg_getattr, fg_getimage
Examples
7-4
83 �
fg_getclip
Prototype
void fg_getclip (int *minx, int *maxx, int *miny, int *maxy); sub FGgetclip (minx%, maxx%, miny%, maxy%) subroutine fg_getclip (int minx, int maxx, int miny, int maxy) procedure fg_getclip (var minx, maxx, miny, maxy : integer);
Description
The fg_getclip routine returns the clipping region extremes in screen space. The clipping region is a rectangular area outside of which certain graphics are suppressed. By default, the clipping region is set to the video page extremes.
Parameters
minx receives the x coordinate of the clipping region's left edge.
maxx receives the x coordinate of the clipping region's right edge.
miny receives the y coordinate of the clipping region's top edge.
maxy receives the y coordinate of the clipping region's bottom edge.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_setclip
84 �
fg_getclock
Prototype
long fg_getclock (void); function FGgetclock& () int4 function fg_getclock () function fg_getclock : longint;
Description
The fg_getclock routine returns the number of clock ticks since midnight.
Parameters
none
Return value
The number of clock ticks since midnight. There are approximately 18.2 clock ticks per second. The return value is always a 32-bit quantity.
Restrictions
none
Examples
16-2
85 �
fg_getcolor
Prototype
int fg_getcolor (void); function FGgetcolor% () int function fg_getcolor () function fg_getcolor : integer;
Description
The fg_getcolor routine returns the current text attribute (in text modes) or color index (in graphics modes), as defined by the most recent call to fg_setattr or fg_setcolor.
Parameters
none
Return value
In graphics video modes, the return value is the current color index. In text modes, it is the current text attribute.
Restrictions
none
See also
fg_setattr, fg_setcolor
86 �
fg_getdacs
Prototype
void fg_getdacs (int start, int count, char *values); sub FGgetdacs (start%, count%, values$) subroutine fg_getdacs (int start, int count, int1 values) procedure fg_getdacs (start, count : integer; var values : shortint);
Description
The fg_getdacs routine retrieves the red, green, and blue color components of a contiguous block of video DAC registers. Each color component is a value between 0 and 63; increasing values produce more intense colors. Reading many DAC registers with fg_getdacs is considerably faster than doing so individually with fg_getrgb.
Parameters
start is the starting video DAC register number, between 0 and 255.
count is the number of contiguous DAC registers to retrieve, between 1 and 256. If the sum of start and count exceeds 256, the register numbers wrap around and resume with register number 0.
values is the name of the array that will receive the color components. The first three bytes of this array receive the red, green, and blue components for DAC register start, the next three bytes receive the components for register start+1, and so forth. The size of the values array must be at least 3*count bytes.
Return value
none
Restrictions
This routine has no effect in text modes, or in CGA, Tandy, and Hercules graphics modes. In modes 13 to 16, it is meaningful only when run on a VGA or SVGA system; its results are unpredictable in these modes when run on an EGA. You can use fg_testmode(18,0) to check for a VGA or SVGA system.
See also
fg_getrgb, fg_setdacs, fg_setrgb
Examples
5-12
87 �
fg_getentry
Prototype
void fg_getentry (int page_number, int *page_addr, int *page_type);
sub FGgetentry (page_number%, page_addr%, page_type%)
subroutine fg_getentry (int page_number, int page_addr, int page_type)
procedure fg_getentry (page_number : integer; var page_addr,
page_type : integer);
Description
The fg_getentry routine retrieves the type and address of a physical, virtual, or logical video page. This routine is useful for saving virtual or logical page contents across video mode changes.
Parameters
page_number is the number of the desired video page. It must be between 0 and 63.
page_addr is the address of the specified page. For physical pages, virtual pages, and logical pages in conventional memory, the address is an ordinary segment address. For logical pages in EMS or XMS memory, the page address is an EMS or XMS handle.
page_type is a return value indicating the page type, as shown here:
0 = unallocated page
1 = physical page
2 = virtual page
3 = logical page in expanded memory (EMS)
4 = logical page in extended memory (XMS)
5 = logical page in conventional memory
Return value
none
Restrictions
none
See also
fg_setentry
Examples
8-12
88 �
fg_gethpage
Prototype
int fg_gethpage (void); function FGgethpage% () int function fg_gethpage () function fg_gethpage : integer;
Description
The fg_gethpage routine returns the hidden video page number (as set in the most recent call to fg_sethpage).
Parameters
none
Return value
The number of the hidden video page, between 0 and 63.
Restrictions
none
See also
fg_sethpage
89 �
fg_getimage
Prototype
void fg_getimage (char *map_array, int width, int height); sub FGgetimage (map_array$, width%, height%) subroutine fg_getimage (int1 map_array, int width, int height) procedure fg_getimage (var map_array : byte; width, height : integer);
Description
The fg_getimage routine retrieves an image as a mode-specific bitmap. The graphics cursor position (the text cursor position in text video modes) defines the lower left corner of the image to retrieve. Refer to the Fastgraph User's Guide for complete information about mode-specific bitmaps.
Parameters
map_array is the name of the array that will receive the bitmap. In BASIC, you must explicitly declare map_array as a fixed-length string variable of length width*height.
width is the width in bytes of the bitmap.
height is the height in bytes (pixel rows) of the bitmap.
Return value
none
Restrictions
In 16-bit modes, the size of map_array is limited to 64K bytes.
See also
fg_clpimage, fg_drwimage, fg_flpimage, fg_getmap, fg_putimage, fg_revimage
Examples
10-12, 10-13, 10-17, 10-18
90 �
fg_getindex
Prototype
int fg_getindex (int index); function FGgetindex% (index%) int function fg_getindex (int index) function fg_getindex (index : integer) : integer;
Description
The fg_getindex routine returns the color value assigned to a specified virtual color index.
Parameters
index is the virtual color index to retrieve, between 0 and 255.
Return value
In graphics video modes with fewer than 256 available colors, the return value is the color value assigned to the specified virtual index. In text modes and 256-color graphics modes, fg_getindex returns the value passed to it.
Restrictions
none
See also
fg_defcolor, fg_palette, fg_setcolor
91 �
fg_getkey
Prototype
void fg_getkey (unsigned char *key, unsigned char *aux); sub FGgetkey (key$, aux$) subroutine fg_getkey (int1 key, int1 aux) procedure fg_getkey (var key, aux : byte);
Description
The fg_getkey routine waits for a keystroke, or reads the next entry from the BIOS keyboard buffer (without echo). It returns the keystroke's standard or extended keyboard code (a list of these appears in Chapter 14 of the Fastgraph User's Guide).
Parameters
key receives the keystroke's standard keyboard code if it represents a standard character. If the keystroke represents an extended character, key will be set to zero. In BASIC, you must explicitly declare key as a fixed- length string variable of length 1.
aux receives the keystroke's extended keyboard code if it represents an extended character. If the keystroke represents a standard character, aux will be set to zero. In BASIC, you must explicitly declare aux as a fixed- length string variable of length 1.
Return value
none
Restrictions
none
See also
fg_intkey, fg_kbtest, fg_waitkey
Examples
13-7, 13-8, 14-1, 16-2
92 �
fg_getlines
Prototype
int fg_getlines (void); function FGgetlines% () int function fg_getlines () function fg_getlines : integer;
Description
The fg_getlines routine returns the number of text rows per video page for the current video mode.
Parameters
none
Return value
The number of text rows per video page for the current video mode.
Restrictions
none
See also
fg_fontsize, fg_setlines
Examples
3-5
93 �
fg_getmap
Prototype
void fg_getmap (char *map_array, int width, int height); sub FGgetmap (map_array$, width%, height%) subroutine fg_getmap (int1 map_array, int width, int height) procedure fg_getmap (var map_array : byte; width, height : integer);
Description
The fg_getmap routine retrieves an image as a mode-independent bitmap. The graphics cursor position defines the lower left corner of the image to retrieve. Refer to the Fastgraph User's Guide for complete information about mode-independent bitmaps.
Parameters
map_array is the name of the array that will receive the bitmap. Each byte of map_array represents eight pixels. Pixels of the current color set the corresponding bits in map_array. Pixels of other colors make the corresponding map_array bits zero. In BASIC, you must explicitly declare map_array as a fixed-length string variable of length width*height.
width is the width in bytes of the bitmap.
height is the height in bytes (pixel rows) of the bitmap.
Return value
none
Restrictions
In 16-bit modes, the size of map_array is limited to 64K bytes.
This routine has no effect in text video modes.
See also
fg_clipmap, fg_drawmap, fg_getimage
Examples
10-10, 10-11
94 �
fg_getmaxx
Prototype
int fg_getmaxx (void); function FGgetmaxx% () int function fg_getmaxx () function fg_getmaxx : integer;
Description
The fg_getmaxx routine returns the maximum x coordinate in screen space when used in a graphics video mode. It returns the maximum column number in character space when used in a text mode. In either case, the maximum x coordinate is one less than the horizontal screen resolution.
Parameters
none
Return value
The maximum x coordinate.
Restrictions
none
See also
fg_getmaxy
Examples
4-1, 4-2
95 �
fg_getmaxy
Prototype
int fg_getmaxy (void); function FGgetmaxy% () int function fg_getmaxy () function fg_getmaxy : integer;
Description
The fg_getmaxy routine returns the maximum y coordinate in screen space when used in a graphics video mode. It returns the maximum row number in character space when used in a text mode. In either case, the maximum y coordinate is one less than the vertical screen resolution.
Parameters
none
Return value
The maximum y coordinate.
Restrictions
none
See also
fg_getmaxx
Examples
4-1, 4-2
96 �
fg_getmode
Prototype
int fg_getmode (void); function FGgetmode% () int function fg_getmode () function fg_getmode : integer;
Description
The fg_getmode routine returns the current video mode number. It is typically one of the first Fastgraph routines called in a program. The value returned by fg_getmode can be retained to restore the original video mode when a program transfers control back to DOS.
Parameters
none
Return value
The current video mode number, between 0 and 29. Refer to the description of fg_setmode for descriptions of each video mode.
Restrictions
none
See also
fg_setmode
Examples
3-3, 3-4, 3-5, 3-6, 3-7, 3-8, 3-10
97 �
fg_getpage
Prototype
int fg_getpage (void); function FGgetpage% () int function fg_getpage () function fg_getpage : integer;
Description
The fg_getpage routine returns the active video page number (as set in the most recent call to fg_setpage).
Parameters
none
Return value
The number of the active video page, between 0 and 63.
Restrictions
none
See also
fg_setpage
Examples
8-9
98 �
fg_getpixel
Prototype
int fg_getpixel (int ix, int iy); function FGgetpixel% (ix%, iy%) int function fg_getpixel (int ix, int iy) function fg_getpixel (ix, iy : integer) : integer;
Description
The fg_getpixel routine returns the color value of a specified pixel.
Parameters
ix is the pixel's screen space x coordinate.
iy is the pixel's screen space y coordinate.
Return value
The color value of the pixel, between 0 and one less than the number of colors available in the current video mode. If the (ix,iy) coordinates lie outside the clipping region, fg_getpixel returns -1. In text modes, fg_getpixel always returns zero.
Restrictions
none
See also
fg_point, fg_pointw
Examples
6-1
99 �
fg_getrgb
Prototype
void fg_getrgb (int number, int *red, int *green, int *blue); sub FGgetrgb (number%, red%, green%, blue%) subroutine fg_getrgb (int number, int red, int green, int blue) procedure fg_getrgb (number : integer; var red, green, blue : integer);
Description
The fg_getrgb routine returns the red, green, and blue color components for a specified video DAC register. Each color component is a value between 0 and 63; increasing values produce more intense colors.
Parameters
number is the video DAC register number. It must be between 0 and 15 in 16- color graphics modes, and between 0 and 255 in 256-color modes.
red, green, and blue respectively receive the red, green, and blue components of the specified video DAC register.
Return value
none
Restrictions
This routine has no effect in text video modes, or in any graphics video mode numbered 12 or below (because these video modes do not use DAC registers). This routine has no effect in modes 13, 14, and 16 when run on an EGA system.
See also
fg_getdacs, fg_palette, fg_setdacs, fg_setrgb
Examples
5-11
100 �
fg_getview
Prototype
void fg_getview (int *view_minx, int *view_maxx, int *view_miny,
int *view_maxy, int *minx, int *maxx, int *miny, int *maxy);
sub FGgetview (view_minx%, view_maxx%, view_miny%, view_maxy%, minx%,
maxx%, miny%, maxy%)
subroutine fg_getview (int view_minx, int view_maxx, int view_miny,
int view_maxy, int minx, int maxx, int miny, int maxy)
procedure fg_getview (var view_minx, view_maxx, view_miny, view_maxy,
minx, maxx, miny, maxy : integer);
Description
The fg_getview routine returns the viewport extremes in viewport units and screen space units.
Parameters
view_minx receives the viewport's left edge in viewport units.
view_maxx receives the viewport's right edge in viewport units.
view_miny receives the viewport's top edge in viewport units.
view_maxy receives the viewport's bottom edge in viewport units.
minx receives the viewport's left edge in screen space units.
maxx receives the viewport's right edge in screen space units.
miny receives the viewport's top edge in screen space units.
maxy receives the viewport's bottom edge in screen space units.
Return value
none
Restrictions
none
See also
fg_setview
101 �
fg_getvpage
Prototype
int fg_getvpage (void); function FGgetvpage% () int function fg_getvpage () function fg_getvpage : integer;
Description
The fg_getvpage routine returns the visual video page number (as set in the most recent call to fg_setvpage).
Parameters
none
Return value
The number of the visual video page, between 0 and 63.
Restrictions
none
See also
fg_setvpage
Examples
8-9
102 �
fg_getworld
Prototype
void fg_getworld (double *xmin, double *xmax, double *ymin, double *ymax); sub FGgetworld (xmin#, xmax#, ymin#, ymax#) subroutine fg_getworld (dbl xmin, dbl xmax, dbl ymin, dbl ymax) procedure fg_getworld (var xmin, xmax, ymin, ymax : real);
Description
The fg_getworld routine returns the current world space limits, as defined in the most recent call to fg_setworld.
Parameters
xmin receives the world space coordinate of the screen's left edge.
xmax receives the world space coordinate of the screen's right edge.
ymin receives the world space coordinate of the screen's bottom edge.
ymax receives the world space coordinate of the screen's top edge.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light.
See also
fg_setworld
Examples
4-4
103 �
fg_getxbox
Prototype
int fg_getxbox (void); function FGgetxbox% () int function fg_getxbox () function fg_getxbox : integer;
Description
The fg_getxbox routine returns the width in pixels of the left and right edges of rectangles drawn with the fg_box family of routines. By default, the width is one pixel, but this can be changed by calling fg_boxdepth.
Parameters
none
Return value
The width in pixels of the left and right sides (that is, the vertical edges) of rectangles drawn with the fg_box family of routines.
Restrictions
none
See also
fg_boxdepth, fg_getybox
104 �
fg_getxjoy
Prototype
int fg_getxjoy (int n); function FGgetxjoy% (n%) int function fg_getxjoy (int n) function fg_getxjoy (n : integer) : integer;
Description
The fg_getxjoy routine returns the horizontal coordinate position of the specified joystick. The actual coordinates depend on the processor speed and brand of joystick used.
Parameters
n specifies the joystick number, either 1 or 2.
Return value
If the return value is positive, it represents the current horizontal coordinate position of the requested joystick. If the return value is -1, it means the requested joystick has not been initialized or is not present.
Restrictions
Before using this routine, you must use fg_initjoy to initialize the requested joystick.
See also
fg_button, fg_getyjoy, fg_initjoy, fg_intjoy
Examples
14-12
105 �
fg_getxjust
Prototype
int fg_getxjust (void); function FGgetxjust% () int function fg_getxjust () function fg_getxjust : integer;
Description
The fg_getxjust routine returns the horizontal justification setting used by fg_print. The fg_setmode routine sets the default justification to -1, and its value may be changed with fg_justify.
Parameters
none
Return value
-1 = strings are left justified relative to the current graphics x position 0 = strings are centered about the current graphics x position 1 = strings are right justified relative to the current graphics x
position
Restrictions
none
See also
fg_getyjust, fg_justify
106 �
fg_getxpos
Prototype
int fg_getxpos (void); function FGgetxpos% () int function fg_getxpos () function fg_getxpos : integer;
Description
The fg_getxpos routine returns the screen space x coordinate of the graphics cursor position.
Parameters
none
Return value
The x coordinate of graphics cursor position.
Restrictions
none
See also
fg_getypos
107 �
fg_getybox
Prototype
int fg_getybox (void); function FGgetybox% () int function fg_getybox () function fg_getybox : integer;
Description
The fg_getybox routine returns the width in pixels of the top and bottom edges of rectangles drawn with the fg_box family of routines. By default, the width is one pixel, but this can be changed by calling fg_boxdepth.
Parameters
none
Return value
The width in pixels of the top and bottom sides (that is, the horizontal edges) of rectangles drawn with the fg_box family of routines.
Restrictions
none
See also
fg_boxdepth, fg_getxbox
108 �
fg_getyjoy
Prototype
int fg_getyjoy (int n); function FGgetyjoy% (n%) int function fg_getyjoy (int n) function fg_getyjoy (n : integer) : integer;
Description
The fg_getyjoy routine returns the vertical coordinate position of the specified joystick. The actual coordinates depend on the processor speed and brand of joystick used.
Parameters
n specifies the joystick number, either 1 or 2.
Return value
If the return value is positive, it represents the current vertical coordinate position of the requested joystick. If the return value is -1, it means the requested joystick has not been initialized or is not present.
Restrictions
Before using this routine, you must use fg_initjoy to initialize the requested joystick.
See also
fg_button, fg_getxjoy, fg_initjoy, fg_intjoy
Examples
14-12
109 �
fg_getyjust
Prototype
int fg_getyjust (void); function FGgetyjust% () int function fg_getyjust () function fg_getyjust : integer;
Description
The fg_getyjust routine returns the vertical justification setting used by fg_print. The fg_setmode routine sets the default justification to -1, and its value may be changed with fg_justify.
Parameters
none
Return value
-1 = strings will have their bottom edge at the current graphics y position 0 = strings are centered about the current graphics y position 1 = strings will have their top edge at the current graphics y position
Restrictions
none
See also
fg_getxjust, fg_justify
110 �
fg_getypos
Prototype
int fg_getypos (void); function FGgetypos% () int function fg_getypos () function fg_getypos : integer;
Description
The fg_getypos routine returns the screen space y coordinate of the graphics cursor position.
Parameters
none
Return value
The y coordinate of graphics cursor position.
Restrictions
none
See also
fg_getxpos
111 �
fg_gifhead
Prototype
int fg_gifhead (char *gif_file, char *gif_header); function FGgifhead% (gif_file$, gif_header$) int function fg_gifhead (char gif_file, int1 gif_header) function fg_gifhead (gif_file : string; var gif_header) : integer;
Description
The fg_gifhead routine reads the global header and first local header from the specified GIF file.
Parameters
gif_file is the name of the GIF file, terminated by a zero byte.
gif_header is name of the 23-byte buffer to receive the GIF file's global header and first local header. In BASIC, it must be a fixed-length 23-byte string.
Return value
0 = Success -1 = The specified file does not exist -2 = The specified file is not a GIF file
Restrictions
none
See also
fg_gifmode, fg_gifrange, fg_showgif
Examples
9-5
112 �
fg_gifmode
Prototype
int fg_gifmode (char *gif_header); function FGgifmode% (gif_header$) int function fg_gifmode (int1 gif_header) function fg_gifmode (var gif_header) : integer;
Description
The fg_gifmode routine determines the optimal video mode for the GIF image associated with the specified GIF file header. The optimal mode is the video mode having the lowest resolution larger than or equal to the image dimensions.
Parameters
gif_header is the name of the buffer containing the 23-byte GIF file header.
Return value
>0 = The optimal video mode for displaying the GIF image -1 = The gif_header buffer does not contain a valid GIF file header -2 = Cannot determine a compatible video mode
Restrictions
none
See also
fg_gifhead, fg_setmode, fg_showgif
Examples
9-5
113 �
fg_gifpal
Prototype
int fg_gifpal (char *gif_file, char *gif_palette); function FGgifpal% (gif_file$, gif_palette$) int function fg_gifpal (char gif_file, int1 gif_palette) function fg_gifpal (gif_file : string; var gif_palette) : integer;
Description
The fg_gifpal routine retrieves the palette of an image stored in a GIF file. The palette values are returned as RGB color components, each between 0 and 63. For video modes 18 and above, the palette values are suitable for fg_setdacs. For the native EGA graphics modes (13 to 16), the palette values must be converted into mode-specific values (with fg_maprgb) before being used with fg_palette or fg_palettes.
If the GIF file includes a local palette for the first image, fg_gifpal will return the values from the local palette. Otherwise, fg_gifpal will return the values from the GIF file's global palette.
Parameters
gif_file is the name of the GIF file. The file name must be terminated by a zero byte.
gif_palette is the name of the array that will receive the GIF palette values. The palette values are returned as RGB color components, each between 0 and 63. The first three bytes of gif_palette will contain the RGB values for color 0, the next three for color 1, and so forth. The size of the gif_palette array must be at least three times the number of colors in the GIF image.
Return value
>0 = the number of colors in the GIF palette -1 = file not found -2 = file is not a GIF file
Restrictions
none
See also
fg_maprgb, fg_palette, fg_palettes, fg_setdacs, fg_showgif
Examples
9-5
114 �
fg_gifrange
Prototype
void fg_gifrange (char *gif_header, int *minx, int *maxx, int *miny,
int *maxy);
sub FGgifrange (gif_header$, minx%, maxx%, miny%, maxy%)
subroutine fg_gifrange (int1 gif_header, int minx, int maxx, int miny,
int maxy)
procedure fg_gifrange (var gif_header; var minx, maxx, miny, maxy :
integer);
Description
The fg_gifrange routine returns the image extents for the GIF image associated with the specified GIF file header.
Parameters
gif_header is the name of the buffer containing the 23-byte GIF file header.
minx receives the x coordinate of the image's left edge. If gif_header does not contain a valid GIF file header, minx will be set to -1.
maxx receives the x coordinate of the image's right edge. If gif_header does not contain a valid GIF file header, maxx will be set to -1.
miny receives the y coordinate of the image's top edge. If gif_header does not contain a valid GIF file header, miny will be set to -1.
maxy receives the y coordinate of the image's bottom edge. If gif_header does not contain a valid GIF file header, maxy will be set to -1.
Return value
none
Restrictions
none
See also
fg_gifhead, fg_showgif
Examples
9-5
115 �
fg_hush
Prototype
void fg_hush (void); sub FGhush () subroutine fg_hush () procedure fg_hush;
Description
The fg_hush routine immediately stops asynchronous sound started with fg_musicb, fg_sounds, or fg_voices. It has no effect if there is no asynchronous sound in progress.
Parameters
none
Return value
none
Restrictions
none
See also
fg_hushnext, fg_musicb, fg_sounds, fg_suspend, fg_voices
Examples
15-7
116 �
fg_hushnext
Prototype
void fg_hushnext (void); sub FGhushnext () subroutine fg_hushnext () procedure fg_hushnext;
Description
The fg_hushnext routine stops asynchronous sound started with fg_musicb, fg_sounds, or fg_voices, but not until the current repetition finishes. It has no effect if there is no asynchronous sound in progress.
Parameters
none
Return value
none
Restrictions
This routine has no effect unless the asynchronous sound is continuous.
See also
fg_hush, fg_musicb, fg_sounds, fg_suspend, fg_voices
Examples
15-7
117 �
fg_imagebuf
Prototype
void fg_imagebuf (char [far] *buffer, unsigned size); sub FGimagebuf (buffer$, size%) subroutine fg_imagebuf (int1 [far] buffer, int size) procedure fg_imagebuf (buffer : pointer; size : word);
Description
The fg_imagebuf routine specifies the size and address of the buffer used internally when creating or displaying GIF, PCX, PPR, or SPR files. Fastgraph's default internal buffer size is 4,096 bytes. Image display or creation is typically faster when a larger buffer is used.
Parameters
buffer is the address of the internal buffer. It is passed by far reference in 16-bit modes except when using BASIC.
size is the buffer size in bytes. If size is zero, Fastgraph will use its own internal buffers when creating or displaying image files.
Return value
none
Restrictions
In real mode Pascal programs, buffer must be allocated dynamically with the GetMem procedure. This is the only way to pass something by far reference in Pascal.
See also
fg_dispfile, fg_flicplay, fg_makegif, fg_makepcx, fg_makeppr, fg_makespr, fg_showflic, fg_showgif, fg_showpcx, fg_showppr, fg_showspr
Examples
9-12
118 �
fg_imagesiz
Prototype
long fg_imagesiz (int width, int height); function FGimagesiz& (width%, height%) int4 function fg_imagesiz (int width, int height) function fg_imagesiz (width, height : integer) : longint;
Description
The fg_imagesiz routine determines the number of bytes required to store a mode-specific bitmapped image of specified dimensions.
Parameters
width specifies the image width in pixels.
height specifies the image height in pixels.
Return value
The number of bytes required to store a mode-specific bitmapped image of the specified size in the current video mode. The return value is always a 32-bit quantity.
Restrictions
none
See also
fg_clpimage, fg_drwimage, fg_flpimage, fg_getblock, fg_getimage, fg_putblock, fg_putimage, fg_revimage
Examples
10-12
119 �
fg_initems
Prototype
int fg_initems (void); function FGinitems% () int function fg_initems () function fg_initems : integer;
Description
The fg_initems routine initializes expanded memory (EMS) for use with Fastgraph.
Parameters
none
Return value
0 = success -1 = Expanded Memory Manager not installed or not accessible
Restrictions
This routine requires an Expanded Memory Manager (EMM) that conforms to the Lotus/Intel/Microsoft Expanded Memory Specification (LIM-EMS) version 3.2 or later. On 80386 and 80486 systems, the EMM386.EXE device driver supplied with DOS 5.0 can be used to treat some or all of extended memory as expanded memory.
After calling fg_setmode, the Expanded Memory Manager is disabled and must be re-initialized.
This routine is meaningful only in real mode. In protected mode, it will always return -1.
The Expanded Memory Manager uses interrupt 67h. As a result, this vector is not available for application programs.
See also
fg_allocems, fg_initxms
Examples
8-10
120 �
fg_initjoy
Prototype
int fg_initjoy (int n); function FGinitjoy% (n%) int function fg_initjoy (int n) function fg_initjoy (n : integer) : integer;
Description
The fg_initjoy routine initializes either joystick and must be called before using fg_getxjoy, fg_getyjoy, or fg_intjoy.
Parameters
n specifies the joystick number, either 1 or 2.
Return value
If the return value is 0, it means the joystick initialization was successful. If it is -1, it means the machine has no game port, or the requested joystick is not connected to the game port.
Restrictions
When you call fg_initjoy, Fastgraph assumes the requested joystick is centered.
See also
fg_button, fg_getxjoy, fg_getyjoy, fg_intjoy
Examples
14-11, 14-12, 14-13
121 �
fg_initpm
Prototype
void fg_initpm (void); sub FGinitpm () subroutine fg_initpm () procedure fg_initpm;
Description
The fg_initpm routine initializes Fastgraph's protected mode kernel for specific DOS extenders. It must be called before any other Fastgraph routine in protected mode programs.
Parameters
none
Return value
none
Restrictions
This routine is not meaningful in real mode.
Examples
1-1
122 �
fg_initw
Prototype
void fg_initw (void); sub FGinitw () subroutine fg_initw () procedure fg_initw;
Description
The fg_initw routine initializes Fastgraph's internal world space parameters. This routine must be called once, before any other routine that uses world space coordinates.
Parameters
none
Return value
none
Restrictions
This routine is not available in Fastgraph/Light.
Examples
4-4, 6-4, 6-9, 7-10, 7-11, 7-12, 7-13
123 �
fg_initxms
Prototype
int fg_initxms (void); function FGinitxms% () int function fg_initxms () function fg_initxms : integer;
Description
The fg_initxms routine initializes extended memory (XMS) for use with Fastgraph.
Parameters
none
Return value
0 = success -1 = XMS driver not installed or not accessible
Restrictions
This routine requires an external driver that conforms to the Lotus/Intel/Microsoft/AST eXtended Memory Specification (XMS) version 2.0, such as HIMEM.SYS. XMS drivers require an 80286, 80386, or 80486 system.
After calling fg_setmode, the XMS driver is disabled and must be re- initialized.
This routine is meaningful only in real mode. In protected mode, it will always return -1.
See also
fg_allocxms, fg_initems
Examples
8-10
124 �
fg_inside
Prototype
int fg_inside (int *vertex_array, int n, int ix, int iy);
function FGinside% (vertex_array%(), n%, ix%, iy%)
int function fg_inside (int vertex_array, int n, int ix, int iy)
function fg_inside (var vertex_array : integer; n, ix, iy : integer) :
integer;
Description
The fg_inside routine determines if the specified point is inside a convex polygon. The fg_polyoff offsets are applied to the polygon vertices but not to the test point.
Parameters
vertex_array is the name of the array containing the (x,y) coordinate pairs of each vertex. The first array element is the x component of the first vertex, the second element is the y component of the first vertex, the third element is the x component of the second vertex, and so forth.
n is the number of vertices in the polygon. Normally, it is one-half the size of vertex_array.
ix is the screen space x coordinate of the test point.
iy is the screen space y coordinate of the test point.
Return value
0 = the test point is outside the polygon 1 = the test point is inside the polygon
Restrictions
If vertex_array does not define a convex polygon, the return value is undefined.
In 16-bit modes, the size of vertex_array is limited to 64K bytes.
See also
fg_polyfill, fg_polyline, fg_polyoff
125 �
fg_intjoy
Prototype
void fg_intjoy (int n, char *key, char *aux); sub FGintjoy (n%, key$, aux$) subroutine fg_intjoy (int n, int1 key, int1 aux) procedure fg_intjoy (n : integer; var key, aux : byte);
Description
The fg_intjoy routine returns the standard and extended keyboard codes analogous to the current position and button status of the specified joystick.
Parameters
n specifies the joystick number, either 1 or 2.
key receives the joystick's button status. If any button on the requested joystick is pressed, key is set to 13, the standard keyboard code for the Enter key. If no buttons are pressed, key is set to zero. In BASIC, you must explicitly declare key as a fixed-length string variable of length 1.
aux receives the joystick's analog position, as listed below. In BASIC, you must explicitly declare aux as a fixed-length string variable of length 1.
joystick position corresponding key extended key code
up and left Home 71
up up arrow 72
up and right PgUp 73
left left arrow 75
centered (no action) 0
right right arrow 77
down and left End 79
down down arrow 80
down and right PgDn 81
If the requested joystick has not been initialized, both key and aux will be set to zero.
Return value
none
Restrictions
Before using this routine, you must use fg_initjoy to initialize the requested joystick.
See also
fg_button, fg_getxjoy, fg_getyjoy, fg_initjoy, fg_intkey
126 �
fg_intjoy (continued)
Examples
14-13
127 �
fg_intkey
Prototype
void fg_intkey (unsigned char *key, unsigned char *aux); sub FGintkey (key$, aux$) subroutine fg_intkey (int1 key, int1 aux) procedure fg_intkey (var key, aux : byte);
Description
The fg_intkey routine reads the next entry from the BIOS keyboard buffer (without echo) and returns the keystroke's standard or extended keyboard code (a list of these appears in Chapter 14 of the Fastgraph User's Guide). It is similar to fg_getkey, but it does not wait for a keystroke if the keyboard buffer is empty.
Parameters
key receives the keystroke's standard keyboard code if it represents a standard character. If the keystroke represents an extended character, key will be set to zero. In BASIC, you must explicitly declare key as a fixed- length string variable of length 1.
aux receives the keystroke's extended keyboard code if it represents an extended character. If the keystroke represents a standard character, aux will be set to zero. In BASIC, you must explicitly declare aux as a fixed- length string variable of length 1.
If the BIOS keyboard buffer is empty, both key and aux will be set to zero.
Return value
none
Restrictions
none
See also
fg_getkey, fg_intjoy, fg_kbtest, fg_waitkey
Examples
14-2, 15-7, 16-1, 16-3
128 �
fg_invert
Prototype
void fg_invert (char *map_array, int width, int height); sub FGinvert (map_array$, width%, height%) subroutine fg_invert (int1 map_array, int width, int height) procedure fg_invert (var map_array; width, height : integer);
Description
The fg_invert routine inverts the orientation of a mode-specific or mode- independent bitmapped image. Fastgraph's bitmapped image display routines expect the image to be stored starting with the bottom row and proceeding toward the top. The fg_invert routine will reverse the row order of such images, so that a "top to bottom" image becomes a "bottom to top" image, or vice versa.
Parameters
map_array is the name of the array containing the bitmap.
width is the width in bytes of the bitmap.
height is the height in bytes (pixel rows) of the bitmap.
Return value
none
Restrictions
In 16-bit modes, the size of map_array is limited to 64K bytes.
See also
fg_clipmap, fg_clpimage, fg_drawmap, fg_drwimage, fg_flpimage, fg_putimage, fg_revimage
Examples
10-14
129 �
fg_justify
Prototype
void fg_justify (int xjust, int yjust); sub FGjustify (xjust%, yjust%) subroutine fg_justify (int xjust, int yjust) procedure fg_justify (xjust, yjust : integer);
Description
The fg_justify routine defines the horizontal and vertical justification settings for strings displayed with fg_print and fg_printc.
Parameters
xjust defines the horizontal justification. If xjust is -1, strings will be displayed left justified relative to the current graphics x position. If xjust is 0, strings will be centered about the x position. If xjust is 1, strings will be right justified.
yjust defines the vertical justification. If yjust is -1, the bottom of the characters will be the current graphics y position. If yjust is 0, strings will be centered about the y position. If yjust is 1, the top of the characters will be at the y position.
Return value
none
Restrictions
The values of xjust and yjust must be -1, 0, or 1.
See also
fg_getxjust, fg_getyjust, fg_print, fg_printc
Examples
7-6, 10-17, 10-18, 13-7, 13-9
130 �
fg_kbinit
Prototype
void fg_kbinit (int state); sub FGkbinit (state%) subroutine fg_kbinit (int state) procedure fg_kbinit (state : integer);
Description
The fg_kbinit routine enables or disables Fastgraph's low-level keyboard handler. If the keyboard handler is already in the requested state, nothing happens.
Parameters
state is a flag specifying if the keyboard handler is to be enabled (state = 1) or disabled (state = 0).
Return value
none
Restrictions
When the low-level keyboard handler is enabled, it is not possible to use fg_getkey, fg_intkey, fg_waitkey, or any third party functions that use BIOS or DOS services to access the keyboard.
See also
fg_kblast, fg_kbreset, fg_kbtest
Examples
14-5
131 �
fg_kblast
Prototype
int fg_kblast (void); function FGkblast% () int function fg_kblast () function fg_kblast : integer;
Description
The fg_kblast routine returns the scan code for the most recent keypress processed by Fastgraph's low-level keyboard handler.
Parameters
none
Return value
The scan code for the most recent keypress processed by the low-level keyboard handler. If there have been no key presses since calling fg_kbinit, the return value will be zero.
Restrictions
The low-level keyboard handler must be enabled for fg_kblast to work properly.
See also
fg_kbinit, fg_kbreset, fg_kbtest
132 �
fg_kbreset
Prototype
void fg_kbreset (void); sub FGkbreset () subroutine fg_kbreset () procedure fg_kbreset;
Description
The fg_kbreset routine resets the state of Fastgraph's low-level keyboard handler to what it was after being initialized with fg_kbinit(1).
Parameters
none
Return value
none
Restrictions
The low-level keyboard handler must be enabled for fg_kbreset to work properly.
See also
fg_kbinit, fg_kblast, fg_kbtest
133 �
fg_kbtest
Prototype
int fg_kbtest (int scan_code); function FGkbtest% (scan_code%) int function fg_kbtest (int scan_code) function fg_kbtest (scan_code : integer) : integer;
Description
The fg_kbtest routine determines if the key having the specified scan code is now pressed or released.
Parameters
scan_code is the scan code of the key to check, or zero. If scan_code is zero, fg_kbtest reports whether any key is pressed. Refer to the Fastgraph User's Guide for a list of scan codes.
Return value
0 = key is released 1 = key is pressed
Restrictions
The low-level keyboard handler must be enabled for fg_kbtest to work properly.
See also
fg_kbinit, fg_kblast, fg_kbreset
Examples
14-5
134 �
fg_loadpcx
Prototype
int fg_loadpcx (char *filename, int flags); function FGloadpcx% (filename$, flags%) int function fg_loadpcx (char filename, int flags) function fg_loadpcx (filename : string; flags : integer) : integer;
Description
The fg_loadpcx routine loads a PCX image into the active virtual buffer.
Parameters
filename is the name of the PCX file. A device and path name may be included as part of the file name. The file name must be terminated by a zero byte.
flags is a bit mask that controls how the image is displayed.
Bit 0
0 = use palette values stored in the PCX file
1 = use the current palette settings
Bit 1
0 = load image at position indicated in PCX header
1 = load image at current graphics position
Bit 2
0 = load image from the specified PCX file
1 = load image from the fg_imagebuf buffer
Bits 3-15 are reserved for future use and should be zero.
Return value
0 = success 1 = file not found 2 = file is not a PCX file
Restrictions
none
See also
fg_showpcx, fg_vbopen
Examples
9-2, 10-19, 13-8
135 �
fg_locate
Prototype
void fg_locate (int row, int column); sub FGlocate (row%, column%) subroutine fg_locate (int row, int column) procedure fg_locate (row, column : integer);
Description
The fg_locate routine changes the text cursor position for the active display page. The fg_setmode routine sets each page's text cursor position to (0,0).
Parameters
row is the text cursor's destination row number, between 0 and one less than the number of character rows available.
column is text cursor's destination column number, between 0 and one less than the number of character columns available.
Return value
none
Restrictions
The first eight video pages (0 to 7) each have their own text cursor. Each subsequent group of 8 video pages (pages 8 through 15, pages 16 to 23, and so forth) respectively share the same text cursor positions as the first 8 pages. For example, changing the text cursor position on video page 9 also changes its position on video page 1.
See also
fg_text, fg_textc, fg_where
Examples
7-1, 7-2, 7-3, 7-4, 7-5, 7-7, 7-8, 7-9, 7-10
136 �
fg_makegif
Prototype
int fg_makegif (int minx, int maxx, int miny, int maxy, char *filename); function FGmakegif% (minx%, maxx%, miny%, maxy%, filename$) int function fg_makegif (int minx, int maxx, int miny, int maxy, char filename) function fg_makegif (minx, maxx, miny, maxy : integer; filename : string) : integer;
Description
The fg_makegif routine creates a GIF file from the specified rectangular region of the active video page or virtual buffer. The region's extremes are expressed in screen space units.
Parameters
minx is the x coordinate of the region's left edge.
maxx is the x coordinate of the region's right edge. It must be greater than or equal to minx.
miny is the y coordinate of the region's top edge.
maxy is the y coordinate of the region's bottom edge. It must be greater than or equal to miny.
filename is the name of the GIF file to create. A device and path name may be included as part of the file name. The file name must be terminated by a null character (that is, a zero byte). If an identically named file already exists, it is overwritten.
Return value
0 = success 1 = file not created
Restrictions
The fg_makegif routine has no effect in text video modes, or in the CGA and Hercules graphics modes.
In the Tandy/PCjr 16-color graphics mode (mode 9) and the native EGA graphics modes (modes 13 through 16), the palette registers are not readable. Hence, fg_makegif will use the default palette settings when used in these video modes on Tandy or EGA systems.
See also
fg_imagebuf, fg_makepcx, fg_makeppr, fg_makespr, fg_showgif
137 �
fg_makegif (continued)
Examples
9-4
138 �
fg_makepcx
Prototype
int fg_makepcx (int minx, int maxx, int miny, int maxy, char *filename);
function FGmakepcx% (minx%, maxx%, miny%, maxy%, filename$)
int function fg_makepcx (int minx, int maxx, int miny, int maxy,
char filename)
function fg_makepcx (minx, maxx, miny, maxy : integer; filename : string) :
integer;
Description
The fg_makepcx routine creates a PCX file from the specified rectangular region of the active video page or virtual buffer. The region's extremes are expressed in screen space units.
Parameters
minx is the x coordinate of the region's left edge. Its value is reduced to a byte boundary if necessary.
maxx is the x coordinate of the region's right edge. It must be greater than or equal to minx.
miny is the y coordinate of the region's top edge.
maxy is the y coordinate of the region's bottom edge. It must be greater than or equal to miny.
filename is the name of the PCX file to create. A device and path name may be included as part of the file name. The file name must be terminated by a null character (that is, a zero byte). If an identically named file already exists, it is overwritten.
Return value
0 = success 1 = file not created
Restrictions
The fg_makepcx routine has no effect in text video modes or in the Hercules low-resolution graphics mode. Refer to the description of fg_showpcx for information about PCX file compatibility between different video modes.
In the Tandy/PCjr 16-color graphics mode (mode 9) and the native EGA graphics modes (modes 13 through 16), the palette registers are not readable. Hence, fg_makepcx will use the default palette settings when used in these video modes on Tandy or EGA systems.
When a virtual buffer is active, fg_makepcx always creates 256-color PCX files, regardless of the current video mode. If the video mode is not a 256-color video mode, the 256-color PCX file will not have an extended palette.
139 �
fg_makepcx (continued)
See also
fg_imagebuf, fg_makegif, fg_makespr, fg_makeppr, fg_showpcx
Examples
9-1
140 �
fg_makeppr
Prototype
int fg_makeppr (int minx, int maxx, int miny, int maxy, char *filename);
function FGmakeppr% (minx%, maxx%, miny%, maxy%, filename$)
int function fg_makeppr (int minx, int maxx, int miny, int maxy,
char filename)
function fg_makeppr (minx, maxx, miny, maxy : integer; filename : string) :
integer;
Description
The fg_makeppr routine creates a packed pixel run (PPR) file from the specified rectangular region of the active video page or virtual buffer. The region's extremes are expressed in screen space units.
Parameters
minx is the x coordinate of the region's left edge.
maxx is the x coordinate of the region's right edge. It must be greater than or equal to minx.
miny is the y coordinate of the region's top edge.
maxy is the y coordinate of the region's bottom edge. It must be greater than or equal to miny.
filename is the name of the PPR file to create. A device and path name may be included as part of the file name. The file name must be terminated by a null character (that is, a zero byte). If an identically named file already exists, it is overwritten.
Return value
0 = success 1 = file not created
Restrictions
This routine has no effect in text video modes.
See also
fg_imagebuf, fg_makegif, fg_makepcx, fg_makespr, fg_showppr
141 �
fg_makespr
Prototype
int fg_makespr (int minx, int maxx, int miny, int maxy, char *filename);
function FGmakespr% (minx%, maxx%, miny%, maxy%, filename$)
int function fg_makespr (int minx, int maxx, int miny, int maxy,
char filename)
function fg_makespr (minx, maxx, miny, maxy : integer; filename : string) :
integer;
Description
The fg_makespr routine creates a standard pixel run (SPR) file from the specified rectangular region of the active video page or virtual buffer.
Parameters
minx is the x coordinate of the region's left edge. Its value is reduced to a byte boundary if necessary.
maxx is the x coordinate of the region's right edge. It must be greater than or equal to minx.
miny is the y coordinate of the region's top edge.
maxy is the y coordinate of the region's bottom edge. It must be greater than or equal to miny.
filename is the name of the SPR file to create. A device and path name may be included as part of the file name. The file name must be terminated by a null character (that is, a zero byte). If an identically named file already exists, it is overwritten.
Return value
0 = success 1 = file not created
Restrictions
This routine has no effect in text video modes.
See also
fg_imagebuf, fg_makegif, fg_makepcx, fg_makeppr, fg_showspr
Examples
9-9
142 �
fg_maprgb
Prototype
int fg_maprgb (int red, int green, int blue); function FGmaprgb% (red%, green%, blue%) int function fg_maprgb (int red, int green, int blue) function fg_maprgb (red, green, blue : integer) : integer;
Description
The fg_maprgb routine maps six-bit red, green, and blue color components into a suitable palette value for the current video mode. You can then pass this value to fg_palette.
Parameters
red, green, and blue respectively specify the color's red, green, and blue components. These values must be between 0 and 63; increasing values produce more intense colors.
Return value
The mode-specific palette value for the specified color components.
Restrictions
This routine is meaningful only in 16-color graphics video modes.
See also
fg_palette, fg_palettes, fg_setrgb
Examples
5-13
143 �
fg_measure
Prototype
int fg_measure (void); function FGmeasure% () int function fg_measure () function fg_measure : integer;
Description
The fg_measure routine returns the approximate number of delay units per clock tick. This quantity is proportional to the system's processor speed. Delay units are used by fg_stall.
Parameters
none
Return value
The approximate number of delay units per clock tick. Typical values for some common systems are:
system delay units
type per clock tick
Tandy 1000 HX 280
25 MHz 80386 3,400
40 MHz 80386 7,100
Restrictions
none
See also
fg_stall
Examples
13-9, 16-3
144 �
fg_memavail
Prototype
long fg_memavail (void); function FGmemavail& () int4 function fg_memavail () function fg_memavail : longint;
Description
The fg_memavail routine determines the amount of conventional memory available to DOS.
Parameters
none
Return value
The amount of conventional memory (in bytes) available to DOS. The return value is always a 32-bit quantity.
Restrictions
none
Examples
17-1
145 �
fg_memory
Prototype
int fg_memory (void); function FGmemory% () int function fg_memory () function fg_memory : integer;
Description
The fg_memory routine returns the amount of video memory present (in kilobytes) on the user's SVGA card.
Parameters
none
Return value
The amount of video memory in kilobytes. For example, if the user's SVGA card has 1MB of video memory installed, the return value will be 1,024.
Restrictions
This routine is only meaningful after successfully initializing Fastgraph's SVGA kernel with fg_svgainit.
See also
fg_svgainit
Examples
3-9, 8-8
146 �
fg_mouse256
Prototype
void fg_mouse256 (char *masks, int xoffset, int yoffset); sub FGmouse256 (masks$, xoffset%, yoffset%) subroutine fg_mouse256 (int1 masks, int xoffset, int yoffset) procedure fg_mouse256 (var masks; xoffset, yoffset : integer);
Description
The fg_mouse256 routine defines the shape and appearance of a multicolored mouse cursor in XVGA and 256-color SVGA graphics modes. Refer to Chapter 14 of the Fastgraph User's Guide for complete information about defining the mouse cursor in graphics modes.
Parameters
masks is a 512-byte array containing the 256-element screen mask followed by the 256-element cursor mask. The mouse driver displays the mouse cursor by logically ANDing video memory with the screen mask, and then XORing that result with the cursor mask. The first item of each mask corresponds to the top row of the mouse cursor. Screen mask values are typically 0 or 255, while cursor mask values are between 0 and 255.
xoffset is the x coordinate of the "hot spot" relative to the upper left corner of the mouse cursor.
yoffset The y coordinate of the "hot spot" relative to the upper left corner of the mouse cursor.
Return value
none
Restrictions
This routine is meaningful only in XVGA and 256-color SVGA graphics modes.
See also
fg_mouseini, fg_mouseptr, fg_mousevis
147 �
fg_mousebut
Prototype
void fg_mousebut (int number, int *count, int *lastx, int *lasty);
sub FGmousebut (number%, count%, lastx%, lasty%)
subroutine fg_mousebut (int number, int count, int lastx, int lasty)
procedure fg_mousebut (number : integer; var count, lastx, lasty :
integer);
Description
The fg_mousebut routine returns information about mouse button press or release counts, as well as the mouse cursor position at the time of the last button press or release.
Parameters
number is the mouse button for which to report information (1 means the left button, 2 the right button, and 3 the middle button). If number is positive, button press counts will be reported. If it is negative, release counts will be reported.
count receives the number of press or release counts for the requested button since the last check, or since calling fg_mouseini.
lastx receives the x coordinate (in screen space) of the mouse cursor position at the time of the last press or release of the requested button. If count is zero, lastx is also set to zero.
lasty receives the y coordinate (in screen space) of the mouse cursor position at the time of the last press or release of the requested button. If count is zero, lasty is also set to zero.
Return value
none
Restrictions
none
See also
fg_mousepos
Examples
14-8
148 �
fg_mousecur
Prototype
void fg_mousecur (int screen_mask, int cursor_mask); sub FGmousecur (screen_mask%, cursor_mask%) subroutine fg_mousecur (int screen_mask, int cursor_mask) procedure fg_mousecur (screen_mask, cursor_mask : integer);
Description
The fg_mousecur routine defines the appearance of the mouse cursor in text video modes. Refer to Chapter 14 of the Fastgraph User's Guide for complete information about defining the mouse cursor in text modes.
Parameters
screen_mask defines the screen mask. When you position the mouse over a specific character cell, the mouse driver logically ANDs the screen mask with the existing contents of that cell.
cursor_mask defines the cursor mask. After logically ANDing the screen mask with the contents of a character cell, the mouse driver XORs the cursor mask with the result to produce the mouse cursor.
The binary structure of screen_mask and cursor_mask is:
bits meaning
0 to 7 ASCII character value
8 to 11 foreground color
12 to 14background color
15 blink
Return value
none
Restrictions
This routine has no effect in graphics video modes.
See also
fg_mouseini, fg_mouseptr, fg_mousevis
Examples
14-9
149 �
fg_mousefin
Prototype
void fg_mousefin (void); sub FGmousefin () subroutine fg_mousefin () procedure fg_mousefin;
Description
The fg_mousefin routine unhooks Fastgraph's XVGA or SVGA mouse handler from the mouse driver. This routine should be used just before reverting to a text mode in programs that have called fg_mouseini in XVGA or SVGA graphics modes.
Parameters
none
Return value
none
Restrictions
This routine is only meaningful in XVGA and SVGA graphics modes.
See also
fg_mouseini
150 �
fg_mouseini
Prototype
int fg_mouseini (void); function FGmouseini% () int function fg_mouseini () function fg_mouseini : integer;
Description
The fg_mouseini routine initializes the mouse and must be called before any of Fastgraph's other mouse support routines.
Parameters
none
Return value
If the return value is positive, it indicates the number of buttons on the mouse being used (2 or 3). If the return value is -1, it means the initialization failed because the mouse driver has not been loaded or the mouse is not physically connected.
Restrictions
This routine is not functional when a virtual buffer is active.
See also
fg_mouse256, fg_mousebut, fg_mousecur, fg_mousefin, fg_mouselim, fg_mousemov, fg_mousepos, fg_mouseptr, fg_mousespd, fg_mousevis, fg_resize
Examples
14-6, 14-7, 14-8, 14-9, 14-10
151 �
fg_mouselim
Prototype
void fg_mouselim (int minx, int maxx, int miny, int maxy); sub FGmouselim (minx%, maxx%, miny%, maxy%) subroutine fg_mouselim (int minx, int maxx, int miny, int maxy) procedure fg_mouselim (minx, maxx, miny, maxy : integer);
Description
The fg_mouselim routine defines the rectangular area in which the mouse cursor may move. In graphics modes, the area is defined in screen space coordinates. In text modes, it is defined in rows and columns.
Parameters
minx is the x coordinate of the area's left edge.
maxx is the x coordinate of the area's right edge. It must be greater than or equal to the value of minx.
miny is the y coordinate of the area's top edge.
maxy is the y coordinate of the area's bottom edge. It must be greater than or equal to the value of miny.
Return value
none
Restrictions
none
See also
fg_mouseini, fg_mousemov
Examples
14-7
152 �
fg_mousemov
Prototype
void fg_mousemov (int ix, int iy); sub FGmousemov (ix%, iy%) subroutine fg_mousemov (int ix, int iy) procedure fg_mousemov (ix, iy : integer);
Description
The fg_mousemov routine moves the mouse cursor to the specified character cell (in text modes) or screen space position (in graphics modes). The mouse cursor is moved whether or not it is currently visible.
Parameters
ix is the x coordinate of the new mouse cursor position.
iy is the y coordinate of the new mouse cursor position.
Return value
none
Restrictions
If you attempt to move the mouse cursor outside the area defined by fg_mouselim, fg_mousemov positions the cursor at the nearest point possible within that area.
See also
fg_mouseini, fg_mouselim
Examples
14-7
153 �
fg_mousepos
Prototype
void fg_mousepos (int *ix, int *iy, int *buttons); sub FGmousepos (ix%, iy%, buttons%) subroutine fg_mousepos (int ix, int iy, int buttons) procedure fg_mousepos (var ix, iy, buttons : integer);
Description
The fg_mousepos routine returns the current mouse position and button status. In graphics modes, the position is defined in screen space coordinates. In text modes, it is defined in rows and columns.
Parameters
ix receives the x coordinate of the mouse cursor position.
iy receives the y coordinate of the mouse cursor position.
buttons receives a bit mask representing the button status, where each bit is set if the corresponding button is pressed. Bit 0 corresponds to the left button, bit 1 to the right button, and bit 2 to the middle button.
Return value
none
Restrictions
none
See also
fg_mousebut, fg_mouseini
Examples
14-8
154 �
fg_mouseptr
Prototype
void fg_mouseptr (short *masks, int xoffset, int yoffset);
sub FGmouseptr (masks%(), xoffset%, yoffset%)
subroutine fg_mouseptr (int2 masks, int xoffset, int yoffset)
procedure fg_mouseptr (var masks : integer; xoffset, yoffset :
integer);
Description
The fg_mouseptr routine defines the shape and appearance of the mouse cursor in graphics video modes. Refer to Chapter 14 of the Fastgraph User's Guide for complete information about defining the mouse cursor in graphics modes.
Parameters
masks is a 32-element array containing the 16-element screen mask followed by the 16-element cursor mask. The mouse driver displays the mouse cursor by logically ANDing video memory with the screen mask, and then XORing that result with the cursor mask. The first item of each mask corresponds to the top row of the mouse cursor. The following table summarizes the cursor appearance for all possible combinations of mask bits.
screen mask bit cursor mask bit resulting cursor pixel
0 0 black
0 1 white
1 0 unchanged
1 1 inverted
xoffset is the x coordinate of the "hot spot" relative to the upper left corner of the mouse cursor.
yoffset is the y coordinate of the "hot spot" relative to the upper left corner of the mouse cursor.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_mouse256, fg_mousecur, fg_mouseini, fg_mousevis
Examples
14-10
155 �
fg_mousespd
Prototype
void fg_mousespd (int xmickeys, int ymickeys); sub FGmousespd (xmickeys%, ymickeys%) subroutine fg_mousespd (int xmickeys, int ymickeys) procedure fg_mousespd (xmickeys, ymickeys : integer);
Description
The fg_mousespd routine defines the number of mickey units per eight pixels of cursor movement (depending on the mouse driver, one mickey unit equals 1/200 or 1/400 of an inch). This effectively controls the speed at which the mouse cursor moves relative to the movement of the mouse itself.
Parameters
xmickeys is the number of mickey units per eight pixels of horizontal mouse cursor movement (the default is 8).
ymickeys is the number of mickey units per eight pixels of vertical mouse cursor movement (the default is 16).
Return value
none
Restrictions
none
See also
fg_mouseini
Examples
14-7
156 �
fg_mousevis
Prototype
void fg_mousevis (int state); sub FGmousevis (state%) subroutine fg_mousevis (int state) procedure fg_mousevis (state : integer);
Description
The fg_mousevis routine makes the mouse cursor visible or invisible. After calling fg_mouseini, the mouse cursor is invisible.
Parameters
state defines the mouse cursor visibility. If state is 0, the mouse cursor is made invisible. If it is 1, the mouse cursor is made visible.
Return value
none
Restrictions
none
See also
fg_mouseini
Examples
14-7, 14-8, 14-9, 14-10
157 �
fg_move
Prototype
void fg_move (int ix, int iy); sub FGmove (ix%, iy%) subroutine fg_move (int ix, int iy) procedure fg_move (ix, iy : integer);
Description
The fg_move routine establishes the graphics cursor position at an absolute screen space point. The fg_setmode routine sets the graphics cursor position to (0,0).
Parameters
ix is the screen space x coordinate of the graphics cursor's new position.
iy is the screen space y coordinate of the graphics cursor's new position.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_moverel, fg_moverw, fg_movew
Examples
6-2, 6-3, 6-5, 6-6, 6-10, 6-17, 7-6, 9-9, 9-10, 9-11, 10-1, 12-4, 12-5, 12-6, 13-5, 13-6
158 �
fg_moverel
Prototype
void fg_moverel (int ix, int iy); sub FGmoverel (ix%, iy%) subroutine fg_moverel (int ix, int iy) procedure fg_moverel (ix, iy : integer);
Description
The fg_moverel routine establishes the graphics cursor position at a screen space point relative to the current position.
Parameters
ix is the screen space x offset of the graphics cursor's new position.
iy is the screen space y offset of the graphics cursor's new position.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_move, fg_moverw, fg_movew
Examples
6-3
159 �
fg_moverw
Prototype
void fg_moverw (double x, double y); sub FGmoverw (x#, y#) subroutine fg_moverw (dbl x, dbl y) procedure fg_moverw (x, y : real);
Description
The fg_moverw routine establishes the graphics cursor position at a world space point relative to the current position.
Parameters
x is the world space x offset of the graphics cursor's new position.
y is the world space y offset of the graphics cursor's new position.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_move, fg_moverel, fg_movew
160 �
fg_movew
Prototype
void fg_movew (double x, double y); sub FGmovew (x#, y#) subroutine fg_movew (dbl x, dbl y) procedure fg_movew (x, y : real);
Description
The fg_movew routine establishes the graphics cursor position at an absolute world space point. The fg_initw routine sets the graphics cursor position to (0.0,0.0).
Parameters
x is the world space x coordinate of the graphics cursor's new position.
y is the world space y coordinate of the graphics cursor's new position.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_move, fg_moverel, fg_moverw
Examples
4-4, 6-4, 6-9, 7-10, 7-11, 7-12, 7-13
161 �
fg_music
Prototype
void fg_music (char *music_string); sub FGmusic (music_string$) subroutine fg_music (char music_string) procedure fg_music (music_string : string);
Description
The fg_music routine uses the programmable timer to play a sequence of musical tones.
Parameters
music_string is an arbitrary-length sequence of music commands, followed by a dollar-sign ($) terminator. Music commands are summarized in the following table:
command meaning
A thru G Play the specified note in the current octave.
- May be appended to a note character (A through G) to make that note
sharp.
. May be appended to a note character (A through G) or a sharp (#) to
extend that note by half its normal length. Multiple dots may be used,
and each will again extend the note by half as much as the previous
extension.
Ln Set the length of subsequent notes and pauses. The value of n is an
integer between 1 and 64, where 1 indicates a whole note, 2 a half
note, 4 a quarter note, and so forth. If no L command is present, L4
is assumed.
On Set the octave for subsequent notes. The value of n may be an integer
between 0 and 6 to set a specific octave. It also can be a plus (+) or
minus (-) character to increment or decrement the current octave
number. Octave 4 contains middle C, and if no O command is present, O4
is assumed.
P Pause (rest) for the duration specified by the most recent L command.
Sn Set the amount of silence between notes. The value of n is an integer
between 0 and 2. If n is 0, each note plays for the full period set by
the L command (music legato). If n is 1, each note plays for 7/8 the
period set by the L command (music normal). If n is 2, each note plays
for 3/4 the period set by the L command (music staccato). If no S
command is present, S1 is assumed.
Tn Set the tempo of the music (the number of quarter notes per minute).
The value of n is an integer between 32 and 255. If no T command is
present, T120 is assumed.
162 �
fg_music (continued)
Parameters (continued)
The fg_music routine ignores any other characters in music_string. It also ignores command values outside the allowable range, such as T20 or O8.
Return value
none
Restrictions
This routine has no effect if there is asynchronous sound in progress.
See also
fg_musicb
Examples
15-3
163 �
fg_musicb
Prototype
void fg_musicb (char *music_string, int ntimes); sub FGmusicb (music_string$, ntimes%) subroutine fg_musicb (char music_string, int ntimes) procedure fg_musicb (music_string : string; ntimes : integer);
Description
The fg_musicb routine uses the programmable timer to play a sequence of musical tones, concurrent with other activity.
Parameters
music_string is an arbitrary-length sequence of music commands, followed by a dollar-sign ($) terminator. Refer to the description of fg_music for a complete list of music commands.
ntimes specifies the number of times to cycle through the music commands in music_string. If ntimes is negative, the music will play repetitively until you stop it with fg_hush or fg_hushnext.
Return value
none
Restrictions
This routine has no effect if there is asynchronous sound already in progress.
To allow for fast-tempo music, Fastgraph temporarily quadruples the clock tick interrupt rate from 18.2 to 72.8 ticks per second while producing asynchronous sound. Because many disk controllers rely on the 18.2 tick per second clock rate to synchronize disk accesses, your programs should not perform any disk operations when asynchronous sound is in progress.
See also
fg_hush, fg_hushnext, fg_music, fg_playing, fg_resume, fg_suspend
Examples
15-6, 15-7, 15-8
164 �
fg_numlock
Prototype
int fg_numlock (void); function FGnumlock% () int function fg_numlock () function fg_numlock : integer;
Description
The fg_numlock routine determines the state of the NumLock key.
Parameters
none
Return value
If the return value is 0, it means the NumLock key is off. If it is 1, it means the NumLock key is on.
Restrictions
none
See also
fg_capslock, fg_scrlock, fg_setcaps, fg_setnum
Examples
14-4
165 �
fg_pack
Prototype
void fg_pack (char *source, char *dest, int width, int height); sub FGpack (source$, dest$, width%, height%) subroutine fg_pack (int1 source, int1 dest, int width, int height) procedure fg_pack (var source, dest; width, height : integer);
Description
The fg_pack routine converts a bitmap in the "one pixel per byte" format used in 256-color graphics modes and virtual buffers to the mode-specific bitmap format for the current video mode. Refer to the Fastgraph User's Guide for complete information about mode-specific bitmaps.
In 256-color graphics modes, or when a virtual buffer is active, fg_pack merely copies the source array to the dest array.
Parameters
source is the name of the array containing the "one pixel per byte" bitmap to convert.
dest is the name of the array that will receive the converted bitmap.
width is the width of the source bitmap in pixels.
height is the height of the source bitmap in pixels.
Return value
none
Restrictions
In 16-bit modes, the size of the source and dest arrays is limited to 64K bytes.
This routine has no effect in text video modes.
See also
fg_clpimage, fg_drwimage, fg_flpimage, fg_getimage, fg_putimage, fg_revimage, fg_scale, fg_shear, fg_unpack
Examples
10-15
166 �
fg_pagesize
Prototype
long fg_pagesize (void); function FGpagesize& () int4 function fg_pagesize () function fg_pagesize : longint;
Description
The fg_pagesize routine returns the video page size in bytes for the current video mode.
Parameters
none
Return value
The video page size in bytes. The return value is always a 32-bit quantity.
Restrictions
This routine always returns the video page size, even when a virtual buffer is active.
167 �
fg_paint
Prototype
void fg_paint (int ix, int iy); sub FGpaint (ix%, iy%) subroutine fg_paint (int ix, int iy) procedure fg_paint (ix, iy : integer);
Description
The fg_paint routine fills an arbitrary closed region with the current color value. The region is defined by specifying a screen space point within its interior.
Parameters
ix is the screen space x coordinate of the interior point.
iy is the screen space y coordinate of the interior point.
Return value
none
Restrictions
This routine has no effect in text video modes. The screen edges are not considered region boundaries, and filling an open region will cause fg_paint to behave unpredictably.
See also
fg_flood, fg_paintw
Examples
6-17, 13-5
168 �
fg_paintw
Prototype
void fg_paintw (double x, double y); sub FGpaintw (x#, y#) subroutine fg_paintw (dbl x, dbl y) procedure fg_paintw (x, y : real);
Description
The fg_paintw routine fills an arbitrary closed region with the current color value. The region is defined by specifying a world space point within its interior.
Parameters
x is the world space x coordinate of the interior point.
y is the world space y coordinate of the interior point.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes. The screen edges are not considered region boundaries, and filling an open region will cause fg_paintw to behave unpredictably.
See also
fg_floodw, fg_paint
169 �
fg_palette
Prototype
void fg_palette (int number, int color); sub FGpalette (number%, color%) subroutine fg_palette (int number, int color) procedure fg_palette (number, color : integer);
Description
The fg_palette routine has different functions depending on the current graphics video mode. For CGA four-color modes (modes 4 and 5), it establishes the current palette and defines the background color for that palette. In the CGA two-color mode (mode 6), it defines the foreground color. For 16-color graphics modes (modes 9, 13, 14, 15, 16, 17, 18, 28, and 29), it defines the value of a palette register. For 256-color graphics modes (modes 19 through 27), it defines the value of a video DAC register.
Parameters
The meanings of the number and color parameters depend on the current video mode. The following table summarizes the parameter meanings and legal values for each video mode.
mode number parameter (range) color parameter (range)
4-5 CGA palette number (0 to 5) background color (0 to 15) 6 ignored foreground color (0 to 15) 9 palette register (0 to 15) palette value (0 to 15) 13-14 palette register (0 to 15) palette value (0 to 23) 15 palette register (0, 1, 4, or 5) palette value (0, 8, or 24) 16 palette register (0 to 15) palette value (0 to 63) 17 palette register (0 or 1) video DAC register (0 to 15) 18 palette register (0 to 15) video DAC register (0 to 15) 19-27 video DAC register (0 to 255) DAC value (0 to 63) 28-29 palette register (0 to 15) video DAC register (0 to 15)
Refer to Chapter 5 of the Fastgraph User's Guide for more specific information about the number and color parameters.
Return value
none
Restrictions
This routine has no effect in text video modes or Hercules graphics modes. Changing the foreground color (in mode 6) always works on true CGA adapters, but there are very few EGA and VGA adapters that correctly implement this capability in their mode 6 emulation.
See also
fg_defcolor, fg_maprgb, fg_palettes, fg_setcolor, fg_setdacs, fg_setrgb
170 �
fg_palette (continued)
Examples
5-1, 5-2, 5-3, 5-6, 5-7, 5-8, 5-9, 5-13, 5-16, 9-11
171 �
fg_palettes
Prototype
void fg_palettes (int *color_array); sub FGpalettes (color_array%()) subroutine fg_palettes (int color_array) procedure fg_palettes (var color_array : integer);
Description
The fg_palettes routine defines all 16 palette registers (in 16-color graphics modes), or the first 16 video DAC registers (in 256-color graphics modes).
Parameters
color_array is a 16-element array that contains the values to assign to the palette registers or video DAC registers.
Return value
none
Restrictions
This routine has no effect in text video modes, CGA graphics modes, or Hercules graphics modes.
See also
fg_maprgb, fg_palette, fg_setdacs
Examples
5-14
172 �
fg_pan
Prototype
void fg_pan (int ix, int iy); sub FGpan (ix%, iy%) subroutine fg_pan (int ix, int iy) procedure fg_pan (ix, iy : integer);
Description
The fg_pan routine changes the screen origin (the upper left corner of the screen) to the specified screen space coordinates.
Parameters
ix is the new screen space x coordinate for the screen origin.
iy is the new screen space y coordinate for the screen origin.
Return value
none
Restrictions
This routine has no effect in text video modes. Because of hardware limitations, only certain coordinate positions can be used as the screen origin. Fastgraph compensates for these restrictions by reducing ix and iy to acceptable values in the pertinent video modes, as shown here:
x will be reduced y will be reduced
video mode to a multiple of: to a multiple of:
4-5 8 2
6 16 2
9 4 4
11 8 4
12 4 2 or 3
The fg_pan routine always applies to video memory, even when a virtual buffer is active.
See also
fg_panw
Examples
13-6, 13-7, 13-9
173 �
fg_panw
Prototype
void fg_panw (double x, double y); sub FGpanw (x#, y#) subroutine fg_panw (dbl x, dbl y) procedure fg_panw (x, y : real);
Description
The fg_panw routine changes the screen origin (the upper left corner of the screen) to the specified world space coordinates.
Parameters
x is the new world space x coordinate for the screen origin.
y is the new world space y coordinate for the screen origin.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
To compensate for the hardware limitations that restrict the screen origin coordinates (see the description of fg_pan), Fastgraph reduces x and y to an acceptable screen space equivalent.
The fg_panw routine always applies to video memory, even when a virtual buffer is active.
See also
fg_pan
174 �
fg_pattern
Prototype
void fg_pattern (int index, int display_pattern); sub FGpattern (index%, display_pattern%) subroutine fg_pattern (int index, int display_pattern) procedure fg_pattern (index, display_pattern : integer);
Description
The fg_pattern routine defines one of Fastgraph's 256 display patterns used with fg_dispfile, fg_display, fg_displayp, fg_showppr, or fg_showspr. When using these routines to display a pixel run map, Fastgraph will use the pattern associated with that color index instead of displaying the color itself. Refer to the Fastgraph User's Guide for more information about display patterns and their default values for each graphics video mode.
Parameters
index is the number of the display pattern to define, between 0 and 255.
display_pattern represents a 16-bit display pattern. Its structure depends on the video mode, as summarized here:
video modes pattern structure
4, 5, 12 shift count (8 bits), four pixels (2 bits each)
6, 11 shift count (8 bits), eight pixels (1 bit each)
9 shift count (8 bits), two pixels (4 bits each)
13-16, 18, 28, 29 unused (8 bits), two pixels (4 bits each)
17 unused (14 bits), two pixels (1 bit each)
The shift count defines the number of bits that display_pattern is rotated left when applied to odd-numbered pixel rows, while the pixels are the actual color values replicated through the pixel run. For the EGA and VGA graphics modes, an implied one pixel shift count is used.
Return value
none
Restrictions
This routine has no effect in text video modes or in 256-color graphics modes.
See also
fg_dispfile, fg_display, fg_displayp, fg_showppr, fg_showspr
Examples
9-11
175 �
fg_pcxhead
Prototype
int fg_pcxhead (char *pcx_file, char *pcx_header); function FGpcxhead% (pcx_file$, pcx_header$) int function fg_pcxhead (char pcx_file, int1 pcx_header) function fg_pcxhead (pcx_file : string; var pcx_header : byte) : integer;
Description
The fg_pcxhead routine reads a PCX file header into a 128-byte buffer.
Parameters
pcx_file is the name of the PCX file. It may include a path specification and must be terminated by a zero byte.
pcx_header is the name of the 128-byte buffer to receive the PCX file header. In BASIC, it must be a fixed-length 128-byte string.
Return value
0 = Success -1 = The specified file does not exist -2 = The specified file is not a PCX file
Restrictions
none
See also
fg_loadpcx, fg_pcxmode, fg_pcxpal, fg_pcxrange, fg_showpcx
Examples
9-2
176 �
fg_pcxmode
Prototype
int fg_pcxmode (char *pcx_header); function FGpcxmode% (pcx_header$) int function fg_pcxmode (int1 pcx_header) function fg_pcxmode (var pcx_header : byte) : integer;
Description
The fg_pcxmode routine determines the optimal video mode for displaying a PCX file. The optimal mode is the compatible video mode having the lowest resolution larger than or equal to the image dimensions. See the description of fg_showpcx for a table of compatible video modes for PCX files.
Parameters
pcx_header is the name of a 128-byte buffer containing the PCX file header. In BASIC, it must be a fixed-length 128-byte string.
Return value
>0 = The optimal video mode for displaying the PCX image -1 = pcx_header does not contain a valid PCX file header -2 = Cannot determine a compatible video mode
Restrictions
none
See also
fg_pcxhead, fg_setmode, fg_showpcx
Examples
9-2
177 �
fg_pcxpal
Prototype
int fg_pcxpal (char *pcx_file, char *pcx_palette); function FGpcxpal% (pcx_file$, pcx_palette$) int function fg_pcxpal (char pcx_file, int1 pcx_palette) function fg_pcxpal (pcx_file : string; var pcx_palette) : integer;
Description
The fg_pcxpal routine retrieves the palette of an image stored in a PCX file. The palette values are returned as RGB color components, each between 0 and 63. For video modes 18 and above, the palette values are suitable for fg_setdacs. For the native EGA graphics modes (13 to 16), the palette values must be converted into mode-specific values (with fg_maprgb) before being used with fg_palette or fg_palettes.
If the PCX file includes an extended (256-color) palette, fg_pcxpal will return the values in the extended palette. Otherwise, fg_pcxpal will return the values from the 16-color palette in the PCX header.
Parameters
pcx_file is name of the PCX file. The file name must be terminated by a zero byte.
pcx_palette is the name of the array that will receive the PCX palette values. The palette values are returned as RGB color components, each between 0 and 63. The first three bytes of pcx_palette will contain the RGB values for color 0, the next three for color 1, and so forth. The size of the pcx_palette array must be at least three times the number of colors in the PCX image.
Return value
>0 = the number of colors in the PCX palette (16 or 256) -1 = file not found -2 = file is not a PCX file
Restrictions
none
See also
fg_loadpcx, fg_maprgb, fg_pcxhead, fg_palette, fg_palettes, fg_setdacs, fg_showpcx
Examples
9-3
178 �
fg_pcxrange
Prototype
void fg_pcxrange (char *pcx_header, int *minx, int *maxx, int *miny,
int *maxy);
sub FGpcxrange (pcx_header$, minx%, maxx%, miny%, maxy%)
subroutine fg_pcxrange (int1 pcx_header, int minx, int maxx, int miny,
int maxy)
procedure fg_pcxrange (var pcx_header; var minx, maxx, miny, maxy :
integer);
Description
The fg_pcxrange routine returns the image extents for the PCX image associated with the specified PCX file header.
Parameters
pcx_header is the name of the buffer containing the 128-byte PCX file header.
minx receives the x coordinate of the image's left edge. If pcx_header does not contain a valid PCX file header, minx will be set to -1.
maxx receives the x coordinate of the image's right edge. If pcx_header does not contain a valid PCX file header, maxx will be set to -1.
miny receives the y coordinate of the image's top edge. If pcx_header does not contain a valid PCX file header, miny will be set to -1.
maxy receives the y coordinate of the image's bottom edge. If pcx_header does not contain a valid PCX file header, maxy will be set to -1.
Return value
none
Restrictions
none
See also
fg_pcxhead, fg_loadpcx, fg_showpcx
Examples
9-3
179 �
fg_playing
Prototype
int fg_playing (void); function FGplaying% () int function fg_playing () function fg_playing : integer;
Description
The fg_playing routine determines whether or not there is any asynchronous sound in progress.
Parameters
none
Return value
If the return value is 0, it means there is no asynchronous sound in progress. If it is 1, then there is asynchronous sound in progress.
Restrictions
none
See also
fg_musicb, fg_sounds, fg_voices
Examples
15-4, 15-5, 15-6, 15-7, 15-8
180 �
fg_point
Prototype
void fg_point (int ix, int iy); sub FGpoint (ix%, iy%) subroutine fg_point (int ix, int iy) procedure fg_point (ix, iy : integer);
Description
The fg_point routine draws a point (displays a pixel) in screen space.
Parameters
ix is the point's screen space x coordinate.
iy is the point's screen space y coordinate.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_pointw, fg_pointx
Examples
6-1
181 �
fg_pointw
Prototype
void fg_pointw (double x, double y); sub FGpointw (x#, y#) subroutine fg_pointw (dbl x, dbl y) procedure fg_pointw (x, y : real);
Description
The fg_pointw routine draws a point (displays a pixel) in world space.
Parameters
x is the point's world space x coordinate.
y is the point's world space y coordinate.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_point, fg_pointxw
182 �
fg_pointx
Prototype
void fg_pointx (int ix, int iy); sub FGpointx (ix%, iy%) subroutine fg_pointx (int ix, int iy) procedure fg_pointx (ix, iy : integer);
Description
The fg_pointx routine draws a point (displays a pixel) in "exclusive or" mode in screen space.
Parameters
ix is the point's screen space x coordinate.
iy is the point's screen space y coordinate.
Return value
none
Restrictions
This routine has no effect in text video modes.
In 16-color EGA, VGA, or SVGA graphics modes, the EGA/VGA function register is reset to its default replacement mode on return.
See also
fg_point, fg_pointxw
183 �
fg_pointxw
Prototype
void fg_pointxw (double x, double y); sub FGpointxw (x#, y#) subroutine fg_pointxw (dbl x, dbl y) procedure fg_pointxw (x, y : real);
Description
The fg_pointxw routine draws a point (displays a pixel) in "exclusive or" mode in world space.
Parameters
x is the point's world space x coordinate.
y is the point's world space y coordinate.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
In 16-color EGA, VGA, or SVGA graphics modes, the EGA/VGA function register is reset to its default replacement mode on return.
See also
fg_pointw, fg_pointx
184 �
fg_polyedge
Prototype
void fg_polyedge (int edge_flag); sub FGpolyedge (edge_flag%) subroutine fg_polyedge (int edge_flag) procedure fg_polyedge (edge_flag : integer);
Description
The fg_polyedge routine specifies if polygons drawn with fg_polyfill will have their right and bottom edge pixels included. By default, such pixels are excluded.
Parameters
edge_flag controls the drawing of a filled polygon's right and bottom edge pixels. If edge_flag is 0, these pixels are included. If it is 1, these pixels are excluded.
Return value
none
Restrictions
none
See also
fg_polyfill
185 �
fg_polyfill
Prototype
void fg_polyfill (int *vertex_array, int *work_array, int n);
sub FGpolyfill (vertex_array%(), work_array%(), n%)
subroutine fg_polyfill (int vertex_array, int work_array, int n)
procedure fg_polyfill (var vertex_array, work_array : integer;
n : integer);
Description
The fg_polyfill routine draws a filled convex polygon in screen space. The polygon is filled with pixels of the current color. By default, pixels along the polygon's right and bottom edges are excluded to improve polygon meshing. This feature can be disabled through fg_polyedge.
Parameters
vertex_array is the name of the array containing the (x,y) coordinate pairs of each vertex. The first array element is the x component of the first vertex, the second element is the y component of the first vertex, the third element is the x component of the second vertex, and so forth.
work_array is used internally by fg_polyfill. Its size in bytes must be at least four times the unclipped polygon height.
n is the number of vertices in the polygon.
Return value
none
Restrictions
If you attempt to fill a non-convex polygon, only a portion of it will be filled.
In 16-bit modes, the size of vertex_array and work_array is limited to 64K bytes.
This routine has no effect in text video modes.
See also
fg_polyedge, fg_polyline, fg_polyoff
Examples
6-8
186 �
fg_polygon
Prototype
void fg_polygon (int *ix_array, int *iy_array, int n); sub FGpolygon (ix_array%(), iy_array%(), n%) subroutine fg_polygon (int ix_array, int iy_array, int n) procedure fg_polygon (var ix_array, iy_array : integer; n : integer);
Description
The fg_polygon routine draws an unfilled polygon in screen space, using two coordinate arrays to define the polygon vertices. The drawing of the polygon begins at the first vertex defined in the coordinate arrays, through the remaining vertices in sequence, and finally back to the first vertex if necessary.
Parameters
ix_array is the name of the array containing the screen space x coordinates of the polygon vertices.
iy_array is the name of the array containing the screen space y coordinates of the polygon vertices.
n is the number of vertices in the polygon.
Return value
none
Restrictions
In 16-bit modes, the size of ix_array and iy_array is limited to 64K bytes.
This routine has no effect in text video modes.
See also
fg_polyline, fg_polygonw
Examples
6-7
187 �
fg_polygonw
Prototype
void fg_polygonw (double *x_array, double *y_array, int n); sub FGpolygonw (x_array#(), y_array#(), n%) subroutine fg_polygonw (dbl x_array, dbl y_array, int n) procedure fg_polygonw (var x_array, y_array : real; n : integer);
Description
The fg_polygonw routine draws an unfilled polygon in world space, using two coordinate arrays to define the polygon vertices. The drawing of the polygon begins at the first vertex defined in the coordinate arrays, through the remaining vertices in sequence, and finally back to the first vertex if necessary.
Parameters
x_array is the name of the array containing the world space x coordinates of the polygon vertices.
y_array is the name of the array containing the world space y coordinates of the polygon vertices.
n is the number of vertices in the polygon.
Return value
none
Restrictions
In 16-bit modes, the size of x_array and y_array is limited to 64K bytes.
This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_polygon
188 �
fg_polyline
Prototype
void fg_polyline (int *vertex_array, int n); sub FGpolyline (vertex_array%(), n%) subroutine fg_polyline (int vertex_array, int n) procedure fg_polyline (var vertex_array : integer; n : integer);
Description
The fg_polyline routine draws an unfilled polygon in screen space, using a single array to define the polygon vertices. Compare this to fg_polygon, which uses separate arrays for the x and y components of each vertex.
Parameters
vertex_array is the name of the array containing the (x,y) coordinate pairs of each vertex. The first array element is the x component of the first vertex, the second element is the y component of the first vertex, the third element is the x component of the second vertex, and so forth.
n is the number of vertices in the polygon.
Return value
none
Restrictions
In 16-bit modes, the size of vertex_array is limited to 64K bytes.
This routine has no effect in text video modes.
See also
fg_polyfill, fg_polygon, fg_polyoff
Examples
6-8
189 �
fg_polyoff
Prototype
void fg_polyoff (int ix, int iy); sub FGpolyoff (ix%, iy%) subroutine fg_polyoff (int ix, int iy) procedure fg_polyoff (ix, iy : integer);
Description
The fg_polyoff routine defines the screen space offset applied to each polygon vertex for fg_inside, fg_polyfill, and fg_polyline. By default, the polygon display functions use an offset of zero, meaning their vertex arrays specify the actual vertex coordinates.
Parameters
ix is the horizontal screen space offset applied to the x component of all vertices.
iy is the vertical screen space offset applied to the y component of all vertices.
Return value
none
Restrictions
none
See also
fg_inside, fg_polyfill, fg_polyline
Examples
6-8
190 �
fg_print
Prototype
void fg_print (char *string, int n); sub FGprint (string$, n%) subroutine fg_print (char string, int n) procedure fg_print (string : string; n : integer);
Description
The fg_print routine displays a string of hardware characters relative to the current graphics position using the current color index, without clipping. By default, strings are displayed such that the bottom row of the first character is at the current graphics position. On return, the graphics cursor is positioned just to the right of the last character displayed.
Parameters
string is the arbitrary-length sequence of characters to display.
n is the number of characters to display from string.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_justify, fg_printc, fg_text
Examples
7-6, 10-17, 10-18, 13-7
191 �
fg_printc
Prototype
void fg_printc (char *string, int n); sub FGprintc (string$, n%) subroutine fg_printc (char string, int n) procedure fg_printc (string : string; n : integer);
Description
The fg_printc routine displays a string of hardware characters relative to the current graphics position using the current color index. By default, strings are displayed such that the bottom row of the first character is at the current graphics position. Only that part of the string that falls within the current clipping limits will be displayed. On return, the graphics cursor is positioned just to the right of the last character displayed.
Parameters
string is the arbitrary-length sequence of characters to display.
n is the number of characters to display from string.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_print, fg_setclip, fg_textc
192 �
fg_putblock
Prototype
void fg_putblock (char [far] *buffer, int minx, int maxx, int miny,
int maxy);
sub FGputblock (buffer$, minx%, maxx%, miny%, maxy%)
subroutine fg_putblock (int1 [far] buffer, int minx, int maxx, int miny,
int maxy)
procedure fg_putblock (buffer : pointer; minx, maxx, miny, maxy : integer);
Description
The fg_putblock routine displays a block (previously obtained with fg_getblock) at the specified position on the active video page or virtual buffer. In text modes, the block extremes are defined in character space; in graphics modes, they are defined in screen space.
Parameters
buffer is the name of the array containing the block. It is passed by far reference in 16-bit modes except when using BASIC.
minx is the x coordinate of the block's left edge. In graphics modes, its value is reduced to a byte boundary if necessary.
maxx is the x coordinate of the block's right edge. It must be greater than or equal to the value of minx. In graphics modes, its value is extended to a byte boundary if necessary.
miny is the y coordinate of the block's top edge.
maxy is the y coordinate of the block's bottom edge. It must be greater than or equal to the value of miny.
Return value
none
Restrictions
In 16-bit modes, the size of buffer is limited to 64K bytes.
In real mode Pascal programs, buffer must be allocated dynamically with the GetMem procedure. This is the only way to pass something by far reference in Pascal.
See also
fg_getblock
Examples
11-10
193 �
fg_putimage
Prototype
void fg_putimage (char *map_array, int width, int height); sub FGputimage (map_array$, width%, height%) subroutine fg_putimage (int1 map_array, int width, int height) procedure fg_putimage (var map_array : byte; width, height : integer);
Description
The fg_putimage routine displays an image stored as a mode-specific bitmap, without treating color 0 as transparent. The image will be positioned so that its lower left corner is at the graphics cursor position. Refer to the Fastgraph User's Guide for complete information about mode-specific bitmaps.
Parameters
map_array is the name of the array containing the bitmap.
width is the width in bytes of the bitmap.
height is the height in bytes (pixel rows) of the bitmap.
Return value
none
Restrictions
In 16-bit modes, the size of map_array is limited to 64K bytes.
See also
fg_drwimage, fg_getimage, fg_invert, fg_pack, fg_unpack
Examples
10-8, 10-9, 10-17, 10-18
194 �
fg_quiet
Prototype
void fg_quiet (void); sub FGquiet () subroutine fg_quiet () procedure fg_quiet;
Description
The fg_quiet routine stops continuous synchronous sound started with fg_sound or fg_voice. It has no effect if there is no continuous sound in progress.
Parameters
none
Return value
none
Restrictions
none
See also
fg_sound, fg_voice
Examples
15-2
195 �
fg_rect
Prototype
void fg_rect (int minx, int maxx, int miny, int maxy); sub FGrect (minx%, maxx%, miny%, maxy%) subroutine fg_rect (int minx, int maxx, int miny, int maxy) procedure fg_rect (minx, maxx, miny, maxy : integer);
Description
The fg_rect routine draws a solid (filled) rectangle in screen space or character space, without regard to the clipping region.
Parameters
minx is the x coordinate of the rectangle's left edge.
maxx is the x coordinate of the rectangle's right edge. It must be greater than or equal to the value of minx.
miny is the y coordinate of the rectangle's top edge.
maxy is the y coordinate of the rectangle's bottom edge. It must be greater than or equal to the value of miny.
Return value
none
Restrictions
none
See also
fg_box, fg_clprect, fg_drect, fg_rectw
Examples
5-8, 5-10, 6-11, 6-13, 7-5, 7-9
196 �
fg_rectw
Prototype
void fg_rectw (double xmin, double xmax, double ymin, double ymax); sub FGrectw (xmin#, xmax#, ymin#, ymax#) subroutine fg_rectw (dbl xmin, dbl xmax, dbl ymin, dbl ymax) procedure fg_rectw (xmin, xmax, ymin, ymax : real);
Description
The fg_rectw routine draws a solid (filled) rectangle in world space, without regard to the clipping region.
Parameters
xmin is the world space x coordinate of the rectangle's left edge.
xmax is the world space x coordinate of the rectangle's right edge. It must be greater than or equal to the value of xmin.
ymin is the world space y coordinate of the rectangle's bottom edge.
ymax is the world space y coordinate of the rectangle's top edge. It must be greater than or equal to the value of ymin.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light.
See also
fg_boxw, fg_clprectw, fg_drectw, fg_rect
Examples
7-13
197 �
fg_reset
Prototype
void fg_reset (void); sub FGreset () subroutine fg_reset () procedure fg_reset;
Description
When the ANSI.SYS driver is not loaded, fg_reset erases the screen. When ANSI.SYS is loaded, fg_reset also restores any previously set screen attributes. It is generally the last Fastgraph routine called in a program.
Parameters
none
Return value
none
Restrictions
This routine has no effect in graphics video modes.
See also
fg_erase
Examples
3-2
198 �
fg_resize
Prototype
void fg_resize (int width, int height); sub FGresize (width%, height%) subroutine fg_resize (int width, int height) procedure fg_resize (width, height : integer);
Description
The fg_resize routine changes the dimensions of a video page in EGA, VGA, and SVGA graphics modes.
Parameters
width specifies the new video page width in pixels.
height specifies the new video page height in pixels.
Return value
none
Restrictions
The size of a video page is constrained only by the amount of video memory available. Increasing the video page size reduces the number of physical pages available proportionally. In mode 13, for example, increasing the page size from 320x200 to 640x400 reduces the number of video pages from 8 to 2.
When you call fg_resize, the visual page must be page 0.
If you have created any logical video pages, you must release them with fg_freepage before calling fg_resize, and then create them again afterward.
If you have initialized the mouse (with fg_mouseini), joysticks (with fg_initjoy), expanded memory (with fg_initems), or extended memory (with fg_initxms), you should re-initialize these resources after calling fg_resize. Most mouse drivers expect a fixed video page width, so the mouse cursor may become distorted after resizing video pages.
The fg_setmode routine re-establishes the dimensions of a video page to the default screen resolution for the selected video mode.
Partial video pages (initially available in some video modes) are unavailable after calling fg_resize, even if you use the video mode's original resolution.
This routine is meaningful only in the native EGA and VGA graphics modes (13 to 18), extended VGA graphics modes (20 to 23), and SVGA graphics modes (24 to 29). It has no effect in other video modes or when a virtual buffer is active.
199 �
fg_resize (continued)
See also
fg_pan
Examples
8-11, 13-7
200 �
fg_restore
Prototype
void fg_restore (int minx, int maxx, int miny, int maxy); sub FGrestore (minx%, maxx%, miny%, maxy%) subroutine fg_restore (int minx, int maxx, int miny, int maxy) procedure fg_restore (minx, maxx, miny, maxy : integer);
Description
The fg_restore routine copies a rectangular region from the hidden video page to the same position on the active video page. In text modes, the region is defined in character space; in graphics modes, it is defined in screen space. As with Fastgraph's other block transfer routines, no clipping is performed.
Parameters
minx is the x coordinate of the region's left edge. In graphics modes, its value is reduced to a byte boundary if necessary.
maxx is the x coordinate of the region's right edge. It must be greater than or equal to the value of minx. In graphics modes, its value is extended to a byte boundary if necessary.
miny is the y coordinate of the region's top edge.
maxy is the y coordinate of the region's bottom edge. It must be greater than or equal to the value of miny.
Return value
none
Restrictions
This routine always applies to video pages, even when a virtual buffer is active.
See also
fg_restorew, fg_save, fg_sethpage, fg_transfer
Examples
11-2, 11-3
201 �
fg_restorew
Prototype
void fg_restorew (double xmin, double xmax, double ymin, double ymax); sub FGrestorew (xmin#, xmax#, ymin#, ymax#) subroutine fg_restorew (dbl xmin, dbl xmax, dbl ymin, dbl ymax) procedure fg_restorew (xmin, xmax, ymin, ymax : real);
Description
The fg_restorew routine copies a rectangular region, defined in world space, from the hidden video page to the same position on the active video page. As with Fastgraph's other block transfer routines, no clipping is performed.
Parameters
xmin is the world space x coordinate of the region's left edge. In graphics modes, its value is reduced to a byte boundary if necessary.
xmax is the world space x coordinate of the region's right edge. It must be greater than or equal to the value of xmin. In graphics modes, its value is extended to a byte boundary if necessary.
ymin is the world space y coordinate of the region's bottom edge.
ymax is the world space y coordinate of the region's top edge. It must be greater than or equal to the value of ymin.
Return value
none
Restrictions
This routine always applies to video pages, even when a virtual buffer is active. It is not available in Fastgraph/Light.
See also
fg_restore, fg_savew, fg_sethpage, fg_transfer
202 �
fg_resume
Prototype
void fg_resume (void); sub FGresume () subroutine fg_resume () procedure fg_resume;
Description
The fg_resume routine restarts asynchronous music previously suspended by fg_suspend. It has no effect if there is no suspended music.
Parameters
none
Return value
none
Restrictions
none
See also
fg_musicb, fg_suspend
Examples
15-8
203 �
fg_revimage
Prototype
void fg_revimage (char *map_array, int width, int height); sub FGrevimage (map_array$, width%, height%) subroutine fg_revimage (int1 map_array, int width, int height) procedure fg_revimage (var map_array : byte; width, height : integer);
Description
The fg_revimage routine displays a reversed image stored as a mode-specific bitmap. The image will be positioned so that its lower left corner is at the graphics cursor position. Refer to the Fastgraph User's Guide for complete information about mode-specific bitmaps.
Parameters
map_array is the name of the array containing the bitmap.
width is the width in bytes of the bitmap.
height is the height in bytes (pixel rows) of the bitmap.
Return value
none
Restrictions
In 16-bit modes, the size of map_array is limited to 64K bytes.
This routine has no effect in text video modes.
See also
fg_clpimage, fg_drwimage, fg_flpimage, fg_getimage, fg_invert, fg_pack, fg_putimage, fg_unpack
Examples
10-8, 10-9
204 �
fg_revmask
Prototype
void fg_revmask (char *map_array, int runs, int width); sub FGrevmask (map_array$, runs%, width%) subroutine fg_revmask (int1 map_array, int runs, int width) procedure fg_revmask (var map_array : byte; runs, width : integer);
Description
The fg_revmask routine displays a reversed image stored as a masking map. The image will be positioned so that its lower left corner is at the graphics cursor position. Refer to the description of fg_drawmask for more information about masking maps.
Parameters
map_array is the name of the array containing the masking map.
runs is the number of pixel runs in the masking map.
width is the width in pixels of the masking map.
Return value
none
Restrictions
In 16-bit modes, the size of map_array is limited to 64K bytes.
This routine has no effect in text video modes.
See also
fg_clipmask, fg_drawmask, fg_flipmask
Examples
10-23
205 �
fg_save
Prototype
void fg_save (int minx, int maxx, int miny, int maxy); sub FGsave (minx%, maxx%, miny%, maxy%) subroutine fg_save (int minx, int maxx, int miny, int maxy) procedure fg_save (minx, maxx, miny, maxy : integer);
Description
The fg_save routine copies a rectangular region from the active video page to the same position on the hidden video page. In text modes, the region is defined in character space; in graphics modes, it is defined in screen space. As with Fastgraph's other block transfer routines, no clipping is performed.
Parameters
minx is the x coordinate of the region's left edge. In graphics modes, its value is reduced to a byte boundary if necessary.
maxx is the x coordinate of the region's right edge. It must be greater than or equal to the value of minx. In graphics modes, its value is extended to a byte boundary if necessary.
miny is the y coordinate of the region's top edge.
maxy is the y coordinate of the region's bottom edge. It must be greater than or equal to the value of miny.
Return value
none
Restrictions
This routine always applies to video pages, even when a virtual buffer is active.
See also
fg_restore, fg_savew, fg_sethpage, fg_transfer
Examples
11-2, 11-3
206 �
fg_savew
Prototype
void fg_savew (double xmin, double xmax, double ymin, double ymax); sub FGsavew (xmin#, xmax#, ymin#, ymax#) subroutine fg_savew (dbl xmin, dbl xmax, dbl ymin, dbl ymax) procedure fg_savew (xmin, xmax, ymin, ymax : real);
Description
The fg_savew routine copies a rectangular region, defined in world space, from the active video page to the same position on the hidden video page. As with Fastgraph's other block transfer routines, no clipping is performed.
Parameters
xmin is the world space x coordinate of the region's left edge. In graphics modes, its value is reduced to a byte boundary if necessary.
xmax is the world space x coordinate of the region's right edge. It must be greater than or equal to the value of xmin. In graphics modes, its value is extended to a byte boundary if necessary.
ymin is the world space y coordinate of the region's bottom edge.
ymax is the world space y coordinate of the region's top edge. It must be greater than or equal to the value of ymin.
Return value
none
Restrictions
This routine always applies to video pages, even when a virtual buffer is active. It is not available in Fastgraph/Light.
See also
fg_restorew, fg_save, fg_sethpage, fg_transfer
207 �
fg_scale
Prototype
void fg_scale (char *source, char *dest, int sw, int sh, int dw, int dh);
sub FGscale (source$, dest$, sw%, sh%, dw%, dh%)
subroutine fg_scale (int1 source, int1 dest, int sw, int sh, int dw,
int dh)
procedure fg_scale (var source, dest; sw, sh, dw, dh : integer);
Description
The fg_scale routine scales a bitmapped image stored in the "one pixel per byte" format.
Parameters
source is the name of the array containing the "one pixel per byte" bitmapped image to be scaled.
dest is the name of the array that will receive the resulting scaled image.
sw is the width of the source image in pixels. It must be greater than zero.
sh is the height of the source image in pixels. It must be greater than zero.
dw is the width of the dest image in pixels. It must be greater than zero.
dh is the height of the dest image in pixels. It must be greater than zero.
Return value
none
Restrictions
In 16-bit modes, the size of the source and dest arrays is limited to 64K
bytes.
The maximum allowable width or height of source and dest is 1,024 pixels.
See also
fg_drwimage, fg_pack, fg_putimage, fg_shear, fg_unpack
Examples
10-17, 10-19
208 �
fg_scrlock
Prototype
int fg_scrlock (void); function FGscrlock% () int function fg_scrlock () function fg_scrlock : integer;
Description
The fg_scrlock routine determines the state of the ScrollLock key.
Parameters
none
Return value
If the return value is 0, it means the ScrollLock key is off. If it is 1, it means the ScrollLock key is on.
Restrictions
Not all PC keyboards have a ScrollLock key. For such systems, fg_scrlock will return a value of zero.
See also
fg_capslock, fg_numlock, fg_setcaps, fg_setnum
Examples
14-4
209 �
fg_scroll
Prototype
void fg_scroll (int minx, int maxx, int miny, int maxy, int jump,
int type);
sub FGscroll (minx%, maxx%, miny%, maxy%, jump%, type%)
subroutine fg_scroll (int minx, int maxx, int miny, int maxy, int jump,
int type)
procedure fg_scroll (minx, maxx, miny, maxy, jump, type : integer);
Description
The fg_scroll routine vertically scrolls a region of the active video page. The scrolling may be done either up or down, using either an end-off or circular method. In text modes, the region is defined in character space; in graphics modes, it is defined in screen space.
Parameters
minx is the x coordinate of the scrolling region's left edge. In graphics modes, its value is reduced to a byte boundary if necessary.
maxx is the x coordinate of the scrolling region's right edge. It must be greater than or equal to the value of minx. In graphics modes, its value is extended to a byte boundary if necessary.
miny is the y coordinate of the scrolling region's top edge.
maxy is the y coordinate of the scrolling region's bottom edge. It must be greater than or equal to the value of miny.
jump is the number of pixels to jump between each scrolling iteration. If jump is negative, the region will scroll toward the top of the screen. If jump is positive, the region will scroll toward the bottom of the screen.
type specifies the type of scroll. If type is zero, rows that scroll off one edge appear at the opposite edge, thus producing a circular scrolling effect. If type is any other value, rows that scroll off one edge will be replaced at the opposite edge by lines of the current color.
Return value
none
Restrictions
This routine has no effect when a virtual buffer is active.
Circular scrolling uses part of the hidden page (as defined in the most recent call to fg_sethpage) as a temporary workspace.
See also
fg_setcolor, fg_sethpage
210 �
fg_scroll (continued)
Examples
13-3, 13-4, 13-5
211 �
fg_setangle
Prototype
void fg_setangle (double angle); sub FGsetangle (angle#) subroutine fg_setangle (dbl angle) procedure fg_setangle (angle : real);
Description
The fg_setangle routine defines the angle of rotation at which software characters are displayed. If a program draws software characters before calling fg_setangle, Fastgraph will use its default angle of zero degrees (that is, horizontal).
Parameters
angle is the angle of rotation, expressed in degrees and measured counterclockwise from the positive x axis.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light. Before using this routine, you must use fg_initw and fg_setworld to establish a world space coordinate system.
See also
fg_initw, fg_setratio, fg_setsize, fg_setsizew, fg_setworld, fg_swchar, fg_swlength, fg_swtext
Examples
7-12
212 �
fg_setattr
Prototype
void fg_setattr (int foreground, int background, int blink); sub FGsetattr (foreground%, background%, blink%) subroutine fg_setattr (int foreground, int background, int blink) procedure fg_setattr (foreground, background, blink : integer);
Description
The fg_setattr routine establishes the current text attribute in text video modes.
Parameters
foreground is attribute's foreground component, between 0 and 15.
background is the attribute's background component, between 0 and 7.
blink is the attribute's blink component, between 0 and 1.
Return value
none
Restrictions
This routine has no effect in graphics video modes.
See also
fg_setcolor
Examples
7-1, 7-2, 7-3, 7-4, 8-1, 8-3, 8-5, 8-7, 10-13, 11-2, 11-4, 13-4, 14-9
213 �
fg_setbanks
Prototype
void fg_setbanks (int read_bank, int write_bank); sub FGsetbanks (read_bank%, write_bank%) subroutine fg_setbanks (int read_bank, int write_bank) procedure fg_setbanks (read_bank, write_bank : integer);
Description
The fg_setbanks routine defines the SVGA read and write bank numbers. This routine is not usually called in an application but is provided as a high- level interface to Fastgraph's SVGA kernel.
Parameters
read_bank is the SVGA bank number used in read operations. If the value of read_bank is negative, the read bank number is not changed.
write_bank is the SVGA bank number used in write operations. If the value of write_bank is negative, the write bank number is not changed.
Return value
none
Restrictions
This routine has no effect if Fastgraph's SVGA kernel has not been initialized.
See also
fg_getbanks, fg_svgainit
214 �
fg_setcaps
Prototype
void fg_setcaps (int state); sub FGsetcaps (state%) subroutine fg_setcaps (int state) procedure fg_setcaps (state : integer);
Description
The fg_setcaps routine controls the state of the CapsLock key.
Parameters
state defines the CapsLock key state. If state is 0, the CapsLock key is turned off. If it is 1, the CapsLock key is turned on.
Return value
none
Restrictions
On most keyboards, changing the CapsLock key state will also change the keyboard state light to reflect the new key state. However, some older keyboards, especially when used on PC, PC/XT, or Tandy 1000 systems, do not update the state light. This makes the state light inconsistent with the true key state.
See also
fg_capslock, fg_numlock, fg_scrlock, fg_setnum
Examples
14-4
215 �
fg_setclip
Prototype
void fg_setclip (int minx, int maxx, int miny, int maxy); sub FGsetclip (minx%, maxx%, miny%, maxy%) subroutine fg_setclip (int minx, int maxx, int miny, int maxy) procedure fg_setclip (minx, maxx, miny, maxy : integer);
Description
The fg_setclip routine defines the clipping region in screen space. The clipping region is a rectangular area outside of which certain graphics are suppressed.
Parameters
minx is the screen space x coordinate of the clipping region's left edge.
maxx is the screen space x coordinate of the clipping region's right edge. It must be greater than or equal to the value of minx.
miny is the screen space y coordinate of the clipping region's top edge.
maxy is the screen space y coordinate of the clipping region's bottom edge. It must be greater than or equal to the value of miny.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_setclipw
Examples
6-5, 6-8, 10-8, 10-9, 10-23, 12-4
216 �
fg_setclipw
Prototype
void fg_setclipw (double xmin, double xmax, double ymin, double ymax); sub FGsetclipw (xmin#, xmax#, ymin#, ymax#) subroutine fg_setclipw (dbl xmin, dbl xmax, dbl ymin, dbl ymax) procedure fg_setclipw (xmin, xmax, ymin, ymax : real);
Description
The fg_setclipw routine defines the clipping region in world space. The clipping region is a rectangular area outside of which certain graphics are suppressed.
Parameters
xmin is the world space x coordinate of the clipping region's left edge.
xmax is the world space x coordinate of the clipping region's right edge. It must be greater than or equal to the value of xmin.
ymin is the world space y coordinate of the clipping region's bottom edge.
ymax is the world space y coordinate of the clipping region's top edge. It must be greater than or equal to the value of ymin.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_setclip
217 �
fg_setcolor
Prototype
void fg_setcolor (int color); sub FGsetcolor (color%) subroutine fg_setcolor (int color) procedure fg_setcolor (color : integer);
Description
The fg_setcolor routine establishes the current color index (which may be a virtual color index) in graphics modes. In text modes, fg_setcolor provides an alternate method of defining the current text attribute.
Parameters
color defines the current color index (in graphics modes) or text attribute (in text modes). Its value must be between 0 and 255.
Return value
none
Restrictions
none
See also
fg_colors, fg_defcolor, fg_getcolor, fg_setattr
Examples
3-1 to 3-8, 3-10
218 �
fg_setdacs
Prototype
void fg_setdacs (int start, int count, char *values); sub FGsetdacs (start%, count%, values$) subroutine fg_setdacs (int start, int count, int1 values) procedure fg_setdacs (start, count : integer; var values : shortint);
Description
The fg_setdacs routine defines the values of a block of contiguous video DAC registers by specifying their red, green, and blue color components. Defining many DAC registers with fg_setdacs is considerably faster than doing so individually with fg_setrgb.
Parameters
start is the starting video DAC register number, between 0 and 255.
count is the number of contiguous DAC registers to define, between 1 and 256. If the sum of start and count exceeds 256, the register numbers wrap around and resume with register number 0.
values is the name of the array containing the color components. The first three bytes of this array must contain the red, green, and blue components for DAC register start, the next three bytes contain the components for register start+1, and so forth. The size of the values array must be at least 3*count bytes.
Return value
none
Restrictions
This routine has no effect in text modes, or in CGA, Tandy, and Hercules graphics modes. In modes 13 to 16, it is meaningful only when run on a VGA or SVGA system; its results are unpredictable in these modes when run on an EGA. You can use fg_testmode(18,0) to check for a VGA or SVGA system.
See also
fg_getdacs, fg_getrgb, fg_setrgb
Examples
5-12
219 �
fg_setentry
Prototype
void fg_setentry (int page_number, int page_addr, int page_type); sub FGsetentry (page_number%, page_addr%, page_type%) subroutine fg_setentry (int page_number, int page_addr, int page_type) procedure fg_setentry (page_number, page_addr, page_type : integer);
Description
The fg_setentry routine specifies the type and address of a physical, virtual, or logical video page. For logical pages, it further specifies if the page resides in conventional, expanded, or extended memory. This routine is useful for saving virtual or logical page contents across video mode changes, or for manual creation of virtual and logical pages.
Parameters
page_number is the number of the video page being defined. It must be between 0 and 63.
page_addr is the address of the specified page. For physical pages, virtual pages, and logical pages in conventional memory, the address is an ordinary segment address. For logical pages in EMS or XMS memory, the page address is an EMS or XMS handle.
page_type is a code indicating the page type. See the description of fg_getentry for valid page type values.
Return value
none
Restrictions
none
See also
fg_getentry
Examples
8-12, 8-13
220 �
fg_setfunc
Prototype
void fg_setfunc (int mode); sub FGsetfunc (mode%) subroutine fg_setfunc (int mode) procedure fg_setfunc (mode : integer);
Description
The fg_setfunc routine specifies the logical operation applied when video memory changes in 16-color EGA/VGA/SVGA graphics modes. Replacement mode is selected after you use fg_setmode to establish a video mode.
Parameters
mode defines the logical operation, as shown here:
value of logical
mode operation
0 replacement
1 and
2 or
3 exclusive or
Return value
none
Restrictions
This routine only functions in 16-color EGA/VGA/SVGA graphics video modes (modes 13 through 18, 28, and 29). It always applies to video memory, even when a virtual buffer is active.
Examples
12-3, 17-2
221 �
fg_sethpage
Prototype
void fg_sethpage (int page_number); sub FGsethpage (page_number%) subroutine fg_sethpage (int page_number) procedure fg_sethpage (page_number : integer);
Description
The fg_sethpage routine establishes the hidden video page. It may be a physical or virtual video page. The fg_setmode routine designates video page 0 as the hidden page.
Parameters
page_number is the hidden video page number, between 0 and 63.
Return value
none
Restrictions
This routine has no effect if page_number references a physical video page that does not exist, or a virtual video page that has not been created.
See also
fg_gethpage, fg_setpage, fg_setvpage
Examples
11-2, 11-3, 13-2, 13-5
222 �
fg_setlines
Prototype
void fg_setlines (int lines); sub FGsetlines (lines%) subroutine fg_setlines (int lines) procedure fg_setlines (lines : integer);
Description
The fg_setlines routine extends an 80-column text mode to 25, 43, or 50 lines per screen. The fg_setmode routine sets the number of lines to 25 when establishing an 80-column text mode.
Parameters
lines is the number of text rows per screen. On EGA systems, the value of lines must be 25 or 43. On MCGA systems, it must be 25 or 50. On VGA and SVGA systems, it must be 25, 43, or 50. Any other value is ignored. Before calling fg_setlines, you should call fg_testmode with pages=0 to see if the user's system supports the number of rows needed.
Return value
none
Restrictions
This routine is only meaningful when running in 80-column text modes on EGA, MCGA, VGA, or SVGA systems (in other cases it does nothing).
When you call fg_setlines, the visual page must be page 0.
Calling fg_setlines makes the text cursor visible.
If you have initialized the mouse (with fg_mouseini), joysticks (with fg_initjoy), expanded memory (with fg_initems), or extended memory (with fg_initxms), you should re-initialize these resources after calling fg_setlines.
See also
fg_getlines, fg_testmode
Examples
3-5
223 �
fg_setmode
Prototype
void fg_setmode (int mode_number); sub FGsetmode (mode_number%) subroutine fg_setmode (int mode_number) procedure fg_setmode (mode_number : integer);
Description
The fg_setmode routine establishes a video mode and initializes Fastgraph's internal parameters for that mode. It must be called before any Fastgraph routine that performs video output. A program can call fg_setmode as many times as needed to switch between different video modes.
Parameters
mode_number is the video mode number, between 0 and 29, as shown here:
Mode No. of Supported Supported No. Type Resolution Colors Adapters Displays
0 T 40x25 16/8 CGA,EGA,VGA,MCGA,SVGA RGB,ECD,VGA,SVGA
1 T 40x25 16/8 CGA,EGA,VGA,MCGA,SVGA RGB,ECD,VGA,SVGA
2 T 80x25 16/8 CGA,EGA,VGA,MCGA,SVGA RGB,ECD,VGA,SVGA
3 T 80x25 16/8 CGA,EGA,VGA,MCGA,SVGA RGB,ECD,VGA,SVGA
4 G 320x200 4 CGA,EGA,VGA,MCGA,SVGA RGB,ECD,VGA,SVGA
5 G 320x200 4 CGA,EGA,VGA,MCGA,SVGA RGB,ECD,VGA,SVGA
6 G 640x200 2/16 CGA,EGA,VGA,MCGA,SVGA RGB,ECD,VGA,SVGA
7 T 80x25 b/w MDA,HGC,EGA,VGA,SVGA Monochrome
9 G 320x200 16 Tandy 1000,PCjr RGB
11 G 720x348 b/w HGC Monochrome
12 G 320x200 b/w HGC Monochrome
13 G 320x200 16 EGA,VGA,SVGA RGB,ECD,VGA,SVGA
14 G 640x200 16 EGA,VGA,SVGA RGB,ECD,VGA,SVGA
15 G 640x350 b/w EGA,VGA,SVGA Mono,VGA,SVGA
16 G 640x350 16/64 EGA,VGA,SVGA ECD,VGA,SVGA
17 G 640x480 2/256K VGA,MCGA,SVGA VGA,SVGA
18 G 640x480 16/256K VGA,SVGA VGA,SVGA
19 G 320x200 256/256K VGA,MCGA,SVGA VGA,SVGA
20 G 320x200 256/256K VGA,SVGA VGA,SVGA
21 G 320x400 256/256K VGA,SVGA VGA,SVGA
22 G 320x240 256/256K VGA,SVGA VGA,SVGA
23 G 320x480 256/256K VGA,SVGA VGA,SVGA
24 G 640x400 256/256K SVGA SVGA
25 G 640x480 256/256K SVGA SVGA
26 G 800x600 256/256K SVGA SVGA
27 G 1024x768 256/256K SVGA SVGA
28 G 800x600 16/256K SVGA SVGA
29 G 1024x768 16/256K SVGA SVGA
For more information about each video mode, including their required display adapters (graphics cards) and monitors, please refer to the Fastgraph User's Guide.
224 �
fg_setmode (continued)
Parameters (continued)
The value of mode_number can also be -1, which tells Fastgraph to use the current video mode. This feature is often useful in programs that use only text video modes, programs executed from another program, or terminate and stay resident (TSR) programs.
Return value
none
Restrictions
The fg_setmode routine does not check if the specified video mode is available on the user's system. If necessary, you should first use fg_testmode to do this.
SVGA graphics modes (24 to 29) are only available after successfully initializing the SVGA kernel with fg_svgainit.
This routine has no effect when a virtual buffer is active.
See also
fg_automode, fg_bestmode, fg_svgainit, fg_testmode
Examples
3-1 to 3-8, 3-10
225 �
fg_setnum
Prototype
void fg_setnum (int state); sub FGsetnum (state%) subroutine fg_setnum (int state) procedure fg_setnum (state : integer);
Description
The fg_setnum routine controls the state of the NumLock key.
Parameters
state defines the NumLock key state. If state is 0, the NumLock key is turned off. If it is 1, the NumLock key is turned on.
Return value
none
Restrictions
On most keyboards, changing the NumLock key state will also change the keyboard state light to reflect the new key state. However, some older keyboards, especially when used on PC, PC/XT, or Tandy 1000 systems, do not update the state light. This makes the state light inconsistent with the true key state.
See also
fg_capslock, fg_numlock, fg_scrlock, fg_setcaps
Examples
14-4
226 �
fg_setpage
Prototype
void fg_setpage (int page_number); sub FGsetpage (page_number%) subroutine fg_setpage (int page_number) procedure fg_setpage (page_number : integer);
Description
The fg_setpage routine establishes the active video page. It may be a physical or virtual video page. The fg_setmode routine designates video page 0 as the active page.
Parameters
page_number is the active video page number, between 0 and 63.
Return value
none
Restrictions
This routine has no effect if page_number references a physical video page that does not exist, or a virtual video page that has not been created.
See also
fg_getpage, fg_sethpage, fg_setvpage
Examples
8-1 to 8-9, 8-13, 12-4, 12-5, 12-6, 13-2, 13-9
227 �
fg_setratio
Prototype
void fg_setratio (double ratio); sub FGsetratio (ratio#) subroutine fg_setratio (dbl ratio) procedure fg_setratio (ratio : real);
Description
The fg_setratio routine defines the aspect ratio for software characters. The aspect ratio is the ratio of character width to character height. If a program draws software characters before calling fg_setratio, Fastgraph will use its default aspect ratio of 1.
Parameters
ratio is the aspect ratio. It must be greater than zero.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light. Before using this routine, you must use fg_initw and fg_setworld to establish a world space coordinate system.
See also
fg_initw, fg_setangle, fg_setsize, fg_setsizew, fg_setworld, fg_swchar, fg_swlength, fg_swtext
Examples
7-11
228 �
fg_setrgb
Prototype
void fg_setrgb (int number, int red, int green, int blue); sub FGsetrgb (number%, red%, green%, blue%) subroutine fg_setrgb (int number, int red, int green, int blue) procedure fg_setrgb (number, red, green, blue : integer);
Description
The fg_setrgb defines the value of a palette register (in Tandy/PCjr and EGA graphics modes) or video DAC register (in VGA, MCGA, XVGA, and SVGA graphics modes) by specifying its red, green, and blue color components.
Parameters
number is the palette or video DAC register number. If it references a palette register, it must be between 0 and 15 (0 and 1 in mode 17). If it references a video DAC register, it must be between 0 and 255. The value of number may be negative to specify an intense color for that palette register in Tandy/PCjr and 200-line EGA graphics modes.
red, green, and blue respectively specify the red, green, and blue components of the specified palette or video DAC register. These values must be 0 or 1 for Tandy/PCjr and 200-line EGA graphics modes, between 0 and 3 for 350-line EGA modes, and between 0 and 63 for VGA, MCGA, XVGA, and SVGA modes.
Return value
none
Restrictions
This routine has no effect in text video modes, CGA graphics modes, or Hercules graphics modes.
See also
fg_getrgb, fg_palette, fg_setcolor, fg_setdacs
Examples
5-9, 5-11, 5-13, 5-16, 9-11
229 �
fg_setsize
Prototype
void fg_setsize (int size); sub FGsetsize (size%) subroutine fg_setsize (int size) procedure fg_setsize (size : integer);
Description
The fg_setsize routine defines the height of software characters in screen space units. If neither fg_setsize nor fg_setsizew is called, Fastgraph will use its default character height of one world space unit.
Parameters
size is the character height in screen space units.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light. Before using this routine, you must use fg_initw and fg_setworld to establish a world space coordinate system.
See also
fg_initw, fg_setangle, fg_setratio, fg_setsizew, fg_setworld, fg_swchar, fg_swlength, fg_swtext
230 �
fg_setsizew
Prototype
void fg_setsizew (double size); sub FGsetsizew (size#) subroutine fg_setsizew (dbl size) procedure fg_setsizew (size : real);
Description
The fg_setsizew routine defines the height of software characters in world space units. If neither fg_setsize nor fg_setsizew is called, Fastgraph will use its default character height of one world space unit.
Parameters
size is the character height in world space units.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light. Before using this routine, you must use fg_initw and fg_setworld to establish a world space coordinate system.
See also
fg_initw, fg_setangle, fg_setratio, fg_setsize, fg_setworld, fg_swchar, fg_swlength, fg_swtext
Examples
7-10, 7-11, 7-12, 7-13
231 �
fg_setview
Prototype
void fg_setview (int view_minx, int view_maxx, int view_miny,
int view_maxy, int minx, int maxx, int miny, int maxy);
sub FGsetview (view_minx%, view_maxx%, view_miny%, view_maxy%, minx%,
maxx%, miny%, maxy%)
subroutine fg_setview (int view_minx, int view_maxx, int view_miny,
int view_maxy, int minx, int maxx, int miny, int maxy)
procedure fg_setview (view_minx, view_maxx, view_miny, view_maxy,
minx, maxx, miny, maxy : integer);
Description
The fg_setview routine defines a viewport with the specified extremes at the specified screen space position.
Parameters
view_minx is the viewport's left edge in viewport units.
view_maxx is the viewport's right edge in viewport units. Its value must be greater than view_minx.
view_miny is the viewport's top edge in viewport units.
view_maxy is the viewport's bottom edge in viewport units. Its value must be greater than view_miny.
minx is the screen space x coordinate corresponding to the viewport's left edge.
maxx is the screen space x coordinate corresponding to the viewport's right edge. It must be greater than minx.
miny is the screen space y coordinate corresponding to the viewport's top edge.
maxy is the screen space y coordinate corresponding to the viewport's bottom edge. It must be greater than miny.
Return value
none
Restrictions
none
See also
fg_getview, fg_xview, fg_yview
232 �
fg_setview (continued)
Examples
4-3
233 �
fg_setvpage
Prototype
void fg_setvpage (int page_number); sub FGsetvpage (page_number%) subroutine fg_setvpage (int page_number) procedure fg_setvpage (page_number : integer);
Description
The fg_setvpage routine establishes the visual video page. It may be a physical or virtual video page, but not a logical page. The fg_setmode routine designates video page 0 as the visual page.
Parameters
page_number is the visual video page number, between 0 and 63.
Return value
none
Restrictions
This routine has no effect if page_number references a physical video page that does not exist, or a virtual video page that has not been created.
See also
fg_getpage, fg_sethpage, fg_setpage
Examples
8-1 to 8-8, 12-6, 13-9
234 �
fg_setworld
Prototype
void fg_setworld (double xmin, double xmax, double ymin, double ymax); sub FGsetworld (xmin#, xmax#, ymin#, ymax#) subroutine fg_setworld (dbl xmin, dbl xmax, dbl ymin, dbl ymax) procedure fg_setworld (xmin, xmax, ymin, ymax : real);
Description
The fg_setworld routine defines the world space coordinates that correspond to the physical edges of the screen.
Parameters
xmin is the world space coordinate of the screen's left edge.
xmax is the world space coordinate of the screen's right edge. It must be greater than the value of xmin.
ymin is the world space coordinate of the screen's bottom edge.
ymax is the world space coordinate of the screen's top edge. It must be greater than the value of ymin.
Return value
none
Restrictions
This routine is not available in Fastgraph/Light. Before using this routine, you must call fg_initw to initialize Fastgraph's world space parameters.
See also
fg_getworld, fg_initw, fg_setview
Examples
4-4, 6-4, 6-9, 7-10, 7-11, 7-12, 7-13
235 �
fg_shear
Prototype
void fg_shear (char *source, char *dest, int width, int height,
int new_size, int type);
sub FGshear (source$, dest$, width%, height%, new_size%, type%)
subroutine fg_shear (int1 source, int1 dest, int width, int height,
int new_size, int type)
procedure fg_shear (var source, dest; width, height, new_size, type :
integer);
Description
The fg_shear routine shears a bitmapped image stored in the "one pixel per byte" format.
Parameters
source is the name of the array containing the "one pixel per byte" bitmapped image to be sheared.
dest is the name of the array that will receive the resulting sheared image.
width is the width of the source image in pixels. It must be greater than zero.
height is the height of the source image in pixels. It must be greater than zero.
new_size is the width in pixels (for horizontal shears) or height in pixels (for vertical shears) of the resulting dest image. It must be at least as large as the corresponding dimension in the source image.
type is a code indicating the shear type and direction, as shown here:
0 = horizontal shear to the left (bottom edge is stretched to the right)
1 = horizontal shear to the right (top edge is stretched to the right)
2 = vertical shear to the left (left edge is stretched up)
3 = vertical shear to the right (right edge is stretched up)
Return value
none
Restrictions
In 16-bit modes, the size of the source and dest arrays is limited to 64K
bytes.
The maximum allowable width or height of source and dest is 1,024 pixels.
See also
fg_drwimage, fg_pack, fg_putimage, fg_scale, fg_unpack
236 �
fg_shear (continued)
Examples
10-18
237 �
fg_showflic
Prototype
int fg_showflic (char *filename, int count, int flags); function FGshowflic% (filename$, count%, flags%) int function fg_showflic (char filename, int count, int flags) function fg_showflic (filename : string; count, flags : integer) : integer;
Description
The fg_showflic routine displays an image stored in an FLI or FLC file (collectively called flic files).
Parameters
filename is the name of the flic file. A device and path name may be included as part of the file name. The file name must be terminated by a zero byte.
count is the number of times to display the flic image. If count is zero, the flic plays continuously. You can stop the flic display at any time by pressing the Escape key.
flags is a bit mask that controls how the image is displayed.
Bit 0
0 = delay between frames as indicated in flic header
1 = no delay between frames
Bit 1
0 = display image relative to screen origin
1 = display image relative current graphics position
Bit 2
0 = display image from the specified flic file
1 = display image from the fg_imagebuf buffer
Bit 4
0 = use palette data in flic file
1 = ignore palette data in flic file
Bits 3 and 5-15 are reserved for future use and should be zero.
Return value
0 = success, 1 = file not found, 2 = file is not a flic file
Restrictions
Flic files are only meaningful in 256-color graphics modes. This routine has no effect in other video modes.
See also
fg_flichead, fg_flicmode, fg_flicplay, fg_flicsize, fg_imagebuf
Examples
9-6
238 �
fg_showgif
Prototype
int fg_showgif (char *filename, int flags); function FGshowgif% (filename$, flags%) int function fg_showgif (char filename, int flags) function fg_showgif (filename : string; flags : integer) : integer;
Description
The fg_showgif routine displays an image stored in a GIF file.
Parameters
filename specifies the name of the GIF file. A device and path name may be included as part of the file name. The file name must be terminated by a zero byte.
flags is a bit mask that controls how the image is displayed.
Bit 0
0 = use palette values stored in the GIF file
1 = use the current palette settings
Bit 1
0 = display image at position indicated in GIF header
1 = display image at current graphics position
Bit 2
0 = display image from the GIF file
1 = display image from the fg_imagebuf buffer
Bits 3-15 are reserved for future use and should be zero.
Return value
0 = success 1 = file not found 2 = file is not a GIF file
Restrictions
This routine has no effect in text video modes, or the CGA and Hercules graphics modes.
When displaying a 256-color GIF in a 16-color graphics mode, fg_showgif displays pixels of color c in color c modulo 16.
See also
fg_gifhead, fg_gifmode, fg_gifpal, fg_gifrange, fg_imagebuf, fg_makegif
Examples
9-4
239 �
fg_showpcx
Prototype
int fg_showpcx (char *filename, int flags); function FGshowpcx% (filename$, flags%) int function fg_showpcx (char filename, int flags) function fg_showpcx (filename : string; flags : integer) : integer;
Description
The fg_showpcx routine displays an image stored in a PCX file.
Parameters
filename is the name of the PCX file. A device and path name may be included as part of the file name. The file name must be terminated by a null character (that is, a zero byte).
flags is a bit mask that controls how the image is displayed.
Bit 0
0 = use palette values stored in the PCX file
1 = use the current palette settings
Bit 1
0 = display image at position indicated in PCX header
1 = display image at current graphics position
Bit 2
0 = display image from the PCX file
1 = display image from the fg_imagebuf buffer
Bits 3-15 are reserved for future use and should be zero.
Return value
0 = success 1 = file not found 2 = file is not a PCX file
Restrictions
PCX files are specific to certain video modes. The following table summarizes the compatible video modes for PCX files.
If PCX file was You can display
created in mode it in these modes
4, 5 4, 5
6, 11 6, 11, 13-18, 28, 29
9 9
13-18 13-18, 28, 29
19-27 19-27
28-29 13-18, 28, 29
240 �
fg_showpcx (continued)
Restrictions (continued)
Displaying a PCX file at a lower resolution (for example, a 640x480 PCX file at 320x200) will truncate the display on the right and on the bottom. This effectively displays the upper left corner of the PCX file. If you attempt to display a PCX file in an incompatible video mode, fg_showpcx will still display something, but it will be garbled.
The fg_showpcx routine has no effect in text video modes or in the Hercules low-resolution graphics mode.
You cannot use fg_showpcx to load a PCX file into a virtual buffer. The fg_loadpcx routine is provided for this purpose.
See also
fg_imagebuf, fg_loadpcx, fg_makepcx, fg_pcxhead, fg_pcxmode, fg_pcxpal, fg_pcxrange
Examples
9-1, 9-12
241 �
fg_showppr
Prototype
int fg_showppr (char *filename, int width); function FGshowppr% (filename$, width%) int function fg_showppr (char filename, int width) function fg_showppr (filename : string; width : integer) : integer;
Description
The fg_showppr routine displays an image stored in a packed pixel run (PPR) file. The image will be positioned so that its lower left corner is at the graphics cursor position on the active video page or virtual buffer.
Parameters
filename specifies the name of the PPR file. A device and path name may be included as part of the file name. The file name must be terminated by a zero byte.
width is the width of the image in pixels. It must be greater than zero.
Return value
0 = success 1 = file not found
Restrictions
This routine has no effect in text video modes.
See also
fg_dispfile, fg_imagebuf, fg_makeppr, fg_pattern, fg_showspr
Examples
9-11
242 �
fg_showspr
Prototype
int fg_showspr (char *filename, int width); function FGshowspr% (filename$, width%) int function fg_showspr (char filename, int width) function fg_showspr (filename : string; width : integer) : integer;
Description
The fg_showspr routine displays an image stored in a standard pixel run (SPR) file. The image will be positioned so that its lower left corner is at the graphics cursor position on the active video page or virtual buffer.
Parameters
filename specifies the name of the SPR file. A device and path name may be included as part of the file name. The file name must be terminated by a zero byte.
width is the width of the image in pixels. It must be greater than zero.
Return value
0 = success 1 = file not found
Restrictions
This routine has no effect in text video modes.
See also
fg_dispfile, fg_imagebuf, fg_makespr, fg_pattern, fg_showppr
Examples
9-9
243 �
fg_sound
Prototype
void fg_sound (int frequency, int duration); sub FGsound (frequency%, duration%) subroutine fg_sound (int frequency, int duration) procedure fg_sound (frequency, duration : integer);
Description
The fg_sound routine produces a tone of a specified frequency and duration using the programmable timer.
Parameters
frequency is tone's frequency in Hertz, between 18 and 32,767.
duration is the tone's length in clock ticks (there are approximately 18.2 clock ticks per second). If duration is zero or negative, the tone is said to be continuous and will play until you stop it with fg_quiet.
Return value
none
Restrictions
This routine has no effect if there is asynchronous sound already in progress.
See also
fg_music, fg_quiet, fg_sounds, fg_voice
Examples
15-1
244 �
fg_sounds
Prototype
void fg_sounds (int *sound_array, int ntimes); sub FGsounds (sound_array%(), ntimes%) subroutine fg_sounds (int sound_array, int ntimes) procedure fg_sounds (var sound_array : integer; ntimes : integer);
Description
The fg_sounds routine uses the programmable timer to play a series of tones of specified frequencies and durations, concurrent with other activity. It is the asynchronous version of fg_sound.
Parameters
sound_array is the name of the array containing a series of (frequency,duration) sound definitions. The format of this array is:
[0] frequency of sound 1
[1] duration of sound 1
[2] frequency of sound 2
[3] duration of sound 2
.
.
.
[2n-2] frequency of sound n
[2n-1] duration of sound n
[2n] terminator (0)
Each frequency value is measured in Hertz and must be between 18 and 32,767. The durations are measured in clock ticks (there are approximately 72.8 clock ticks per second). A null character (that is, a zero byte) terminates the array.
ntimes specifies the number of times to cycle through the sounds defined in sound_array. If ntimes is negative, the sounds will play repetitively until stopped with fg_hush or fg_hushnext.
Return value
none
Restrictions
This routine has no effect if there is asynchronous sound already in progress.
245 �
fg_sounds (continued)
Restrictions (continued)
To expand the range of sound effects, Fastgraph temporarily quadruples the clock tick interrupt rate from 18.2 to 72.8 ticks per second while producing asynchronous sound. Because many disk controllers rely on the 18.2 tick per second clock rate to synchronize disk accesses, your programs should not perform any disk operations when asynchronous sound is in progress.
In 16-bit modes, the size of sound_array is limited to 64K bytes.
See also
fg_hush, fg_hushnext, fg_musicb, fg_playing, fg_sound, fg_voice, fg_voices
Examples
15-4
246 �
fg_split
Prototype
void fg_split (int iy); sub FGsplit (iy%) subroutine fg_split (int iy) procedure fg_split (iy : integer);
Description
The fg_split routine enables or disables a split screen environment. When a split screen is enabled, the top portion of the screen (rows 0 through iy-1) will contain a subset of the visual video page. The bottom portion (starting at row iy) will contain the first fg_getmaxy()-iy+1 rows of video page 0.
Parameters
iy is the screen space row number at which the split screen takes effect. To disable a split screen, set iy to the vertical resolution of the current video mode.
Return value
none
Restrictions
This routine is meaningful only in EGA, VGA, MCGA, and XVGA graphics modes (modes 13 to 23) when run on a VGA or SVGA system.
See also
fg_pan, fg_setvpage
Examples
13-9
247 �
fg_stall
Prototype
void fg_stall (int delay); sub FGstall (delay%) subroutine fg_stall (int delay) procedure fg_stall (delay : integer);
Description
The fg_stall routine delays a program's execution for a given number of processor-specific delay units. You can use fg_measure to obtain the number of delay units per clock tick for the system being used.
Parameters
delay is the number of delay units to wait.
Return value
none
Restrictions
none
See also
fg_measure, fg_waitfor
Examples
13-9, 16-3
248 �
fg_suspend
Prototype
void fg_suspend (void); sub FGsuspend () subroutine fg_suspend () procedure fg_suspend;
Description
The fg_suspend routine suspends asynchronous music previously started by fg_musicb. It has no effect if there is no asynchronous music in progress.
Parameters
none
Return value
none
Restrictions
A program must not exit to DOS with music suspended. You must call fg_hush to cancel the music first.
See also
fg_hush, fg_musicb, fg_resume
Examples
15-8
249 �
fg_svgainit
Prototype
int fg_svgainit (int method); function FGsvgainit% (method%) int function fg_svgainit (int method) function fg_svgainit (method : integer) : integer;
Description
The fg_svgainit routine initializes Fastgraph's SVGA kernel. It must be called before establishing an SVGA graphics mode (modes 24 to 29) with fg_setmode, before testing SVGA video mode availability with fg_bestmode or fg_testmode, or before calling fg_memory.
Parameters
method specifies how to initialize the SVGA kernel. If method is 0, the SVGA kernel performs a chipset autodetect, giving chipset-specific code precedence over the VESA BIOS. If method is 1, the SVGA kernel also performs an autodetect but gives the VESA BIOS precedence over chipset- specific code. If method is 2 or more, the SVGA kernel is initialized for a specific chipset (without testing for presence of that chipset). Refer to Chapter 3 of the Fastgraph User's Guide for a list of supported chipsets.
Return value
For autodetect requests (method = 0 or 1), fg_svgainit returns a value between 1 and 34 corresponding to the SVGA chipset found. A value of 1 means a VESA BIOS will be used. A value between 2 and 34 means a specific SVGA chipset will be used. If no VESA BIOS or supported SVGA chipset is found, fg_svgainit returns zero.
For specific chipsets, fg_svgainit returns the chipset value passed to it. No checks are made to see if that chipset is actually present.
Restrictions
none
See also
fg_setmode, fg_svgastat
Examples
3-9, 3-10
250 �
fg_svgastat
Prototype
int fg_svgastat (void); function FGsvgastat% () int function fg_svgastat () function fg_svgastat : integer;
Description
The fg_svgastat routine returns information about the current state of Fastgraph's SVGA kernel.
Parameters
none
Return value
A bit mask containing information about the SVGA kernel.
Bit 0
0 = SVGA kernel not initialized (all bits will be 0 in this case)
1 = SVGA kernel initialized
Bit 1
0 = VESA support disabled
1 = VESA support enabled
Bit 2
0 = Extended video pages are not available in modes 13-23
1 = Extended video pages are available in these modes
Bit 3
0 = SVGA chipset uses one bank for reading and writing
1 = SVGA chipset has separate read and write banks
Bits 4-15 are reserved for future use and are all zero.
Restrictions
none
See also
fg_svgainit
Examples
8-8
251 �
fg_svgaver
Prototype
void fg_svgaver (int *major, int *minor); sub FGsvgaver (major%, minor%) subroutine fg_svgaver (int major, int minor) procedure fg_svgaver (var major, minor : integer);
Description
The fg_svgaver routine returns the major and minor version numbers for Fastgraph's SVGA kernel.
Parameters
major receives the SVGA kernel major version number.
minor receives the SVGA kernel minor version number, expressed in hundredths.
Return value
none
Restrictions
none
See also
fg_svgainit, fg_version
Examples
3-9
252 �
fg_swchar
Prototype
void fg_swchar (char *string, int n, int justify); sub FGswchar (string$, n%, justify%) subroutine fg_swchar (char string, int n, int justify) procedure fg_swchar (string : string; n, justify : integer);
Description
The fg_swchar routine displays a string of software characters in the current color index. The string may be left justified, centered, or right justified relative to the graphics cursor.
Parameters
string is the arbitrary-length sequence of characters to display. It may contain special operators, as summarized in the following table.
operatormeaning
\ switch to other font
\^ superscript the next character
\v subscript the next character
_ begin underlining characters until another
underscore character is encountered
n is the number of characters in string, including any special operator characters.
justify determines how string is positioned relative to the current position. If justify is negative, string is left justified; if it is zero, string is centered; if it is positive, string is right justified.
Return value
none
Restrictions
Before using this routine, you must use fg_initw and fg_setworld to establish a world space coordinate system. This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_initw, fg_setangle, fg_setratio, fg_setsize, fg_setsizew, fg_setworld, fg_swlength, fg_swtext
Examples
7-10, 7-11
253 �
fg_swlength
Prototype
double fg_swlength (char *string, int n); function FGswlength# (string$, n%) dbl function fg_swlength (char string, int n) function fg_swlength (string : string; n : integer) : real;
Description
The fg_swlength routine computes the length of a string of software characters.
Parameters
string is the arbitrary-length sequence of characters for which to compute the length. It may contain special operators used by the fg_swchar and fg_swtext routines.
n is the number of characters in string, including any special operator characters.
Return value
The length of string, in world space units.
Restrictions
Before using this routine, you must use fg_initw and fg_setworld to establish a world space coordinate system. This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_initw, fg_setangle, fg_setratio, fg_setsize, fg_setsizew, fg_setworld, fg_swchar, fg_swtext
Examples
7-13
254 �
fg_swtext
Prototype
void fg_swtext (char *string, int n, int justify); sub FGswtext (string$, n%, justify%) subroutine fg_swtext (char string, int n, int justify) procedure fg_swtext (string : string; n, justify : integer);
Description
The fg_swtext routine is a scaled down version of fg_swchar. It does not include the alternate font character definitions and thus requires less memory than fg_swchar.
Parameters
string is the arbitrary-length sequence of characters to display. It may contain special operators, as summarized in the following table.
operatormeaning
\^ superscript the next character
\v subscript the next character
_ begin underlining characters until another
underscore character is encountered
n is the number of characters in string, including any special operator characters.
justify determines how string is positioned relative to the current position. If justify is negative, string is left justified; if it is zero, string is centered; if it is positive, string is right justified.
Return value
none
Restrictions
Before using this routine, you must use fg_initw and fg_setworld to establish a world space coordinate system. This routine is not available in Fastgraph/Light and has no effect in text video modes.
See also
fg_initw, fg_setangle, fg_setratio, fg_setsize, fg_setsizew, fg_setworld, fg_swchar, fg_swlength
Examples
7-12, 7-13
255 �
fg_tcdefine
Prototype
void fg_tcdefine (int index, int attribute); sub FGtcdefine (index%, attribute%) subroutine fg_tcdefine (int index, int attribute) procedure fg_tcdefine (index, attribute : integer);
Description
The fg_tcdefine routine defines the transparency attribute of a color index for use with fg_tcxfer and fg_vbtcxfer.
Parameters
index is the color index being defined (between 0 and 255).
attribute is the transparency attribute for the color index. If the attribute is 0, the specified color will be opaque (non-transparent). If it is any other value, fg_tcxfer and fg_vbtcxfer will treat the color as transparent.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_tcmask, fg_tcxfer, fg_vbtcxfer
Examples
11-9
256 �
fg_tcmask
Prototype
void fg_tcmask (int mask); sub FGtcmask (mask%) subroutine fg_tcmask (int mask) procedure fg_tcmask (mask : integer);
Description
The fg_tcmask routine defines which of the first 16 color values fg_tcxfer and fg_vbtcxfer will consider transparent. Use fg_tcdefine to control the transparency of colors 17 to 255 in the 256-color graphics modes.
Parameters
mask is a 16-bit mask, where each bit indicates whether or not the corresponding color value is transparent. For example, if bit 0 (the rightmost bit) is 1, then color 0 will be transparent. If bit 0 is 0, color 0 will not be transparent.
Return value
none
Restrictions
This routine has no effect in text video modes.
See also
fg_tcdefine, fg_tcxfer, fg_vbtcxfer
Examples
11-8
257 �
fg_tcxfer
Prototype
void fg_tcxfer (int minx, int maxx, int miny, int maxy, int newx, int newy,
int source_page, int dest_page);
sub FGtcxfer (minx%, maxx%, miny%, maxy%, newx%, newy%, source_page%,
dest_page%)
subroutine fg_tcxfer (int minx, int maxx, int miny, int maxy, int newx,
int newy, int source_page, int dest_page)
procedure fg_tcxfer (minx, maxx, miny, maxy, newx, newy, source_page,
dest_page : integer);
Description
The fg_tcxfer routine copies a rectangular region from any position on any video page to any position on any video page, excluding any pixels whose color is transparent. As with Fastgraph's other block transfer routines, no clipping is performed. The fg_tcdefine and fg_tcmask routines define which colors are transparent.
Parameters
minx is the x coordinate of the source region's left edge. Its value is reduced to a byte boundary if necessary.
maxx is the x coordinate of the source region's right edge. It must be greater than or equal to the value of minx. Its value is extended to a byte boundary if necessary.
miny is the y coordinate of the source region's top edge.
maxy is the y coordinate of the source region's bottom edge. It must be greater than or equal to the value of miny.
newx is the x coordinate of the destination region's left edge. Its value is reduced to a byte boundary if necessary.
newy is the y coordinate of the destination region's bottom edge.
source_page is the video page number containing the source region.
dest_page is the video page number for the destination region.
Return value
none
Restrictions
If source_page and dest_page reference the same video page, the source and destination regions must not overlap. This routine has no effect in text video modes.
258 �
fg_tcxfer (continued)
Restrictions (continued)
The fg_tcxfer routine always applies to video pages, even when a virtual buffer is active.
See also
fg_tcdefine, fg_tcmask, fg_transfer, fg_vbtccopy, fg_vbtcxfer
Examples
11-8
259 �
fg_testmode
Prototype
int fg_testmode (int mode, int pages); function FGtestmode% (mode%, pages%) int function fg_testmode (int mode, int pages) function fg_testmode (mode, pages : integer) : integer;
Description
The fg_testmode routine determines whether or not a specified video mode is available on the user's system. Additionally, fg_testmode can check if there is enough video memory (for physical pages) or random-access memory (for virtual pages) to support the number of video pages needed.
Parameters
mode is the video mode number to test, between 0 and 29. Refer to the description of fg_setmode for a list of available video modes.
pages is the number of video pages required (either physical pages, virtual pages, or both). If the pages parameter is zero or negative, fg_testmode checks for availability of the video mode but does not consider video memory requirements.
Return value
If the requested video mode is available (with the requested number of video pages), fg_testmode returns 1. If not, it returns 0.
Restrictions
SVGA graphics modes are available only after successfully initializing the SVGA kernel with fg_svgainit.
The fg_testmode routine does not consider extended video pages when testing if the requested number of video pages is available.
See also
fg_automode, fg_bestmode, fg_setmode, fg_svgainit
Examples
3-3, 3-5, 3-8, 3-10, 5-16, 6-7, 6-8
260 �
fg_text
Prototype
void fg_text (char *string, int n); sub FGtext (string$, n%) subroutine fg_text (char string, int n) procedure fg_text (string : string; n : integer);
Description
The fg_text routine displays a string of hardware characters, starting at the text cursor position, using the current text attribute (for text modes) or color index (for graphics modes), without clipping. This routine leaves the text cursor one column to the right of the last character displayed (or the first column of the next row if the last character is at the end of a row).
Parameters
string is the arbitrary-length sequence of characters to display.
n is the number of characters to display from string.
Return value
none
Restrictions
none
See also
fg_locate, fg_print, fg_setattr, fg_textc
Examples
7-1, 7-2, 7-3, 7-4, 7-5, 7-7, 7-8, 7-9, 7-10
261 �
fg_textc
Prototype
void fg_textc (char *string, int n); sub FGtextc (string$, n%) subroutine fg_textc (char string, int n) procedure fg_textc (string : string; n : integer);
Description
The fg_textc routine displays a string of hardware characters, starting at the text cursor position, using the current text attribute (for text modes) or color index (for graphics modes). In graphics modes, only that part of the string that falls within the current clipping limits will be displayed. This routine leaves the text cursor one column to the right of the last character displayed (or the first column of the next row if the last character is at the end of a row).
Parameters
string is the arbitrary-length sequence of characters to display.
n The number of characters to display from string.
Return value
none
Restrictions
none
See also
fg_locate, fg_printc, fg_setattr, fg_setclip, fg_text
262 �
fg_transfer
Prototype
void fg_transfer (int minx, int maxx, int miny, int maxy, int newx,
int newy, int source_page, int dest_page);
sub FGtransfer (minx%, maxx%, miny%, maxy%, newx%, newy%, source_page%,
dest_page%)
subroutine fg_transfer (int minx, int maxx, int miny, int maxy, int newx,
int newy, int source_page, int dest_page)
procedure fg_transfer (minx, maxx, miny, maxy, newx, newy, source_page,
dest_page : integer);
Description
The fg_transfer routine copies a rectangular region from one video page to another, or to a non-overlapping position on the same video page. In text modes, the region is defined in character space; in graphics modes, it is defined in screen space. As with Fastgraph's other block transfer routines, no clipping is performed.
Parameters
minx is the x coordinate of the source region's left edge. In graphics modes, its value is reduced to a byte boundary if necessary.
maxx is the x coordinate of the source region's right edge. It must be greater than or equal to the value of minx. In graphics modes, its value is extended to a byte boundary if necessary.
miny is the y coordinate of the source region's top edge.
maxy is the y coordinate of the source region's bottom edge. It must be greater than or equal to the value of miny.
newx is the x coordinate of the destination region's left edge. Its value is reduced to a byte boundary if necessary.
newy is the y coordinate of the destination region's bottom edge.
source_page is the video page number containing the source region.
dest_page is the video page number for the destination region.
Return value
none
Restrictions
If source_page and dest_page reference the same video page, the source and destination regions must not overlap.
The fg_transfer routine always applies to video pages, even when a virtual buffer is active.
263 �
fg_transfer (continued)
See also
fg_copypage, fg_restore, fg_save, fg_tcxfer, fg_vbcopy
Examples
11-4, 11-5, 11-6, 12-4, 12-5, 12-6
264 �
fg_unpack
Prototype
void fg_unpack (char *source, char *dest, int size); sub FGunpack (source$, dest$, size%) subroutine fg_unpack (int1 source, int1 dest, int size) procedure fg_unpack (var source, dest; size : integer);
Description
The fg_unpack routine converts a mode-specific bitmapped image to the "one pixel per byte" format used in 256-color graphics modes and virtual buffers. Refer to the Fastgraph User's Guide for complete information about mode-specific bitmaps.
In 256-color graphics modes, or when a virtual buffer is active, fg_unpack merely copies the source array to the dest array.
Parameters
source is the name of the array containing the mode-specific bitmapped image to convert. It is assumed to be in the mode-specific format for the current video mode.
dest is the name of the array that will receive the converted bitmapped image.
size is the size of the source array in bytes.
Return value
none
Restrictions
In 16-bit modes, the size of the source and dest arrays is limited to 64K bytes.
This routine has no effect in text video modes.
See also
fg_clpimage, fg_drwimage, fg_flpimage, fg_getimage, fg_pack, fg_putimage, fg_revimage, fg_scale, fg_shear
Examples
10-16
265 �
fg_vbaddr
Prototype
long fg_vbaddr (int handle); function FGvbaddr& (handle%) int4 function fg_vbaddr (int handle) function fg_vbaddr (handle : integer) : pointer;
Description
The fg_vbaddr routine returns the address of the specified virtual buffer.
Parameters
handle is the handle that references the virtual buffer, between 0 and 31.
Return value
The address of the specified virtual buffer. In 16-bit modes, the address will be a real mode segment:offset pair or protected mode selector:offset pair. In 32-bit modes, it will be an offset into the default data segment.
Restrictions
If handle does not reference a valid virtual buffer handle, the return value will be undefined.
See also
fg_vbopen
266 �
fg_vballoc
Prototype
int fg_vballoc (int width, int height); function FGvballoc% (width%, height%) int function fg_vballoc (int width, int height) function fg_vballoc (width, height : integer) : integer;
Description
The fg_vballoc routine creates a virtual buffer of the specified size. The memory for the virtual buffer is allocated automatically. This routine should be used instead of fg_vbdefine for real mode compilers that do not support huge memory blocks (that is, far blocks larger than 64K bytes).
Parameters
width is the width of the virtual buffer in pixels.
height is the height of the virtual buffer in pixels.
Return value
If successful, fg_vballoc returns a handle by which the virtual buffer is referenced (between 0 and 31). If unsuccessful, the possible return codes are -1 (virtual buffer table full) or -2 (cannot allocate memory for the virtual buffer).
Restrictions
This routine is present in the Fastgraph real mode libraries only. In protected mode, use fg_vbdefine to create virtual buffers.
BASIC programmers must use the SETMEM function to reduce the far heap size by the virtual buffer size plus 16 bytes before creating a virtual buffer with fg_vballoc.
Pascal programmers must use the $M directive to reduce the far heap size by the virtual buffer size before calling fg_vballoc.
See also
fg_vbdefine, fg_vbfree, fg_vbinit, fg_vbopen
267 �
fg_vbclose
Prototype
void fg_vbclose (void); sub FGvbclose () subroutine fg_vbclose () procedure fg_vbclose;
Description
The fg_vbclose routine closes the active virtual buffer and directs graphics output back to the active video page.
Parameters
none
Return value
none
Restrictions
none
See also
fg_vbopen
Examples
8-14, 8-15, 8-16, 8-17, 9-2, 10-16, 10-19, 11-7, 11-9, 13-8
268 �
fg_vbcopy
Prototype
void fg_vbcopy (int minx, int maxx, int miny, int maxy, int newx, int newy,
int source, int dest);
sub FGvbcopy (minx%, maxx%, miny%, maxy%, newx%, newy%, source%, dest%)
subroutine fg_vbcopy (int minx, int maxx, int miny, int maxy, int newx,
int newy, int source, int dest)
procedure fg_vbcopy (minx, maxx, miny, maxy, newx, newy, source, dest :
integer);
Description
The fg_vbcopy routine copies a rectangular region from one virtual buffer to another, or to a non-overlapping position within the same virtual buffer.
Parameters
minx is the x coordinate of the source region's left edge.
maxx is the x coordinate of the source region's right edge. It must be greater than or equal to the value of minx.
miny is the y coordinate of the source region's top edge.
maxy is the y coordinate of the source region's bottom edge. It must be greater than or equal to the value of miny.
newx is the x coordinate of the destination region's left edge.
newy is the y coordinate of the destination region's bottom edge.
source is the handle for the virtual buffer containing the source region.
dest is the handle for the virtual buffer containing the destination region.
Return value
none
Restrictions
If source and dest reference the same virtual buffer, the source and destination regions must not overlap.
See also
fg_vbcut, fg_vbdefine, fg_vbpaste
Examples
11-7
269 �
fg_vbcut
Prototype
void fg_vbcut (int minx, int maxx, int miny, int maxy, int newx, int newy);
sub FGvbcut (minx%, maxx%, miny%, maxy%, newx%, newy%)
subroutine fg_vbcut (int minx, int maxx, int miny, int maxy, int newx,
int newy)
procedure fg_vbcut (minx, maxx, miny, maxy, newx, newy : integer);
Description
The fg_vbcut routine copies a rectangular region from the active video page to the active virtual buffer.
Parameters
minx is the x coordinate of the source region's left edge.
maxx is the x coordinate of the source region's right edge. It must be greater than or equal to the value of minx.
miny is the y coordinate of the source region's top edge.
maxy is the y coordinate of the source region's bottom edge. It must be greater than or equal to the value of miny.
newx is the x coordinate of the destination region's left edge.
newy is the y coordinate of the destination region's bottom edge.
Return value
none
Restrictions
none
See also
fg_vbcopy, fg_vbdefine, fg_vbpaste
Examples
8-15, 8-17
270 �
fg_vbdefine
Prototype
int fg_vbdefine (char [huge] *buffer, int width, int height); function FGvbdefine% (buffer$, width%, height%) int function fg_vbdefine (int1 [huge] buffer, int width, int height) function fg_vbdefine (buffer : pointer; width, height : integer) : integer;
Description
The fg_vbdefine routine creates a virtual buffer of the specified size.
Parameters
buffer is the address of the virtual buffer. It must reference a memory block of at least width*height bytes. Refer to Chapter 8 of the Fastgraph User's Guide for details about allocating blocks of memory suitable for virtual buffers. Note that buffer is passed by far reference in 16-bit modes except when using BASIC.
width is the width of the virtual buffer in pixels.
height is the height of the virtual buffer in pixels.
Return value
If successful, fg_vbdefine returns a handle by which the virtual buffer is referenced (between 0 and 31). If unsuccessful, the routine returns -1.
Restrictions
none
See also
fg_vballoc, fg_vbinit, fg_vbopen, fg_vbundef
Examples
8-14, 8-15, 8-16, 8-17, 9-2, 10-16, 10-19, 11-7, 11-9, 13-8
271 �
fg_vbfree
Prototype
void fg_vbfree (int handle); sub FGvbfree (handle%) subroutine fg_vbfree (int handle) procedure fg_vbfree (handle : integer);
Description
The fg_vbfree routine releases a virtual buffer's handle and frees the memory allocated to the virtual buffer.
Parameters
handle is the handle that references the virtual buffer to free. Its value must be between 0 and 31 and must not reference the active virtual buffer.
Return value
none
Restrictions
This routine is present in the Fastgraph real mode libraries only.
You should use fg_vbfree only with virtual buffers created with fg_vballoc.
This routine has no effect if handle references the active virtual buffer.
See also
fg_vballoc
272 �
fg_vbhandle
Prototype
int fg_vbhandle (void); function FGvbhandle% () int function fg_vbhandle () function fg_vbhandle : integer;
Description
The fg_vbhandle routine returns the handle of the active virtual buffer.
Parameters
none
Return value
The active virtual buffer handle, between 0 and 31. If no virtual buffer is active, the return value is -1.
Restrictions
none
See also
fg_vbopen
273 �
fg_vbinit
Prototype
void fg_vbinit (void); sub FGvbinit () subroutine fg_vbinit () procedure fg_vbinit;
Description
The fg_vbinit routine initializes Fastgraph's virtual buffer environment. This routine must be called once, before any other routines that reference virtual buffers.
Parameters
none
Return value
none
Restrictions
none
See also
fg_vballoc, fg_vbclose, fg_vbcopy, fg_vbcut, fg_vbdefine, fg_vbfree, fg_vbhandle, fg_vbopen, fg_vbpaste, fg_vbtcxfer, fg_vbundef
Examples
8-14, 8-15, 8-16, 8-17, 9-2, 10-16, 10-19, 11-7, 11-9, 13-8
274 �
fg_vbopen
Prototype
int fg_vbopen (int handle); function FGvbopen% (handle%) int function fg_vbopen (int handle) function fg_vbopen (handle : integer) : integer;
Description
The fg_vbopen routine makes an existing virtual buffer the active virtual buffer.
Parameters
handle is the handle of the desired virtual buffer, as returned by fg_vballoc or fg_vbdefine. Its value must be a valid virtual buffer handle between 0 and 31. If another virtual buffer is open when you call this routine, that virtual buffer is first closed.
Return value
0 = Virtual buffer opened successfully -1 = Invalid virtual buffer handle -2 = No virtual buffer yet defined for specified handle
Restrictions
none
See also
fg_vbclose, fg_vbdefine, fg_vbinit
Examples
8-14, 8-15, 8-16, 8-17, 9-2, 10-16, 10-19, 11-7, 11-9, 13-8
275 �
fg_vbpaste
Prototype
void fg_vbpaste (int minx, int maxx, int miny, int maxy, int newx,
int newy);
sub FGvbcopy (minx%, maxx%, miny%, maxy%, newx%, newy%)
subroutine fg_vbpaste (int minx, int maxx, int miny, int maxy, int newx,
int newy)
procedure fg_vbpaste (minx, maxx, miny, maxy, newx, newy : integer);
Description
The fg_vbpaste routine copies a rectangular region from the active virtual buffer to the active video page.
Parameters
minx is the x coordinate of the source region's left edge.
maxx is the x coordinate of the source region's right edge. It must be greater than or equal to the value of minx.
miny is the y coordinate of the source region's top edge.
maxy is the y coordinate of the source region's bottom edge. It must be greater than or equal to the value of miny.
newx is the x coordinate of the destination region's left edge.
newy is the y coordinate of the destination region's bottom edge.
Return value
none
Restrictions
none
See also
fg_vbcopy, fg_vbcut, fg_vbdefine, fg_vbtcxfer
Examples
8-14, 8-15, 8-16, 8-17, 9-2, 10-16, 10-19, 11-7, 11-9, 13-8
276 �
fg_vbtccopy
Prototype
void fg_vbtccopy (int minx, int maxx, int miny, int maxy, int newx,
int newy, int source, int dest);
sub FGvbtccopy (minx%, maxx%, miny%, maxy%, newx%, newy%, source%, dest%)
subroutine fg_vbtccopy (int minx, int maxx, int miny, int maxy, int newx,
int newy, int source, int dest)
procedure fg_vbtccopy (minx, maxx, miny, maxy, newx, newy, source, dest :
integer);
Description
The fg_vbtccopy routine copies a rectangular region from one virtual buffer to another, or to a non-overlapping position within the same virtual buffer, with transparent colors. Use fg_tcdefine or fg_tcmask to define which colors are transparent.
Parameters
minx is the x coordinate of the source region's left edge.
maxx is the x coordinate of the source region's right edge. It must be greater than or equal to the value of minx.
miny is the y coordinate of the source region's top edge.
maxy is the y coordinate of the source region's bottom edge. It must be greater than or equal to the value of miny.
newx is the x coordinate of the destination region's left edge.
newy is the y coordinate of the destination region's bottom edge.
source is the handle for the virtual buffer containing the source region.
dest is the handle for the virtual buffer containing the destination region.
Return value
none
Restrictions
If source and dest reference the same virtual buffer, the source and destination regions must not overlap.
See also
fg_tcdefine, fg_tcmask, fg_tcxfer, fg_vbcopy
277 �
fg_vbtcxfer
Prototype
void fg_vbtcxfer (int minx, int maxx, int miny, int maxy, int newx,
int newy);
sub FGvbtcxfer (minx%, maxx%, miny%, maxy%, newx%, newy%)
subroutine fg_vbtcxfer (int minx, int maxx, int miny, int maxy, int newx,
int newy)
procedure fg_vbtcxfer (minx, maxx, miny, maxy, newx, newy : integer);
Description
The fg_vbtcxfer routine copies a rectangular region from the active virtual buffer to the active video page, excluding any transparent pixels. The fg_tcdefine and fg_tcmask routines define which colors are transparent.
Parameters
minx is the x coordinate of the source region's left edge.
maxx is the x coordinate of the source region's right edge. It must be greater than or equal to the value of minx.
miny is the y coordinate of the source region's top edge.
maxy is the y coordinate of the source region's bottom edge. It must be greater than or equal to the value of miny.
newx is the x coordinate of the destination region's left edge.
newy is the y coordinate of the destination region's bottom edge.
Return value
none
Restrictions
none
See also
fg_tcdefine, fg_tcmask, fg_tcxfer, fg_vbdefine, fg_vbpaste, fg_vbtccopy
Examples
11-9
278 �
fg_vbundef
Prototype
void fg_vbundef (int handle); sub FGvbundef (handle%) subroutine fg_vbundef (int handle) procedure fg_vbundef (handle : integer);
Description
The fg_vbundef routine releases the handle associated with a virtual buffer.
Parameters
handle is the virtual buffer handle to release. Its value must be between 0 and 31 and must not reference the active virtual buffer.
Return value
none
Restrictions
This routine has no effect if handle references the active virtual buffer.
See also
fg_vbdefine
279 �
fg_version
Prototype
void fg_version (int *major, int *minor); sub FGversion (major%, minor%) subroutine fg_version (int major, int minor) procedure fg_version (var major, minor : integer);
Description
The fg_version routine returns the major and minor version numbers for your copy of Fastgraph or Fastgraph/Light. For example, if you are using Fastgraph version 2.10, the major version number is 2 and the minor version number is 10.
Parameters
major receives the major version number.
minor receives the minor version number, expressed in hundredths.
Return value
none
Restrictions
none
See also
fg_svgaver
Examples
1-1
280 �
fg_vgastate
Prototype
void fg_vgastate (int option); sub FGvgastate (option%) subroutine fg_vgastate (int option) procedure fg_vgastate (option : integer);
Description
The fg_vgastate routine saves or restores the state of the VGA Graphics Controller and Sequence Controller registers used by Fastgraph. The following items are saved or restored:
* Graphics Controller index
* Graphics Controller registers 0-8
* Sequence Controller index
* Sequence Controller register 2
If you request a restore operation before performing a save operation, fg_vgastate does nothing.
Parameters
option specifies whether fg_vgastate performs a save or restore operation. If option is zero, the current register values are saved. If it is any other value, the previously saved register values are restored.
Return value
none
Restrictions
This routine is meaningful only in video modes numbered 13 and above when running on a VGA or SVGA system.
281 �
fg_voice
Prototype
void fg_voice (int channel, int frequency, int volume, int duration); sub FGvoice (channel%, frequency%, volume%, duration%) subroutine fg_voice (int channel, int frequency, int volume, int duration) procedure fg_voice (channel, frequency, volume, duration : integer);
Description
The fg_voice routine produces a tone of a specified frequency, duration, and volume using one of the TI sound chip's four independent voice channels.
Parameters
channel defines the voice channel or type of noise, as shown here:
value meaning
1 voice channel #1
2 voice channel #2
3 voice channel #3
4 voice channel #4, periodic noise
5 voice channel #4, white noise
frequency defines the tone's frequency in Hertz. If channel is 1, 2, or 3, then frequency represents the actual frequency, between 18 and 32,767. If channel is 4 or 5, frequency is instead a value that represents a specific frequency, as shown here:
value frequency
0 512 Hertz
1 1024 Hertz
2 2048 Hertz
volume is the tone's volume, between 0 (silent) and 15 (loudest).
duration is the tone's length in clock ticks (there are approximately 18.2 clock ticks per second). If duration is zero or negative, the tone is said to be continuous and will play until you stop it with fg_quiet.
Return value
none
Restrictions
This routine should only be used on systems equipped with the TI sound chip (namely, the PCjr and Tandy 1000 systems). It has no effect if there is asynchronous sound already in progress.
282 �
fg_voice (continued)
See also
fg_music, fg_quiet, fg_sound, fg_voices
Examples
15-2
283 �
fg_voices
Prototype
void fg_voices (int *sound_array, int ntimes); sub FGvoices (sound_array%(), ntimes%) subroutine fg_voices (int sound_array, int ntimes) procedure fg_voices (var sound_array : integer; ntimes : integer);
Description
The fg_voices routine uses the TI sound chip to play a series of tones of specified frequencies, durations, and volumes, concurrent with other activity. It is the asynchronous version of fg_voice.
Parameters
sound_array is the name of the array containing a series of (channel, frequency, volume, duration) sound definitions. The format of this array is:
[0] channel # of sound 1
[1] frequency of sound 1
[2] volume of sound 1
[3] duration of sound 1
.
.
.
[4n-4] channel # of sound n
[4n-3] frequency of sound n
[4n-2] volume of sound n
[4n-1] duration of sound n
[4n] terminator (0)
The channel numbers, frequencies, volumes, and durations must be in the same ranges as discussed in the description of fg_voice, except the durations are quadrupled because of the accelerated clock tick interrupt rate (there are 72.8 instead of 18.2 clock ticks per second). A null character (that is, a zero byte) terminates the array.
ntimes specifies the number of times to cycle through the sounds defined in sound_array. If ntimes is negative, the sounds will play repetitively until stopped with fg_hush or fg_hushnext.
284 �
fg_voices (continued)
Return value
none
Restrictions
This routine should only be used on systems equipped with the TI sound chip (namely, the PCjr and Tandy 1000 systems). It has no effect if there is asynchronous sound already in progress.
To expand the range of sound effects, Fastgraph temporarily quadruples the clock tick interrupt rate from 18.2 to 72.8 ticks per second while producing asynchronous sound. Because many disk controllers rely on the 18.2 tick per second clock rate to synchronize disk accesses, your programs should not perform any disk operations when asynchronous sound is in progress.
In 16-bit modes, the size of sound_array is limited to 64K bytes.
See also
fg_hush, fg_hushnext, fg_musicb, fg_playing, fg_sounds, fg_voice
Examples
15-5
285 �
fg_waitfor
Prototype
void fg_waitfor (int ticks); sub FGwaitfor (ticks%) subroutine fg_waitfor (int ticks) procedure fg_waitfor (ticks : integer);
Description
The fg_waitfor routine delays a program's execution for a given number of clock ticks. There are 18.2 clock ticks per second, regardless of the system's processor speed.
Parameters
ticks is the number of clock ticks to wait.
Return value
none
Restrictions
none
See also
fg_stall
Examples
5-11, 5-12, 12-1 to 12-6, 13-5, 13-6, 14-2, 14-5, 14-7, 14-8, 14-12, 14-13, 15-1, 15-2, 15-3, 15-6, 15-7, 16-1
286 �
fg_waitkey
Prototype
void fg_waitkey (void); sub FGwaitkey () subroutine fg_waitkey () procedure fg_waitkey;
Description
The fg_waitkey routine flushes the BIOS keyboard buffer (that is, removes any type-ahead characters) and then waits for another keystroke. It is most useful in "press any key to continue" situations.
Parameters
none
Return value
none
Restrictions
none
See also
fg_getkey, fg_intkey
Examples
3-2 to 3-8, 3-10
287 �
fg_waitvr
Prototype
void fg_waitvr (int state); sub FGwaitvr (state%) subroutine fg_waitvr (int state) procedure fg_waitvr (state : integer);
Description
The fg_waitvr routine disables or enables Fastgraph's internal vertical retrace waiting (it is enabled by default). When it is disabled, Fastgraph assumes your application will control the retrace synchronization as needed. Vertical retrace waiting applies to the Fastgraph routines listed in the "see also" section below.
Parameters
state defines whether vertical retrace waiting is enabled or disabled. If state is 0, vertical retrace waiting is disabled. If it is 1, vertical retrace waiting is enabled.
Return value
none
Restrictions
none
See also
fg_getdacs, fg_makegif, fg_makepcx, fg_palettes, fg_pan, fg_setdacs, fg_setvpage, fg_showgif, fg_showpcx
288 �
fg_where
Prototype
void fg_where (int *row, int *column); sub FGwhere (row%, column%) subroutine fg_where (int row, int column) procedure fg_where (row, column : integer);
Description
The fg_where routine retrieves the text cursor position for the active display page.
Parameters
row receives the text cursor's current row number, between 0 and one less than the number of character rows available.
column receives text cursor's current column number, between 0 and one less than the number of character columns available.
Return value
none
Restrictions
none
See also
fg_locate
Examples
7-2
289 �
fg_xalpha
Prototype
int fg_xalpha (int ix); function FGxalpha% (ix%) int function fg_xalpha (int ix) function fg_xalpha (ix : integer) : integer;
Description
The fg_xalpha routine translates a screen space x coordinate to the character space column containing that coordinate.
Parameters
ix is the screen space coordinate to translate.
Return value
The character space column containing the screen space coordinate ix. In text modes, the return value is equal to the value of ix.
Restrictions
none
See also
fg_xconvert, fg_yalpha, fg_yconvert
Examples
14-10
290 �
fg_xconvert
Prototype
int fg_xconvert (int column); function FGxconvert% (column%) int function fg_xconvert (int column) function fg_xconvert (column : integer) : integer;
Description
The fg_xconvert routine translates a character space column to the screen space coordinate of its leftmost pixel. In graphics video modes, fg_xconvert(1) is an easy way to determine the width in pixels of a character cell.
Parameters
column is the character space column to translate.
Return value
The screen space x coordinate of the leftmost pixel in the character space column column. In text modes, the return value is equal to the value of column.
Restrictions
none
See also
fg_xalpha, fg_yalpha, fg_yconvert
Examples
7-9, 14-8
291 �
fg_xscreen
Prototype
int fg_xscreen (double x); function FGxscreen% (x#) int function fg_xscreen (dbl x) function fg_xscreen (x : real) : integer;
Description
The fg_xscreen routine translates a world space x coordinate to its screen space equivalent.
Parameters
x is the world space coordinate to translate.
Return value
The screen space x coordinate equivalent to the world space coordinate x.
Restrictions
This routine is not available in Fastgraph/Light.
See also
fg_xworld, fg_yscreen, fg_yworld
292 �
fg_xview
Prototype
int fg_xview (int vx); function FGxview% (vx%) int function fg_xview (int vx) function fg_xview (vx : integer) : integer;
Description
The fg_xview routine translates a horizontal viewport coordinate to the corresponding screen space x coordinate.
Parameters
vx is the horizontal viewport coordinate to translate.
Return value
The screen space x coordinate corresponding to the specified viewport coordinate. If no viewport has been defined, the return value will be equal to vx.
Restrictions
none
See also
fg_getview, fg_setview, fg_yview
Examples
4-3
293 �
fg_xworld
Prototype
double fg_xworld (int ix); function FGxworld# (ix%) dbl function fg_xworld (int ix) function fg_xworld (ix : integer) : real;
Description
The fg_xworld routine translates a screen space x coordinate to its world space equivalent.
Parameters
ix is the screen space coordinate to translate.
Return value
The world space x coordinate equivalent to the screen space coordinate ix.
Restrictions
This routine is not available in Fastgraph/Light.
See also
fg_xscreen, fg_yscreen, fg_yworld
294 �
fg_yalpha
Prototype
int fg_yalpha (int iy); function FGyalpha% (iy%) int function fg_yalpha (int iy) function fg_yalpha (iy : integer) : integer;
Description
The fg_yalpha routine translates a screen space y coordinate to the character space row containing that coordinate.
Parameters
iy is the screen space coordinate to translate.
Return value
The character space row containing the screen space coordinate iy. In text modes, the return value is equal to the value of iy.
Restrictions
none
See also
fg_xalpha, fg_xconvert, fg_yconvert
Examples
14-10
295 �
fg_yconvert
Prototype
int fg_yconvert (int row); function FGyconvert% (row%) int function fg_yconvert (int row) function fg_yconvert (row : integer) : integer;
Description
The fg_yconvert routine translates a character space row to the screen space coordinate of its top (lowest-numbered) pixel. In graphics video modes, fg_yconvert(1) is an easy way to determine the height in pixels of a character cell.
Parameters
row is the character space row to translate.
Return value
The screen space y coordinate of the top pixel in the character space row row. In text modes, the return value is equal to the value of row.
Restrictions
none
See also
fg_xalpha, fg_xconvert, fg_yalpha
Examples
7-9, 14-8
296 �
fg_yscreen
Prototype
int fg_yscreen (double y); function FGyscreen% (y#) int function fg_yscreen (dbl y) function fg_yscreen (y : real) : integer;
Description
The fg_yscreen routine translates a world space y coordinate to its screen space equivalent.
Parameters
y is the world space coordinate to translate.
Return value
The screen space y coordinate equivalent to the world space coordinate y.
Restrictions
This routine is not available in Fastgraph/Light.
See also
fg_xscreen, fg_xworld, fg_yworld
297 �
fg_yview
Prototype
int fg_yview (int vy); function FGyview% (vy%) int function fg_yview (int vy) function fg_yview (vy : integer) : integer;
Description
The fg_yview routine translates a vertical viewport coordinate to the corresponding screen space y coordinate.
Parameters
vy is the vertical viewport coordinate to translate.
Return value
The screen space y coordinate corresponding to the specified viewport coordinate. If no viewport has been defined, the return value will be equal to vy.
Restrictions
none
See also
fg_getview, fg_setview, fg_xview
Examples
4-3
298 �
fg_yworld
Prototype
double fg_yworld (int iy); function FGyworld# (iy%) dbl function fg_yworld (int iy) function fg_yworld (iy : integer) : real;
Description
The fg_yworld routine translates a screen space y coordinate to its world space equivalent.
Parameters
iy is the screen space coordinate to translate.
Return value
The world space y coordinate equivalent to the screen space coordinate iy.
Restrictions
This routine is not available in Fastgraph/Light.
See also
fg_xscreen, fg_xworld, fg_yscreen
299
�
