Archon::Display::Window Struct Reference

A window whose main purpose is OpenGL rendering. More...

#include <archon/display/window.H>

Inheritance diagram for Archon::Display::Window:

Inheritance graph
[legend]
Collaboration diagram for Archon::Display::Window:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void setTitle (string title)=0
 Sets a new title in the title bar of this window.
virtual void move (int left, int top)=0
 Move this window.
virtual void resize (int width, int height)=0
 Resize this window.
virtual int getWidth ()=0
 Get the current width of this window.
virtual int getHeight ()=0
 Get the current width of this window.
virtual void swapBuffers ()=0
 Swap foreground and background buffers.
virtual void processEvents (EventHandler *h)=0
 Call this method regularly (at least 10 times per second to get reasonable responsiveness) to process incoming events.

Detailed Description

A window whose main purpose is OpenGL rendering.

On the X Window System this is a wrapper around the Window structure of Xlib.

New windows are created by calling Visual::createWindow.

See also:
http://www.opengl.org

http://www.mesa3d.org

http://www.x.org

Definition at line 70 of file window.H.


Member Function Documentation

virtual int Archon::Display::Window::getHeight  )  [pure virtual]
 

Get the current width of this window.

The returned value will reflect the current height only if you call processEvents regularly.

Returns:
The height in pixels of the windows contents area.

Implements Archon::Display::Drawable.

Implemented in Archon::Display::WindowX11.

virtual int Archon::Display::Window::getWidth  )  [pure virtual]
 

Get the current width of this window.

The returned value will reflect the current width only if you call processEvents regularly.

Returns:
The width in pixels of the windows contents area.

Implements Archon::Display::Drawable.

Implemented in Archon::Display::WindowX11.

virtual void Archon::Display::Window::move int  left,
int  top
[pure virtual]
 

Move this window.

Parameters:
left Initial horizontal displacement of the left outside edge of the window measured from the left edge of the screen. Increasing this value moves the window further to the right.
top Initial vertical displacement of upper outside edge of the window measured from the top edge of the screen. Increasing this value moves the window further down.

Implemented in Archon::Display::WindowX11.

virtual void Archon::Display::Window::processEvents EventHandler h  )  [pure virtual]
 

Call this method regularly (at least 10 times per second to get reasonable responsiveness) to process incoming events.

Parameters:
h A pointer to your event handler derived from EventHandler.

Implemented in Archon::Display::WindowX11.

virtual void Archon::Display::Window::resize int  width,
int  height
[pure virtual]
 

Resize this window.

This generates a resize event.

Parameters:
width New width in pixels of the windows contents area.
height New height in pixels of the windows contents area.

Implemented in Archon::Display::WindowX11.

virtual void Archon::Display::Window::setTitle string  title  )  [pure virtual]
 

Sets a new title in the title bar of this window.

Parameters:
title New title.

Implemented in Archon::Display::WindowX11.

virtual void Archon::Display::Window::swapBuffers  )  [pure virtual]
 

Swap foreground and background buffers.

Performs an implicit glFlush()

Implemented in Archon::Display::WindowX11.


The documentation for this struct was generated from the following file:
Generated on Sun Jul 30 22:56:49 2006 for Archon by  doxygen 1.4.4