Derm.Render.RenderWindow Class Reference

Rendering window. More...

Inheritance diagram for Derm.Render.RenderWindow:

List of all members.

Public Member Functions
	RenderWindow (int w, int h)
	Constructor.
void	Dispose ()
	Release RenderWindow resources.
override IntPtr	GetDeviceContext ()
	Get the device context associated to this RenderWindow.
void	GetExtents (out int w, out int h)
	Get this RenderWindow extents.
void	GetPosition (out int x, out int y)
	Get this RenderWindow position.
void	HideWindow ()
	Make this RenderWindow invisible.
void	RegisterInput (IKeyboardInput input)
	Register keyboard input handler.
void	RegisterInput (MouseInput input)
	Register mouse input handler.
void	SetExtents (int w, int h)
	Set this RenderWindow extents.
void	SetPosition (int x, int y)
	Set this RenderWindow position.
void	ShowWindow ()
	Make this RenderWindow visible.
override void	SwapSurface ()
	Swap render surface.
Protected Member Functions
override bool	ValidPixelFormat (RenderContext.PixelFormat pFormat)
	Derived implementation status for passing surface pixel format.
Properties
bool	MainWindow [get, set]
	Main window property.
Form	NestedForm [get]
	Get the Form handle used for rendering.
override bool	Swappable [get]
	Determine whether this surface has to be swapped.
bool	Visible [get]
	Check whether this RenderWindow is visible.

---

Detailed Description

Rendering window.

A RenderWindow shall be considered an object able to output the graphical result of some rendering operation. A RenderWindow instance must have associated a RenderContext instance.

---

Constructor & Destructor Documentation

Derm.Render.RenderWindow.RenderWindow	(	int	w,
		int	h
	)

Constructor.

Parameters:

	w	A System.Int32 specifing window width (in pixels).
	h	A System.Int32 specifing window height (in pixels).

---

Member Function Documentation

void Derm.Render.RenderWindow.Dispose

(

)

Release RenderWindow resources.

override IntPtr Derm.Render.RenderWindow.GetDeviceContext

(

)

[virtual]

Get the device context associated to this RenderWindow.

Returns:

A IntPtr representing the device context related to this RenderWindow.

Implements Derm.Render.RenderSurface.

void Derm.Render.RenderWindow.GetExtents	(	out int	w,
		out int	h
	)

Get this RenderWindow extents.

Parameters:

	w	A System.Int32 returning the RenderWindow width.
	h	A System.Int32 returning the RenderWindow height.

void Derm.Render.RenderWindow.GetPosition	(	out int	x,
		out int	y
	)

Get this RenderWindow position.

Parameters:

	x	A System.Int32 returning the X coordinate.
	y	A System.Int32 returning the Y coordinate.

void Derm.Render.RenderWindow.HideWindow

(

)

Make this RenderWindow invisible.

void Derm.Render.RenderWindow.RegisterInput

(

IKeyboardInput

input

)

Register keyboard input handler.

Parameters:

input

void Derm.Render.RenderWindow.RegisterInput

(

MouseInput

input

)

Register mouse input handler.

Parameters:

input

void Derm.Render.RenderWindow.SetExtents	(	int	w,
		int	h
	)

Set this RenderWindow extents.

Parameters:

	w	A System.Int32 specifying the RenderWindow width.
	h	A System.Int32 specifying the RenderWindow height.

void Derm.Render.RenderWindow.SetPosition	(	int	x,
		int	y
	)

Set this RenderWindow position.

Parameters:

	x	A System.Int32 specifying the X coordinate.
	y	A System.Int32 specifying the Y coordinate.

void Derm.Render.RenderWindow.ShowWindow

(

)

Make this RenderWindow visible.

override void Derm.Render.RenderWindow.SwapSurface

(

)

[virtual]

Swap render surface.

Implements Derm.Render.RenderSurface.

override bool Derm.Render.RenderWindow.ValidPixelFormat

(

RenderContext.PixelFormat

pFormat

)

[protected, virtual]

Derived implementation status for passing surface pixel format.

Parameters:

pFormat

A RenderContext.PixelFormat to be validated by derived implementation.

Returns:

It returns true in the case the pixel format is valid for usage in the derived implementation, otherwise it returns false.

Implements Derm.Render.RenderSurface.

---

Property Documentation

bool Derm.Render.RenderWindow.MainWindow [get, set]

Main window property.

Form Derm.Render.RenderWindow.NestedForm [get]

Get the Form handle used for rendering.

override bool Derm.Render.RenderWindow.Swappable [get]

Determine whether this surface has to be swapped.

Reimplemented from Derm.Render.RenderSurface.

bool Derm.Render.RenderWindow.Visible [get]

Check whether this RenderWindow is visible.