Recent Changes - Search:

Documentation

Help

Tutorials

RoadMap

Help Docs for wiki writers:

PmWiki

edit SideBar

SetUp

bool SetUp(
unsigned int Screen_Width,
unsigned int Screen_Heigth,
bool FullSreenMod,
std::string _WindowName,
bool _Resize,
int _fps,
unsigned int _BitDepthOfScreen,
bool Anyformat
);

Public function of the Epee Engine Class

Description:
initialize the Epee Engine and opens a new window

Arguments:

Required:

unsigned int Screen_Width
The width of the new window

unsigned int Screen_Heigth
The heigth of the new window

Optional:

bool FullSreenMod
if true the new window is full screen
if false a window with a border is opened
defaults to false

std::string _WindowName
The text to appear in the top right of the new window's title bar
does not appear in full screen mode
Defaults to "Your App Name Here"

bool _Resize
if true allows the user to resize the window
THIS CURRENTLY DOES NOT WORK this is always set to false
Defaults to false

int _fps
Frames Per Second the render engine tries to render at.
This give you a constance render speed no mater how fast the processor is.
On faster processors the render engine will sleep, if the processor is to slow to render at _fps then the render engine will not sleep.
defaults to 60

unsigned int _BitDepthOfScreen
Sets the bit depth of the screen. This should be set to bit depth of the biggest image that you are drawing
defaults to 16

bool Anyformat
allows any bit depth to be drawn to the screen other wise the engine will try to convent the image to _BitDepthOfScreen see SDL_ANYFORMAT for more information
defaults to false

Return Value:
returns true if successful false otherwise

Edit - History - Print - Recent Changes - Search
Page last modified on April 04, 2007, at 05:29 PM