MuGameFramework  1.0
MuGameFramework is a 2D game framework built upon C# and SFML
 All Classes Namespaces Files Functions Variables Enumerations Properties
MuGameFramework.Window Class Reference

Container class allowing creation and access of the Window More...

Inheritance diagram for MuGameFramework.Window:
MuGameFramework.IRenderTarget

Public Member Functions

 Window (string windowName, Rectangle sizeloc)
 Generate a new window for the game to run in windowed mode
 Window (string windowName)
 Generate a new window for the game to run in fullscreen mode
void DispatchEvents ()
 Call the DispatchEvents method to update all the events for this window
void Display ()
 Call the Display function to update what is drawn on screen
void CloseWindow ()
 Close the window and notify the engine
void ChangeCameraView (CameraView view)
 Change the current CameraView of this window
void Dispose ()
 Used to explicitly free all resources currently in use by this object before destruction
- Public Member Functions inherited from MuGameFramework.IRenderTarget
SFMLRenderTarget GetRenderTarget ()
 Get the RenderTarget for the SpriteBatch to use

Protected Member Functions

virtual void Dispose (bool disposing)
 Dispose any and all objects, either managed or unmanaged at the end of this objects lifespan

Properties

CameraView DefaultView [get]
 Get the default view of this window
Size WindowDimensions [get, set]
 Get the dimensions of the Window
Point WindowPosition [get, set]
 Get the position of the window
bool IsOpen [get, set]
 Defines if the window is currently open or not
bool HasFocus [get, set]
 Defines if the window has focus or not

Detailed Description

Container class allowing creation and access of the Window

Constructor & Destructor Documentation

MuGameFramework.Window.Window ( string  windowName,
Rectangle  sizeloc 
)

Generate a new window for the game to run in windowed mode

Parameters
windowNameTitle for the window
sizelocSize of the window
MuGameFramework.Window.Window ( string  windowName)

Generate a new window for the game to run in fullscreen mode

Parameters
windowNameTitle for the window

Member Function Documentation

void MuGameFramework.Window.ChangeCameraView ( CameraView  view)

Change the current CameraView of this window

Parameters
viewNew CameraView to set
void MuGameFramework.Window.CloseWindow ( )

Close the window and notify the engine

void MuGameFramework.Window.DispatchEvents ( )

Call the DispatchEvents method to update all the events for this window

void MuGameFramework.Window.Display ( )

Call the Display function to update what is drawn on screen

virtual void MuGameFramework.Window.Dispose ( bool  disposing)
protectedvirtual

Dispose any and all objects, either managed or unmanaged at the end of this objects lifespan

Parameters
disposingDispose of Managed objects?
void MuGameFramework.Window.Dispose ( )

Used to explicitly free all resources currently in use by this object before destruction

Property Documentation

CameraView MuGameFramework.Window.DefaultView
get

Get the default view of this window

bool MuGameFramework.Window.HasFocus
getset

Defines if the window has focus or not

bool MuGameFramework.Window.IsOpen
getset

Defines if the window is currently open or not

Size MuGameFramework.Window.WindowDimensions
getset

Get the dimensions of the Window

Point MuGameFramework.Window.WindowPosition
getset

Get the position of the window


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