wiki:GraphicsApi

Version 14 (modified by davea, 16 years ago) (diff)

--

Application graphics

A BOINC application may produce graphics with a separate 'graphics app' program having the properties that:

  • If invoked with --fullscreen, it opens a full-screen borderless window, and must exit on mouse or keyboard input.
  • Otherwise it opens a standard window, and may handle mouse/keyboard input.

The logical name of the program must be 'graphics_app'. When you set up your application version directory, give it a filename like

graphics_app=uc2_graphics_5.10_windows_intelx86.exe

The graphics app is launched by the BOINC Manager and by the screensaver. It may be killed at any time. Multiple instances of the graphics app may run at the same time (e.g. if the user opens a graphics window via the Manager, and then the screensaver runs and launches another instance).

The BOINC graphics API provides cross-platform support for developing graphics apps; however, you need not use it.

A complete example can be found in boinc_samples/example_app.

Compatibility

Let's call this the "new" way of doing graphics. There is also an "old" way, in which graphics are generated by a separate thread in the application process (see old API description).

Applications types interact with client software versions as follows:

old apps new apps
client version 5 * *
client version 6+ *
  • graphics work except on Vista with service-mode install

App will work with "Show graphics" button, but not screensaver, and not on Vista with service-mode install

* graphics work in all situations

The BOINC Graphics API

BOINC supplies a library (libboinc_graphics2.a) that makes it easy to develop graphics apps. To use this library, the graphics app must call

boinc_graphics_loop(int argc, char** argv);

after its initialization. This function executes an event loop, and does not return.

The application must supply the following functions:

void app_graphics_render(int xs, ys, double time_of_day);

This will be called periodically. It should generate the current graphic. xs and ys are the X and Y sizes of the window, and time_of_day is the relative time in seconds.

void app_graphics_resize(int x, int y);

Called when the window size changes.

void boinc_app_mouse_move(
    int x, int y,       // new coords of cursor
    int left,          // whether left mouse button is down
    int middle,
    int right
);

void boinc_app_mouse_button(
    int x, int y,       // coords of cursor
    int which,          // which button (0/1/2)
    int is_down        // true iff button is now down
);

void boinc_app_key_press(
    int, int            // system-specific key encodings
)

void boinc_app_key_release(
    int, int            // system-specific key encodings
)

Communicating with the main application

The graphics app may want to get information from the main app. This can be done efficiently using shared memory. The BOINC library supplies the following functions to facilitate this:

void* boinc_graphics_make_shmem(char* appname, int size);
void* boinc_graphics_get_shmem(char* appname);

boinc_graphics_make_shmem() (called from the main app) creates a shared memory segment of the given size. 'appname' should be the name of this application (used to ensure uniqueness of the shared-memory segment name). boinc_graphics_get_shmem() (called from the graphics app) attaches to an existing segment.

The contents of the shared memory segment are up to you. You may want to include the following items:

struct UC_SHMEM {
    double update_time;
    double fraction_done;
    double cpu_time;
    BOINC_STATUS status;
};

This structure should be updated by the main app once per second, using boinc_set_timer_handler(). The items are:

update_time
The current time (dtime()). The graphics app should exit if the current time exceeds this by 5 seconds or so.
fraction_done
The last fraction done reported by the main app.
cpu_time
The current CPU time.
status
The BOINC status. If the 'suspended' flag is set, the graphics app should stop changing its display, and simply display an "application suspended" message.

Keep in mind that multiple instances of the graphics app may run simultaneously; avoid having the graphics app write to the shared memory. If you use shared memory to store a data structure, use a semaphore to synchronize access so that the graphics app doesn't see an inconsistent state.