OpenTK.Graphics.GraphicsMode Class Reference

Defines the format for graphics operations. More...

Public Member Functions
	GraphicsMode ()
	Constructs a new GraphicsMode with sensible default parameters.
	GraphicsMode (ColorFormat color)
	Constructs a new GraphicsMode with the specified parameters.
	GraphicsMode (ColorFormat color, int depth)
	Constructs a new GraphicsMode with the specified parameters.
	GraphicsMode (ColorFormat color, int depth, int stencil)
	Constructs a new GraphicsMode with the specified parameters.
	GraphicsMode (ColorFormat color, int depth, int stencil, int samples)
	Constructs a new GraphicsMode with the specified parameters.
	GraphicsMode (ColorFormat color, int depth, int stencil, int samples, ColorFormat accum)
	Constructs a new GraphicsMode with the specified parameters.
	GraphicsMode (ColorFormat color, int depth, int stencil, int samples, ColorFormat accum, int buffers)
	Constructs a new GraphicsMode with the specified parameters.
	GraphicsMode (ColorFormat color, int depth, int stencil, int samples, ColorFormat accum, int buffers, bool stereo)
	Constructs a new GraphicsMode with the specified parameters.
override string	ToString ()
	Returns a System.String describing the current GraphicsFormat.
Properties
IntPtr	Index `[get, set]`
	Gets a nullable System.IntPtr value, indicating the platform-specific index for this GraphicsMode.
ColorFormat	ColorFormat `[get, set]`
	Gets an OpenTK.Graphics.ColorFormat that describes the color format for this GraphicsFormat.
ColorFormat	AccumulatorFormat `[get, set]`
	Gets an OpenTK.Graphics.ColorFormat that describes the accumulator format for this GraphicsFormat.
int	Depth `[get, set]`
	Gets a System.Int32 that contains the bits per pixel for the depth buffer for this GraphicsFormat.
int	Stencil `[get, set]`
	Gets a System.Int32 that contains the bits per pixel for the stencil buffer of this GraphicsFormat.
int	Samples `[get, set]`
	Gets a System.Int32 that contains the number of FSAA samples per pixel for this GraphicsFormat.
bool	Stereo `[get, set]`
	Gets a System.Boolean indicating whether this DisplayMode is stereoscopic.
int	Buffers `[get, set]`
	Gets a System.Int32 containing the number of buffers associated with this DisplayMode.
static GraphicsMode	Default `[get]`
	Returns an OpenTK.GraphicsFormat compatible with the underlying platform.

Detailed Description

Defines the format for graphics operations.

Definition at line 17 of file GraphicsMode.cs.

Constructor & Destructor Documentation

OpenTK.Graphics.GraphicsMode.GraphicsMode ( )

Constructs a new GraphicsMode with sensible default parameters.

Definition at line 74 of file GraphicsMode.cs.

00075             : this(Default)
00076         { }

OpenTK.Graphics.GraphicsMode.GraphicsMode ( ColorFormat color )

Constructs a new GraphicsMode with the specified parameters.

Parameters:

color

The ColorFormat of the color buffer.

Definition at line 84 of file GraphicsMode.cs.

00085             : this(color, Default.Depth, Default.Stencil, Default.Samples, Default.AccumulatorFormat, Default.Buffers, Default.Stereo)
00086         { }

OpenTK.Graphics.GraphicsMode.GraphicsMode	(	ColorFormat	color,
		int	depth
	)

Constructs a new GraphicsMode with the specified parameters.

Parameters:

	color	The ColorFormat of the color buffer.
	depth	The number of bits in the depth buffer.

Definition at line 95 of file GraphicsMode.cs.

00096             : this(color, depth, Default.Stencil, Default.Samples, Default.AccumulatorFormat, Default.Buffers, Default.Stereo)
00097         { }

OpenTK.Graphics.GraphicsMode.GraphicsMode	(	ColorFormat	color,
		int	depth,
		int	stencil
	)

Constructs a new GraphicsMode with the specified parameters.

Parameters:

	color	The ColorFormat of the color buffer.
	depth	The number of bits in the depth buffer.
	stencil	The number of bits in the stencil buffer.

Definition at line 107 of file GraphicsMode.cs.

00108             : this(color, depth, stencil, Default.Samples, Default.AccumulatorFormat, Default.Buffers, Default.Stereo)
00109         { }

OpenTK.Graphics.GraphicsMode.GraphicsMode	(	ColorFormat	color,
		int	depth,
		int	stencil,
		int	samples
	)

Constructs a new GraphicsMode with the specified parameters.

Parameters:

	color	The ColorFormat of the color buffer.
	depth	The number of bits in the depth buffer.
	stencil	The number of bits in the stencil buffer.
	samples	The number of samples for FSAA.

Definition at line 120 of file GraphicsMode.cs.

00121             : this(color, depth, stencil, samples, Default.AccumulatorFormat, Default.Buffers, Default.Stereo)
00122         { }

