AgateLib: ERY.AgateLib.ImplBase.DisplayWindowImpl Class Reference

List of all members.


Public Member Functions
abstract void	Dispose ()
	Disposes of unmanaged resources.
void	ToggleFullScreen ()
	Toggles windowed/fullscreen. If this is unsupported, this method should silently return (do not throw an error).
void	ToggleFullScreen (int width, int height, int bpp)
	Toggles windowed/fullscreen. If this is unsupported, this method should silently return (do not throw an error).
abstract 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.
abstract void	SetFullScreen ()
	Sets the display to a full screen display. This overload should use the same resolution as the desktop environment.
abstract 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.
abstract void	BeginRender ()
	Utility function which may be called by the DisplayImpl when rendering begins.
abstract void	EndRender ()
	Utility function which may be called by the DisplayImpl when rendering is done.
Static Protected Member Functions
static void	InitializeWindowsForm (out Form frm, out Control renderTarget, string title, int clientWidth, int clientHeight, bool startFullscreen, bool allowResize)
	Creates a System.Windows.Forms.Form object for rendering to.
Properties
abstract bool	IsClosed `[get]`
	Returns true if the DisplayWindowImpl has been closed. This happens if the user clicks the close box, or Dispose is called.
abstract bool	IsFullScreen `[get]`
	Returns true if this DisplayWindowImpl is being used as a full-screen device.
abstract Size	Size `[get, set]`
	Gets or sets the size of the render area.
int	Width `[get, set]`
	Gets or sets the width of the render area.
int	Height `[get, set]`
	Gets or sets the height of the render area.
abstract string	Title `[get, set]`
	Gets or sets the window title.
abstract Point	MousePosition `[get, set]`
	Gets or sets the mouse position within the render area.

Detailed Description

Member Function Documentation

abstract void ERY.AgateLib.ImplBase.DisplayWindowImpl.Dispose ( ) [pure virtual]

Disposes of unmanaged resources.

void ERY.AgateLib.ImplBase.DisplayWindowImpl.ToggleFullScreen ( )

Toggles windowed/fullscreen. If this is unsupported, this method should silently return (do not throw an error).

void ERY.AgateLib.ImplBase.DisplayWindowImpl.ToggleFullScreen	(	int	width,
		int	height,
		int	bpp
	)

Toggles windowed/fullscreen. If this is unsupported, this method should silently return (do not throw an error).

Attempts to match width, height and bpp as best as possible.

Parameters:

	width
	height
	bpp

abstract void ERY.AgateLib.ImplBase.DisplayWindowImpl.SetWindowed ( ) [pure virtual]

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.

abstract void ERY.AgateLib.ImplBase.DisplayWindowImpl.SetFullScreen ( ) [pure virtual]

Sets the display to a full screen display. This overload should use the same resolution as the desktop environment.

abstract void ERY.AgateLib.ImplBase.DisplayWindowImpl.SetFullScreen	(	int	width,
		int	height,
		int	bpp
	)			`[pure virtual]`

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:

	width
	height
	bpp

static void ERY.AgateLib.ImplBase.DisplayWindowImpl.InitializeWindowsForm	(	out Form	frm,
		out Control	renderTarget,
		string	title,
		int	clientWidth,
		int	clientHeight,
		bool	startFullscreen,
		bool	allowResize
	)			`[static, protected]`

Creates a System.Windows.Forms.Form object for rendering to.

Parameters:

	frm	Returns the created form.
	renderTarget	Returns the control which is rendered into.
	title	Title of the window.
	clientWidth	Width of client area, in pixels.
	clientHeight	Height of client area, in pixels.
	startFullscreen	True if we should start with a full-screen window.
	allowResize	True if we should allow the user to resize the window.