Struct OS

pub struct OS { /* private fields */ }

core singleton class OS inherits Object (unsafe).

Official documentation

See the documentation of this class in the Godot engine’s official documentation.

Feature flag

This type is behind the gdnative crate’s common feature flag.

Class hierarchy

OS inherits methods from:

• Object

Implementations

impl OS

pub fn godot_singleton() -> Self

pub fn set_clipboard(&mut self, clipboard: GodotString)

pub fn get_clipboard(&self) -> GodotString

pub fn get_video_driver_count(&self) -> i64

pub fn get_video_driver_name(&self, driver: i64) -> GodotString

pub fn get_audio_driver_count(&self) -> i64

pub fn get_audio_driver_name(&self, driver: i64) -> GodotString

pub fn get_connected_midi_inputs(&mut self) -> StringArray

pub fn get_screen_count(&self) -> i64

pub fn get_current_screen(&self) -> i64

pub fn set_current_screen(&mut self, screen: i64)

pub fn get_screen_position(&self, screen: i64) -> Vector2

pub fn get_screen_size(&self, screen: i64) -> Vector2

pub fn get_screen_dpi(&self, screen: i64) -> i64

pub fn get_window_position(&self) -> Vector2

pub fn set_window_position(&mut self, position: Vector2)

pub fn get_window_size(&self) -> Vector2

pub fn set_window_size(&mut self, size: Vector2)

pub fn get_window_safe_area(&self) -> Rect2

pub fn set_window_fullscreen(&mut self, enabled: bool)

pub fn is_window_fullscreen(&self) -> bool

pub fn set_window_resizable(&mut self, enabled: bool)

pub fn is_window_resizable(&self) -> bool

pub fn set_window_minimized(&mut self, enabled: bool)

pub fn is_window_minimized(&self) -> bool

pub fn set_window_maximized(&mut self, enabled: bool)

pub fn is_window_maximized(&self) -> bool

pub fn set_window_always_on_top(&mut self, enabled: bool)

pub fn is_window_always_on_top(&self) -> bool

pub fn request_attention(&mut self)

pub fn get_real_window_size(&self) -> Vector2

pub fn center_window(&mut self)

pub fn set_borderless_window(&mut self, borderless: bool)

pub fn get_borderless_window(&self) -> bool

pub fn get_window_per_pixel_transparency_enabled(&self) -> bool

pub fn set_window_per_pixel_transparency_enabled(&mut self, enabled: bool)

pub fn set_ime_position(&mut self, position: Vector2)

pub fn set_screen_orientation(&mut self, orientation: i64)

pub fn get_screen_orientation(&self) -> OSScreenOrientation

pub fn set_keep_screen_on(&mut self, enabled: bool)

pub fn is_keep_screen_on(&self) -> bool

pub fn has_touchscreen_ui_hint(&self) -> bool

pub fn set_window_title(&mut self, title: GodotString)

pub fn set_low_processor_usage_mode(&mut self, enable: bool)

pub fn is_in_low_processor_usage_mode(&self) -> bool

pub fn get_processor_count(&self) -> i64

pub fn get_executable_path(&self) -> GodotString

pub fn execute( &mut self, path: GodotString, arguments: StringArray, blocking: bool, output: VariantArray, ) -> i64

pub fn kill(&mut self, pid: i64) -> GodotResult

pub fn shell_open(&mut self, uri: GodotString) -> GodotResult

pub fn get_process_id(&self) -> i64

pub fn get_environment(&self, environment: GodotString) -> GodotString

pub fn has_environment(&self, environment: GodotString) -> bool

pub fn get_name(&self) -> GodotString

pub fn get_cmdline_args(&mut self) -> StringArray

pub fn get_datetime(&self, utc: bool) -> Dictionary

pub fn get_date(&self, utc: bool) -> Dictionary

pub fn get_time(&self, utc: bool) -> Dictionary

pub fn get_time_zone_info(&self) -> Dictionary

pub fn get_unix_time(&self) -> i64

pub fn get_datetime_from_unix_time(&self, unix_time_val: i64) -> Dictionary

pub fn get_unix_time_from_datetime(&self, datetime: Dictionary) -> i64

pub fn get_system_time_secs(&self) -> i64

pub fn set_icon(&mut self, icon: Option<Image>)

pub fn get_exit_code(&self) -> i64

pub fn set_exit_code(&mut self, code: i64)

pub fn delay_usec(&self, usec: i64)

pub fn delay_msec(&self, msec: i64)

pub fn get_ticks_msec(&self) -> i64

pub fn get_ticks_usec(&self) -> i64

pub fn get_splash_tick_msec(&self) -> i64

pub fn get_locale(&self) -> GodotString

pub fn get_latin_keyboard_variant(&self) -> GodotString

pub fn get_model_name(&self) -> GodotString

pub fn can_draw(&self) -> bool

pub fn is_userfs_persistent(&self) -> bool

pub fn is_stdout_verbose(&self) -> bool

pub fn can_use_threads(&self) -> bool

pub fn is_debug_build(&self) -> bool

pub fn dump_memory_to_file(&mut self, file: GodotString)

pub fn dump_resources_to_file(&mut self, file: GodotString)

pub fn has_virtual_keyboard(&self) -> bool

pub fn show_virtual_keyboard(&mut self, existing_text: GodotString)

pub fn hide_virtual_keyboard(&mut self)

pub fn get_virtual_keyboard_height(&mut self) -> i64

pub fn print_resources_in_use(&mut self, short: bool)

pub fn print_all_resources(&mut self, tofile: GodotString)

