AgateLib.ImplementationBase.DisplayWindowImpl Class Reference

Implementation of DisplayWindow class. More...

Inheritance diagram for AgateLib.ImplementationBase.DisplayWindowImpl:

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

Implementation of DisplayWindow class.

---

Member Function Documentation

abstract void AgateLib.ImplementationBase.DisplayWindowImpl.BeginRender

(

)

[pure virtual]

Utility function which may be called by the DisplayImpl when rendering begins.

Implements AgateLib.ImplementationBase.IRenderTargetImpl.

abstract void AgateLib.ImplementationBase.DisplayWindowImpl.Dispose

(

)

[pure virtual]

Disposes of unmanaged resources.

abstract void AgateLib.ImplementationBase.DisplayWindowImpl.EndRender

(

)

[pure virtual]

Utility function which may be called by the DisplayImpl when rendering is done.

Implements AgateLib.ImplementationBase.IRenderTargetImpl.

abstract void AgateLib.ImplementationBase.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

abstract void AgateLib.ImplementationBase.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 AgateLib.ImplementationBase.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.

void AgateLib.ImplementationBase.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

void AgateLib.ImplementationBase.DisplayWindowImpl.ToggleFullScreen

(

)

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

---

Property Documentation

int AgateLib.ImplementationBase.DisplayWindowImpl.Height [get, set]

Gets or sets the height of the render area.

Implements AgateLib.ImplementationBase.IRenderTargetImpl.

abstract bool AgateLib.ImplementationBase.DisplayWindowImpl.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 AgateLib.ImplementationBase.DisplayWindowImpl.IsFullScreen [get]

Returns true if this DisplayWindowImpl is being used as a full-screen device.

abstract Point AgateLib.ImplementationBase.DisplayWindowImpl.MousePosition [get, set]

Gets or sets the mouse position within the render area.

abstract Size AgateLib.ImplementationBase.DisplayWindowImpl.Size [get, set]

Gets or sets the size of the render area.

Implements AgateLib.ImplementationBase.IRenderTargetImpl.

abstract string AgateLib.ImplementationBase.DisplayWindowImpl.Title [get, set]

Gets or sets the window title.

int AgateLib.ImplementationBase.DisplayWindowImpl.Width [get, set]

Gets or sets the width of the render area.

Implements AgateLib.ImplementationBase.IRenderTargetImpl.

---

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

• ImplementationBase/DisplayWindowImpl.cs