AgateLib: ERY.AgateLib.DisplayWindow Class Reference

List of all members.


Public Member Functions
	DisplayWindow (System.Windows.Forms.Control renderTarget)
	Creates a DisplayWindow object using the specified System.Windows.Forms.Control object as a render context. A DisplayWindow made in this manner cannot be made into a full-screen DisplayWindow.
	DisplayWindow (string title, int clientWidth, int clientHeight)
	Creates a DisplayWindow object by creating a windowed Form. By default, this window does not allow the user to resize it.
	DisplayWindow (string title, int clientWidth, int clientHeight, string iconFile)
	Creates a DisplayWindow object by creating a windowed Form. By default, this window does not allow the user to resize it.
	DisplayWindow (string title, int clientWidth, int clientHeight, string iconFile, bool startFullscreen)
	Creates a DisplayWindow object by creating a windowed or fullscreen Form. By default, this window does not allow the user to resize it.
	DisplayWindow (string title, int clientWidth, int clientHeight, string iconFile, bool startFullscreen, bool allowResize)
	Creates a DisplayWindow object by creating a windowed or fullscreen Form.
void	Dispose ()
	Disposes of unmanaged resources.
void	ToggleFullScreen ()
	Toggles windowed and full screen. Not guaranteed to work; some drivers (eg. GDI) don't support fullscreen displays. If this fails it returns without any error thrown. Check to see if it worked by examining IsFullScreen property.
void	SetWindowed ()
	Sets the display to windowed. Does nothing if the display is already windowed. The DisplayWindow retains the same height and width as the previous full screen resolution.
void	SetFullScreen ()
	Sets the display to a full screen display. This overload uses the desktop resolution for the full-screen display.
void	SetFullScreen (int width, int height, int bpp)
	Sets the display to a full screen display. The resolution chosen is driver/video card/monitor dependent, but it should be fairly close to values specified.
Public Attributes
event EventHandler	Resize
	Event raised when the window is resized by the user.
Properties
bool	IsClosed `[get]`
	Returns true if this DisplayWindow has been closed, either by a call to Dispose(), or perhaps the user clicked the close box in a form.
[Obsolete("Use IsClosed property instead.")] bool	Closed `[get]`
	OBSOLETE: Use IsClosed property instead. Returns true if this DisplayWindow has been closed, either by a call to Dispose(), or perhaps the user clicked the close box in a form. .
Size	Size `[get, set]`
	Gets or sets the size of the client area in pixels.
int	Width `[get, set]`
	Gets or sets the width of the client area in pixels.
int	Height `[get, set]`
	Gets or sets the height of the client area in pixels.
Point	MousePosition `[get, set]`
	Gets or sets the position of the cursor, in the client coordinates of the window.
DisplayWindowImpl	Impl `[get]`
	Returns the DisplayWindowImpl object.
string	Title `[get, set]`
	Gets or sets the title of the window.
bool	IsFullScreen `[get]`
	Returns true if this window is displayed fullscreen.

Detailed Description

Creating a DisplayWindow can be done in two ways. By specifying a title and width and height, the DisplayWindow will create and manage a window.

Constructor & Destructor Documentation

ERY.AgateLib.DisplayWindow.DisplayWindow ( System.Windows.Forms.Control renderTarget )

Creates a DisplayWindow object using the specified System.Windows.Forms.Control object as a render context. A DisplayWindow made in this manner cannot be made into a full-screen DisplayWindow.

[Experimental - The API may be changed in the future.]

Parameters:

renderTarget

Windows.Forms control which should be used as the render target.

ERY.AgateLib.DisplayWindow.DisplayWindow	(	string	title,
		int	clientWidth,
		int	clientHeight
	)

Creates a DisplayWindow object by creating a windowed Form. By default, this window does not allow the user to resize it.

Parameters:

	title
	clientWidth
	clientHeight

ERY.AgateLib.DisplayWindow.DisplayWindow	(	string	title,
		int	clientWidth,
		int	clientHeight,
		string	iconFile
	)

Creates a DisplayWindow object by creating a windowed Form. By default, this window does not allow the user to resize it.

Parameters:

	title	Title of the window.
	clientWidth	Width of the drawing area in pixels.
	clientHeight	Height of the drawing area in pixels.
	iconFile	File name of a Win32 .ico file to use for the window icon. Pass null or "" to not use an icon.

ERY.AgateLib.DisplayWindow.DisplayWindow	(	string	title,
		int	clientWidth,
		int	clientHeight,
		string	iconFile,
		bool	startFullscreen
	)

Creates a DisplayWindow object by creating a windowed or fullscreen Form. By default, this window does not allow the user to resize it.

Parameters:

	title	Title of the window.
	clientWidth	Width of the drawing area in pixels.
	clientHeight	Height of the drawing area in pixels.
	iconFile	File name of a Win32 .ico file to use for the window icon.
	startFullscreen	True to start as a full screen window.

ERY.AgateLib.DisplayWindow.DisplayWindow	(	string	title,
		int	clientWidth,
		int	clientHeight,
		string	iconFile,
		bool	startFullscreen,
		bool	allowResize
	)

Creates a DisplayWindow object by creating a windowed or fullscreen Form.

Parameters:

	title	Title of the window.
	clientWidth	Width of the drawing area in pixels.
	clientHeight	Height of the drawing area in pixels.
	iconFile	File name of a Win32 .ico file to use for the window icon.
	startFullscreen	True to start as a full screen window.
	allowResize	True to allow the user to manually resize the window by dragging the border.

Member Function Documentation

void ERY.AgateLib.DisplayWindow.Dispose ( )

Disposes of unmanaged resources.

void ERY.AgateLib.DisplayWindow.ToggleFullScreen ( )

Toggles windowed and full screen. Not guaranteed to work; some drivers (eg. GDI) don't support fullscreen displays. If this fails it returns without any error thrown. Check to see if it worked by examining IsFullScreen property.

void ERY.AgateLib.DisplayWindow.SetWindowed ( )

Sets the display to windowed. Does nothing if the display is already windowed. The DisplayWindow retains the same height and width as the previous full screen resolution.

void ERY.AgateLib.DisplayWindow.SetFullScreen ( )

Sets the display to a full screen display. This overload uses the desktop resolution for the full-screen display.

This call is not guaranteed to work; some drivers (eg. GDI) don't support fullscreen displays. If this fails it returns without any error thrown. Check to see if it worked by examining IsFullScreen property.

void ERY.AgateLib.DisplayWindow.SetFullScreen	(	int	width,
		int	height,
		int	bpp
	)

Sets the display to a full screen display. The resolution chosen is driver/video card/monitor dependent, but it should be fairly close to values specified.

Parameters: