|Maintainer||Sven Panne <email@example.com>|
GLUT supports two types of windows: top-level windows and subwindows. Both types support OpenGL rendering and GLUT callbacks. There is a single identifier space for both types of windows.
- data Window
- createWindow :: String -> IO Window
- createSubWindow :: Window -> Position -> Size -> IO Window
- destroyWindow :: Window -> IO ()
- parentWindow :: GettableStateVar (Maybe Window)
- numSubWindows :: GettableStateVar Int
- currentWindow :: StateVar (Maybe Window)
- postRedisplay :: Maybe Window -> IO ()
- swapBuffers :: IO ()
- windowPosition :: StateVar Position
- windowSize :: StateVar Size
- fullScreen :: IO ()
- fullScreenToggle :: IO ()
- pushWindow :: IO ()
- popWindow :: IO ()
- data WindowStatus
- windowStatus :: SettableStateVar WindowStatus
- windowTitle :: SettableStateVar String
- iconTitle :: SettableStateVar String
- data Cursor
- cursor :: StateVar Cursor
- pointerPosition :: SettableStateVar Position
An opaque identifier for a top-level window or a subwindow.
Creating and destroying (sub-)windows
Each created window has a unique associated OpenGL context. State changes to a window's associated OpenGL context can be done immediately after the window is created.
The display state of a window is initially for the window to be shown. But
the window's display state is not actually acted upon until
mainLoop is entered. This means until
mainLoop is called, rendering to a created window is
ineffective because the window can not yet be displayed.
Create a top-level window. The given name will be provided to the window system as the window's name. The intent is that the window system will label the window with the name.Implicitly, the current window is set to the newly created window.
X Implementation Notes: The proper X Inter-Client Communication Conventions
Manual (ICCCM) top-level properties are established. The
property that lists the command line used to invoke the GLUT program is only
established for the first window created.
Identifier of the subwindow's parent window.
Window position in pixels relative to parent window's origin.
Window size in pixels
|-> IO Window|
The identifier for the newly created subwindow
Create a subwindow of the identified window with the given relative position and size. Implicitly, the current window is set to the newly created subwindow. Subwindows can be nested arbitrarily deep.
Destroy the specified window and the window's associated OpenGL context,
logical colormap (if the window is color index), and overlay and related
state (if an overlay has been established). Any subwindows of the destroyed
window are also destroyed by
destroyWindow. If the specified window was the
current window, the current window becomes invalid (
Contains the current window\'s parent. If the current window is a
Nothing is returned.
Contains the number of subwindows the current window has, not counting children of children.
Manipulating the current window
Re-displaying and double buffer management
Mark the normal plane of given window (or the current window, if none
is supplied) as needing to be redisplayed. The next iteration through
mainLoop, the window's display callback will be
called to redisplay the window's normal plane. Multiple calls to
postRedisplay before the next display callback opportunity generates only a
single redisplay callback.
postRedisplay may be called within a window's
display or overlay display callback to re-mark that window for redisplay.
Logically, normal plane damage notification for a window is treated as a
postRedisplay on the damaged window. Unlike damage reported by the window
postRedisplay will not set to true the normal plane's damaged
Mark the normal plane of the given window as needing to be redisplayed,
otherwise the same as
The advantage of this routine is that it saves the cost of using
currentWindow (entailing an expensive OpenGL context switch), which is
particularly useful when multiple windows need redisplays posted at the same
Perform a buffer swap on the layer in use for the current window.
swapBuffers promotes the contents of the back buffer of the
layer in use of the current window to become the contents of the front
buffer. The contents of the back buffer then become undefined. The update
typically takes place during the vertical retrace of the monitor, rather than
swapBuffers is called.
flush is done by
swapBuffers before it returns. Subsequent OpenGL commands can be issued
immediately after calling
swapBuffers, but are not executed until the
buffer exchange is completed.
If the layer in use is not double buffered,
swapBuffers has no effect.
Changing the window geometry
Note that the requests by
are not processed immediately. A request is executed after returning to the
main event loop. This allows multiple requests to the same window to be
Controls the position of the current window. For top-level windows,
Position are pixel offsets from the screen origin. For
subwindows, the parameters are pixel offsets from the window's parent window
In the case of top-level windows, setting
windowPosition is considered only
a request for positioning the window. The window system is free to apply its
own policies to top-level window placement. The intent is that top-level
windows should be repositioned according to the value of
Controls the size of the current window. The parameters of
size extents in pixels. The width and height must be positive values.
In the case of top-level windows, setting
windowSize is considered only a
request for sizing the window. The window system is free to apply its own
policies to top-level window sizing. The intent is that top-level windows
should be reshaped according to the value of
windowSize. Whether a reshape
actually takes effect and, if so, the reshaped dimensions are reported to the
program by a reshape callback.
Request that the current window be made full screen. The exact semantics of what full screen means may vary by window system. The intent is to make the window as large as possible and disable any window decorations or borders added the window system. The window width and height are not guaranteed to be the same as the screen width and height, but that is the intent of making a window full screen.
fullScreen is defined to work only on top-level windows.
X Implementation Notes: In the X implementation of GLUT, full screen is
implemented by sizing and positioning the window to cover the entire screen
and posting the
_MOTIF_WM_HINTS property on the window requesting
absolutely no decorations. Non-Motif window managers may not respond to
Manipulating the stacking order
popWindow work on both top-level windows and subwindows.
The effect of pushing and popping windows does not take place immediately.
Instead the push or pop is saved for execution upon return to the GLUT event
loop. Subsequent pop or push requests on a window replace the previously
saved request for that window. The effect of pushing and popping top-level
windows is subject to the window system's policy for restacking windows.
Change the stacking order of the current window relative to its siblings (lowering it).
Change the stacking order of the current window relative to its siblings, bringing the current window closer to the top.
Managing a window's display status
The display status of a window.
Controls the display status of the current window.
Note that the effect of showing, hiding, and iconifying windows does not take place immediately. Instead the requests are saved for execution upon return to the GLUT event loop. Subsequent show, hide, or iconification requests on a window replace the previously saved request for that window. The effect of hiding, showing, or iconifying top-level windows is subject to the window system's policy for displaying windows. Subwindows can't be iconified.
Changing the window/icon title
iconTitle should be set only when the /current
window/ is a top-level window. Upon creation of a top-level window, the
window and icon names are determined by the name given to
Once created, setting
iconTitle can change the window and
icon names respectively of top-level windows. Each call requests the window
system change the title appropriately. Requests are not buffered or
coalesced. The policy by which the window and icon name are displayed is
window system dependent.
Controls the window title of the current top-level window.
The different cursor images GLUT supports.
Arrow pointing up and to the right.
Arrow pointing up and to the left.
Skull & cross bones.
Arrows rotating in a circle.
Insertion point cursor for text.
Bi-directional pointing up & down.
Bi-directional pointing left & right.
Arrow pointing to top side.
Arrow pointing to bottom side.
Arrow pointing to left side.
Arrow pointing to right side.
Arrow pointing to top-left corner.
Arrow pointing to top-right corner.
Arrow pointing to bottom-left corner.
Arrow pointing to bottom-right corner.
Use parent's cursor.
Full-screen cross-hair cursor (if possible, otherwise
Change the cursor image of the current window. Each call requests the
window system change the cursor appropriately. The cursor image when a window
is created is
Inherit. The exact cursor images used are implementation
dependent. The intent is for the image to convey the meaning of the cursor
name. For a top-level window,
Inherit uses the default window system
X Implementation Notes: GLUT for X uses SGI's
convention to access a full-screen cross-hair cursor if possible.
pointerPosition warps the window system's pointer to a new
location relative to the origin of the current window by the specified
pixel offset, which may be negative. The warp is done immediately.
If the pointer would be warped outside the screen's frame buffer region, the location will be clamped to the nearest screen edge. The window system is allowed to further constrain the pointer's location in window system dependent ways.
Good advice from Xlib's
XWarpPointer man page: "There is seldom any
reason for calling this function. The pointer should normally be left to the