RPG::Screen Class Reference

Used for the screen, including window properties and FPS. More...

#include <Screen.h>

Public Member Functions
HWND	getCanvasHWND ()
	Returns the HWND of the window control on which the screen is drawn.
void	setFPS (int fps)
	Changes the framerate (and thus the overall speed of the game)
void	update (Scene scene)
	Redraws the screen for a certain scene.
void	toggleFullScreen (bool fullScreen)
	Built-in RM2k3 function that changes between fullScreen and windowed mode.
void	toggleLargeWindow (bool largeWindow)
	Built-in RM2k3 function that changes game window size mode.

Public Attributes
AuroraDrawMain *	auroraDrawMain
	Not implemented yet.
bool	fullScreen
	Is fullscreen active?
bool	largeWindow
	Is the large window (640x480) active?
Canvas *	canvas
	RPG::Canvas which should be used for drawing on the screen.
RECT	canvasRect
void *	FilgraphManager
void *	IGraphBuilder
void *	IVideoWindow
void *	IMediaControl
void *	IMediaEvent
void *	IMediaSeeking
RECT	movieRect
bool	movieIsPlaying
bool	isIdle
bool	wasScreenSaver
double	millisecondsPerFrame
	Milliseconds a frame should take.
int	maxFPS
	Maximum FPS.

Detailed Description

Used for the screen, including window properties and FPS.

See also

RPG::screen

Member Function Documentation

getCanvasHWND()

HWND RPG::Screen::getCanvasHWND

(

)

Returns the HWND of the window control on which the screen is drawn.

Note

In windowed mode, this is not the window itself, but a child of it.

setFPS()

void RPG::Screen::setFPS

(

int

fps

)

Changes the framerate (and thus the overall speed of the game)

This function changes the speed of the whole game by changing the number of frames rendered per second. The default is 60.

Parameters

fps	New framerate

toggleFullScreen()

void RPG::Screen::toggleFullScreen

(

bool

fullScreen

)

Built-in RM2k3 function that changes between fullScreen and windowed mode.

Parameters

fullScreen

Change to windowed mode if false or change to fullScreen mode if true

toggleLargeWindow()

void RPG::Screen::toggleLargeWindow

(

bool

largeWindow

)

Built-in RM2k3 function that changes game window size mode.

Parameters

largeWindow

Change to small mode if false or change to large mode if true

update()

void RPG::Screen::update

(

Scene

scene

)

Redraws the screen for a certain scene.

This function completely redraws the screen and uses the drawing method of the specified scene. Normally, you would use the current scene for that. This function will also wait for the next frame without using 100% CPU, so that you can use this function to do something which takes longer than one frame.

Parameters

scene

Scene to draw

---

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

• include/DynRPG/Screen.h