igor::iWindow Class Reference

#include <iWindow.h>

Public Member Functions
iWindowID	getID () const
void	setDoubleClick (bool doubleClick)
bool	getDoubleClick () const
void	setVSync (bool vsync)
bool	getVSync () const
void	setTitle (const iaString &title)
iaString	getTitle () const
int32	getWidth () const
int32	getHeight () const
int32	getClientWidth () const
int32	getClientHeight () const
int32	getXPos () const
int32	getYPos () const
bool	isOpen () const
bool	open ()
void	close ()
void	setColorDepth (uint8 colordepth)
uint8	getColorDepth () const
void	setZDepth (uint8 zdepth)
uint8	getZDepth () const
void	setSize (int32 width, int32 height)
void	setClientSize (int32 width, int32 height)
void	setSizeByDesktop ()
void	getDesktopSize (int32 &width, int32 &height)
void	setPosition (int32 x, int32 y)
void	setFullscreen (bool fullscreen=true)
void	setCentered ()
bool	isFullscreen ()
void	addView (iView *view, int32 zIndex=0)
void	removeView (iView *view)

Static Public Attributes
static const iWindowID	INVALID_WINDOW_ID = IGOR_INVALID_ID

Friends
class	iApplication
class	iRenderContextThread
class	iWindowImpl

Detailed Description

application window

Member Function Documentation

addView()

void igor::iWindow::addView	(	iView *	view,
		int32	zIndex = 0
	)

adds view to the window

Parameters

view	the view to be added
zIndex	determines the render order of the views

close()

void igor::iWindow::close

(

)

closes window

getClientHeight()

int32 igor::iWindow::getClientHeight

(

)

const

Returns

height of render area

getClientWidth()

int32 igor::iWindow::getClientWidth

(

)

const

Returns

width of render area

getColorDepth()

uint8 igor::iWindow::getColorDepth

(

)

const

Returns

color buffer depth

getDesktopSize()

void igor::iWindow::getDesktopSize	(	int32 &	width,
		int32 &	height
	)

returns desktop size

Parameters

[out]	width	the width of the desktop
[out]	height	the height of the desktop

getDoubleClick()

bool igor::iWindow::getDoubleClick

(

)

const

Returns

true if the window understands double clicks

getHeight()

int32 igor::iWindow::getHeight

(

)

const

Returns

height of window

getID()

iWindowID igor::iWindow::getID

(

)

const

Returns

id of the window

getTitle()

iaString igor::iWindow::getTitle

(

)

const

Returns

title of the window

getVSync()

bool igor::iWindow::getVSync

(

)

const

Returns

true if vsync is activated

getWidth()

int32 igor::iWindow::getWidth

(

)

const

Returns

width of window

getXPos()

int32 igor::iWindow::getXPos

(

)

const

Returns

horizontal position of window

getYPos()

int32 igor::iWindow::getYPos

(

)

const

Returns

vertical position of window

getZDepth()

uint8 igor::iWindow::getZDepth

(

)

const

Returns

depth buffer depth in bits

isFullscreen()

bool igor::iWindow::isFullscreen

(

)

Returns

if window is in full screen or window mode

isOpen()

bool igor::iWindow::isOpen

(

)

const

returns if window is open or closed

Returns

true: window is open; false: window is closed

open()

bool igor::iWindow::open

(

)

opens window

Returns

true: success; false: fail

removeView()

void igor::iWindow::removeView

(

iView *

view

)

removes view from the window

Parameters

view	the view to be removed

setCentered()

void igor::iWindow::setCentered

(

)

centers the window relative to the desktop horizontally and vertically

setClientSize()

void igor::iWindow::setClientSize	(	int32	width,
		int32	height
	)

set resolution of window by setting the client rectangle size

Parameters

width	horizontal width in pixel of client rectangle
height	vertical height in pixel of client rectangle

setColorDepth()

void igor::iWindow::setColorDepth

(

uint8

colordepth

)

set color depth

Parameters

colordepth

in bit per pixel

setDoubleClick()

void igor::iWindow::setDoubleClick

(

bool

doubleClick

)

sets if the window understands double clicks

can only be called as long as window is closed

Parameters

doubleClick

if true window understands double clicks

setFullscreen()

void igor::iWindow::setFullscreen

(

bool

fullscreen = true

)

sets the windows full screen or window mode

Parameters

fullscreen

true: set window to full screen mode; false: set window to window mode

setPosition()

void igor::iWindow::setPosition	(	int32	x,
		int32	y
	)

set position of window relative to desktop

Parameters

x	horizontal position in pixel
y	vertical position in pixel

setSize()

void igor::iWindow::setSize	(	int32	width,
		int32	height
	)

set resolution of window

Parameters

width	horizontal width in pixel
height	vertical height in pixel

setSizeByDesktop()

void igor::iWindow::setSizeByDesktop

(

)

set window resolution so same value as desktop resolution

setTitle()

void igor::iWindow::setTitle

(

const iaString &

title

)

sets title of window

Parameters

title

the windows title

setVSync()

void igor::iWindow::setVSync

(

bool

vsync

)

sets the usage of vsync or not

Parameters

vsync

if true vsync will be used

setZDepth()

void igor::iWindow::setZDepth

(

uint8

zdepth

)

set depth buffer depth

Parameters

zdepth

the depth buffer depth in bits

Friends And Related Function Documentation

iApplication

friend class iApplication

friend

iRenderContextThread

friend class iRenderContextThread

friend

iWindowImpl

friend class iWindowImpl

friend

Member Data Documentation

INVALID_WINDOW_ID

const iWindowID igor::iWindow::INVALID_WINDOW_ID = IGOR_INVALID_ID

static

invalid node id definition

---

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

• /home/maddin/dev/Igor/src/igor/igor/system/iWindow.h
• /home/maddin/dev/Igor/src/igor/igor/system/iWindow.cpp