projects / projects / chimara / chimara.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
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 d2e37f5cf0f0c3a09aa8ed1e4137e49cfa7adc19..09b2dcf352a8ce2f6ce1055d76471c24ed624692 100644 (file)
--- a/docs/reference/chimara-sections.txt
+++ b/docs/reference/chimara-sections.txt
@@ -1,10 +1,14 @@
 <SECTION>
 <FILE>chimara-glk</FILE>
+<INCLUDE>libchimara/chimara-glk.h</INCLUDE>
 <TITLE>ChimaraGlk</TITLE>
 ChimaraGlk
 ChimaraError
 CHIMARA_ERROR
 chimara_error_quark
+ChimaraResourceLoadFunc
+ChimaraResourceType
+ChimaraGlkWindowType
 chimara_glk_new
 chimara_glk_set_interactive
 chimara_glk_get_interactive
@@ -16,11 +20,19 @@ 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_tag
+chimara_glk_get_tag_names
+chimara_glk_update_style
+chimara_glk_set_resource_load_callback
 <SUBSECTION Standard>
 CHIMARA_GLK
 CHIMARA_IS_GLK
@@ -33,6 +45,7 @@ CHIMARA_GLK_GET_CLASS
 
 <SECTION>
 <FILE>chimara-if</FILE>
+<INCLUDE>libchimara/chimara-if.h</INCLUDE>
 ChimaraIFFormat
 ChimaraIFInterpreter
 ChimaraIFZmachineVersion
@@ -42,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>
@@ -54,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>
@@ -99,16 +115,24 @@ glk_gestalt
 gestalt_Version
 gestalt_Unicode
 GLK_MODULE_UNICODE
+gestalt_UnicodeNorm
+GLK_MODULE_UNICODE_NORM
 gestalt_CharOutput
 gestalt_CharOutput_CannotPrint
 gestalt_CharOutput_ApproxPrint
 gestalt_CharOutput_ExactPrint
 gestalt_LineInput
+gestalt_LineInputEcho
+GLK_MODULE_LINE_ECHO
+gestalt_LineTerminators
+GLK_MODULE_LINE_TERMINATORS
+gestalt_LineTerminatorKey
 gestalt_CharInput
 gestalt_MouseInput
 gestalt_Timer
 gestalt_Graphics
 gestalt_DrawImage
+gestalt_Sound2
 gestalt_Sound
 gestalt_SoundVolume
 gestalt_SoundNotify
@@ -116,6 +140,9 @@ gestalt_Hyperlinks
 gestalt_HyperlinkInput
 gestalt_SoundMusic
 gestalt_GraphicsTransparency
+gestalt_DateTime
+gestalt_ResourceStream
+GLK_MODULE_RESOURCE_STREAM
 </SECTION>
 
 <SECTION>
@@ -160,6 +187,13 @@ glk_buffer_to_upper_case_uni
 glk_buffer_to_title_case_uni
 </SECTION>
 
+<SECTION>
+<FILE>glk-normalize</FILE>
+<TITLE>Unicode String Normalization</TITLE>
+glk_buffer_canon_decompose_uni
+glk_buffer_canon_normalize_uni
+</SECTION>
+
 <SECTION>
 <FILE>glk-window-opening</FILE>
 <TITLE>Window Opening, Closing, and Constraints</TITLE>
@@ -170,10 +204,13 @@ winmethod_Above
 winmethod_Below
 winmethod_Fixed
 winmethod_Proportional
+winmethod_Border
+winmethod_NoBorder
 glk_window_close
 <SUBSECTION Private>
 winmethod_DirMask
 winmethod_DivisionMask
+winmethod_BorderMask
 </SECTION>
 
 <SECTION>
@@ -233,6 +270,7 @@ evtype_Arrange
 evtype_Redraw
 evtype_SoundNotify
 evtype_Hyperlink
+evtype_VolumeNotify
 </SECTION>
 
 <SECTION>
@@ -249,6 +287,8 @@ glk_cancel_char_event
 glk_request_line_event
 glk_request_line_event_uni
 glk_cancel_line_event
+glk_set_echo_line_event
+glk_set_terminators_line_event
 </SECTION>
 
 <SECTION>
@@ -381,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>
@@ -460,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>
 
@@ -468,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>
 
@@ -484,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>
@@ -506,10 +554,41 @@ glk_cancel_hyperlink_event
 GLK_MODULE_HYPERLINKS
 </SECTION>
 
+<SECTION>
+<FILE>glk-clock</FILE>
+<TITLE>The System Clock</TITLE>
+glktimeval_t
+glk_current_time
+glk_current_simple_time
+</SECTION>
+
+<SECTION>
+<FILE>glk-clock-conversions</FILE>
+<TITLE>Time and Date Conversions</TITLE>
+glkdate_t
+glk_time_to_date_utc
+glk_time_to_date_local
+glk_simple_time_to_date_utc
+glk_simple_time_to_date_local
+glk_date_to_time_utc
+glk_date_to_time_local
+glk_date_to_simple_time_utc
+glk_date_to_simple_time_local
+</SECTION>
+
+<SECTION>
+<FILE>glk-clock-testing</FILE>
+<TITLE>Testing for Clock Capabilities</TITLE>
+GLK_MODULE_DATETIME
+</SECTION>
+
+<INCLUDE>libchimara/glk.h, libchimara/gi-dispa.h</INCLUDE>
+
 <SECTION>
 <FILE>dispatch-interrogating</FILE>
 <TITLE>Interrogating the Interface</TITLE>
 gidispatch_count_classes
+gidispatch_get_class
 gidispatch_count_intconst
 gidispatch_get_intconst
 gidispatch_intconst_t
@@ -546,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>
@@ -569,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>
@@ -593,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>
@@ -612,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>
@@ -619,32 +706,26 @@ 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
+garglk_set_zcolors_stream
 garglk_set_reversevideo
+garglk_set_reversevideo_stream
 <SUBSECTION Constants>
 zcolor_Current
 zcolor_Default
-zcolor_Black
-zcolor_Red
-zcolor_Green
-zcolor_Yellow
-zcolor_Blue
-zcolor_Magenta
-zcolor_Cyan
-zcolor_White
-zcolor_LightGrey
-zcolor_MediumGrey
-zcolor_DarkGrey
+zcolor_Cursor
+zcolor_Transparent
 keycode_Erase
-<SUBSECTION Private>
-zcolor_NUMCOLORS
-</SECTION>
\ No newline at end of file
+keycode_MouseWheelUp
+keycode_MouseWheelDown
+</SECTION>
Unnamed repository; edit this file 'description' to name the repository.