Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
SiliconStudio.Paradox.Games.GameWindow Class Referenceabstract

An abstract window. More...

Inheritance diagram for SiliconStudio.Paradox.Games.GameWindow:
SiliconStudio.Core.ComponentBase SiliconStudio.Core.IComponent SiliconStudio.Core.ICollectorHolder SiliconStudio.Core.IReferencable SiliconStudio.Core.IReferencable

Public Member Functions

abstract void BeginScreenDeviceChange (bool willBeFullScreen)
 
void EndScreenDeviceChange ()
 
abstract void EndScreenDeviceChange (int clientWidth, int clientHeight)
 
- Public Member Functions inherited from SiliconStudio.Core.ComponentBase
void Dispose ()
 
override string ToString ()
 

Public Attributes

bool IsActivated
 Indicate if the window is currently activated. More...
 
- Public Attributes inherited from SiliconStudio.Core.ComponentBase
PropertyContainer Tags
 Gets the attached properties to this component. More...
 

Protected Member Functions

void OnActivated (object source, EventArgs e)
 
void OnClientSizeChanged (object source, EventArgs e)
 
void OnDeactivated (object source, EventArgs e)
 
void OnOrientationChanged (object source, EventArgs e)
 
abstract void SetTitle (string title)
 
- Protected Member Functions inherited from SiliconStudio.Core.ComponentBase
 ComponentBase ()
 Initializes a new instance of the ComponentBase class. More...
 
 ComponentBase (string name)
 Initializes a new instance of the ComponentBase class. More...
 
virtual void OnNameChanged ()
 Called when Name property was changed. More...
 
virtual void Destroy ()
 Disposes of object resources. More...
 

Properties

abstract bool AllowUserResizing [get, set]
 Gets or sets, user possibility to resize this window. More...
 
abstract Rectangle ClientBounds [get]
 Gets the client bounds. More...
 
abstract DisplayOrientation CurrentOrientation [get]
 Gets the current orientation. More...
 
abstract bool IsMinimized [get]
 Gets a value indicating whether this instance is minimized. More...
 
abstract bool IsMouseVisible [get, set]
 Gets or sets a value indicating whether the mouse pointer is visible over this window. More...
 
abstract WindowHandle NativeWindow [get]
 Gets the native window. More...
 
abstract bool Visible [get, set]
 Gets or sets a value indicating whether this GameWindow is visible. More...
 
virtual Int2 Position [get, set]
 Gets or sets the position of the window on the screen. More...
 
abstract bool IsBorderLess [get, set]
 Gets or sets a value indicating whether this window has a border More...
 
string Title [get, set]
 Gets or sets the title of the window. More...
 
- Properties inherited from SiliconStudio.Core.ComponentBase
long Id [get, set]
 
string Name [get, set]
 Gets or sets the name of this component. More...
 
bool IsDisposed [get, set]
 Has the component been disposed or not yet. More...
 
- Properties inherited from SiliconStudio.Core.IComponent
long Id [get]
 Gets the id of this component. More...
 
string Name [get]
 Gets the name of this component. More...
 
- Properties inherited from SiliconStudio.Core.IReferencable
int ReferenceCount [get]
 Gets the reference count of this instance. More...
 
- Properties inherited from SiliconStudio.Core.ICollectorHolder
ObjectCollector Collector [get]
 Gets the collector. More...
 

Events

EventHandler< EventArgsActivated
 Occurs when this window is activated. More...
 
EventHandler< EventArgsClientSizeChanged
 Occurs, when device client size is changed. More...
 
EventHandler< EventArgsDeactivated
 Occurs when this window is deactivated. More...
 
EventHandler< EventArgsOrientationChanged
 Occurs, when device orientation is changed. More...
 

Detailed Description

An abstract window.

Definition at line 35 of file GameWindow.cs.

Member Function Documentation

abstract void SiliconStudio.Paradox.Games.GameWindow.BeginScreenDeviceChange ( bool  willBeFullScreen)
pure virtual
void SiliconStudio.Paradox.Games.GameWindow.EndScreenDeviceChange ( )