OpenTK.Graphics.GraphicsMode.GraphicsMode	(	ColorFormat	color,
		int	depth,
		int	stencil,
		int	samples,
		ColorFormat	accum
	)

Constructs a new GraphicsMode with the specified parameters.

Parameters:

	color	The ColorFormat of the color buffer.
	depth	The number of bits in the depth buffer.
	stencil	The number of bits in the stencil buffer.
	samples	The number of samples for FSAA.
	accum	The ColorFormat of the accumilliary buffer.

Definition at line 134 of file GraphicsMode.cs.

00135             : this(color, depth, stencil, samples, accum, Default.Buffers, Default.Stereo)
00136         { }

OpenTK.Graphics.GraphicsMode.GraphicsMode	(	ColorFormat	color,
		int	depth,
		int	stencil,
		int	samples,
		ColorFormat	accum,
		int	buffers
	)

Constructs a new GraphicsMode with the specified parameters.

Parameters:

	color	The ColorFormat of the color buffer.
	depth	The number of bits in the depth buffer.
	stencil	The number of bits in the stencil buffer.
	samples	The number of samples for FSAA.
	accum	The ColorFormat of the accumilliary buffer.
	buffers	The number of render buffers. Typical values include one (single-), two (double-) or three (triple-buffering).

Definition at line 149 of file GraphicsMode.cs.

00150             : this(color, depth, stencil, samples, accum, buffers, Default.Stereo)
00151         { }

OpenTK.Graphics.GraphicsMode.GraphicsMode	(	ColorFormat	color,
		int	depth,
		int	stencil,
		int	samples,
		ColorFormat	accum,
		int	buffers,
		bool	stereo
	)

Constructs a new GraphicsMode with the specified parameters.

Parameters:

	color	The ColorFormat of the color buffer.
	depth	The number of bits in the depth buffer.
	stencil	The number of bits in the stencil buffer.
	samples	The number of samples for FSAA.
	accum	The ColorFormat of the accumilliary buffer.
	stereo	Set to true for a GraphicsMode with stereographic capabilities.
	buffers	The number of render buffers. Typical values include one (single-), two (double-) or three (triple-buffering).

Definition at line 165 of file GraphicsMode.cs.

00166             : this(null, color, depth, stencil, samples, accum, buffers, stereo) { }

Member Function Documentation

override string OpenTK.Graphics.GraphicsMode.ToString ( )

Returns a System.String describing the current GraphicsFormat.

Returns:: ! System.String describing the current GraphicsFormat.

Definition at line 327 of file GraphicsMode.cs.

00328         {
00329             return String.Format("Index: {0}, Color: {1}, Depth: {2}, Stencil: {3}, Samples: {4}, Accum: {5}, Buffers: {6}, Stereo: {7}",
00330                 Index, ColorFormat, Depth, Stencil, Samples, AccumulatorFormat, Buffers, Stereo);
00331         }

Property Documentation

ColorFormat OpenTK.Graphics.GraphicsMode.AccumulatorFormat [get, set]

Gets an OpenTK.Graphics.ColorFormat that describes the accumulator format for this GraphicsFormat.

Definition at line 224 of file GraphicsMode.cs.

int OpenTK.Graphics.GraphicsMode.Buffers [get, set]

Gets a System.Int32 containing the number of buffers associated with this DisplayMode.

Definition at line 292 of file GraphicsMode.cs.

ColorFormat OpenTK.Graphics.GraphicsMode.ColorFormat [get, set]

Gets an OpenTK.Graphics.ColorFormat that describes the color format for this GraphicsFormat.

Definition at line 211 of file GraphicsMode.cs.

GraphicsMode OpenTK.Graphics.GraphicsMode.Default [static, get]

Returns an OpenTK.GraphicsFormat compatible with the underlying platform.

Definition at line 303 of file GraphicsMode.cs.

int OpenTK.Graphics.GraphicsMode.Depth [get, set]

Gets a System.Int32 that contains the bits per pixel for the depth buffer for this GraphicsFormat.

Definition at line 238 of file GraphicsMode.cs.

IntPtr OpenTK.Graphics.GraphicsMode.Index [get, set]

Gets a nullable System.IntPtr value, indicating the platform-specific index for this GraphicsMode.

Definition at line 180 of file GraphicsMode.cs.

int OpenTK.Graphics.GraphicsMode.Samples [get, set]

Gets a System.Int32 that contains the number of FSAA samples per pixel for this GraphicsFormat.

Definition at line 265 of file GraphicsMode.cs.

int OpenTK.Graphics.GraphicsMode.Stencil [get, set]

Gets a System.Int32 that contains the bits per pixel for the stencil buffer of this GraphicsFormat.

Definition at line 252 of file GraphicsMode.cs.

bool OpenTK.Graphics.GraphicsMode.Stereo [get, set]

Gets a System.Boolean indicating whether this DisplayMode is stereoscopic.

Definition at line 278 of file GraphicsMode.cs.

OpenTK.Graphics.GraphicsMode Class Reference

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation