AgateLib.DisplayLib.CreateWindowParams Class Reference

Class which describes how a DisplayWindow should be created. Several static methods exist to allow. More...

List of all members.

Static Public Member Functions
static CreateWindowParams	FromControl (object control)
	Creates a CreateWindowParams object which describes rendering into a WinForms control.
static CreateWindowParams	FullScreen (string title, int width, int height, int bpp)
	Creates a CreateWindowParams object which describes a fullscreen window.
static CreateWindowParams	Windowed (string title, int width, int height, bool allowResize, string iconFile)
	Creates a CreateWindowParams object which describes a typical window for non-fullscreen use.
static CreateWindowParams	NoFrame (string title, int width, int height)
	Creates a CreateWindowParams object which describes a desktop window with no frame or titlebar. This might be used for showing a splashscreen as the application loads.
Properties
string	Title [get, set]
	Title of the window.
bool	IsFullScreen [get, set]
	Whether or not the window should be created as a full screen window. Defaults to false.
Size	Size [get, set]
	Size of the window. Defaults to 1024x768.
int	Width [get, set]
	Width of the window.
int	Height [get, set]
	Height of the window.
WindowPosition	WindowPosition [get, set]
	Sets the initial position of the window.
int	Bpp [get, set]
	Bit depth for the framebuffer for the window. This defaults to 32. This field is (usually) ignored if we are not creating a full-screen window.
bool	IsResizable [get, set]
	Whether or not the user can manually resize the window. Defaults to false. Ignored for full-screen windows.
bool	HasFrame [get, set]
	Whether or not the window is drawn with a frame and titlebar. This property is ignored for fullscreen windows. Defaults to true.
bool	HasMaximize [get, set]
	Whether or not the window has a maximize button. In general, this should be equal to the IsResizable property.
bool	HasMinimize [get, set]
	Whether or not the window has a minimize button. This should generally be true.
string	IconFile [get, set]
	Path to a .ico file to use for the window icon.
bool	RenderToControl [get, set]
	True if we are in fact rendering to a WinForms control, rather than creating a window to be managed by AgateLib.
object	RenderTarget [get, set]
	Control to be rendered to. This is ignored if RenderToControl is false.

---

Detailed Description

Class which describes how a DisplayWindow should be created. Several static methods exist to allow.

---

Member Function Documentation

static CreateWindowParams AgateLib.DisplayLib.CreateWindowParams.FromControl

(

object

control

)

[static]

Creates a CreateWindowParams object which describes rendering into a WinForms control.

Parameters:

control

Returns:

static CreateWindowParams AgateLib.DisplayLib.CreateWindowParams.FullScreen	(	string	title,
		int	width,
		int	height,
		int	bpp
	)			[static]

Creates a CreateWindowParams object which describes a fullscreen window.

Parameters:

	title
	width
	height
	bpp

Returns:

static CreateWindowParams AgateLib.DisplayLib.CreateWindowParams.NoFrame	(	string	title,
		int	width,
		int	height
	)			[static]

Creates a CreateWindowParams object which describes a desktop window with no frame or titlebar. This might be used for showing a splashscreen as the application loads.

Parameters:

	title
	width
	height

Returns:

static CreateWindowParams AgateLib.DisplayLib.CreateWindowParams.Windowed	(	string	title,
		int	width,
		int	height,
		bool	allowResize,
		string	iconFile
	)			[static]

Creates a CreateWindowParams object which describes a typical window for non-fullscreen use.

Parameters:

	title
	width
	height
	iconFile
	allowResize

Returns:

---

Property Documentation

int AgateLib.DisplayLib.CreateWindowParams.Bpp [get, set]

Bit depth for the framebuffer for the window. This defaults to 32. This field is (usually) ignored if we are not creating a full-screen window.

bool AgateLib.DisplayLib.CreateWindowParams.HasFrame [get, set]

Whether or not the window is drawn with a frame and titlebar. This property is ignored for fullscreen windows. Defaults to true.

bool AgateLib.DisplayLib.CreateWindowParams.HasMaximize [get, set]

Whether or not the window has a maximize button. In general, this should be equal to the IsResizable property.

bool AgateLib.DisplayLib.CreateWindowParams.HasMinimize [get, set]

Whether or not the window has a minimize button. This should generally be true.

int AgateLib.DisplayLib.CreateWindowParams.Height [get, set]

Height of the window.

string AgateLib.DisplayLib.CreateWindowParams.IconFile [get, set]

Path to a .ico file to use for the window icon.

bool AgateLib.DisplayLib.CreateWindowParams.IsFullScreen [get, set]

Whether or not the window should be created as a full screen window. Defaults to false.

bool AgateLib.DisplayLib.CreateWindowParams.IsResizable [get, set]

Whether or not the user can manually resize the window. Defaults to false. Ignored for full-screen windows.

object AgateLib.DisplayLib.CreateWindowParams.RenderTarget [get, set]

Control to be rendered to. This is ignored if RenderToControl is false.

bool AgateLib.DisplayLib.CreateWindowParams.RenderToControl [get, set]

True if we are in fact rendering to a WinForms control, rather than creating a window to be managed by AgateLib.

Size AgateLib.DisplayLib.CreateWindowParams.Size [get, set]

Size of the window. Defaults to 1024x768.

string AgateLib.DisplayLib.CreateWindowParams.Title [get, set]

Title of the window.

int AgateLib.DisplayLib.CreateWindowParams.Width [get, set]

Width of the window.

WindowPosition AgateLib.DisplayLib.CreateWindowParams.WindowPosition [get, set]

Sets the initial position of the window.

---

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

• DisplayLib/CreateWindowParams.cs