The Open Toolkit library  1.1
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Events | List of all members
OpenTK.Platform.IGameWindow Interface Reference

Defines the interface for a GameWindow. More...

Inheritance diagram for OpenTK.Platform.IGameWindow:
OpenTK.INativeWindow OpenTK.GameWindow

Public Member Functions

void Run ()
 Enters the game loop of the GameWindow using the maximum update rate. More...
 
void Run (double updateRate)
 Enters the game loop of the GameWindow using the specified update rate. More...
 
void MakeCurrent ()
 Makes the GraphicsContext current on the calling thread. More...
 
void SwapBuffers ()
 Swaps the front and back buffers of the current GraphicsContext, presenting the rendered scene to the user. More...
 
- Public Member Functions inherited from OpenTK.INativeWindow
void Close ()
 Closes this window. More...
 
void ProcessEvents ()
 Processes pending window events. More...
 
Point PointToClient (Point point)
 Transforms the specified point from screen to client coordinates. More...
 
Point PointToScreen (Point point)
 Transforms the specified point from client to screen coordinates. More...
 

Events

EventHandler< EventArgs > Load
 Occurs before the window is displayed for the first time. More...
 
EventHandler< EventArgs > Unload
 Occurs before the window is destroyed. More...
 
EventHandler< FrameEventArgsUpdateFrame
 Occurs when it is time to update a frame. More...
 
EventHandler< FrameEventArgsRenderFrame
 Occurs when it is time to render a frame. More...
 
- Events inherited from OpenTK.INativeWindow
EventHandler< EventArgs > Move
 Occurs whenever the window is moved. More...
 
EventHandler< EventArgs > Resize
 Occurs whenever the window is resized. More...
 
EventHandler< CancelEventArgs > Closing
 Occurs when the window is about to close. More...
 
EventHandler< EventArgs > Closed
 Occurs after the window has closed. More...
 
EventHandler< EventArgs > Disposed
 Occurs when the window is disposed. More...
 
EventHandler< EventArgs > IconChanged
 Occurs when the Icon property of the window changes. More...
 
EventHandler< EventArgs > TitleChanged
 Occurs when the Title property of the window changes. More...
 
EventHandler< EventArgs > VisibleChanged
 Occurs when the Visible property of the window changes. More...
 
EventHandler< EventArgs > FocusedChanged
 Occurs when the Focused property of the window changes. More...
 
EventHandler< EventArgs > WindowBorderChanged
 Occurs when the WindowBorder property of the window changes. More...
 
EventHandler< EventArgs > WindowStateChanged
 Occurs when the WindowState property of the window changes. More...
 
EventHandler
< OpenTK.Input.KeyboardKeyEventArgs
KeyDown
 Occurs whenever a keybord key is pressed. More...
 
EventHandler< KeyPressEventArgsKeyPress
 Occurs whenever a character is typed. More...
 
EventHandler
< OpenTK.Input.KeyboardKeyEventArgs
KeyUp
 Occurs whenever a keyboard key is released. More...
 
EventHandler< EventArgs > MouseLeave
 Occurs whenever the mouse cursor leaves the window Bounds. More...
 
EventHandler< EventArgs > MouseEnter
 Occurs whenever the mouse cursor enters the window Bounds. More...
 

Additional Inherited Members

- Properties inherited from OpenTK.INativeWindow
Icon Icon [get, set]
 Gets or sets the System.Drawing.Icon of the window. More...
 
string Title [get, set]
 Gets or sets the title of the window. More...
 
bool Focused [get]
 Gets a System.Boolean that indicates whether this window has input focus. More...
 
bool Visible [get, set]
 Gets or sets a System.Boolean that indicates whether the window is visible. More...
 
bool Exists [get]
 Gets a System.Boolean that indicates whether the window has been created and has not been destroyed. More...
 
IWindowInfo WindowInfo [get]
 Gets the OpenTK.Platform.IWindowInfo for this window. More...
 
WindowState WindowState [get, set]
 Gets or sets the OpenTK.WindowState for this window. More...
 
WindowBorder WindowBorder [get, set]
 Gets or sets the OpenTK.WindowBorder for this window. More...
 
Rectangle Bounds [get, set]
 Gets or sets a System.Drawing.Rectangle structure the contains the external bounds of this window, in screen coordinates. External bounds include the title bar, borders and drawing area of the window. More...
 
Point Location [get, set]
 Gets or sets a System.Drawing.Point structure that contains the location of this window on the desktop. More...
 
Size Size [get, set]
 Gets or sets a System.Drawing.Size structure that contains the external size of this window. More...
 
int X [get, set]
 Gets or sets the horizontal location of this window on the desktop. More...
 
int Y [get, set]
 Gets or sets the vertical location of this window on the desktop. More...
 
int Width [get, set]
 Gets or sets the external width of this window. More...
 
int Height [get, set]
 Gets or sets the external height of this window. More...
 
Rectangle ClientRectangle [get, set]
 Gets or sets a System.Drawing.Rectangle structure that contains the internal bounds of this window, in client coordinates. The internal bounds include the drawing area of the window, but exclude the titlebar and window borders. More...
 
Size ClientSize [get, set]
 Gets or sets a System.Drawing.Size structure that contains the internal size this window. More...
 
OpenTK.Input.IInputDriver InputDriver [get]
 This property is deprecated and should not be used. More...
 
bool CursorVisible [get, set]
 Gets or sets a value, indicating whether the mouse cursor is visible. More...
 

Detailed Description

Defines the interface for a GameWindow.

Member Function Documentation

void OpenTK.Platform.IGameWindow.MakeCurrent ( )

Makes the GraphicsContext current on the calling thread.

Implemented in OpenTK.GameWindow.

void OpenTK.Platform.IGameWindow.Run ( )

Enters the game loop of the GameWindow using the maximum update rate.

See Also
Run(double)

Implemented in OpenTK.GameWindow.

void OpenTK.Platform.IGameWindow.Run ( double  updateRate)

Enters the game loop of the GameWindow using the specified update rate.

Implemented in OpenTK.GameWindow.

void OpenTK.Platform.IGameWindow.SwapBuffers ( )

Swaps the front and back buffers of the current GraphicsContext, presenting the rendered scene to the user.

Implemented in OpenTK.GameWindow.

Event Documentation

EventHandler<EventArgs> OpenTK.Platform.IGameWindow.Load

Occurs before the window is displayed for the first time.

EventHandler<FrameEventArgs> OpenTK.Platform.IGameWindow.RenderFrame

Occurs when it is time to render a frame.

EventHandler<EventArgs> OpenTK.Platform.IGameWindow.Unload

Occurs before the window is destroyed.

EventHandler<FrameEventArgs> OpenTK.Platform.IGameWindow.UpdateFrame

Occurs when it is time to update a frame.