Definition at line 159 of file GameWindow.cs.

abstract void SiliconStudio.Paradox.Games.GameWindow.EndScreenDeviceChange ( int  clientWidth,
int  clientHeight 
)
pure virtual
void SiliconStudio.Paradox.Games.GameWindow.OnActivated ( object  source,
EventArgs  e 
)
protected

Definition at line 194 of file GameWindow.cs.

void SiliconStudio.Paradox.Games.GameWindow.OnClientSizeChanged ( object  source,
EventArgs  e 
)
protected

Definition at line 205 of file GameWindow.cs.

void SiliconStudio.Paradox.Games.GameWindow.OnDeactivated ( object  source,
EventArgs  e 
)
protected

Definition at line 214 of file GameWindow.cs.

void SiliconStudio.Paradox.Games.GameWindow.OnOrientationChanged ( object  source,
EventArgs  e 
)
protected

Definition at line 225 of file GameWindow.cs.

abstract void SiliconStudio.Paradox.Games.GameWindow.SetTitle ( string  title)
protectedpure virtual

Member Data Documentation

bool SiliconStudio.Paradox.Games.GameWindow.IsActivated

Indicate if the window is currently activated.

Definition at line 50 of file GameWindow.cs.

Property Documentation

abstract bool SiliconStudio.Paradox.Games.GameWindow.AllowUserResizing
getset

Gets or sets, user possibility to resize this window.

Definition at line 79 of file GameWindow.cs.

abstract Rectangle SiliconStudio.Paradox.Games.GameWindow.ClientBounds
get

Gets the client bounds.

The client bounds.

Definition at line 85 of file GameWindow.cs.

abstract DisplayOrientation SiliconStudio.Paradox.Games.GameWindow.CurrentOrientation
get

Gets the current orientation.

The current orientation.

Definition at line 91 of file GameWindow.cs.

abstract bool SiliconStudio.Paradox.Games.GameWindow.IsBorderLess
getset

Gets or sets a value indicating whether this window has a border

true if this window has a border; otherwise, false.

Definition at line 126 of file GameWindow.cs.

abstract bool SiliconStudio.Paradox.Games.GameWindow.IsMinimized
get

Gets a value indicating whether this instance is minimized.

true if this instance is minimized; otherwise, false.

Definition at line 97 of file GameWindow.cs.

abstract bool SiliconStudio.Paradox.Games.GameWindow.IsMouseVisible
getset

Gets or sets a value indicating whether the mouse pointer is visible over this window.

true if this instance is mouse visible; otherwise, false.

Definition at line 103 of file GameWindow.cs.

abstract WindowHandle SiliconStudio.Paradox.Games.GameWindow.NativeWindow
get

Gets the native window.

The native window.

Definition at line 109 of file GameWindow.cs.

virtual Int2 SiliconStudio.Paradox.Games.GameWindow.Position
getset

Gets or sets the position of the window on the screen.

Definition at line 120 of file GameWindow.cs.

string SiliconStudio.Paradox.Games.GameWindow.Title
getset

Gets or sets the title of the window.

Definition at line 132 of file GameWindow.cs.

abstract bool SiliconStudio.Paradox.Games.GameWindow.Visible
getset

Gets or sets a value indicating whether this GameWindow is visible.

true if visible; otherwise, false.

Definition at line 115 of file GameWindow.cs.

Event Documentation

EventHandler<EventArgs> SiliconStudio.Paradox.Games.GameWindow.Activated

Occurs when this window is activated.

Definition at line 55 of file GameWindow.cs.

EventHandler<EventArgs> SiliconStudio.Paradox.Games.GameWindow.ClientSizeChanged

Occurs, when device client size is changed.

Definition at line 60 of file GameWindow.cs.

EventHandler<EventArgs> SiliconStudio.Paradox.Games.GameWindow.Deactivated

Occurs when this window is deactivated.

Definition at line 65 of file GameWindow.cs.

EventHandler<EventArgs> SiliconStudio.Paradox.Games.GameWindow.OrientationChanged

Occurs, when device orientation is changed.

Definition at line 70 of file GameWindow.cs.


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