1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
|
<html>
<!-- vi:set sw=2: -->
<head>
<link rev="made" href="brian_e_paul@yahoo.com">
<link rev="made" href="gregcouch@users.sourceforge.net">
<title>Togl</title>
</head>
<body>
<center>
<h1>Togl — a Tk OpenGL widget</h1>
<h3>Copyright (C) 1996-2002 Brian Paul and Ben Bederson</h3>
</center>
<br>
<h2>Contents</h2>
<ul>
<li><a href="#intro">Introduction</a>
<li><a href="#prereq">Prerequisites</a>
<li><a href="#getting">Getting Togl</a>
<li><a href="#mailing">Mailing List</a>
<li><a href="#using">Using Togl with your Application</a>
<li><a href="#cfuncs">C Togl Functions</a>
<li><a href="#tclfuncs">Tcl Togl Functions</a>
<li><a href="#demo">Demo Programs</a>
<li><a href="#stereo">Stereo Rendering</a>
<li><a href="#problems">Common Questions and Problems</a>
<li><a href="#bugs">Reporting Bugs</a>
<li><a href="#version">Version History</a>
<li><a href="#contrib">Contributors</a>
</ul>
<br>
<h2><a name="intro">Introduction</a></h2>
Togl is a Tk widget for OpenGL rendering.
Togl was originally based on OGLTK, written by Benjamin Bederson at
the University of New Mexico.
Togl adds the new features:
<ul>
<li>color-index mode support including color allocation functions
<li>support for requesting stencil, accumulation, alpha buffers, etc
<li>multiple OpenGL drawing widgets
<li>OpenGL extension testing from Tcl
<li>simple, portable font support
<li>overlay plane support
</ul>
<p>
Togl allows one to create and manage a special Tk/OpenGL widget
with Tcl and render into it with a C program. That is,
a typical Togl program will have Tcl code for managing the user interface
and a C program for computations and OpenGL rendering.
<p>
Togl is copyrighted by
<a href="http://www.mesa3d.org/brianp/home.html">Brian Paul</a>
<a href="mailto:brian_e_paul@yahoo.com">(brian_e_paul@yahoo.com)</a> and
<a href="http://www.cs.umd.edu/~bederson/">Benjamin Bederson</a>
<a href="mailto:bederson@cs.umd.edu">(bederson@cs.umd.edu)</a>.
See the LICENSE file for details.
<p>
The <a href="http://www.sourceforge.net/projects/togl/">
Togl project</a> and
<a href="http://togl.sourceforge.net">home page</a> are
hosted by <a href="http://www.sourceforge.net">SourceForge</a>.
<br>
<h2><a name="prereq">Prerequisites</a></h2>
<p>
You should have
<a href="http://www.tcl.tk/">Tcl and Tk</a>
installed on your computer. Togl works with Tcl/Tk
version 8.0 and up. The Mac OS X version requires version 8.4.
<p>
You must also have
<a href="http://www.opengl.org">OpenGL</a> or
<a href="http://www.mesa3d.org">Mesa</a>
(a free alternative to OpenGL) installed on your computer.
<p>
One should be familiar with Tcl, Tk, OpenGL, and C programming to use Togl
effectively.
<br>
<h2><a name="getting">Getting Togl</a></h2>
<p>
The current version of Togl is 1.7.
Togl can be downloaded from
<a href="http://sourceforge.net/project/showfiles.php?group_id=519">
SourceForge</a>.
<br>
<h2><a name="mailing">Mailing list</a></h2>
<p>
See the <a href="http://www.sourceforge.net/projects/togl/">
Togl project at SourceForge</a> for mailing list information.
<br>
<h2><a name="using">Using Togl With Your Application</a></h2>
<p>
There are basically two ways of using Togl with your application:
<ul>
<li>
Link or "compile in" Togl with your executable or shared library. In this
case you must call Togl_Init() from your C code to initialize Togl. This
is the way the included Togl examples are built.
<li>
Install the Togl shared library and pkgIndex.tcl file
(using <em>make install</em>) and then load it into <i>wish</i> using
<i>package require Togl</i>.
Then, before creating the Togl widget, call functions in your application
code (also a compiled into a shared library and loaded into <i>wish</i>)
to setup the Togl widget for the OpenGL rendering.
Create the blank Togl widget,
and then you're managing redraws and buffer swapping from the Tcl level.
</ul>
Since Togl is compiled into a shared library using the Tcl/Tk stubs-interface,
the same binary can be used with any version of Tck/Tk from 8.06 and up.
See <code>README.stubs</code> for more info.
<h3>Unix/X11 usage</h3>
<p>
Unix/X systems only need the <code>togl.c</code>, <code>togl.h</code>
and the public Tcl/Tk include files.
<h3>Windows 95/NT/2000/XP usage</h3>
<p>
Windows platforms need <code>tkWinInt.h</code>
and other internal Tk header files. So you need a Tcl/Tk
source distribution in addition to the Togl distribution
(or copy over the various include files).
<p>
Here's the minimal way to build Togl with Tcl/Tk
using the <a href="http://gcc.gnu.org">gcc</a> that is distributed
as part of the <a href="http://cygwin.com/">cygwin</a> tools
(<a href="www.microsoft.com">Microsoft</a>'s compilers work too):
<blockquote><code><pre>
VER=8.4.12
SRCDIR=`pwd`
cd $SRCDIR/tcl$VER/win
env 'CC=gcc -mno-cygwin' ./configure --enable-threads
make libtclstub84.a
cd $SRCDIR/tk$VER/win
env 'CC=gcc -mno-cygwin' ./configure --enable-threads
make libtkstub84.a
cd $SRCDIR/Togl
env 'CC=gcc -mno-cygwin' ./configure --with-tcl=../tcl$VER/win --with-tk=../tk$VER/win
make
</pre></code></blockquote>
The resulting <code>Togl17.dll</code> and <code>pkgIndex.tcl</code>
should be installed into your Tcl distribution just like any other package.
<h3>Mac OS X usage</h3>
<p>
These special instructions are for building the Aqua version of Togl.
Mac OS X needs <code>tkMacOSXInt.h</code>
and other internal Tk header files. Unfortunately, the Tcl and Tk
frameworks that Apple distributes are missing the internal headers.
So you need a Tcl/Tk source distribution in addition to the Togl
distribution (or copy over the various include files).
You would probably want a newer version of Tcl and Tk anyway
because each minor revision of 8.4 has many Aqua bug fixes.
<p>
Here's one way to build Tcl, Tk, and Togl on Mac OS X (assuming they
are all in the same directory) to install in your home directory:
<blockquote><code><pre>
VER=8.4.12
mkdir -p ~/bin
make -C tcl$VER/macosx install PREFIX="${HOME}" INSTALL_PATH="${HOME}/Library/Frameworks"
make -C tk$VER/macosx install PREFIX="${HOME}" INSTALL_PATH="${HOME}/Library/Frameworks"
(cd Togl; ./configure --prefix="${HOME}")
make -C Togl install
</pre></code></blockquote>
<br>
<h2><a name="cfuncs">C Togl Functions</a></h2>
<p>
These are the Togl functions one may call from a C program.
<blockquote>
<code>
#include "togl.h"
</code>
</blockquote>
<p>
For portability, you should include the togl.h header
before any other OpenGL header so that various
Windows 95/NT/2000/XP stuff falls into place.
<h3>Setup and Initialization Functions</h3>
<dl>
<dt><code>int Togl_Init(Tcl_Interp *interp)</code>
<dd>
Initializes the Togl module. This is typically called from the
Tk_Main() function
or via Tcl's <code>package require</code> command.
</dl>
<dl>
<dt><code>void Togl_CreateFunc(Togl_Callback *proc)
<br>
void Togl_DisplayFunc(Togl_Callback *proc)
<br>
void Togl_ReshapeFunc(Togl_Callback *proc)
<br>
void Togl_DestroyFunc(Togl_Callback *proc)
</code>
<dd>
Register C functions to be called by Tcl/Tk when a widget is realized,
must be redrawn, is resized, or is destroyed respectively.
<p>
Each C callback must be of the form:
<pre>
void callback(Togl *togl)
{
...your code...
}
</pre>
</dl>
<dl>
<dt><code>void Togl_TimerFunc(Togl_Callback *proc)</code>
<dd>
Register a C timer callback function which will be called every
<em>n</em> milliseconds. The interval <em>n</em> is specified
by the <code>-time</code> option to the Togl Tcl command.
<p>
The C callback must be of the form:
<pre>
void my_timer_callback(Togl *togl)
{
...your code...
}
</pre>
</dl>
<dl>
<dt><code>void Togl_ResetDefaultCallbacks(void)</code>
<dd>
Reset all default callback pointers to NULL.
</dl>
<dl>
<dt><code>void Togl_CreateCommand(char *cmd_name, Togl_CmdProc *cmd_proc)</code>
<dd>
Used to create a new Togl sub-command. The C function which implements
the command must be of the form:
<p>
<pre>
int callback(Togl *togl, int argc, char *argv[])
{
...your code...
return TCL_OK or TCL_ERROR;
}
</pre>
</dl>
<h3>Drawing-related Commands</h3>
<dl>
<dt><code>void Togl_PostRedisplay(Togl *togl)</code>
<dd>
Signals that the widget should be redrawn. When Tk is next idle the
user's C render callback will be invoked. This is typically called
from within a Togl sub-command which was registered with
Togl_CreateCommand().
</dl>
<dl>
<dt><code>void Togl_SwapBuffers(const Togl *togl)</code>
<dd>
Swaps the front and back color buffers for a double-buffered widget.
glFlush() is executed if the window is single-buffered. This is
typically called in the rendering function which was registered with
Togl_DisplayFunc().
</dl>
<dl>
<dt><code>void Togl_MakeCurrent(const Togl *togl)</code>
<dd>
Sets the current rendering context to the given widget. This is done
automatically before the Togl callback functions are called. So the
call is only needed if you have multiple widgets with separate OpenGL
contexts. If the argument is NULL, then the rendering context is cleared
and subsequent OpenGL commands will fail.
</dl>
<h3>Query Functions</h3>
<dl>
<dt><code>char *Togl_Ident(const Togl *togl)</code>
<dd>
Returns a pointer to the identification string associated with a Togl
widget or NULL if there's no identifier string.
</dl>
<dl>
<dt><code>int Togl_Width(const Togl *togl)</code>
<dd>
Returns the width of the given Togl widget. Typically called in the
function registered with Togl_ReshapeFunc().
</dl>
<dl>
<dt><code>int Togl_Height(const Togl *togl)</code>
<dd>
Returns the height of the given Togl widget. Typically called in the
function registered with Togl_ReshapeFunc().
</dl>
<dl>
<dt><code>Tcl_Interp *Togl_Interp(const Togl *togl)</code>
<dd>
Returns the Tcl interpreter associated with the given Togl widget.
</dl>
<dl>
<dt>
<code>Tk_Window Togl_TkWin(const Togl *togl)</code>
<dd>
Returns the Tk window associated with the given Togl widget.
</dl>
<h3>Color Index Mode Functions</h3>
<p>
These functions are only used for color index mode.
<dl>
<dt><code>unsigned long Togl_AllocColor(Togl *togl, float red, float green, float blue)</code>
<dd>
Allocate a color from a read-only colormap. Given a color specified
by red, green, and blue return a colormap index (aka pixel value)
whose entry most closely matches the red, green, blue color. Red,
green, and blue are values in [0,1]. This function is only used in
color index mode when the <code>-privatecmap</code> option is false.
</dl>
<dl>
<dt><code>void Togl_FreeColor(Togl *togl, unsigned long index)</code>
<dd>
Free a color in a read-only colormap. Index is a value which was
returned by the Togl_AllocColor() function. This function is only
used in color index mode when the <code>-privatecmap</code> option
is false.
</dl>
<dl>
<dt><code>void Togl_SetColor(Togl *togl,
int index, float red, float green, float blue)</code>
<dd>
Load the colormap entry specified by index with the given red, green
and blue values. Red, green, and blue are values in [0,1]. This
function is only used in color index mode when the
<code>-privatecmap</code> option is true.
</dl>
<h3>Font Functions</h3>
<dl>
<dt><code>GLuint Togl_LoadBitmapFont(Togl *togl,
const char *fontname)</code>
<dd>
Load the named font as a set of glBitmap display lists.
<var>fontname</var> may be one of
<code>
<ul>
<li>TOGL_BITMAP_8_BY_13
<li>TOGL_BITMAP_9_BY_15
<li>TOGL_BITMAP_TIMES_ROMAN_10
<li>TOGL_BITMAP_TIMES_ROMAN_24
<li>TOGL_BITMAP_HELVETICA_10
<li>TOGL_BITMAP_HELVETICA_12
<li>TOGL_BITMAP_HELVETICA_18
</code>
<li>or any X11 font name
</ul>
Zero is returned if this function fails.
<br>
After Togl_LoadBitmapFont() has been called, returning <var>fontbase</var>,
you can render a string <em>s</em> with:
<blockquote>
<code>
glListBase(fontbase);
<br>
glCallLists(strlen(s), GL_BYTE, s);
</code>
</blockquote>
To maximize the portability of your application it is best to use one
of the predefined TOGL_BITMAP_* fonts.
</dl>
<dl>
<dt><code>void Togl_UnloadBitmapFont(Togl *togl, GLuint fontbase)
</code>
<dd>
Destroys the bitmap display lists created by by Togl_LoadBitmapFont().
</dl>
<h3>Client Data Functions</h3>
<dl>
<dt><code>void Togl_SetClientData(Togl *togl, ClientData clientData)</code>
<dd>
<em>clientData</em> is a pointer to an arbitrary user data structure.
Each Togl struct has such a pointer.
This function sets the Togl widget's client data pointer.
</dl>
<dl>
<dt><code>ClientData Togl_GetClientData(const Togl *togl)</code>
<dd>
<em>clientData</em> is a pointer to an arbitrary user data structure.
Each Togl struct has such a pointer.
This function returns the Togl widget's client data pointer.
</dl>
<dl>
<dt><code>void Togl_ClientData(ClientData clientData)</code>
<dd>
<em>clientData</em> is a pointer to an arbitrary user data structure.
Set default client data pointer for subsequent new Togl widgets.
Default value is NULL.
</dl>
<h3>Overlay Functions</h3>
<p>
These functions are modelled after GLUT's overlay sub-API.
<dl>
<dt><code>void Togl_UseLayer(Togl *togl, int layer)</code>
<dd>
Select the layer into which subsequent OpenGL rendering will be
directed. <em>layer</em> may be either <em>TOGL_OVERLAY</em> or
<em>TOGL_NORMAL</em>.
</dl>
<dl>
<dt><code>void Togl_ShowOverlay(Togl *togl)</code>
<dd>
Display the overlay planes, if any.
</dl>
<dl>
<dt><code>void Togl_HideOverlay(Togl *togl)</code>
<dd>
Hide the overlay planes, if any.
</dl>
<dl>
<dt><code>void Togl_PostOverlayRedisplay(Togl *togl)</code>
<dd>
Signal that the overlay planes should be redraw.
When Tk is next idle the user's C overlay display callback will be invoked.
This is typically called from within a Togl sub-command which was
registered with Togl_CreateCommand().
</dl>
<dl>
<dt><code>void Togl_OverlayDisplayFunc(Togl_Callback *proc)</code>
<dd>
Registers the C callback function which should be called to redraw the
overlay planes. This is the function which will be called in
response to Togl_PostOverlayRedisplay().
The callback must be of the form:
<p>
<pre>
void RedrawOverlay(Togl *togl)
{
...your code...
}
</pre>
</dl>
<dl>
<dt><code>int Togl_ExistsOverlay(Togl *togl)</code>
<dd>
Returns 1 if overlay planes exist, 0 otherwise.
</dl>
<dl>
<dt><code>int Togl_GetOverlayTransparentValue(const Togl *togl)</code>
<dd>
Returns the color index of the overlay's transparent pixel value.
</dl>
<dl>
<dt><code>int Togl_IsMappedOverlay(const Togl *togl)</code>
<dd>
Returns 1 if the overlay planes are currently displayed, 0 otherwise.
</dl>
<dl>
<dt><code>unsigned long Togl_AllocColorOverlay(const Togl *togl,
float red, float green, float blue)</code>
<dd>
Allocate a color in the overlay planes. Red, green, and blue are
values in [0,1]. Return the color index or -1 if the allocation
fails.
</dl>
<dl>
<dt><code>void Togl_FreeColorOverlay(const Togl *togl, unsigned long index)</code>
<dd>
Free a color which was allocated with Togl_AllocColorOverlay().
</dl>
<h3>X11-only Functions</h3>
<p>
These functions are only implemented on systems using the X Window System.
We recommend that you avoid using these functions in your application since
they are not portable to other operating/window systems
(use <code>Togl_TkWin()</code> and normal Tk functions instead).
<p>
<dl>
<dt><code>Display *Togl_Display(const Togl *togl)</code>
<dd>
Returns the X Display of a Togl widget.
</dl>
<dl>
<dt><code>Screen *Togl_Screen(const Togl *togl)</code>
<dd>
Returns the X Screen of a Togl widget.
</dl>
<dl>
<dt><code>int Togl_ScreenNumber(const Togl *togl)</code>
<dd>
Returns the X screen number of a Togl widget.
</dl>
<dl>
<dt><code>Colormap Togl_Colormap(const Togl *togl)</code>
<dd>
Returns the X Colormap used by a Togl widget.
</dl>
<h3>Postscript Output</h3>
<p>
<dl>
<dt><code>int Togl_DumpToEpsFile(const Togl *togl,
const char *filename, int rgbFlag, void (*user_redraw)())</code>
<dd>
Generate an encapsulated Postscript file of the image in a Togl widget.
<em>filename</em> is the name of the file to generate.
If <em>rgbFlag</em> is non-zero then an RGB image file is written,
else a grayscale image file is written.
<em>user_redraw</em> is a pointer to the function which will render the
desired image. This will typically be the same as the function passed
to Togl_DisplayFunc().
</dl>
<br>
<h2><a name="tclfuncs">Tcl Togl commands</a></h2>
<p>
These are the Togl commands one may call from a Tcl program.
<dl>
<dt><code>togl <var>pathName</var> [options]</code>
<dd>
Creates a new togl widget with name <var>pathName</var> and
an optional list of configuration options. Options include:
<p>
<table border="0">
<colgroup span="3">
<col align="left">
<col align="center">
<col align="left">
</colgroup>
<tr>
<th>Option</th> <th>Default</th> <th>Comments</th>
</tr>
<tr>
<td><code>-width</code></td> <td align="center">400</td> <td>
Width of widget in pixels.</td>
</tr>
<tr>
<td><code>-height</code></td> <td>400</td> <td>
Height of widget in pixels.</td>
</tr>
<tr><td colspan=3> </td></tr>
<tr>
<td><code>-ident</code></td> <td>""</td> <td>
A user identification string. This is used match widgets
for the <code>-sharecontext</code>
and the <code>-sharelist</code> options (see below).
This is also useful in your callback functions
to determine which Togl widget is the caller.
</td>
</tr>
<tr><td colspan=3> </td></tr>
<tr>
<td><code>-rgba</code></td> <td>true</td> <td>
If true, use RGB(A) mode, otherwise use Color Index mode.</td>
</tr>
<tr>
<td><code>-redsize</code></td> <td>1</td> <td>
Minimum number of bits in red component.</td>
</tr>
<tr>
<td nowrap="1"><code>-greensize</code></td> <td>1</td> <td>
Minimum number of bits in green component.</td>
</tr>
<tr>
<td><code>-bluesize</code></td> <td>1</td> <td>
Minimum number of bits in blue component.</td>
</tr>
<tr>
<td><code>-alpha</code></td> <td>1</td> <td>
If true and <code>-rgba</code> is true, request an alpha channel.</td>
</tr>
<tr>
<td><code>-alphasize</code></td> <td>1</td> <td>
Minimum number of bits in alpha component.</td>
</tr>
<tr><td colspan=3> </td></tr>
<tr>
<td><code>-double</code></td> <td>false</td> <td>
If true, request a double-buffered window, otherwise
request a single-buffered window.</td>
</tr>
<tr><td colspan=3> </td></tr>
<tr>
<td><code>-depth</code></td> <td>false</td> <td>
If true, request a depth buffer.</td>
</tr>
<tr>
<td><code>-depthsize</code></td> <td>1</td> <td>
Minimum number of bits in depth buffer.</td>
</tr>
<tr><td colspan=3> </td></tr>
<tr>
<td><code>-accum</code></td> <td>false</td> <td>
If true, request an accumulation buffer.</td>
</tr>
<tr>
<td><code>-accumredsize</code></td> <td>1</td> <td>
Minimum number of bits in accumulation buffer red component.</td>
</tr>
<tr>
<td nowrap="1"><code>-accumgreensize</code></td> <td>1</td> <td>
Minimum number of bits in accumulation buffer green component.</td>
</tr>
<tr>
<td><code>-accumbluesize</code></td> <td>1</td> <td>
Minimum number of bits in accumulation buffer blue component.</td>
</tr>
<tr>
<td><code>-accumalphasize</code></td> <td>1</td> <td>
Minimum number of bits in accumulation buffer alpha component.</td>
</tr>
<tr><td colspan=3> </td></tr>
<tr>
<td><code>-stencil</code></td> <td>false</td> <td>
If true, request a stencil buffer.</td>
</tr>
<tr>
<td><code>-stencilsize</code></td> <td>1</td> <td>
Minimum number of bits in stencil component.</td>
</tr>
<tr><td colspan=3> </td></tr>
<tr>
<td><code>-auxbuffers</code></td> <td>0</td> <td>
Desired number of auxiliary buffers.</td>
</tr>
<tr><td colspan=3> </td></tr>
<tr>
<td><code>-privatecmap</code></td> <td>false</td> <td>
Only applicable in color index mode.
If false, use a shared read-only colormap.
If true, use a private read/write colormap.
</td>
</tr>
<tr><td colspan=3> </td></tr>
<tr>
<td><code>-overlay</code></td> <td>false</td> <td>
If true, request overlay planes.</td>
</tr>
<tr><td colspan=3> </td></tr>
<tr>
<td><code>-stereo</code></td> <td>false</td> <td>
If true, request a stereo-capable window.</td>
</tr>
<tr>
<td><code>-oldstereo</code></td> <td>false</td> <td>
On SGI workstations only: if true, request divided-screen stereo.
</td>
</tr>
<tr><td colspan=3> </td></tr>
<tr>
<td><code>-time</code></td> <td>1</td> <td>
Specifies the interval, in milliseconds, for
calling the C timer callback function which
was registered with Togl_TimerFunc.</td>
</tr>
<tr><td colspan=3> </td></tr>
<tr>
<td><code>-sharelist</code></td> <td>""</td> <td>
Name of an existing Togl widget with which to
share display lists.
</td>
</tr>
<tr>
<td><code>-sharecontext</code></td> <td>""</td> <td>
Name of an existing Togl widget with which to
share the OpenGL context. NOTE: most other
attributes such as double buffering, RGBA vs CI,
ancillary buffer specs, etc are then ignored.
</td>
</tr>
<tr><td colspan=3> </td></tr>
<tr>
<td><code>-indirect</code></td> <td>false</td> <td>
If present, request an indirect rendering context.
A direct rendering context is normally requested.
<em>Only significant on Unix/X11.</em>
</td>
</tr>
<tr><td colspan=3> </td></tr>
<tr>
<td><code>-cursor</code></td> <td>""</td> <td>
Set the cursor in the widget window.</td>
</tr>
<tr><td colspan=3> </td></tr>
<tr>
<td><code>-pixelformat</code></td> <td>0</td> <td>
Set the pixel format to the (platform-dependent) given value.</td>
</tr>
</table>
</dl>
<dl>
<dt><code><var>pathName</var> configure</code>
<dd>
Returns all configuration records for the named togl widget.
</dl>
<dl>
<dt><code><var>pathName</var> configure <var>-option</var></code>
<dd>
Returns configuration information for the specifed <var>option</var>
which may be one of:
<dl>
<dt><code>-width</code>
<dd>
Returns the width configuration of the widget in the form:
<br>
<code>-width width Width <var>W</var> <var>w</var></code>
<br>
where <var>W</var> is the default width in pixels
and <var>w</var> is the current width in pixels
</dl>
<dl>
<dt><code>-height</code>
<dd>
Returns the height configuration of the widget in the form:
<br>
<code>-height height Height <var>H</var> <var>h</var></code>
<br>
where <var>H</var> is the default height in pixels
and <var>h</var> is the current height in pixels
</dl>
<dl>
<dt><code>-extensions</code>
<dd>
Returns a list of OpenGL extensions available. For example:
<code>GL_EXT_polygon_offset GL_EXT_vertex_array</code>
</dl>
</dl>
<dl>
<dt><code><var>pathName</var> configure <var>-option</var> <var>value</var></code>
<dd>
Reconfigure a Togl widget. <var>option</var> may be any one of the
options listed in the <code>togl</code> command above.
</dl>
<dl>
<dt><code><var>pathName</var> render</code>
<dd>
Causes the render callback function to be called for <var>pathName</var>.
</dl>
<dl>
<dt><code><var>pathName</var> swapbuffers</code>
<dd>
Causes front/back buffers to be swapped if in double buffer mode.
And flushs the OpenGL command buffer if in single buffer mode.
(So this is appropriate to call after every frame is drawn.)
</dl>
<dl>
<dt><code><var>pathName</var> makecurrent</code>
<dd>
Make the widget specified by <var>pathName</var> and its OpenGL context
the current ones.
</dl>
<br>
<h2><a name="demo">Demo Programs</a></h2>
<p>
There are six demo programs:
<blockquote>
<table border="0">
<colgroup span="2">
<col align="left">
<col align="left">
</colgroup>
<tr>
<td>double.tcl</td>
<td>— compares single vs double buffering with two Togl widgets</td>
</tr>
<tr>
<td>texture.tcl</td>
<td>— lets you play with texture mapping options</td>
</tr>
<tr>
<td>index.tcl</td>
<td>— demo of using color index mode</td>
</tr>
<tr>
<td>overlay.tcl</td>
<td>— example of using overlay planes (requires overlay hardware)</td>
</tr>
<tr>
<td>stereo.tcl</td>
<td>— stereo example</td>
</tr>
<tr>
<td>gears.tcl</td>
<td>— spinning gears demo</td>
</tr>
</table>
</blockquote>
<p>
To compile the demos, edit the Makefile to suit your system, then
type <code>make demos</code>.
The demos are compiled into shared libraries,
that can are loaded into the Tcl interpreter as Tcl/Tk-extensions.
Demos are started by running the corrsponding Tcl script.
To run a demo just type <code>./double.tcl </code>or <code>./texture.tcl</code> etc.
<br>
<h2><a name="stereo">Stereo Rendering</a></h2>
<p>
Quad-buffered stereo-in-a-window is supported. Quad-buffer stereo
is only available on workstation-class graphics cards
(<a href="http://www.3dlabs.com">3Dlabs</a> Wildcat series,
<a href="http://www.ati.com">ATI</a> FireGL series,
<a href="http://www.nvidia.com">NVidia</a> Quadro series,
and <a href="http://www.sgi.com">SGI</a> workstations).
Legacy support for divided-screen stereo on SGI workstations is
available via the <code>-oldstereo</code> option.
Developers for SGI workstations might also like the
<a href="http://www.cgl.ucsf.edu/Overview/software.html#autostereo">
autostereo</a> package to automatically switch the display
in and out of stereo (other systems already do it automatically).
<p>
Full-screen stereo that gaming graphics cards support (ATI Radeon,
NVidia GeForce) is not supported.
<br>
<h2><a name="problems">Common Questions and Problems</a></h2>
<p>
If you have something to add to this section please let us know.
<h3>Bad Match X errors on Sun systems</h3>
<p>
There's a bug in Sun's XmuLookupStandardColormap X library function.
If you compile togl.c with the SOLARIS_BUG symbol defined (-DSOLARIS_BUG)
this function call will be omitted.
<br>
<h2><a name="bugs">Reporting Bugs</a></h2>
<p>
There is a bug database on the
<a href="http://sourceforge.net/projects/togl/">Togl Project Page</a>.
You may also discuss bugs on the mailing list.
<p>
When reporting bugs please provide as much information as possible.
Also, it's very helpful to us if you can provide an example program
which demonstrates the problem.
<br>
<h2><a name="version">Version History</a></h2>
<h3>Version 1.0 — March, 1996</h3>
<ul>
<li>Initial version
</ul>
<h3>Version 1.1 (never officially released)</h3>
<ul>
<li>Added Togl_LoadBitmapFont function
<li>Fixed a few bugs
</ul>
<h3>Version 1.2 — November, 1996</h3>
<ul>
<li>added swapbuffers and makecurrent Tcl commands
<li>More bug fixes
<li>Upgraded to suport Tcl 7.6 and Tk 4.2
<li>Added stereo and overlay plane support
<li>Added Togl_Get/SetClientData() functions
<li>Added Togl_DestroyFunc()
</ul>
<h3>Version 1.3 — May 2, 1997</h3>
<ul>
<li>fixed a bug in Togl_Configure()
<li>fixed a compilation problem in using Tcl_PkgProvide() with Tcl < 7.4
<li>new overlay functions: Togl_ExistsOverlay, Togl_GetOverlayTransparentValue,
Togl_IsMappedOverlay, Togl_AllocColorOverlay, Togl_FreeColorOverlay
<li>added X11 functions: Togl_Display, Togl_Screen, Togl_ScreenNumber,
Togl_Colormap
<li>added Togl_DumpToEpsFile function
<li>fixed a C++ compilation problem
<li>more robust overlay code
<li>added timers (Togl_TimerFunc) from Peter Dern and Elmar Gerwalin
</ul>
<h3>Version 1.4 — September 17, 1997</h3>
<ul>
<li>Ported to Windows NT (Robert Casto)
<li>Updated for Tcl/Tk 8.0
<li>Added many config flags (-redsize, -depthsize, etc) (Matthias Ott)
<li>Added Togl_Set*Func() functions to reassign callback functions (Matthias Ott)
<li>Added Togl_ResetDefaultCallbacks() and Togl_ClientData() functions (Greg Couch)
</ul>
<h3>Version 1.5 — September 18, 1998</h3>
<ul>
<li>Fixed a few Unix and Windows compilation bugs
<li>Added Ben Evan's SGI stereo functions
<li>Multiple expose events now reduced to one redraw
<li>Destroying Togl widgets caused problems, patched by Adrian J. Chung
<li>Added Togl_TkWin() function
<li>Updated for Tcl/Tk 8.0p2
<li>Added gears demo from Philip Quaife
<li>Added <code>-sharelist</code> and <code>-sharecontext</code> config flags
<li>Fixed a few overlay update bugs
<li>Added <code>-indirect</code> config flag
</ul>
<h3>Version 1.6 — May 7, 2003</h3>
<ul>
<li>Added Togl_SetTimerFunc function
<li>Updated for Tcl/Tk 8.0.5 and 8.1
<li>Context sharing added for Windows
<li>Macintosh support (by Paul Thiessen)
<li>Tcl/Tk stubs support — see README.tcl (by Jonas Beskow)
</ul>
<h3>Version 1.7 — Jan 2006</h3>
<ul>
<li>Added Mac OS X support
<li>Enabled asking for quad-buffered stereo pixel formats on all platforms
(use -oldstereo on SGIs for splitscreen stereo — C API changed too)
<li>Configuring the cursor is no longer slow
<li>Added <code>-pixelformat</code> config flag
<li>Added setgrid support (unfortunately many window managers can't cope with 1x1 pixel grid)
<li>Only free context when last reference is gone
<li>Switched to TEA-based configure (instead of editting make files)
</ul>
<h3>Version 2.0 — ??? 2006</h3>
<ul>
<li>integrate <a href="http://www.tcl3d.org/">tcl3dTogl</a>'s changes
</ul>
<br>
<h3>Future plans</h3>
<ul>
<li>add callback command options for create/display/reshape/destroy
<li>add vertical sync control
<li>multisampling support (can be worked-around by passing in a pixelformat)
<li>replace EPS support with TK photo image support
<li>simplify C API by requiring callback command options
<li>stubify C API
<li>Use Tcl object interface for callbacks
<li>allow (require?) private colormap to given with TK photo image
</ul>
<br>
<h2><a name="contrib">Contributors</a></h2>
<p>
Several people have contributed new features to Togl. Among them are:
<ul>
<li>Ramon Ramsan — overlay plane support
<li>Miguel A. De Riera Pasenau — more overlay functions, X11 functions
and EPS output
<li>Peter Dern and Elmar Gerwalin — Togl_TimerFunc and related code
<li>Robert Casto — Windows NT port
<li>Geza Groma — Windows 95/NT patches
<li>Ben Evans — SGI stereo support
<li>Paul Thiessen — Macintosh support
<li>Jonas Beskow — Tcl/Tk stubs support
<li>Paul Kienzle — TEA debugging and patches
<li>Greg Couch — version 1.7
</ul>
Many others have contributed bug fixes. Thanks for your contributions!
<br>
<hr>
Last edited on 25 October 2005 by Greg Couch.
</body>
</html>
|
