Changes between Version 35 and Version 36 of GraphicsApi

Timestamp:

Jan 19, 2014, 4:50:31 PM (12 years ago)

Author:

davea

Comment:

--

GraphicsApi

@@ -103 +103 @@
 }}}
 `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.
+'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.
 It must be called AFTER boinc_parse_init_data_file().
 
@@ -120 +121 @@
 using [BasicApi#timer 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.
+ 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.
+ status:: The BOINC status.  If the 'suspended' flag is set,
+the graphics app should stop changing its display,
+and instead display an "application suspended" message.
 
 Keep in mind that multiple instances of the graphics app may run simultaneously;
@@ -200 +204 @@
 == Displaying text ==
 
-Older versions of the BOINC graphics API library included functions for rendering ''texture fonts'' using font files of the form ''*.txf''.  These have been eliminated, and we have instead added support for displaying strings using !TrueType fonts in BOINC graphics applications.
+BOINC supports the display of text using !TrueType fonts.
+
  * Add the files `api/ttfont.cpp` and `api/ttfont.h` to your application (they are not included in any BOINC library.)
- * You will need to link with the [http://www.freetype.org FreeType2] and [http://sourceforge.net/projects/ftgl/files/FTGL%20Source/ FTGL] libraries.  Depending on how you build the FreeType2 library, FreeType2 may require the libz and libbz2 libraries.  For Windows, prebuilt libraries are available in the `boinc_depends_win_vs2005` repository.  To build these libraries on the Mac, please see MacBuild.
- * We have put copies of the free [https://fedorahosted.org/liberation-fonts Liberation fonts] in the `api/ttf/` directory.  If you wish to use other !TrueType fonts, you will need to adjust the list of font names in `ttfont.cpp`.  (Another source of free fonts is the [http://www.gnu.org/software/freefont GNU Freefont project].)
- * Download the desired !TrueType fonts to the client where they are available to your graphics application.
-
-For examples, please see the `clientscr/ss_app.cpp` and `samples/exampple_app/uc2_graphics.cpp` in the BOINC SVN trunk.
-
-If your graphics application currently uses the older ''texture fonts'', note that the ttf_load_fonts() and txf_render_string() APIs are slightly different from the old txf_load_fonts() and txf_render_string() APIs, which have been eliminated.  Please see the `ttfont.cpp` and `ttfont.h` files for details.
+ * Link with the [http://www.freetype.org FreeType2]
+  and [http://sourceforge.net/projects/ftgl/files/FTGL%20Source/ FTGL] libraries.
+  Depending on how you build the FreeType2 library, FreeType2 may require the libz and libbz2 libraries.
+  For Windows, prebuilt libraries are available in the `boinc_depends_win_vs2005` repository.
+  To build these libraries on the Mac, please see MacBuild.
+ * Include the desired !TrueType fonts in your [AppVersionNew  app versions].
+  The set of free [https://fedorahosted.org/liberation-fonts Liberation fonts] in included the `api/ttf/` directory.
+  If you wish to use other !TrueType fonts,
+  you'll need to adjust the list of font names in `ttfont.cpp`.
+  (Another source of free fonts is the [http://www.gnu.org/software/freefont GNU Freefont project].)
+ * To display text, use the following API functions:
+{{{
+float white[4] = {1., 1., 1., 1.};
+APP_INIT_DATA aid;
+boinc_get_init_data(aid);
+
+// read font files; they're in the project directory
+//
+ttf_load_fonts(aid.project_dir);
+...
+ttf_render_string(
+   x, y, z,            // where to display string
+   500,                // size
+   white,              // color
+   "App suspended"     // the text
+   0,                  // which font (see ttfont.cpp)
+                       // default is Sans-Regular (0)
+);
+
+}}}
+
+Other parameters to '''ttf_render_string()''' let you specify rotation; see ttfont.h.
+For examples, see the `clientscr/ss_app.cpp` and `samples/exampple_app/uc2_graphics.cpp` in the BOINC trunk.