OpenTK.Graphics.GraphicsMode Class Reference

Defines the format for graphics operations. More...

Inherits IEquatable< GraphicsMode >.

Public Member Functions
	GraphicsMode ()
	Constructs a new GraphicsMode with sensible default parameters. More...
	GraphicsMode (ColorFormat color)
	Constructs a new GraphicsMode with the specified parameters. More...
	GraphicsMode (ColorFormat color, int depth)
	Constructs a new GraphicsMode with the specified parameters. More...
	GraphicsMode (ColorFormat color, int depth, int stencil)
	Constructs a new GraphicsMode with the specified parameters. More...
	GraphicsMode (ColorFormat color, int depth, int stencil, int samples)
	Constructs a new GraphicsMode with the specified parameters. More...
	GraphicsMode (ColorFormat color, int depth, int stencil, int samples, ColorFormat accum)
	Constructs a new GraphicsMode with the specified parameters. More...
	GraphicsMode (ColorFormat color, int depth, int stencil, int samples, ColorFormat accum, int buffers)
	Constructs a new GraphicsMode with the specified parameters. More...
	GraphicsMode (ColorFormat color, int depth, int stencil, int samples, ColorFormat accum, int buffers, bool stereo)
	Constructs a new GraphicsMode with the specified parameters. More...
override string	ToString ()
	Returns a System.String describing the current GraphicsFormat. More...
override int	GetHashCode ()
	Returns the hashcode for this instance. More...
override bool	Equals (object obj)
	Indicates whether obj is equal to this instance. More...
bool	Equals (GraphicsMode other)
	Indicates whether other represents the same mode as this instance. More...

Properties
IntPtr	Index [get, set]
	Gets a nullable System.IntPtr value, indicating the platform-specific index for this GraphicsMode. More...
ColorFormat	ColorFormat [get, set]
	Gets an OpenTK.Graphics.ColorFormat that describes the color format for this GraphicsFormat. More...
ColorFormat	AccumulatorFormat [get, set]
	Gets an OpenTK.Graphics.ColorFormat that describes the accumulator format for this GraphicsFormat. More...
int	Depth [get, set]
	Gets a System.Int32 that contains the bits per pixel for the depth buffer for this GraphicsFormat. More...
int	Stencil [get, set]
	Gets a System.Int32 that contains the bits per pixel for the stencil buffer of this GraphicsFormat. More...
int	Samples [get, set]
	Gets a System.Int32 that contains the number of FSAA samples per pixel for this GraphicsFormat. More...
bool	Stereo [get, set]
	Gets a System.Boolean indicating whether this DisplayMode is stereoscopic. More...
int	Buffers [get, set]
	Gets a System.Int32 containing the number of buffers associated with this DisplayMode. More...
static GraphicsMode	Default [get]
	Returns an OpenTK.GraphicsFormat compatible with the underlying platform. More...

Detailed Description

Defines the format for graphics operations.

Constructor & Destructor Documentation

OpenTK.Graphics.GraphicsMode.GraphicsMode

(

)

Constructs a new GraphicsMode with sensible default parameters.

OpenTK.Graphics.GraphicsMode.GraphicsMode

(

ColorFormat

color

)

Constructs a new GraphicsMode with the specified parameters.

Parameters

color

The ColorFormat of the color buffer.

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.

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.

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.

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.

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).

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).

Member Function Documentation

override bool OpenTK.Graphics.GraphicsMode.Equals

(

object

obj

)

Indicates whether obj is equal to this instance.

Parameters

obj	An object instance to compare for equality.

Returns

True, if obj equals this instance; false otherwise.

bool OpenTK.Graphics.GraphicsMode.Equals

(

GraphicsMode

other

)

Indicates whether other represents the same mode as this instance.

Parameters

other

The GraphicsMode to compare to.

Returns

True, if other is equal to this instance; false otherwise.

override int OpenTK.Graphics.GraphicsMode.GetHashCode

(

)

Returns the hashcode for this instance.

Returns

A System.Int32 hashcode for this instance.

override string OpenTK.Graphics.GraphicsMode.ToString

(

)

Returns a System.String describing the current GraphicsFormat.

Returns

! System.String describing the current GraphicsFormat.

Property Documentation

ColorFormat OpenTK.Graphics.GraphicsMode.AccumulatorFormat

getset

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

int OpenTK.Graphics.GraphicsMode.Buffers

getset

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

ColorFormat OpenTK.Graphics.GraphicsMode.ColorFormat

getset

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

GraphicsMode OpenTK.Graphics.GraphicsMode.Default

staticget

Returns an OpenTK.GraphicsFormat compatible with the underlying platform.

int OpenTK.Graphics.GraphicsMode.Depth

getset

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

IntPtr OpenTK.Graphics.GraphicsMode.Index

getset

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

int OpenTK.Graphics.GraphicsMode.Samples

getset

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

int OpenTK.Graphics.GraphicsMode.Stencil

getset

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

bool OpenTK.Graphics.GraphicsMode.Stereo

getset

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