X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;ds=sidebyside;f=libchimara%2Fdoc.c;h=ab842bbdf3c1022af06afc322ce80b6574482c01;hb=c4142afddd5b220686eb64c4bd346a722f9e20c1;hp=277245c452714be615ed09c4525fca0f30282dc8;hpb=90090906ff9ca843e5dac0d26342f5bf85bab4f2;p=projects%2Fchimara%2Fchimara.git
diff --git a/libchimara/doc.c b/libchimara/doc.c
index 277245c..ab842bb 100644
--- a/libchimara/doc.c
+++ b/libchimara/doc.c
@@ -800,7 +800,7 @@
/**
* SECTION:glk-stream-types
- * @short_description: Window, memory, and file streams
+ * @short_description: Window, memory, file, and resource streams
*
* Window Streams
*
@@ -863,6 +863,30 @@
* linkend="chimara-File-References">File References.
*
*
+ * Resource Streams
+ *
+ * You can open a stream which reads from (but not writes to) a resource file.
+ *
+ *
+ * Typically this is embedded in a Blorb file, as Blorb is the official
+ * resource-storage format of Glk. A Blorb file can contain images and sounds,
+ * but it can also contain raw data files, which are accessed by
+ * glk_stream_open_resource() and glk_stream_open_resource_uni(). A data file
+ * is identified by number, not by a filename. The Blorb usage field will be
+ * 'Data'
. The chunk type will be 'TEXT'
for text
+ * resources, 'BINA'
for binary resources.
+ *
+ *
+ *
+ * If the running program is not associated with a Blorb file, the library may
+ * look for data files as actual files instead. These would be named
+ * DATA1, DATA2, etc, with a suffix
+ * distinguishing text and binary files. See Other Resource
+ * Arrangements
in the Blorb spec:
+ *
+ *
+ *
*/
/**
@@ -1440,8 +1464,8 @@
* So the version number 78.2.11 would be encoded as 0x004E020B.
*
*
- * The current Glk specification version is 0.7.3, so this selector will return
- * 0x00000703.
+ * The current Glk specification version is 0.7.4, so this selector will return
+ * 0x00000704.
*
* |[
* glui32 res;
@@ -1834,6 +1858,18 @@
*
*/
+/**
+ * gestalt_ResourceStream:
+ *
+ * |[
+ * res = glk_gestalt(gestalt_ResourceStream, 0);
+ * ]|
+ *
+ * This returns 1 if the glk_stream_open_resource() and
+ * glk_stream_open_resource_uni() functions are available. If it returns 0, you
+ * should not call them.
+ */
+
/**
* evtype_None:
*