Commit 29bca65ddaaec4c01b788237a94770c1e5750cbb

Werner Lemberg 2013-11-05T23:46:25

Improve documentation of `FT_Load_Sfnt_Table'.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
diff --git a/include/freetype/tttables.h b/include/freetype/tttables.h
index 3766b53..ce7ad79 100644
--- a/include/freetype/tttables.h
+++ b/include/freetype/tttables.h
@@ -676,6 +676,12 @@ FT_BEGIN_HEADER
   *       error = FT_Load_Sfnt_Table( face, tag, 0, buffer, &length );
   *       if ( error ) { ... could not load table ... }
   *     }
+  *
+  *   Note that structures like @TT_Header or @TT_OS2 can't be used with
+  *   this function; the are limited to @FT_Get_Sfnt_Table.  Reason is that
+  *   the size of those structures may vary depending on the processor
+  *   architecture (e.g. 32bit vs. 64bit or big endian vs. little endian).
+  *
   */
   FT_EXPORT( FT_Error )
   FT_Load_Sfnt_Table( FT_Face    face,