pub fn get_static_memory_usage(&self) -> i64

pub fn get_static_memory_peak_usage(&self) -> i64

pub fn get_dynamic_memory_usage(&self) -> i64

pub fn get_user_data_dir(&self) -> GodotString

pub fn get_system_dir(&self, dir: i64) -> GodotString

pub fn get_unique_id(&self) -> GodotString

pub fn is_ok_left_and_cancel_right(&self) -> bool

pub fn print_all_textures_by_size(&mut self)

pub fn print_resources_by_type(&mut self, types: StringArray)

pub fn native_video_play( &mut self, path: GodotString, volume: f64, audio_track: GodotString, subtitle_track: GodotString, ) -> GodotResult

pub fn native_video_is_playing(&mut self) -> bool

pub fn native_video_stop(&mut self)

pub fn native_video_pause(&mut self)

pub fn native_video_unpause(&mut self)

pub fn get_scancode_string(&self, code: i64) -> GodotString

pub fn is_scancode_unicode(&self, code: i64) -> bool

pub fn find_scancode_from_string(&self, string: GodotString) -> i64

pub fn set_use_file_access_save_and_swap(&mut self, enabled: bool)

pub fn alert(&mut self, text: GodotString, title: GodotString)

pub fn set_thread_name(&mut self, name: GodotString) -> GodotResult

pub fn set_use_vsync(&mut self, enable: bool)

pub fn is_vsync_enabled(&self) -> bool

pub fn has_feature(&self, tag_name: GodotString) -> bool

pub fn get_power_state(&mut self) -> OSPowerState

pub fn get_power_seconds_left(&mut self) -> i64

pub fn get_power_percent_left(&mut self) -> i64

pub fn _notification(&mut self, what: i64)

Inherited from Object.

pub fn _set(&mut self, property: GodotString, value: Variant) -> bool

Inherited from Object.

pub fn _get(&mut self, property: GodotString) -> Variant

Inherited from Object.

pub fn _get_property_list(&mut self) -> VariantArray

Inherited from Object.

pub fn _init(&mut self)

Inherited from Object.

pub fn get_class(&self) -> GodotString

Inherited from Object.

pub fn is_class(&self, _type: GodotString) -> bool

Inherited from Object.

pub fn set(&mut self, property: GodotString, value: Variant)

Inherited from Object.

pub fn get(&self, property: GodotString) -> Variant

Inherited from Object.

pub fn set_indexed(&mut self, property: NodePath, value: Variant)

Inherited from Object.

pub fn get_indexed(&self, property: NodePath) -> Variant

Inherited from Object.

pub fn get_property_list(&self) -> VariantArray

Inherited from Object.

pub fn get_method_list(&self) -> VariantArray

Inherited from Object.

pub fn notification(&mut self, what: i64, reversed: bool)

Inherited from Object.

pub fn get_instance_id(&self) -> i64

Inherited from Object.

pub fn set_script(&mut self, script: Option<Reference>)

Inherited from Object.

pub fn get_script(&self) -> Option<Reference>

Inherited from Object.

pub fn set_meta(&mut self, name: GodotString, value: Variant)

Inherited from Object.

pub fn get_meta(&self, name: GodotString) -> Variant

Inherited from Object.

pub fn has_meta(&self, name: GodotString) -> bool

Inherited from Object.

pub fn get_meta_list(&self) -> StringArray

Inherited from Object.

pub fn add_user_signal(&mut self, signal: GodotString, arguments: VariantArray)

Inherited from Object.

pub fn has_user_signal(&self, signal: GodotString) -> bool

Inherited from Object.

pub fn emit_signal( &mut self, signal: GodotString, varargs: &[Variant], ) -> Variant

Inherited from Object.

pub fn call(&mut self, method: GodotString, varargs: &[Variant]) -> Variant

Inherited from Object.

pub fn call_deferred( &mut self, method: GodotString, varargs: &[Variant], ) -> Variant

Inherited from Object.

pub fn callv(&mut self, method: GodotString, arg_array: VariantArray) -> Variant

Inherited from Object.

pub fn has_method(&self, method: GodotString) -> bool

Inherited from Object.

pub fn get_signal_list(&self) -> VariantArray

Inherited from Object.

pub fn get_signal_connection_list(&self, signal: GodotString) -> VariantArray

Inherited from Object.

pub fn get_incoming_connections(&self) -> VariantArray

Inherited from Object.

pub fn connect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, binds: VariantArray, flags: i64, ) -> GodotResult

Inherited from Object.

pub fn disconnect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, )

Inherited from Object.

pub fn is_connected( &self, signal: GodotString, target: Option<Object>, method: GodotString, ) -> bool

Inherited from Object.

pub fn set_block_signals(&mut self, enable: bool)

Inherited from Object.

pub fn is_blocking_signals(&self) -> bool

Inherited from Object.

pub fn property_list_changed_notify(&mut self)

Inherited from Object.

pub fn set_message_translation(&mut self, enable: bool)

Inherited from Object.

pub fn can_translate_messages(&self) -> bool

Inherited from Object.

pub fn tr(&self, message: GodotString) -> GodotString

Inherited from Object.

pub fn is_queued_for_deletion(&self) -> bool

Inherited from Object.

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations

impl Clone for OS

fn clone(&self) -> OS

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OS

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl GodotObject for OS

fn class_name() -> &'static str

impl ToVariant for OS

fn to_variant(&self) -> Variant

fn from_variant(variant: &Variant) -> Option<Self>

impl Copy for OS