Todo List

The latest list is available at http://www.openglean.org/todo.html.

Note:

Bug reports and other suggestions should be directed to the developers at this time.

• Remove most of these to \todo, \bug, or \note annotations.

• Drop the ones that no longer apply.

• In the Atlantis demo, under windows and with the task bar to the left of the screen, the GLUT window comes up in a position relative to the corner of the screen while the freeglut window comes up down and to the right of where it was the last time it was opened.

• In the Atlantis demo, if you stop the animation and move the mouse around with a menu open, the whales jiggle but don't circulate. My guess is that you need a way to redisplay the menu without forcing a redisplay from the application.

• In the Atlantis demo, if you bring up the menu in GLUT the animation stops; in freeglut the fish and whales wiggle without advancing. This may be another manifestation of (2).

• With the "bluepony" demo under Windows, if you reshape the window using the mouse, the scene does not redraw until you move it with a keypress (arrow key or space bar to start the animation). Check out the "CS_VREDRAW or CS_HREDRAW" sections in MSVC help for a pointer about this.

• If you compare the "bounce" demo with freeglut and GLUT, you see that the freeglut lights are larger and dimmer (and don't shine on the walls) than the GLUT lights.

• Large submenus in freeglut tend to cover their parent menus, making it difficult to get past them. This is visible in the "geoface" demo. In GLUT the menus can extend outside the window; freeglut should do the same thing.

• The "fgCleanUpGlutsMess" function seems to duplicate the "fgDestroyStructure" or "fgDeinitialize" function and should probably be removed.

• P-GUIDE apparently calls the get and set window size functions repeatedly. Each time it does, the window shrinks by 2 pixels in each direction.

• X support wrongly assumes exactly 3 mouse buttons.

• Indexed color is untested on WIN32. glut[GS]etColor() are unimplemented on WIN32.

• Overlays are not supported, but one of the GLUT conformance tests fails due to glutLayerGet( GLUT_NORMAL_DAMAGED ) returning FALSE when the window has actually been damaged.

• Does the init display string work?

• The visibility/window status function is a conceptual mess. I had to peer into the GLUT source code to see what actually happens inside. It helped me a bit, but still one of the visibility tests fails. This is probably the reason for which a window covered by enlightenment status bar is marked as hidden and does not get redrawn.

• GLX 1.3 spec states that glXChooseVisual() et consortes are deprecated. Consider moving to glXFBConfig. (I cannot find glXFBConfig() in any library on /usr/X11R6/lib/ nor in /usr/pkg/lib; either this is a typo, or "no one" supports this feature yet.)

• Need to investigate what happens when initial window position is set to (-1,-1). GLUT specification says, that the window positioning should be left to the window system. And I do not know how to force it do so...

• I was told it is wrong to have the redisplay forced in the main loop. Is that right? I am not aware of any place where it is forced, but it is certainly wrong to force it if there's no request from the client nor informing event from the OS.

• Some of the tests freeze because they do not generate the glutPostRedisplay() call every frame. Is this still a problem? (This is unclear...)

• Menus do not display in single-buffered windows, although they are active and the user can pick from them if he knows how to move the mouse exactly right. Fixed, I think.

• In the "boundary.c" demo in the "advanced" directory, if the outline rendering is turned on the menu background turns black.

• When you get around the requirement for an existing window in "comp.c", you find that freeglut renders the window differently from GLUT. For starters, freeglut looks like it is double-buffering while GLUT looks like it is single-buffering. In freeglut the background is all black while in GLUT it starts black and turns white before your eyes.

• Running the "convolve" GLUT demo in the "advanced" directory (after fixing it so it doesn't terminate on error), I find that the freeglut version runs much more slowly than the GLUT version. I think this has to do with forcing redraws when the menu comes up.

• The "genmipmap" demo runs much more slowly in freeglut than in GLUT (try moving a window!) and flashes the texture over the whole window instead of just the part of the window where it finally settles down.

• We need to keep the freeglut structure current (including the GLUT action on window closure) after the last window closes. (Aleksandar Donev email, 7/4/03, 5:00 PM). Is this fixed?

• The visibility callback is not invoked when minimizing a window. It should be.

• We should add a glutExit() call to the interface. Also a glutGet() to tell whether it has been initialized properly. And have freeglut call glutExit() before it calls exit().

• Remove (post-1.0) the glutVisibilityFunc(). See the API proposal for this.

Global OPENGLEAN_MENU_FONT

Stuff these into global state variables

Global OPENGLEAN_MENU_FONT

Maybe support runtime selection between bitmapped and stroked?

Global glutInit

Should -sync cause a window system sync at the top of the event loop (or at the open/close of the glutMainEventLoop())?

Global glutLeaveMainLoop

Could use longjmp(); see oghTakeActionOnWindowClose(). This would let us terminate the entire loop immediately.

Group window

At some point, the API should be revised so that one can make a more meaningful query/request pattern to restore window size/position. We should be able to do better than the current situation.

----

OpenGLEAN has numerous data structures that must be initialized before use. Additionally, OpenGLEAN supports some interaction with the user and environment during initialization---for example, setting the window size and position. In the same family, there are a few functions for letting the program set default values and make requests.

The glutInit*() functions cover these needs.

Bear in mind that:

• The only chance that the user may have to control some aspects about a window is via the command-lined (parsed by OpenGLEAN's glutInit().
• When a new option is set or requested, OpenGLEAN forgets the old option's value (if any) immediately. glutInit() can override previous glutInitWindowPosition() settings---and vice versa.
• Other than basic data structure initialization, few if any glutInit*() functions have any direct bearing on subwindows.
• Windows, especially top-level windows, may be subject to modification (before and after opening) by the window manager, and the user. Any requests by your program after the window is opened may be delayed, altered, or discarded. See the ``window'' group.

Global glutCreateSubWindow

Consider implementing subwindows as a "mode" or "style" of a more generic window creation interface. (The parentID could then be omitted and instead we'd use the current window.)

Global glutDestroyWindow

Is this safe if we are not initialized yet?

Global glutDestroyWindow

Clean this up.

Global glutInitDisplayString

GLUT_BORDERLESS is not represented.

offscreen is not tested.

Not all features appear to be implemented. In particular, numeric parameters and comparator specifications are lacking. See GLUT 3.7 sources for example.

PyOpenGL glutInitDisplayString documentation.

Global glutReshapeWindow

Add support for offscreen windows.

Global glutSetCursor

Presently on X11, if we fail to create the new cursor, we behave as if GLUT_CURSOR_INHERIT were requested. We should probably leave the cursor unchanged. Before I tighten this up too much, I should determine what we can truly guarnatee with WIN32.

Note:

The X branch of OpenGLEAN does not do thorough error checking.

The X branch of OpenGLEAN always converts FULL_CROSSHAIR to CROSSHAIR. This is acceptable, but if a host system supports a fullscreen crosshair, it would be nice to support that. OpenGLEAN actually rewrites your cursor choice, at present, rather than silently pretending that you said something else. This is not what GLUT, or freeglut (now), do.

Out of range cursorID values generate warnings.

Has no visible effect if the current window is of type GLUT_OFFSCREEN.

Consider importing the cursor-caching that freeglut has recently added. Useful for those special corner cases where you're running your application remotely and don't want to keep re-generating the cursor over a network link.

Global glutSwapBuffers

How does this interact with overlays?

Consider making GLUT_FPS keep per-window stats in a multi-window program.

Global glutDeviceGet

Consider moving to a table-based approach rather than a switch(), letting us move to modular functions.

Global glutGet

Multisample support (GLUT_WINDOW_NUM_SAMPLES, here).

GLUT_WINDOW_BUFFER_SIZE should be implemented for WIN32.

Add GLUT_WINDOW_AUX_BUFFERS?

It looks like we could use an OPENGLEAN_REQUIRE_WINDOW() macro invocation in addition to OPENGLEAN_REQUIRE_READY().

GLUT_DISPLAY_MODE_POSSIBLE does not need us to run OPENGLEAN_REQUIRE_READY(), does it?

This function is a bit messy, especially the WINCE part. Fix.

Lots of code uses return to hop out. Since it's such a sprawling function, it's easy to be in the middle and not be 100% sure if there's anything important at the end of the function, or if it is safe to just "drop out" of the current case and head for the bottom.

Global glutExtensionSupported

Consider an ogWarning() if there is no current rendering context.

This is an ugly bit of code with 5 return statements, one of which is never reached.

Global glutLayerGet

Probably we should merge the below sections unless and until layer support is actually added.

Global glutLayerGet

Should be set when the window is damaged; should not be set just for glutPostRedisplay().

Global glutCopyColormap

Determine if we should set the current window

Test.

WIN32 version.

Global glutGetColor

Untested.

WIN32 version.

Global glutSetColor

Error checking.

Testing.

WIN32 version.

Global glutCreateMenuWindow

Consider making "menu windowness" a mode for a generic window creation API entry point.

Global glutSetWindowStayOnTop

Can a glutGet() be defined to tell us whether a window can be made to stay on top? Or whether a window has (successfully) been marked for staying on top?

Investigate making a workalike variant using glutPopWindow() to mimic the feature where not directly supported.

Global glutAttachMenu

Assumes 3 mouse buttons. (Actually OPENGLEAN_MAX_MENUS holds the assumed number of buttons.) Cannot bind to more buttons. Will not issue any warnings or errors if the user does not have enough buttons to reach your menu.

Global glutBitmapHeight

We have discussed adding a "font descender" query. We should go ahead and do it.

Global glutCloseFunc

There needs to be some work to rationalize the behavior when a window is closed. Presently, the handling is ad-hoc and sloppy.

Global glutGameModeGet

OpenGLEAN intrepretation of GLUT_GAME_MODE_DISPLAY_CHANGED

Global glutMenuDestroyFunc

What on Earth is rationale for this feature? Menus should only be destroyed when we ask them to be destroyed, or when their window is destroyed. In the former case, we already know that the menu is being destroyed because we requested it. In the latter case, it is easy for the client to track that if they care, via window-destruction callbacks.

Global glutSolidSierpinskiSponge

Consider removing the offset parameter from the API (use a helper function).

num_levels should really be unsigned.

Global glutSolidTetrahedron

See todo-list on glutWireTetrahedron().

Global glutStrokeHeight

We have discussed adding a "font descender" query. We should go ahead and do it.

Global glutStrokeWidth

Determine if any glyphs are either wider than this function or if they render outside of the bounding box given by (0,-descent) by (width,height-descent).

Global glutTabletButtonFunc

We might want to add support for this sooner or later. Although a tablet could also be generalized as a mouse. There are relatively cheap AipTek HyperPen tablets, and slightly less cheap Wacom tablets on many store shelves.

Global glutTabletMotionFunc

We might want to add support for this sooner or later. Although a tablet could also be generalized as a mouse. There are relatively cheap AipTek HyperPen tablets, and slightly less cheap Wacom tablets on many store shelves.

Global glutWireOctahedron

It may be faster (and look better) to draw each edge once, setting the Normal at each edge. (I don't think that this matters all that much, but a lineloop was proposed for the wire Cube for speed.)

Global glutWireSierpinskiSponge

Refer to the TODO entries for glutWireSierpinksySponge().

Global glutWireTetrahedron

Merge r0 r1 r2 and r3 into one array.

Put the normals into the (or an) array.

Make the array static const, with file scope, and share with glutSolidTetrahedron().

Maybe consolidate with the SierpinskySponge?

Supported in part by SourceForge.net.

Generated on Fri Sep 16 20:15:32 2005 for OpenGLEAN by doxygen 1.4.3
The OpenGLEAN project is hosted by olib.org and SourceForge.