Update to Blorb protocol 1.5

[projects/chimara/chimara.git] / docs / reference / chimara-sections.txt

diff --git a/docs/reference/chimara-sections.txt b/docs/reference/chimara-sections.txt
index 4a4e2af79c0d15ca2e15a4356ec07a605399a780..09b2dcf352a8ce2f6ce1055d76471c24ed624692 100644 (file)
--- a/docs/reference/chimara-sections.txt
+++ b/docs/reference/chimara-sections.txt
@@ -1,5 +1,6 @@
 <SECTION>
 <FILE>chimara-glk</FILE>
+<INCLUDE>libchimara/chimara-glk.h</INCLUDE>
 <TITLE>ChimaraGlk</TITLE>
 ChimaraGlk
 ChimaraError
@@ -19,14 +20,15 @@ chimara_glk_set_css_to_default
 chimara_glk_set_css_from_file
 chimara_glk_set_css_from_string
 chimara_glk_run
+chimara_glk_run_file
 chimara_glk_stop
 chimara_glk_wait
+chimara_glk_unload_plugin
 chimara_glk_get_running
 chimara_glk_feed_char_input
 chimara_glk_feed_line_input
 chimara_glk_is_char_input_pending
 chimara_glk_is_line_input_pending
-chimara_glk_get_num_tag_names
 chimara_glk_get_tag
 chimara_glk_get_tag_names
 chimara_glk_update_style
@@ -43,6 +45,7 @@ CHIMARA_GLK_GET_CLASS
 
 <SECTION>
 <FILE>chimara-if</FILE>
+<INCLUDE>libchimara/chimara-if.h</INCLUDE>
 ChimaraIFFormat
 ChimaraIFInterpreter
 ChimaraIFZmachineVersion
@@ -52,6 +55,7 @@ chimara_if_new
 chimara_if_set_preferred_interpreter
 chimara_if_get_preferred_interpreter
 chimara_if_run_game
+chimara_if_run_game_file
 chimara_if_get_format
 chimara_if_get_interpreter
 <SUBSECTION Standard>
@@ -64,6 +68,8 @@ CHIMARA_IS_IF_CLASS
 CHIMARA_IF_GET_CLASS
 </SECTION>
 
+<INCLUDE>libchimara/glk.h</INCLUDE>
+
 <SECTION>
 <FILE>glk-exiting</FILE>
 <TITLE>Exiting Your Program</TITLE>
@@ -126,6 +132,7 @@ gestalt_MouseInput
 gestalt_Timer
 gestalt_Graphics
 gestalt_DrawImage
+gestalt_Sound2
 gestalt_Sound
 gestalt_SoundVolume
 gestalt_SoundNotify
@@ -133,6 +140,9 @@ gestalt_Hyperlinks
 gestalt_HyperlinkInput
 gestalt_SoundMusic
 gestalt_GraphicsTransparency
+gestalt_DateTime
+gestalt_ResourceStream
+GLK_MODULE_RESOURCE_STREAM
 </SECTION>
 
 <SECTION>
@@ -260,6 +270,7 @@ evtype_Arrange
 evtype_Redraw
 evtype_SoundNotify
 evtype_Hyperlink
+evtype_VolumeNotify
 </SECTION>
 
 <SECTION>
@@ -410,6 +421,8 @@ glk_stream_open_memory
 glk_stream_open_memory_uni
 glk_stream_open_file
 glk_stream_open_file_uni
+glk_stream_open_resource
+glk_stream_open_resource_uni
 </SECTION>
 
 <SECTION>
@@ -489,6 +502,7 @@ GLK_MODULE_IMAGE
 <FILE>glk-sound-channels</FILE>
 <TITLE>Creating and Destroying Sound Channels</TITLE>
 glk_schannel_create
+glk_schannel_create_ext
 glk_schannel_destroy
 </SECTION>
 
@@ -497,8 +511,12 @@ glk_schannel_destroy
 <TITLE>Playing Sounds</TITLE>
 glk_schannel_play
 glk_schannel_play_ext
+glk_schannel_play_multi
 glk_schannel_stop
+glk_schannel_pause
+glk_schannel_unpause
 glk_schannel_set_volume
+glk_schannel_set_volume_ext
 glk_sound_load_hint
 </SECTION>
 
@@ -513,6 +531,7 @@ glk_schannel_get_rock
 <FILE>glk-sound-testing</FILE>
 <TITLE>Testing for Sound Capabilities</TITLE>
 GLK_MODULE_SOUND
+GLK_MODULE_SOUND2
 </SECTION>
 
 <SECTION>
@@ -560,10 +579,11 @@ glk_date_to_simple_time_local
 <SECTION>
 <FILE>glk-clock-testing</FILE>
 <TITLE>Testing for Clock Capabilities</TITLE>
-gestalt_DateTime
 GLK_MODULE_DATETIME
 </SECTION>
 
+<INCLUDE>libchimara/glk.h, libchimara/gi-dispa.h</INCLUDE>
+
 <SECTION>
 <FILE>dispatch-interrogating</FILE>
 <TITLE>Interrogating the Interface</TITLE>
@@ -605,6 +625,8 @@ gidispatch_get_objrock
 gidispatch_set_retained_registry
 </SECTION>
 
+<INCLUDE>libchimara/glk.h, libchimara/gi-blorb.h</INCLUDE>
+
 <SECTION>
 <FILE>blorb-program</FILE>
 <TITLE>What the Program Does</TITLE>
@@ -628,12 +650,15 @@ giblorb_count_resources
 giblorb_method_DontLoad
 giblorb_method_Memory
 giblorb_method_FilePos
-giblorb_ID_Snd
 giblorb_ID_Exec
+giblorb_ID_Snd
 giblorb_ID_Pict
+giblorb_ID_Data
 giblorb_ID_Copyright
 giblorb_ID_AUTH
 giblorb_ID_ANNO
+giblorb_ID_TEXT
+giblorb_ID_BINA
 <SUBSECTION Private>
 giblorb_make_id
 </SECTION>
@@ -652,6 +677,8 @@ giblorb_err_Format
 giblorb_err_NotFound
 </SECTION>
 
+<INCLUDE>libchimara/glk.h, libchimara/glkstart.h</INCLUDE>
+
 <SECTION>
 <FILE>glkext-startup</FILE>
 <TITLE>Startup Code</TITLE>
@@ -671,6 +698,7 @@ NULL
 <SECTION>
 <FILE>glkext-unix</FILE>
 <TITLE>Unix Extensions</TITLE>
+glkunix_stream_open_pathname_gen
 glkunix_stream_open_pathname
 glkunix_set_base_file
 </SECTION>
@@ -678,13 +706,14 @@ glkunix_set_base_file
 <SECTION>
 <FILE>glkext-garglk</FILE>
 <TITLE>Gargoyle Extensions</TITLE>
+<INCLUDE>libchimara/glk.h, libchimara/garglk.h</INCLUDE>
 GARGLK
 <SUBSECTION Functions>
 garglk_fileref_get_name
 garglk_set_program_name
 garglk_set_program_info
 garglk_set_story_name
-garglk_set_line_terminators
+garglk_set_story_title
 garglk_unput_string
 garglk_unput_string_uni
 garglk_set_zcolors
@@ -699,6 +728,4 @@ zcolor_Transparent
 keycode_Erase
 keycode_MouseWheelUp
 keycode_MouseWheelDown
-<SUBSECTION Private>
-zcolor_NUMCOLORS
 </SECTION>