mirror of
https://github.com/fltk/fltk.git
synced 2026-05-25 17:42:14 +08:00
more html to doxygen conversion for {enumerations,glut,forms}.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6408 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
engelsman
+241
-259
File diff suppressed because it is too large
Load Diff
+166
-129
@@ -2,172 +2,205 @@
|
||||
|
||||
\page forms E - Forms Compatibility
|
||||
|
||||
<P>This appendix describes the Forms compatibility included with FLTK.
|
||||
<H2>Importing Forms Layout Files</H2>
|
||||
This appendix describes the Forms compatibility included with FLTK.
|
||||
|
||||
\section forms_importing Importing Forms Layout Files
|
||||
|
||||
<A href=fluid.html#FLUID>FLUID</A> can read the .fd files put out by
|
||||
all versions of Forms and XForms fdesign. However, it will mangle them
|
||||
a bit, but it prints a warning message about anything it does not
|
||||
understand. FLUID cannot write fdesign files, so you should save to a
|
||||
new name so you don't write over the old one.
|
||||
<P>You will need to edit your main code considerably to get it to link
|
||||
|
||||
You will need to edit your main code considerably to get it to link
|
||||
with the output from FLUID. If you are not interested in this you may
|
||||
have more immediate luck with the forms compatibility header, <TT>
|
||||
<FL/forms.H></TT>. </P>
|
||||
<H2>Using the Compatibility Header File</H2>
|
||||
You should be able to compile existing Forms or XForms source code by
|
||||
changing the include directory switch to your compiler so that the <TT>
|
||||
forms.h</TT> file supplied with FLTK is included. Take a look at <TT>
|
||||
forms.h</TT> to see how it works, but the basic trick is lots of inline
|
||||
have more immediate luck with the forms compatibility header, <tt>
|
||||
<FL/forms.H></tt>.
|
||||
|
||||
\section forms_using Using the Compatibility Header File
|
||||
|
||||
You should be able to compile existing Forms or XForms source code by
|
||||
changing the include directory switch to your compiler so that the <tt>
|
||||
forms.h</tt> file supplied with FLTK is included. Take a look at <tt>
|
||||
forms.h</tt> to see how it works, but the basic trick is lots of inline
|
||||
functions. Most of the XForms demo programs work without changes.
|
||||
<P>You will also have to compile your Forms or XForms program using a
|
||||
|
||||
You will also have to compile your Forms or XForms program using a
|
||||
C++ compiler. The FLTK library does not provide C bindings or header
|
||||
files. </P>
|
||||
<P>Although FLTK was designed to be compatible with the GL Forms
|
||||
files.
|
||||
|
||||
Although FLTK was designed to be compatible with the GL Forms
|
||||
library (version 0.3 or so), XForms has bloated severely and it's
|
||||
interface is X-specific. Therefore, XForms compatibility is no longer
|
||||
a goal of FLTK. Compatibility was limited to things that were free, or
|
||||
that would add code that would not be linked in if the feature is
|
||||
unused, or that was not X-specific. </P>
|
||||
<P>To use any new features of FLTK, you should rewrite your code to not
|
||||
unused, or that was not X-specific.
|
||||
|
||||
To use any new features of FLTK, you should rewrite your code to not
|
||||
use the inline functions and instead use "pure" FLTK. This will make
|
||||
it a lot cleaner and make it easier to figure out how to call the FLTK
|
||||
functions. Unfortunately this conversion is harder than expected and
|
||||
even Digital Domain's inhouse code still uses <TT>forms.H</TT> a lot. </P>
|
||||
<H2>Problems You Will Encounter</H2>
|
||||
<P>Many parts of XForms use X-specific structures like <TT>XEvent</TT>
|
||||
in their interface. I did not emulate these! Unfortunately these
|
||||
even Digital Domain's inhouse code still uses <tt>forms.H</tt> a lot.
|
||||
|
||||
\section forms_problems Problems You Will Encounter
|
||||
|
||||
Many parts of XForms use X-specific structures like <tt>XEvent</tt>
|
||||
in their interface. I did not emulate these! Unfortunately these
|
||||
features (such as the "canvas" widget) are needed by most large
|
||||
programs. You will need to rewrite these to use FLTK subclasses. </P>
|
||||
<P><A href=Fl_Free.html#Fl_Free><TT>Fl_Free</TT></A> widgets emulate
|
||||
programs. You will need to rewrite these to use FLTK subclasses.
|
||||
|
||||
<A href=Fl_Free.html#Fl_Free><tt>Fl_Free</tt></A> widgets emulate
|
||||
the <I>old</I> Forms "free" widget. It may be useful for porting
|
||||
programs that change the <TT>handle()</TT> function on widgets, but you
|
||||
will still need to rewrite things. </P>
|
||||
<P><A href=Fl_Timer.html#Fl_Timer><TT>Fl_Timer</TT></A> widgets are
|
||||
programs that change the <tt>handle()</tt> function on widgets, but you
|
||||
will still need to rewrite things.
|
||||
|
||||
<A href=Fl_Timer.html#Fl_Timer><tt>Fl_Timer</tt></A> widgets are
|
||||
provided to emulate the XForms timer. These work, but are quite
|
||||
inefficient and inaccurate compared to using <A href="Fl.html#Fl.add_timeout">
|
||||
<TT>Fl::add_timeout()</TT></A>. </P>
|
||||
<P><I>All instance variables are hidden.</I> If you directly refer to
|
||||
<tt>Fl::add_timeout()</tt></A>.
|
||||
|
||||
<I>All instance variables are hidden.</I> If you directly refer to
|
||||
the x, y, w, h, label, or other fields of your Forms widgets you will
|
||||
have to add empty parenthesis after each reference. The easiest way to
|
||||
do this is to globally replace "->x" with "->x()", etc. Replace
|
||||
"boxtype" with "box()". </P>
|
||||
<P><TT>const char *</TT> arguments to most FLTK methods are simply
|
||||
stored, while Forms would <TT>strdup()</TT> the passed string. This is
|
||||
"boxtype" with "box()".
|
||||
|
||||
<tt>const char *</tt> arguments to most FLTK methods are simply
|
||||
stored, while Forms would <tt>strdup()</tt> the passed string. This is
|
||||
most noticable with the label of widgets. Your program must always
|
||||
pass static data such as a string constant or malloc'd buffer to <TT>
|
||||
label()</TT>. If you are using labels to display program output you
|
||||
may want to try the <A href=Fl_Output.html#Fl_Output><TT>Fl_Output</TT></A>
|
||||
widget. </P>
|
||||
<P>The default fonts and sizes are matched to the older GL version of
|
||||
pass static data such as a string constant or malloc'd buffer to <tt>
|
||||
label()</tt>. If you are using labels to display program output you
|
||||
may want to try the <A href=Fl_Output.html#Fl_Output><tt>Fl_Output</tt></A>
|
||||
widget.
|
||||
|
||||
The default fonts and sizes are matched to the older GL version of
|
||||
Forms, so all labels will draw somewhat larger than an XForms program
|
||||
does. </P>
|
||||
<P>fdesign outputs a setting of a "fdui" instance variable to the main
|
||||
does.
|
||||
|
||||
fdesign outputs a setting of a "fdui" instance variable to the main
|
||||
window. I did not emulate this because I wanted all instance variables
|
||||
to be hidden. You can store the same information in the <TT>user_data()</TT>
|
||||
to be hidden. You can store the same information in the <tt>user_data()</tt>
|
||||
field of a window. To do this, search through the fdesign output for
|
||||
all occurances of "->fdui" and edit to use "->user_data()" instead.
|
||||
This will require casts and is not trivial. </P>
|
||||
<P>The prototype for the functions passed to <TT>fl_add_timeout()</TT>
|
||||
and <TT>fl_set_idle_callback()</TT> callback are different. </P>
|
||||
<P><B>All the following XForms calls are missing:</B></P>
|
||||
<UL>
|
||||
<LI><TT>FL_REVISION</TT>, <TT>fl_library_version()</TT></LI>
|
||||
<LI><TT>FL_RETURN_DBLCLICK</TT> (use <TT>Fl::event_clicks()</TT>) </LI>
|
||||
<LI><TT>fl_add_signal_callback()</TT></LI>
|
||||
<LI><TT>fl_set_form_atactivate()</TT> <TT>fl_set_form_atdeactivate()</TT>
|
||||
</LI>
|
||||
<LI><TT>fl_set_form_property()</TT></LI>
|
||||
<LI><TT>fl_set_app_mainform()</TT>, <TT>fl_get_app_mainform()</TT></LI>
|
||||
<LI><TT>fl_set_form_minsize()</TT>, <TT>fl_set_form_maxsize()</TT></LI>
|
||||
<LI><TT>fl_set_form_event_cmask()</TT>, <TT>fl_get_form_event_cmask()</TT>
|
||||
</LI>
|
||||
<LI><TT>fl_set_form_dblbuffer()</TT>, <TT>fl_set_object_dblbuffer()</TT>
|
||||
(use an <TT>Fl_Double_Window</TT> instead) </LI>
|
||||
<LI><TT>fl_adjust_form_size()</TT></LI>
|
||||
<LI><TT>fl_register_raw_callback()</TT></LI>
|
||||
<LI><TT>fl_set_object_bw()</TT>, <TT>fl_set_border_width()</TT></LI>
|
||||
<LI><TT>fl_set_object_resize()</TT>, <TT>fl_set_object_gravity()</TT></LI>
|
||||
<LI><TT>fl_set_object_shortcutkey()</TT></LI>
|
||||
<LI><TT>fl_set_object_automatic()</TT></LI>
|
||||
<LI><TT>fl_get_object_bbox()</TT> (maybe FLTK should do this) </LI>
|
||||
<LI><TT>fl_set_object_prehandler()</TT>, <TT>fl_set_object_posthandler()</TT>
|
||||
</LI>
|
||||
<LI><TT>fl_enumerate_fonts()</TT></LI>
|
||||
<LI>Most drawing functions </LI>
|
||||
<LI><TT>fl_set_coordunit()</TT> (FLTK uses pixels all the time) </LI>
|
||||
<LI><TT>fl_ringbell()</TT></LI>
|
||||
<LI><TT>fl_gettime()</TT></LI>
|
||||
<LI><TT>fl_win*()</TT> (all these functions) </LI>
|
||||
<LI><TT>fl_initialize(argc,argv,x,y,z)</TT> ignores last 3 arguments </LI>
|
||||
<LI><TT>fl_read_bitmapfile()</TT>, <TT>fl_read_pixmapfile()</TT></LI>
|
||||
<LI><TT>fl_addto_browser_chars()</TT></LI>
|
||||
<LI><TT>FL_MENU_BUTTON</TT> just draws normally </LI>
|
||||
<LI><TT>fl_set_bitmapbutton_file()</TT>, <TT>fl_set_pixmapbutton_file()</TT>
|
||||
</LI>
|
||||
<LI><TT>FL_CANVAS</TT> objects </LI>
|
||||
<LI><TT>FL_DIGITAL_CLOCK</TT> (comes out analog) </LI>
|
||||
<LI><TT>fl_create_bitmap_cursor()</TT>, <TT>fl_set_cursor_color()</TT></LI>
|
||||
<LI><TT>fl_set_dial_angles()</TT></LI>
|
||||
<LI><TT>fl_show_oneliner()</TT></LI>
|
||||
<LI><TT>fl_set_choice_shortcut(a,b,c) </TT></LI>
|
||||
<LI>command log </LI>
|
||||
<LI>Only some of file selector is emulated </LI>
|
||||
<LI><TT>FL_DATE_INPUT</TT></LI>
|
||||
<LI><TT>fl_pup*()</TT> (all these functions) </LI>
|
||||
<LI>textbox object (should be easy but I had no sample programs) </LI>
|
||||
<LI>xyplot object </LI>
|
||||
</UL>
|
||||
<H2>Additional Notes</H2>
|
||||
These notes were written for porting programs written with the older
|
||||
This will require casts and is not trivial.
|
||||
|
||||
The prototype for the functions passed to <tt>fl_add_timeout()</tt>
|
||||
and <tt>fl_set_idle_callback()</tt> callback are different.
|
||||
|
||||
<B>All the following XForms calls are missing:</B>
|
||||
|
||||
\li <tt>FL_REVISION</tt>, <tt>fl_library_version()</tt>
|
||||
\li <tt>FL_RETURN_DBLCLICK</tt> (use <tt>Fl::event_clicks()</tt>)
|
||||
\li <tt>fl_add_signal_callback()</tt>
|
||||
\li <tt>fl_set_form_atactivate()</tt> <tt>fl_set_form_atdeactivate()</tt>
|
||||
\li <tt>fl_set_form_property()</tt>
|
||||
\li <tt>fl_set_app_mainform()</tt>, <tt>fl_get_app_mainform()</tt>
|
||||
\li <tt>fl_set_form_minsize()</tt>, <tt>fl_set_form_maxsize()</tt>
|
||||
\li <tt>fl_set_form_event_cmask()</tt>, <tt>fl_get_form_event_cmask()</tt>
|
||||
\li <tt>fl_set_form_dblbuffer()</tt>, <tt>fl_set_object_dblbuffer()</tt>
|
||||
(use an <tt>Fl_Double_Window</tt> instead)
|
||||
\li <tt>fl_adjust_form_size()</tt>
|
||||
\li <tt>fl_register_raw_callback()</tt>
|
||||
\li <tt>fl_set_object_bw()</tt>, <tt>fl_set_border_width()</tt>
|
||||
\li <tt>fl_set_object_resize()</tt>, <tt>fl_set_object_gravity()</tt>
|
||||
\li <tt>fl_set_object_shortcutkey()</tt>
|
||||
\li <tt>fl_set_object_automatic()</tt>
|
||||
\li <tt>fl_get_object_bbox()</tt> (maybe FLTK should do this)
|
||||
\li <tt>fl_set_object_prehandler()</tt>, <tt>fl_set_object_posthandler()</tt>
|
||||
\li <tt>fl_enumerate_fonts()</tt>
|
||||
\li Most drawing functions
|
||||
\li <tt>fl_set_coordunit()</tt> (FLTK uses pixels all the time)
|
||||
\li <tt>fl_ringbell()</tt>
|
||||
\li <tt>fl_gettime()</tt>
|
||||
\li <tt>fl_win*()</tt> (all these functions)
|
||||
\li <tt>fl_initialize(argc,argv,x,y,z)</tt> ignores last 3 arguments
|
||||
\li <tt>fl_read_bitmapfile()</tt>, <tt>fl_read_pixmapfile()</tt>
|
||||
\li <tt>fl_addto_browser_chars()</tt>
|
||||
\li <tt>FL_MENU_BUTTON</tt> just draws normally
|
||||
\li <tt>fl_set_bitmapbutton_file()</tt>, <tt>fl_set_pixmapbutton_file()</tt>
|
||||
\li <tt>FL_CANVAS</tt> objects
|
||||
\li <tt>FL_DIGITAL_CLOCK</tt> (comes out analog)
|
||||
\li <tt>fl_create_bitmap_cursor()</tt>, <tt>fl_set_cursor_color()</tt>
|
||||
\li <tt>fl_set_dial_angles()</tt>
|
||||
\li <tt>fl_show_oneliner()</tt>
|
||||
\li <tt>fl_set_choice_shortcut(a,b,c) </tt>
|
||||
\li command log
|
||||
\li Only some of file selector is emulated
|
||||
\li <tt>FL_DATE_INPUT</tt>
|
||||
\li <tt>fl_pup*()</tt> (all these functions)
|
||||
\li textbox object (should be easy but I had no sample programs)
|
||||
\li xyplot object
|
||||
|
||||
\section forms_notes Additional Notes
|
||||
|
||||
These notes were written for porting programs written with the older
|
||||
IRISGL version of Forms. Most of these problems are the same ones
|
||||
encountered when going from old Forms to XForms:
|
||||
<H3>Does Not Run In Background</H3>
|
||||
The IRISGL library always forked when you created the first window,
|
||||
|
||||
\par Does Not Run In Background
|
||||
|
||||
The IRISGL library always forked when you created the first window,
|
||||
unless "foreground()" was called. FLTK acts like "foreground()" is
|
||||
called all the time. If you really want the fork behavior do "if
|
||||
(fork()) exit(0)" right at the start of your program.
|
||||
<H3>You Cannot Use IRISGL Windows or fl_queue</H3>
|
||||
If a Forms (not XForms) program if you wanted your own window for
|
||||
|
||||
\par You Cannot Use IRISGL Windows or fl_queue
|
||||
|
||||
If a Forms (not XForms) program if you wanted your own window for
|
||||
displaying things you would create a IRISGL window and draw in it,
|
||||
periodically calling Forms to check if the user hit buttons on the
|
||||
panels. If the user did things to the IRISGL window, you would find
|
||||
this out by having the value FL_EVENT returned from the call to Forms.
|
||||
<P>None of this works with FLTK. Nor will it compile, the necessary
|
||||
calls are not in the interface. </P>
|
||||
<P>You have to make a subclass of <A href=Fl_Gl_Window.html#Fl_Gl_Window>
|
||||
<TT>Fl_Gl_Window</TT></A> and write a <TT>draw()</TT> method and <TT>
|
||||
handle()</TT> method. This may require anywhere from a trivial to a
|
||||
major rewrite. </P>
|
||||
<P>If you draw into the overlay planes you will have to also write a <TT>
|
||||
draw_overlay()</TT> method and call <TT>redraw_overlay()</TT> on the
|
||||
OpenGL window. </P>
|
||||
<P>One easy way to hack your program so it works is to make the <TT>
|
||||
draw()</TT> and <TT>handle()</TT> methods on your window set some
|
||||
|
||||
None of this works with FLTK. Nor will it compile, the necessary
|
||||
calls are not in the interface.
|
||||
|
||||
You have to make a subclass of <A href=Fl_Gl_Window.html#Fl_Gl_Window>
|
||||
<tt>Fl_Gl_Window</tt></A> and write a <tt>draw()</tt> method and <tt>
|
||||
handle()</tt> method. This may require anywhere from a trivial to a
|
||||
major rewrite.
|
||||
|
||||
If you draw into the overlay planes you will have to also write a <tt>
|
||||
draw_overlay()</tt> method and call <tt>redraw_overlay()</tt> on the
|
||||
OpenGL window.
|
||||
|
||||
One easy way to hack your program so it works is to make the <tt>
|
||||
draw()</tt> and <tt>handle()</tt> methods on your window set some
|
||||
static variables, storing what event happened. Then in the main loop
|
||||
of your program, call <TT>Fl::wait()</TT> and then check these
|
||||
variables, acting on them as though they are events read from <TT>
|
||||
fl_queue</TT>. </P>
|
||||
<H3>You Must Use OpenGL to Draw Everything</H3>
|
||||
<P>The file <TT><FL/gl.h></TT> defines replacements for a lot of IRISGL
|
||||
of your program, call <tt>Fl::wait()</tt> and then check these
|
||||
variables, acting on them as though they are events read from <tt>
|
||||
fl_queue</tt>.
|
||||
|
||||
\par You Must Use OpenGL to Draw Everything
|
||||
|
||||
The file <tt><FL/gl.h></tt> defines replacements for a lot of IRISGL
|
||||
calls, translating them to OpenGL. There are much better translators
|
||||
available that you might want to investigate. </P>
|
||||
<H3>You Cannot Make Forms Subclasses</H3>
|
||||
Programs that call <TT>fl_make_object</TT> or directly setting the
|
||||
available that you might want to investigate.
|
||||
|
||||
\par You Cannot Make Forms Subclasses
|
||||
|
||||
Programs that call <tt>fl_make_object</tt> or directly setting the
|
||||
handle routine will not compile. You have to rewrite them to use a
|
||||
subclass of <TT>Fl_Widget</TT>. It is important to note that the <TT>
|
||||
handle()</TT> method is not exactly the same as the <TT>handle()</TT>
|
||||
function of Forms. Where a Forms <TT>handle()</TT> returned non-zero,
|
||||
your <TT>handle()</TT> must call <TT>do_callback()</TT>. And your <TT>
|
||||
handle()</TT> must return non-zero if it "understood" the event.
|
||||
<P>An attempt has been made to emulate the "free" widget. This appears
|
||||
subclass of <tt>Fl_Widget</tt>. It is important to note that the <tt>
|
||||
handle()</tt> method is not exactly the same as the <tt>handle()</tt>
|
||||
function of Forms. Where a Forms <tt>handle()</tt> returned non-zero,
|
||||
your <tt>handle()</tt> must call <tt>do_callback()</tt>. And your <tt>
|
||||
handle()</tt> must return non-zero if it "understood" the event.
|
||||
|
||||
An attempt has been made to emulate the "free" widget. This appears
|
||||
to work quite well. It may be quicker to modify your subclass into a
|
||||
"free" widget, since the "handle" functions match. </P>
|
||||
<P>If your subclass draws into the overlay you are in trouble and will
|
||||
have to rewrite things a lot. </P>
|
||||
<H3>You Cannot Use <device.h></H3>
|
||||
If you have written your own "free" widgets you will probably get a
|
||||
"free" widget, since the "handle" functions match.
|
||||
|
||||
If your subclass draws into the overlay you are in trouble and will
|
||||
have to rewrite things a lot.
|
||||
|
||||
\par You Cannot Use <device.h>
|
||||
|
||||
If you have written your own "free" widgets you will probably get a
|
||||
lot of errors about "getvaluator". You should substitute:
|
||||
<CENTER><TABLE border=1 WIDTH=90% summary="Mapping of Forms valuators to FLTK.">
|
||||
|
||||
<CENTER>
|
||||
<TABLE border=1 WIDTH=90% summary="Mapping of Forms valuators to FLTK.">
|
||||
<TR><TH align=center>Forms</TH><TH align=center>FLTK</TH></TR>
|
||||
<TR><TD>MOUSE_X</TD><TD>Fl::event_x_root()</TD></TR>
|
||||
<TR><TD>MOUSE_Y</TD><TD>Fl::event_y_root()</TD></TR>
|
||||
@@ -178,10 +211,14 @@ lot of errors about "getvaluator". You should substitute:
|
||||
<TR><TD>MOUSE1,RIGHTMOUSE</TD><TD>Fl::event_state()</TD></TR>
|
||||
<TR><TD>MOUSE2,MIDDLEMOUSE</TD><TD>Fl::event_state()</TD></TR>
|
||||
<TR><TD>MOUSE3,LEFTMOUSE</TD><TD>Fl::event_state()</TD></TR>
|
||||
</TABLE></CENTER>
|
||||
Anything else in <TT>getvaluator</TT> and you are on your own...
|
||||
<H3>Font Numbers Are Different</H3>
|
||||
The "style" numbers have been changed because I wanted to insert
|
||||
</TABLE>
|
||||
</CENTER>
|
||||
|
||||
Anything else in <tt>getvaluator</tt> and you are on your own...
|
||||
|
||||
\par Font Numbers Are Different
|
||||
|
||||
The "style" numbers have been changed because I wanted to insert
|
||||
bold-italic versions of the normal fonts. If you use Times, Courier,
|
||||
or Bookman to display any text you will get a different font out of
|
||||
FLTK. If you are really desperate to fix this use the following code:
|
||||
|
||||
+152
-106
@@ -2,117 +2,155 @@
|
||||
|
||||
\page glut D - GLUT Compatibility
|
||||
|
||||
<P>This appendix describes the GLUT compatibility header file supplied with FLTK. FLTK's GLUT compatibility is based on the original GLUT 3.7 and the follow-on FreeGLUT 2.4.0 libraries.</P>
|
||||
<H2>Using the GLUT Compatibility Header File</H2>
|
||||
<P>You should be able to compile existing GLUT source code by including <TT><FL/glut.H></TT> instead of <TT><GL/glut.h></TT>. This can be done by editing the source, by changing the <TT>-I</TT> switches to the compiler, or by providing a symbolic link from <TT>GL/glut.h</TT> to <TT>FL/glut.H</TT>.</P>
|
||||
<P><I>All files calling GLUT procedures must be compiled with C++</I>. You may have to alter them slightly to get them to compile without warnings, and you may have to rename them to get make to use the C++ compiler.</P>
|
||||
<P>You must link with the FLTK library. Most of <TT>FL/glut.H</TT> is inline functions. You should take a look at it (and maybe at <TT>test/glpuzzle.cxx</TT> in the FLTK source) if you are having trouble porting your GLUT program. </P>
|
||||
<P>This has been tested with most of the demo programs that come with the GLUT and FreeGLUT distributions.</P>
|
||||
<H2>Known Problems</H2>
|
||||
<P>The following functions and/or arguments to functions are missing, and
|
||||
you will have to replace them or comment them out for your code to
|
||||
compile:
|
||||
<UL>
|
||||
<LI><TT>glutGet(GLUT_ELAPSED_TIME)</TT></LI>
|
||||
<LI><TT>glutGet(GLUT_SCREEN_HEIGHT_MM)</TT></LI>
|
||||
<LI><TT>glutGet(GLUT_SCREEN_WIDTH_MM)</TT></LI>
|
||||
<LI><TT>glutGet(GLUT_WINDOW_NUM_CHILDREN)</TT></LI>
|
||||
<LI><TT>glutInitDisplayMode(GLUT_LUMINANCE)</TT></LI>
|
||||
<LI><TT>glutLayerGet(GLUT_HAS_OVERLAY)</TT></LI>
|
||||
<LI><TT>glutLayerGet(GLUT_LAYER_IN_USE)</TT></LI>
|
||||
<LI><TT>glutPushWindow()</TT></LI>
|
||||
<LI><TT>glutSetColor(), glutGetColor(), glutCopyColormap()</TT></LI>
|
||||
<LI><TT>glutVideoResize()</TT> missing. </LI>
|
||||
<LI><TT>glutWarpPointer()</TT></LI>
|
||||
<LI><TT>glutWindowStatusFunc()</TT></LI>
|
||||
<LI>Spaceball, buttonbox, dials, and tablet functions</LI>
|
||||
</UL>
|
||||
Most of the symbols/enumerations have different values than GLUT uses.
|
||||
This will break code that relies on the actual values. The only
|
||||
symbols guaranteed to have the same values are true/false pairs like <TT>
|
||||
GLUT_DOWN</TT> and <TT>GLUT_UP</TT>, mouse buttons <TT>
|
||||
GLUT_LEFT_BUTTON, GLUT_MIDDLE_BUTTON, GLUT_RIGHT_BUTTON</TT>, and <TT>
|
||||
GLUT_KEY_F1</TT> thru <TT>F12</TT>.
|
||||
<P>The strings passed as menu labels are not copied. </P>
|
||||
<P><TT>glutPostRedisplay()</TT> does not work if called from inside a
|
||||
display function. You must use <TT>glutIdleFunc()</TT> if you want
|
||||
your display to update continuously. </P>
|
||||
<P><TT>glutSwapBuffers()</TT> does not work from inside a display
|
||||
function. This is on purpose, because FLTK swaps the buffers for you. </P>
|
||||
<P><TT>glutUseLayer()</TT> does not work well, and should only be used
|
||||
This appendix describes the GLUT compatibility header file supplied with
|
||||
FLTK. FLTK's GLUT compatibility is based on the original GLUT 3.7 and
|
||||
the follow-on FreeGLUT 2.4.0 libraries.
|
||||
|
||||
\section glut_using Using the GLUT Compatibility Header File
|
||||
|
||||
You should be able to compile existing GLUT source code by including
|
||||
<tt><FL/glut.H></tt> instead of <tt><GL/glut.h></tt>. This can be
|
||||
done by editing the source, by changing the <tt>-I</tt> switches to
|
||||
the compiler, or by providing a symbolic link from <tt>GL/glut.h</tt>
|
||||
to <tt>FL/glut.H</tt>.
|
||||
|
||||
<I>All files calling GLUT procedures must be compiled with C++</I>. You
|
||||
may have to alter them slightly to get them to compile without warnings,
|
||||
and you may have to rename them to get make to use the C++ compiler.
|
||||
|
||||
You must link with the FLTK library. Most of <tt>FL/glut.H</tt>
|
||||
is inline functions. You should take a look at it (and maybe at
|
||||
<tt>test/glpuzzle.cxx</tt> in the FLTK source) if you are having trouble
|
||||
porting your GLUT program.
|
||||
|
||||
This has been tested with most of the demo programs that come with
|
||||
the GLUT and FreeGLUT distributions.
|
||||
|
||||
\section glut_known_problems Known Problems
|
||||
|
||||
The following functions and/or arguments to functions are missing,
|
||||
and you will have to replace them or comment them out for your code
|
||||
to compile:
|
||||
|
||||
\li <tt>glutGet(GLUT_ELAPSED_TIME)</tt>
|
||||
\li <tt>glutGet(GLUT_SCREEN_HEIGHT_MM)</tt>
|
||||
\li <tt>glutGet(GLUT_SCREEN_WIDTH_MM)</tt>
|
||||
\li <tt>glutGet(GLUT_WINDOW_NUM_CHILDREN)</tt>
|
||||
\li <tt>glutInitDisplayMode(GLUT_LUMINANCE)</tt>
|
||||
\li <tt>glutLayerGet(GLUT_HAS_OVERLAY)</tt>
|
||||
\li <tt>glutLayerGet(GLUT_LAYER_IN_USE)</tt>
|
||||
\li <tt>glutPushWindow()</tt>
|
||||
\li <tt>glutSetColor(), glutGetColor(), glutCopyColormap()</tt>
|
||||
\li <tt>glutVideoResize()</tt> missing.
|
||||
\li <tt>glutWarpPointer()</tt>
|
||||
\li <tt>glutWindowStatusFunc()</tt>
|
||||
\li Spaceball, buttonbox, dials, and tablet functions
|
||||
|
||||
Most of the symbols/enumerations have different values than GLUT uses.
|
||||
This will break code that relies on the actual values. The only
|
||||
symbols guaranteed to have the same values are true/false pairs like <tt>
|
||||
GLUT_DOWN</tt> and <tt>GLUT_UP</tt>, mouse buttons <tt>
|
||||
GLUT_LEFT_BUTTON, GLUT_MIDDLE_BUTTON, GLUT_RIGHT_BUTTON</tt>, and <tt>
|
||||
GLUT_KEY_F1</tt> thru <tt>F12</tt>.
|
||||
|
||||
The strings passed as menu labels are not copied.
|
||||
|
||||
<tt>glutPostRedisplay()</tt> does not work if called from inside a
|
||||
display function. You must use <tt>glutIdleFunc()</tt> if you want
|
||||
your display to update continuously.
|
||||
|
||||
<tt>glutSwapBuffers()</tt> does not work from inside a display
|
||||
function. This is on purpose, because FLTK swaps the buffers for you.
|
||||
|
||||
<tt>glutUseLayer()</tt> does not work well, and should only be used
|
||||
to initialize transformations inside a resize callback. You should
|
||||
redraw overlays by using <TT>glutOverlayDisplayFunc()</TT>. </P>
|
||||
<P>Overlays are cleared before the overlay display function is called. <TT>
|
||||
glutLayerGet(GLUT_OVERLAY_DAMAGED)</TT> always returns true for
|
||||
redraw overlays by using <tt>glutOverlayDisplayFunc()</tt>.
|
||||
|
||||
Overlays are cleared before the overlay display function is called. <tt>
|
||||
glutLayerGet(GLUT_OVERLAY_DAMAGED)</tt> always returns true for
|
||||
compatibility with some GLUT overlay programs. You must rewrite your
|
||||
code so that <TT>gl_color()</TT> is used to choose colors in an
|
||||
overlay, or you will get random overlay colors. </P>
|
||||
<P><TT>glutSetCursor(GLUT_CURSOR_FULL_CROSSHAIR)</TT> just results in a
|
||||
small crosshair. </P>
|
||||
<P>The fonts used by <TT>glutBitmapCharacter() and glutBitmapWidth()</TT>
|
||||
may be different. </P>
|
||||
<P><TT>glutInit(argc,argv)</TT> will consume different switches than
|
||||
code so that <tt>gl_color()</tt> is used to choose colors in an
|
||||
overlay, or you will get random overlay colors.
|
||||
|
||||
<tt>glutSetCursor(GLUT_CURSOR_FULL_CROSSHAIR)</tt> just results in a
|
||||
small crosshair.
|
||||
|
||||
The fonts used by <tt>glutBitmapCharacter() and glutBitmapWidth()</tt>
|
||||
may be different.
|
||||
|
||||
<tt>glutInit(argc,argv)</tt> will consume different switches than
|
||||
GLUT does. It accepts the switches recognized by <A href="Fl.html#Fl.args">
|
||||
<TT>Fl::args()</TT></A>, and will accept any abbreviation of these
|
||||
switches (such as "-di" for "-display"). </P>
|
||||
<H2>Mixing GLUT and FLTK Code</H2>
|
||||
You can make your GLUT window a child of a <TT>Fl_Window</TT> with the
|
||||
following scheme. The biggest trick is that GLUT insists on <TT>show()</TT>
|
||||
'ing the window at the point it is created, which means the <TT>
|
||||
Fl_Window</TT> parent window must already be shown.
|
||||
<UL>
|
||||
<LI>Don't call <TT>glutInit()</TT>. </LI>
|
||||
<LI>Create your <TT>Fl_Window</TT>, and any FLTK widgets. Leave a
|
||||
blank area in the window for your GLUT window. </LI>
|
||||
<LI><TT>show()</TT> the <TT>Fl_Window</TT>. Perhaps call <TT>
|
||||
show(argc,argv)</TT>. </LI>
|
||||
<LI>Call <TT>window->begin()</TT> so that the GLUT window will be
|
||||
automatically added to it. </LI>
|
||||
<LI>Use <TT>glutInitWindowSize()</TT> and <TT>glutInitWindowPosition()</TT>
|
||||
to set the location in the parent window to put the GLUT window. </LI>
|
||||
<LI>Put your GLUT code next. It probably does not need many changes.
|
||||
Call <TT>window->end()</TT> immediately after the <TT>
|
||||
glutCreateWindow()</TT>! </LI>
|
||||
<LI>You can call either <TT>glutMainLoop()</TT>, <TT>Fl::run()</TT>, or
|
||||
loop calling <TT>Fl::wait()</TT> to run the program. </LI>
|
||||
</UL>
|
||||
<tt>Fl::args()</tt></A>, and will accept any abbreviation of these
|
||||
switches (such as "-di" for "-display").
|
||||
|
||||
\section glut_mixing Mixing GLUT and FLTK Code
|
||||
|
||||
You can make your GLUT window a child of a <tt>Fl_Window</tt> with the
|
||||
following scheme. The biggest trick is that GLUT insists on
|
||||
<tt>show()</tt>'ing the window at the point it is created, which means the
|
||||
<tt>Fl_Window</tt> parent window must already be shown.
|
||||
|
||||
\li Don't call <tt>glutInit()</tt>.
|
||||
\li Create your <tt>Fl_Window</tt>, and any FLTK widgets. Leave a
|
||||
blank area in the window for your GLUT window.
|
||||
\li <tt>show()</tt> the <tt>Fl_Window</tt>. Perhaps call <tt>
|
||||
show(argc,argv)</tt>.
|
||||
\li Call <tt>window->begin()</tt> so that the GLUT window will be
|
||||
automatically added to it.
|
||||
\li Use <tt>glutInitWindowSize()</tt> and <tt>glutInitWindowPosition()</tt>
|
||||
to set the location in the parent window to put the GLUT window.
|
||||
\li Put your GLUT code next. It probably does not need many changes.
|
||||
Call <tt>window->end()</tt> immediately after the
|
||||
<tt>glutCreateWindow()</tt>!
|
||||
\li You can call either <tt>glutMainLoop()</tt>, <tt>Fl::run()</tt>,
|
||||
or loop calling <tt>Fl::wait()</tt> to run the program.
|
||||
|
||||
<HR break>
|
||||
<A NAME="Fl_Glut_Window"></A> <!-- For old HTML links only ! -->
|
||||
\section glut_Fl_Glut_Window class Fl_Glut_Window
|
||||
<HR>
|
||||
<H3>Class Hierarchy</H3>
|
||||
|
||||
\subsection glut_class_hierarchy Class Hierarchy
|
||||
|
||||
\code
|
||||
<A href=Fl_Gl_Window.html#Fl_Gl_Window>Fl_Gl_Window</A>
|
||||
Fl_Gl_Window
|
||||
|
|
||||
+----<B>Fl_Glut_Window</B>
|
||||
+----Fl_Glut_Window
|
||||
\endcode
|
||||
|
||||
<H3>Include Files</H3>
|
||||
\subsection glut_include_files Include Files
|
||||
|
||||
\code
|
||||
#include <FL/glut.H>
|
||||
\endcode
|
||||
|
||||
<H3>Description</H3>
|
||||
Each GLUT window is an instance of this class. You may find it useful
|
||||
\subsection glut_description Description
|
||||
|
||||
Each GLUT window is an instance of this class. You may find it useful
|
||||
to manipulate instances directly rather than use GLUT window id's.
|
||||
These may be created without opening the display, and thus can fit
|
||||
These may be created without opening the display, and thus can fit
|
||||
better into FLTK's method of creating windows.
|
||||
<P>The current GLUT window is available in the global variable <TT>
|
||||
glut_window</TT>. </P>
|
||||
<P><TT>new Fl_Glut_Window(...)</TT> is the same as <TT>
|
||||
glutCreateWindow()</TT> except it does not <TT>show()</TT> the window
|
||||
|
||||
The current GLUT window is available in the global variable <tt>
|
||||
glut_window</tt>. </P>
|
||||
|
||||
<tt>new Fl_Glut_Window(...)</tt> is the same as <tt>
|
||||
glutCreateWindow()</tt> except it does not <tt>show()</tt> the window
|
||||
or make the window current. </P>
|
||||
<P><TT>window->make_current()</TT> is the same as <TT>
|
||||
glutSetWindow(number)</TT>. If the window has not had <TT>show()</TT>
|
||||
called on it yet, some functions that assumme an OpenGL context will
|
||||
not work. If you do <TT>show()</TT> the window, call <TT>make_current()</TT>
|
||||
again to set the context. </P>
|
||||
<P><TT>~Fl_Glut_Window()</TT> is the same as <TT>glutDestroyWindow()</TT>
|
||||
. </P>
|
||||
<H3>Members</H3>
|
||||
The <TT>Fl_Glut_Window</TT> class contains several public members that can
|
||||
|
||||
<tt>window->make_current()</tt> is the same as <tt>glutSetWindow(number)</tt>.
|
||||
If the window has not had <tt>show()</tt> called on it yet, some functions
|
||||
that assumme an OpenGL context will not work.
|
||||
If you do <tt>show()</tt> the window, call <tt>make_current()</tt>
|
||||
again to set the context. </P>
|
||||
|
||||
<tt>~Fl_Glut_Window()</tt> is the same as <tt>glutDestroyWindow()</tt>.
|
||||
|
||||
\subsection glut_members Members
|
||||
|
||||
The <tt>Fl_Glut_Window</tt> class contains several public members that can
|
||||
be altered directly:
|
||||
|
||||
<CENTER><TABLE WIDTH="80%" BORDER="1" ALT="Fl_Glut_Window public members.">
|
||||
<TR>
|
||||
<TH>member</TH>
|
||||
@@ -169,25 +207,33 @@ be altered directly:
|
||||
</TR>
|
||||
</TABLE></CENTER>
|
||||
|
||||
<H3>Methods</H3>
|
||||
<UL>
|
||||
<LI><A href=#Fl_Glut_Window.Fl_Glut_Window>Fl_Glut_Window</A></LI>
|
||||
<LI><A href=#Fl_Glut_Window.~Fl_Glut_Window>~Fl_Glut_Window</A></LI>
|
||||
<LI><A href=#Fl_Glut_Window.make_current>make_current</A></LI>
|
||||
</UL>
|
||||
<H4><A name=Fl_Glut_Window.Fl_Glut_Window>
|
||||
\subsection glut_methods Methods
|
||||
|
||||
\li <A href=#Fl_Glut_Window.Fl_Glut_Window>Fl_Glut_Window</A>
|
||||
\li <A href=#Fl_Glut_Window.~Fl_Glut_Window>~Fl_Glut_Window</A>
|
||||
\li <A href=#Fl_Glut_Window.make_current>make_current</A>
|
||||
|
||||
<A name="Fl_Glut_Window.Fl_Glut_Window"></A> <!-- For old HTML links only ! -->
|
||||
Fl_Glut_Window::Fl_Glut_Window(int x, int y, int w, int h, const char
|
||||
*title = 0)
|
||||
<BR> Fl_Glut_Window::Fl_Glut_Window(int w, int h, const char *title = 0)</A>
|
||||
</H4>
|
||||
The first constructor takes 4 int arguments to create the window with
|
||||
*title = 0) <br>
|
||||
Fl_Glut_Window::Fl_Glut_Window(int w, int h, const char *title = 0)
|
||||
|
||||
\par
|
||||
The first constructor takes 4 int arguments to create the window with
|
||||
a preset position and size. The second constructor with 2 arguments
|
||||
will create the window with a preset size, but the window manager will
|
||||
choose the position according to it's own whims.
|
||||
<H4><A name=Fl_Glut_Window.~Fl_Glut_Window>virtual
|
||||
Fl_Glut_Window::~Fl_Glut_Window()</A></H4>
|
||||
Destroys the GLUT window.
|
||||
<H4><A name="Fl_Glut_Window.make_current">void Fl_Glut_Window::make_current()</A></H4>
|
||||
|
||||
<A name="Fl_Glut_Window.~Fl_Glut_Window"> </A> <!-- For old HTML links only ! -->
|
||||
virtual Fl_Glut_Window::~Fl_Glut_Window()
|
||||
|
||||
\par
|
||||
Destroys the GLUT window.
|
||||
|
||||
<A name="Fl_Glut_Window.make_current"> </A> <!-- For old HTML links only ! -->
|
||||
void Fl_Glut_Window::make_current()
|
||||
|
||||
\par
|
||||
Switches all drawing functions to the GLUT window.
|
||||
|
||||
<hr>
|
||||
|
||||
Reference in New Issue
Block a user