OpenTK.Graphics.IGraphicsContext Interface Reference

Provides methods for creating and interacting with an OpenGL context. More...

Inheritance diagram for OpenTK.Graphics.IGraphicsContext:

Public Member Functions
void	SwapBuffers ()
	Swaps buffers, presenting the rendered scene to the user. More...
void	MakeCurrent (IWindowInfo window)
	Makes the GraphicsContext current in the calling thread. More...
void	Update (IWindowInfo window)
	Updates the graphics context. This must be called when the region the graphics context is drawn to is resized. More...
void	LoadAll ()
	Loads all OpenGL entry points. Requires this instance to be current on the calling thread. More...

Properties
bool	IsCurrent [get]
	Gets a System.Boolean indicating whether this instance is current in the calling thread. More...
bool	IsDisposed [get]
	Gets a System.Boolean indicating whether this instance has been disposed. It is an error to access any instance methods if this property returns true. More...
bool	VSync [get, set]
	Gets or sets a value indicating whether VSync is enabled. When VSync is enabled, SwapBuffers() calls will be synced to the refresh rate of the DisplayDevice that contains improving visual quality and reducing CPU usage. However, systems that cannot maintain the requested rendering rate will suffer from large jumps in performance. This can be counteracted by increasing the SwapInterval value. More...
int	SwapInterval [get, set]
	Gets or sets a positive integer in the range [1, n), indicating the number of DisplayDevice refreshes between consecutive SwapBuffers() calls. The maximum value for n is implementation-dependent. The default value is 1. This value will only affect instances where VSync is enabled. Invalid values will be clamped to the valid range. More...
GraphicsMode	GraphicsMode [get]
	Gets the GraphicsMode of this instance. More...
bool	ErrorChecking [get, set]
	Gets or sets a System.Boolean, indicating whether automatic error checking should be performed. More...

Detailed Description

Provides methods for creating and interacting with an OpenGL context.

Member Function Documentation

void OpenTK.Graphics.IGraphicsContext.LoadAll

(

)

Loads all OpenGL entry points. Requires this instance to be current on the calling thread.

Implemented in OpenTK.Graphics.GraphicsContext.

void OpenTK.Graphics.IGraphicsContext.MakeCurrent

(

IWindowInfo

window

)

Makes the GraphicsContext current in the calling thread.

Parameters

window

An OpenTK.Platform.IWindowInfo structure that points to a valid window.

OpenGL commands in one thread, affect the GraphicsContext which is current in that thread.

It is an error to issue an OpenGL command in a thread without a current GraphicsContext.

Implemented in OpenTK.Graphics.GraphicsContext.

void OpenTK.Graphics.IGraphicsContext.SwapBuffers

(

)

Swaps buffers, presenting the rendered scene to the user.

Implemented in OpenTK.Graphics.GraphicsContext.

void OpenTK.Graphics.IGraphicsContext.Update

(

IWindowInfo

window

)

Updates the graphics context. This must be called when the region the graphics context is drawn to is resized.

Parameters

window

Implemented in OpenTK.Graphics.GraphicsContext.

Property Documentation

bool OpenTK.Graphics.IGraphicsContext.ErrorChecking

getset

Gets or sets a System.Boolean, indicating whether automatic error checking should be performed.

It is an error to enable error checking inside a Begin()-End() region.

This method only affects the debug version of OpenTK.dll.

GraphicsMode OpenTK.Graphics.IGraphicsContext.GraphicsMode

get

Gets the GraphicsMode of this instance.

bool OpenTK.Graphics.IGraphicsContext.IsCurrent

get

Gets a System.Boolean indicating whether this instance is current in the calling thread.

bool OpenTK.Graphics.IGraphicsContext.IsDisposed

get

Gets a System.Boolean indicating whether this instance has been disposed. It is an error to access any instance methods if this property returns true.

int OpenTK.Graphics.IGraphicsContext.SwapInterval

getset

Gets or sets a positive integer in the range [1, n), indicating the number of DisplayDevice refreshes between consecutive SwapBuffers() calls. The maximum value for n is implementation-dependent. The default value is 1. This value will only affect instances where VSync is enabled. Invalid values will be clamped to the valid range.

bool OpenTK.Graphics.IGraphicsContext.VSync

getset

Gets or sets a value indicating whether VSync is enabled. When VSync is enabled, SwapBuffers() calls will be synced to the refresh rate of the DisplayDevice that contains improving visual quality and reducing CPU usage. However, systems that cannot maintain the requested rendering rate will suffer from large jumps in performance. This can be counteracted by increasing the SwapInterval value.