OpenTK.GameWindow Class Reference

The GameWindow class contains cross-platform methods to create and render on an OpenGL window, handle input and load resources. More...

Inheritance diagram for OpenTK.GameWindow:

List of all members.

Public Member Functions
	GameWindow ()
	Constructs a new GameWindow with sensible default attributes.
	GameWindow (int width, int height)
	Constructs a new GameWindow with the specified attributes.
	GameWindow (int width, int height, GraphicsMode mode)
	Constructs a new GameWindow with the specified attributes.
	GameWindow (int width, int height, GraphicsMode mode, string title)
	Constructs a new GameWindow with the specified attributes.
	GameWindow (int width, int height, GraphicsMode mode, string title, GameWindowFlags options)
	Constructs a new GameWindow with the specified attributes.
	GameWindow (int width, int height, GraphicsMode mode, string title, GameWindowFlags options, DisplayDevice device)
	Constructs a new GameWindow with the specified attributes.
	GameWindow (int width, int height, GraphicsMode mode, string title, GameWindowFlags options, DisplayDevice device, int major, int minor, GraphicsContextFlags flags)
	Constructs a new GameWindow with the specified attributes.
	GameWindow (int width, int height, GraphicsMode mode, string title, GameWindowFlags options, DisplayDevice device, int major, int minor, GraphicsContextFlags flags, IGraphicsContext sharedContext)
	Constructs a new GameWindow with the specified attributes.
override void	Dispose ()
	Disposes of the GameWindow, releasing all resources consumed by it.
virtual void	Exit ()
	Closes the GameWindow. Equivalent to NativeWindow.Close method.
void	MakeCurrent ()
	Makes the GraphicsContext current on the calling thread.
void	Run ()
	Enters the game loop of the GameWindow using the maximum update rate.
void	Run (double updateRate)
	Enters the game loop of the GameWindow using the specified update rate. maximum possible render frequency.
void	Run (double updates_per_second, double frames_per_second)
	Enters the game loop of the GameWindow updating and rendering at the specified frequency.
void	SwapBuffers ()
	Swaps the front and back buffer, presenting the rendered scene to the user.
Protected Member Functions
override void	OnClosing (System.ComponentModel.CancelEventArgs e)
	Called when the NativeWindow is about to close.
virtual void	OnLoad (EventArgs e)
	Called after an OpenGL context has been established, but before entering the main loop.
virtual void	OnUnload (EventArgs e)
	Called after GameWindow.Exit was called, but before destroying the OpenGL context.
virtual void	Dispose (bool manual)
	Override to add custom cleanup logic.
virtual void	OnRenderFrame (FrameEventArgs e)
	Called when the frame is rendered.
virtual void	OnUpdateFrame (FrameEventArgs e)
	Called when the frame is updated.
virtual void	OnWindowInfoChanged (EventArgs e)
	Called when the WindowInfo for this GameWindow has changed.
override void	OnResize (EventArgs e)
	Called when the NativeWindow is resized.
Properties
IGraphicsContext	Context `[get]`
	Returns the opengl IGraphicsContext associated with the current GameWindow.
bool	IsExiting `[get]`
	Gets a value indicating whether the shutdown sequence has been initiated for this window, by calling GameWindow.Exit() or hitting the 'close' button. If this property is true, it is no longer safe to use any OpenTK.Input or OpenTK.Graphics.OpenGL functions or properties.
IList< JoystickDevice >	Joysticks `[get]`
	Gets a readonly IList containing all available OpenTK.Input.JoystickDevices.
KeyboardDevice	Keyboard `[get]`
	Gets the primary Keyboard device, or null if no Keyboard exists.
MouseDevice	Mouse `[get]`
	Gets the primary Mouse device, or null if no Mouse exists.
double	RenderFrequency `[get]`
	Gets a double representing the actual frequency of RenderFrame events, in hertz (i.e. fps or frames per second).
double	RenderPeriod `[get]`
	Gets a double representing the period of RenderFrame events, in seconds.
double	RenderTime `[get, set]`
	Gets a double representing the time spent in the RenderFrame function, in seconds.
double	TargetRenderFrequency `[get, set]`
	Gets or sets a double representing the target render frequency, in hertz.
double	TargetRenderPeriod `[get, set]`
	Gets or sets a double representing the target render period, in seconds.
double	TargetUpdateFrequency `[get, set]`
	Gets or sets a double representing the target update frequency, in hertz.
double	TargetUpdatePeriod `[get, set]`
	Gets or sets a double representing the target update period, in seconds.
double	UpdateFrequency `[get]`
	Gets a double representing the frequency of UpdateFrame events, in hertz.
double	UpdatePeriod `[get]`
	Gets a double representing the period of UpdateFrame events, in seconds.
double	UpdateTime `[get]`
	Gets a double representing the time spent in the UpdateFrame function, in seconds.
VSyncMode	VSync `[get, set]`
	Gets or sets the VSyncMode.
override WindowState	WindowState `[get, set]`
	Gets or states the state of the NativeWindow.
Events
EventHandler< EventArgs >	Load
	Occurs before the window is displayed for the first time.
EventHandler< FrameEventArgs >	RenderFrame
	Occurs when it is time to render a frame.
EventHandler< EventArgs >	Unload
	Occurs before the window is destroyed.
EventHandler< FrameEventArgs >	UpdateFrame
	Occurs when it is time to update a frame.

Detailed Description

The GameWindow class contains cross-platform methods to create and render on an OpenGL window, handle input and load resources.

GameWindow contains several events you can hook or override to add your custom logic:

OnLoad: Occurs after creating the OpenGL context, but before entering the main loop. Override to load resources.
OnUnload: Occurs after exiting the main loop, but before deleting the OpenGL context. Override to unload resources.
OnResize: Occurs whenever GameWindow is resized. You should update the OpenGL Viewport and Projection Matrix here.
OnUpdateFrame: Occurs at the specified logic update rate. Override to add your game logic.
OnRenderFrame: Occurs at the specified frame render rate. Override to add your rendering code.

Call the Run() method to start the application's main loop. Run(double, double) takes two parameters that specify the logic update rate, and the render update rate.

Definition at line 72 of file GameWindow.cs.

Constructor & Destructor Documentation

OpenTK.GameWindow.GameWindow ( )

Constructs a new GameWindow with sensible default attributes.

Definition at line 100 of file GameWindow.cs.

00101             : this(640, 480, GraphicsMode.Default, "OpenTK Game Window", 0, DisplayDevice.Default) { }

OpenTK.GameWindow.GameWindow	(	int	width,
		int	height
	)