Struct rust_libretro_sys::retro_core_option_v2_definition

source · [−]

#[repr(C)]pub struct retro_core_option_v2_definition {
    pub key: *const c_char,
    pub desc: *const c_char,
    pub desc_categorized: *const c_char,
    pub info: *const c_char,
    pub info_categorized: *const c_char,
    pub category_key: *const c_char,
    pub values: [retro_core_option_value; 128],
    pub default_value: *const c_char,
}

Fields

key: *const c_char

Variable to query in RETRO_ENVIRONMENT_GET_VARIABLE. Valid key characters are [a-z, A-Z, 0-9, _, -]

desc: *const c_char

Human-readable core option description

Used as menu label when frontend does not have core option category support e.g. “Video > Aspect Ratio”

desc_categorized: *const c_char

Human-readable core option description

Used as menu label when frontend has core option category support e.g. “Aspect Ratio”, where associated retro_core_option_v2_category::desc is “Video” If empty or NULL, the string specified by desc will be used as the menu label Will be ignored (and may be set to NULL) if category_key is empty or NULL

info: *const c_char

Human-readable core option information

Used as menu sublabel

info_categorized: *const c_char

Human-readable core option information

Used as menu sublabel when frontend has core option category support (e.g. may be required when info text references an option by name/desc, and the desc/desc_categorized text for that option differ) If empty or NULL, the string specified by info will be used as the menu sublabel Will be ignored (and may be set to NULL) if category_key is empty or NULL

category_key: *const c_char

Variable specifying category (e.g. “video”, “audio”) that will be assigned to the option if frontend has core option category support.

Categorized options will be displayed in a subsection/submenu of the frontend core option interface Specified string must match one of the retro_core_option_v2_category::key values in the associated retro_core_option_v2_category array; If no match is not found, specified string will be considered as NULL If specified string is empty or NULL, option will have no category and will be shown at the top level of the frontend core option interface

values: [retro_core_option_value; 128]

Array of retro_core_option_value structs, terminated by NULL

default_value: *const c_char

Default core option value. Must match one of the values in the retro_core_option_value array, otherwise will be ignored