AgateLib.DisplayLib.ScreenMode Class Reference

Class which contains information about an available screen mode. More...

List of all members.

Public Member Functions
	ScreenMode (int width, int height, int bpp)
	Constructs a ScreenMode object.
Static Public Member Functions
static ScreenMode	SelectBestMode (int width, int height, int bpp)
	Searches through the available screen resolutions and selects the one which is the closest match for the parameters passed in.
Properties
int	Width [get]
	Width of the screen mode in pixels.
int	Height [get]
	Height of the screen mode in pixels.
int	Bpp [get]
	Bits per pixel of the screen mode.

---

Detailed Description

Class which contains information about an available screen mode.

---

Constructor & Destructor Documentation

AgateLib.DisplayLib.ScreenMode.ScreenMode	(	int	width,
		int	height,
		int	bpp
	)

Constructs a ScreenMode object.

Parameters:

	width
	height
	bpp

---

Member Function Documentation

static ScreenMode AgateLib.DisplayLib.ScreenMode.SelectBestMode	(	int	width,
		int	height,
		int	bpp
	)			[static]

Searches through the available screen resolutions and selects the one which is the closest match for the parameters passed in.

Parameters:

	width
	height
	bpp

Returns:

null if no screen mode could be found, otherwise the appropriate ScreenMode structure.

---

Property Documentation

int AgateLib.DisplayLib.ScreenMode.Bpp [get]

Bits per pixel of the screen mode.

int AgateLib.DisplayLib.ScreenMode.Height [get]

Height of the screen mode in pixels.

int AgateLib.DisplayLib.ScreenMode.Width [get]

Width of the screen mode in pixels.

---

The documentation for this class was generated from the following file:

• DisplayLib/ScreenMode.cs