Annotations glossary: RetroGTK Reference Manual

# Annotations glossary

## Annotation Glossary

### A

array

  Parameter points to an array of items.

### E

element-type

  Generics and defining elements of containers and arrays.

### N

nullable

  NULL may be passed as the value in, out, in-out; or as a return value.

### O

optional

  NULL may be passed instead of a pointer to a location.

out

  Parameter for returning results. Default is transfer full.

### P

Private

  An interface that can be used within the GNOME stack itself, but that is not documented for end-users. Such functions should only be used in specified and documented ways.

### T

transfer full

  Free data after the code is done.

transfer none

  Don't free data after the code is done.

type

  Override the parsed C type with given type.

### R

RetroAnalogId, enum RetroAnalogId
RetroAnalogIndex, enum RetroAnalogIndex
RetroController, RetroController
RetroController::state-changed, The “state-changed” signal
RetroControllerInterface, struct RetroControllerInterface
RetroControllerIterator, RetroControllerIterator
RetroControllerType, enum RetroControllerType
RetroCore, RetroCore
RetroCore::crashed, The “crashed” signal
RetroCore::log, The “log” signal
RetroCore::message, The “message” signal
RetroCore::shutdown, The “shutdown” signal
RetroCore::video-output, The “video-output” signal
RetroCore:api-version, The “api-version” property
RetroCore:content-directory, The “content-directory” property
RetroCore:filename, The “filename” property
RetroCore:frames-per-second, The “frames-per-second” property
RetroCore:game-loaded, The “game-loaded” property
RetroCore:is-initiated, The “is-initiated” property
RetroCore:runahead, The “runahead” property
RetroCore:save-directory, The “save-directory” property
RetroCore:speed-rate, The “speed-rate” property
RetroCore:support-no-game, The “support-no-game” property
RetroCore:system-directory, The “system-directory” property
RetroCoreDescriptor, RetroCoreDescriptor
RetroCoreView, RetroCoreView
RetroCoreView::controller-state-changed, The “controller-state-changed” signal
RetroCoreView:can-grab-pointer, The “can-grab-pointer” property
RetroCoreView:snap-pointer-to-borders, The “snap-pointer-to-borders” property
RetroJoypadId, enum RetroJoypadId
RetroKeyJoypadMapping, RetroKeyJoypadMapping
RetroLightgunId, enum RetroLightgunId
RetroMemoryType, enum RetroMemoryType
RetroModuleIterator, RetroModuleIterator
RetroModuleQuery, RetroModuleQuery
RetroMouseId, enum RetroMouseId
RetroOption, RetroOption
RetroOption::value-changed, The “value-changed” signal
RetroOptionIterator, RetroOptionIterator
RetroPointerId, enum RetroPointerId
RetroRumbleEffect, enum RetroRumbleEffect
RetroVideoFilter, enum RetroVideoFilter
retro_controller_emit_state_changed, retro_controller_emit_state_changed ()
retro_controller_get_capabilities, retro_controller_get_capabilities ()
retro_controller_get_controller_type, retro_controller_get_controller_type ()
retro_controller_get_input_state, retro_controller_get_input_state ()
retro_controller_get_supports_rumble, retro_controller_get_supports_rumble ()
retro_controller_has_capability, retro_controller_has_capability ()
retro_controller_iterator_next, retro_controller_iterator_next ()
retro_controller_set_rumble_state, retro_controller_set_rumble_state ()
retro_controller_type_get_id_count, retro_controller_type_get_id_count ()
retro_controller_type_get_index_count, retro_controller_type_get_index_count ()
retro_core_boot, retro_core_boot ()
retro_core_descriptor_get_firmwares, retro_core_descriptor_get_firmwares ()
retro_core_descriptor_get_firmware_md5, retro_core_descriptor_get_firmware_md5 ()
retro_core_descriptor_get_firmware_path, retro_core_descriptor_get_firmware_path ()
retro_core_descriptor_get_firmware_sha512, retro_core_descriptor_get_firmware_sha512 ()
retro_core_descriptor_get_icon, retro_core_descriptor_get_icon ()
retro_core_descriptor_get_id, retro_core_descriptor_get_id ()
retro_core_descriptor_get_is_emulator, retro_core_descriptor_get_is_emulator ()
retro_core_descriptor_get_is_firmware_mandatory, retro_core_descriptor_get_is_firmware_mandatory ()
retro_core_descriptor_get_is_game, retro_core_descriptor_get_is_game ()
retro_core_descriptor_get_mime_type, retro_core_descriptor_get_mime_type ()
retro_core_descriptor_get_module, retro_core_descriptor_get_module ()
retro_core_descriptor_get_module_file, retro_core_descriptor_get_module_file ()
retro_core_descriptor_get_name, retro_core_descriptor_get_name ()
retro_core_descriptor_get_platform_supports_mime_types, retro_core_descriptor_get_platform_supports_mime_types ()
retro_core_descriptor_get_uri, retro_core_descriptor_get_uri ()
retro_core_descriptor_has_firmwares, retro_core_descriptor_has_firmwares ()
retro_core_descriptor_has_firmware_md5, retro_core_descriptor_has_firmware_md5 ()
retro_core_descriptor_has_firmware_sha512, retro_core_descriptor_has_firmware_sha512 ()
retro_core_descriptor_has_icon, retro_core_descriptor_has_icon ()
retro_core_descriptor_has_platform, retro_core_descriptor_has_platform ()
retro_core_descriptor_new, retro_core_descriptor_new ()
retro_core_get_api_version, retro_core_get_api_version ()
retro_core_get_can_access_state, retro_core_get_can_access_state ()
retro_core_get_content_directory, retro_core_get_content_directory ()
retro_core_get_filename, retro_core_get_filename ()
retro_core_get_frames_per_second, retro_core_get_frames_per_second ()
retro_core_get_game_loaded, retro_core_get_game_loaded ()
retro_core_get_is_initiated, retro_core_get_is_initiated ()
retro_core_get_memory_size, retro_core_get_memory_size ()
retro_core_get_option, retro_core_get_option ()
retro_core_get_runahead, retro_core_get_runahead ()
retro_core_get_save_directory, retro_core_get_save_directory ()
retro_core_get_speed_rate, retro_core_get_speed_rate ()
retro_core_get_support_no_game, retro_core_get_support_no_game ()
retro_core_get_system_directory, retro_core_get_system_directory ()
retro_core_has_option, retro_core_has_option ()
retro_core_iterate_controllers, retro_core_iterate_controllers ()
retro_core_iterate_options, retro_core_iterate_options ()
retro_core_iteration, retro_core_iteration ()
retro_core_load_memory, retro_core_load_memory ()
retro_core_load_state, retro_core_load_state ()
retro_core_new, retro_core_new ()
retro_core_override_option_default, retro_core_override_option_default ()
retro_core_reset, retro_core_reset ()
retro_core_run, retro_core_run ()
retro_core_save_memory, retro_core_save_memory ()
retro_core_save_state, retro_core_save_state ()
retro_core_set_content_directory, retro_core_set_content_directory ()
retro_core_set_controller, retro_core_set_controller ()
retro_core_set_current_media, retro_core_set_current_media ()
retro_core_set_default_controller, retro_core_set_default_controller ()
retro_core_set_keyboard, retro_core_set_keyboard ()
retro_core_set_medias, retro_core_set_medias ()
retro_core_set_runahead, retro_core_set_runahead ()
retro_core_set_save_directory, retro_core_set_save_directory ()
retro_core_set_speed_rate, retro_core_set_speed_rate ()
retro_core_set_system_directory, retro_core_set_system_directory ()
retro_core_stop, retro_core_stop ()
retro_core_view_as_controller, retro_core_view_as_controller ()
retro_core_view_get_can_grab_pointer, retro_core_view_get_can_grab_pointer ()
retro_core_view_get_controller_capabilities, retro_core_view_get_controller_capabilities ()
retro_core_view_get_input_state, retro_core_view_get_input_state ()
retro_core_view_get_key_joypad_mapping, retro_core_view_get_key_joypad_mapping ()
retro_core_view_get_pixbuf, retro_core_view_get_pixbuf ()
retro_core_view_get_snap_pointer_to_borders, retro_core_view_get_snap_pointer_to_borders ()
retro_core_view_new, retro_core_view_new ()
retro_core_view_set_as_default_controller, retro_core_view_set_as_default_controller ()
retro_core_view_set_can_grab_pointer, retro_core_view_set_can_grab_pointer ()
retro_core_view_set_core, retro_core_view_set_core ()
retro_core_view_set_filter, retro_core_view_set_filter ()
retro_core_view_set_key_joypad_mapping, retro_core_view_set_key_joypad_mapping ()
retro_core_view_set_pixbuf, retro_core_view_set_pixbuf ()
retro_core_view_set_snap_pointer_to_borders, retro_core_view_set_snap_pointer_to_borders ()
RETRO_GTK_CHECK_VERSION, RETRO_GTK_CHECK_VERSION()
RETRO_GTK_ENCODE_VERSION, RETRO_GTK_ENCODE_VERSION()
RETRO_GTK_MAJOR_VERSION, RETRO_GTK_MAJOR_VERSION
RETRO_GTK_MICRO_VERSION, RETRO_GTK_MICRO_VERSION
RETRO_GTK_MINOR_VERSION, RETRO_GTK_MINOR_VERSION
RETRO_GTK_VERSION, RETRO_GTK_VERSION
RETRO_GTK_VERSION_HEX, RETRO_GTK_VERSION_HEX
RETRO_GTK_VERSION_S, RETRO_GTK_VERSION_S
retro_g_log, retro_g_log ()
retro_input_copy, retro_input_copy ()
retro_input_free, retro_input_free ()
retro_input_get_analog, retro_input_get_analog ()
retro_input_get_controller_type, retro_input_get_controller_type ()
retro_input_get_joypad, retro_input_get_joypad ()
retro_input_get_lightgun, retro_input_get_lightgun ()
retro_input_get_mouse, retro_input_get_mouse ()
retro_input_get_pointer, retro_input_get_pointer ()
retro_input_new, retro_input_new ()
retro_joypad_id_from_button_code, retro_joypad_id_from_button_code ()
retro_joypad_id_to_button_code, retro_joypad_id_to_button_code ()
retro_key_joypad_mapping_get_button_key, retro_key_joypad_mapping_get_button_key ()
retro_key_joypad_mapping_new, retro_key_joypad_mapping_new ()
retro_key_joypad_mapping_new_default, retro_key_joypad_mapping_new_default ()
retro_key_joypad_mapping_set_button_key, retro_key_joypad_mapping_set_button_key ()
retro_module_iterator_get, retro_module_iterator_get ()
retro_module_iterator_new, retro_module_iterator_new ()
retro_module_iterator_next, retro_module_iterator_next ()
retro_module_query_iterator, retro_module_query_iterator ()
retro_module_query_new, retro_module_query_new ()
retro_option_get_description, retro_option_get_description ()
retro_option_get_key, retro_option_get_key ()
retro_option_get_value, retro_option_get_value ()
retro_option_get_values, retro_option_get_values ()
retro_option_iterator_next, retro_option_iterator_next ()
retro_option_set_value, retro_option_set_value ()
retro_pixbuf_get_aspect_ratio, retro_pixbuf_get_aspect_ratio ()
retro_pixbuf_set_aspect_ratio, retro_pixbuf_set_aspect_ratio ()
retro_pixdata_copy, retro_pixdata_copy ()
retro_pixdata_free, retro_pixdata_free ()
retro_pixdata_get_aspect_ratio, retro_pixdata_get_aspect_ratio ()
retro_pixdata_get_height, retro_pixdata_get_height ()
retro_pixdata_get_width, retro_pixdata_get_width ()
retro_pixdata_load_gl_texture, retro_pixdata_load_gl_texture ()
retro_pixdata_to_pixbuf, retro_pixdata_to_pixbuf ()
RETRO_TYPE_CONTROLLER, RETRO_TYPE_CONTROLLER
RETRO_TYPE_CONTROLLER_ITERATOR, RETRO_TYPE_CONTROLLER_ITERATOR
RETRO_TYPE_CORE, RETRO_TYPE_CORE
RETRO_TYPE_CORE_DESCRIPTOR, RETRO_TYPE_CORE_DESCRIPTOR
RETRO_TYPE_CORE_VIEW, RETRO_TYPE_CORE_VIEW
RETRO_TYPE_KEY_JOYPAD_MAPPING, RETRO_TYPE_KEY_JOYPAD_MAPPING
RETRO_TYPE_MODULE_ITERATOR, RETRO_TYPE_MODULE_ITERATOR
RETRO_TYPE_MODULE_QUERY, RETRO_TYPE_MODULE_QUERY
RETRO_TYPE_OPTION, RETRO_TYPE_OPTION
RETRO_TYPE_OPTION_ITERATOR, RETRO_TYPE_OPTION_ITERATOR
retro_video_filter_from_string, retro_video_filter_from_string ()