cEngine Struct Reference

Inheritance diagram for cEngine

Inheritance graph

Collaboration diagram for cEngine:

Collaboration graph


Public Methods

int cEngine_Lock (struct cEngine *ptr_engine)
int cEngine_Unlock (struct cEngine *ptr_engine)

Public Attributes

struct cEngine Screen

Detailed Description

Provides timely graphical output. The screen shows only one cEngine object.

See also:
Base Structures

Member Function Documentation

int cEngine_Lock ( struct cEngine * ptr_engine )
 

Locks a cEngine object.
Updates are not performed while it is locked. After each cEngine_Lock function, the cEngine_Unlock function must be called somewhere later in the program.

Parameters:
ptr_engine   A pointer to the initialized cEngine object
Returns:
Lock counter 
       #include <cywin.h>
       ...
       cEngine_Lock( &Screen );
       ...
       //  Performs time-consuming drawing.
       ...
       cEngine_Unlock(  &Screen );
       ...
See also:
cEngine_Unlock.

int cEngine_Unlock ( struct cEngine * ptr_engine )
 

Unlocks a cEngine object.
The cEngine_Unlock function must be called once for every time the cEngine_Lock function was called.

Parameters:
ptr_engine   A pointer to the initialized cEngine object
Returns:
Lock counter. If it is greater than 0, cEngine is still locked 
       #include <cywin.h>
       ...
       cEngine_Lock( &Screen );
       //  Performs time-consuming drawing.
       ...
       cEngine_Unlock(  &Screen );
       ...
See also:
cEngine_Lock.

Member Data Documentation

struct cEngine Screen
 

Global CyWin cEngine object.

       #include <cywin.h>
       ...
       cEngine_Lock( &Screen );
       ...
       //  Performs time-consuming drawing.
       ...
       cEngine_Unlock(  &Screen );
       ...