Changes between Version 8 and Version 9 of GraphicsApi

Timestamp:

Oct 9, 2007, 3:46:10 PM (17 years ago)

Author:

davea

Comment:

--

GraphicsApi

@@ -1 @@
-= Application graphics (version 6+) =
+= Application graphics =
 
-[[T(VersionSix)]]
-
-Starting with BOINC version 6.0,
-application graphics are generated by a separate 'graphics app' program.
-The only constraints on a graphics app are:
+The recommended way to do application graphics 
+is 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.
@@ -17 +14 @@
 
 The BOINC graphics API (described below) provides cross-platform support for
-developing graphics apps;
-however, you need not use it.
+developing graphics apps; however, you need not use it.
 
 The logical name of the program must be 'graphics_app'.
@@ -25 +21 @@
 graphics_app=uc2_graphics_5.10_windows_intelx86.exe
 }}}
+
+== 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
+(the old API is described [GraphicsApi here]).
+
+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
+
+** graphics work in all situations
 
 == The BOINC Graphics API ==
@@ -39 +52 @@
 {{{
 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);
-void boinc_app_mouse_move();
-void boinc_app_mouse_button();
-void boinc_app_key_press();
-void boinc_app_key_release();
 }}}
-These functions are described [GraphicsApi here].
+
+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 ==