class_os

OS

####Inherits: Object ####Category: Core

Brief Description

Operating System functions.

Member Functions

void set_clipboard ( String clipboard )
String get_clipboard ( ) const
void set_video_mode ( Vector2 size, bool fullscreen, bool resizable, int screen=0 )
Vector2 get_video_mode_size ( int screen=0 ) const
bool is_video_mode_fullscreen ( int screen=0 ) const
bool is_video_mode_resizable ( int screen=0 ) const
Array get_fullscreen_mode_list ( int screen=0 ) const
int get_screen_count ( ) const
int get_current_screen ( ) const
void set_current_screen ( int screen )
Vector2 get_screen_position ( int screen=0 ) const
Vector2 get_screen_size ( int screen=0 ) const
Vector2 get_window_position ( ) const
void set_window_position ( Vector2 position )
Vector2 get_window_size ( ) const
void set_window_size ( Vector2 size )
void set_window_fullscreen ( bool enabled )
bool is_window_fullscreen ( ) const
void set_window_resizable ( bool enabled )
bool is_window_resizable ( ) const
void set_window_minimized ( bool enabled )
bool is_window_minimized ( ) const
void set_window_maximized ( bool enabled )
bool is_window_maximized ( ) const
void set_iterations_per_second ( int iterations_per_second )
int get_iterations_per_second ( ) const
void set_target_fps ( int target_fps )
float get_target_fps ( ) const
void set_time_scale ( float time_scale )
float get_time_scale ( )
bool has_touchscreen_ui_hint ( ) const
void set_window_title ( String title )
void set_low_processor_usage_mode ( bool enable )
bool is_in_low_processor_usage_mode ( ) const
int get_processor_count ( ) const
String get_executable_path ( ) const
int execute ( String path, StringArray arguments, bool blocking, Array output=Array() )
int kill ( int pid )
int shell_open ( String uri )
int get_process_ID ( ) const
String get_environment ( String environment ) const
bool has_environment ( String environment ) const
String get_name ( ) const
StringArray get_cmdline_args ( )
Object get_main_loop ( ) const
Dictionary get_date ( ) const
Dictionary get_time ( ) const
int get_unix_time ( ) const
void set_icon ( Image arg0 )
void delay_usec ( int usec ) const
void delay_msec ( int msec ) const
int get_ticks_msec ( ) const
int get_splash_tick_msec ( ) const
String get_locale ( ) const
String get_model_name ( ) const
String get_custom_level ( ) const
bool can_draw ( ) const
int get_frames_drawn ( )
bool is_stdout_verbose ( ) const
bool can_use_threads ( ) const
bool is_debug_build ( ) const
void dump_memory_to_file ( String file )
void dump_resources_to_file ( String file )
void print_resources_in_use ( bool short=false )
void print_all_resources ( String tofile="" )
int get_static_memory_usage ( ) const
int get_static_memory_peak_usage ( ) const
int get_dynamic_memory_usage ( ) const
String get_data_dir ( ) const
String get_system_dir ( int dir ) const
String get_unique_ID ( ) const
bool is_ok_left_and_cancel_right ( ) const
float get_frames_per_second ( ) const
void print_all_textures_by_size ( )
void print_resources_by_type ( StringArray arg0 )
int native_video_play ( String arg0, float arg1, String arg2, String arg3 )
bool native_video_is_playing ( )
void native_video_stop ( )
void native_video_pause ( )
String get_scancode_string ( int code ) const
bool is_scancode_unicode ( int code ) const
int find_scancode_from_string ( String string ) const
void set_use_file_access_save_and_swap ( bool enabled )

Numeric Constants

DAY_SUNDAY = 0
DAY_MONDAY = 1
DAY_TUESDAY = 2
DAY_WEDNESDAY = 3
DAY_THURSDAY = 4
DAY_FRIDAY = 5
DAY_SATURDAY = 6
MONTH_JANUARY = 0
MONTH_FEBRUARY = 1
MONTH_MARCH = 2
MONTH_APRIL = 3
MONTH_MAY = 4
MONTH_JUNE = 5
MONTH_JULY = 6
MONTH_AUGUST = 7
MONTH_SEPTEMBER = 8
MONTH_OCTOBER = 9
MONTH_NOVEMBER = 10
MONTH_DECEMBER = 11
SYSTEM_DIR_DESKTOP = 0
SYSTEM_DIR_DCIM = 1
SYSTEM_DIR_DOCUMENTS = 2
SYSTEM_DIR_DOWNLOADS = 3
SYSTEM_DIR_MOVIES = 4
SYSTEM_DIR_MUSIC = 5
SYSTEM_DIR_PICTURES = 6
SYSTEM_DIR_RINGTONES = 7

Description

Operating System functions. OS Wraps the most common functionality to communicate with the host Operating System, such as: -Mouse Grabbing -Mouse Cursors
-Clipboard -Video Mode -Date " Time -Timers
-Environment Variables -Execution of Binaries -Command Line

Member Function Description

set_clipboard

void set_clipboard ( String clipboard )

Set clipboard to the OS.

get_clipboard

String get_clipboard ( ) const

Get clipboard from the host OS.

set_video_mode

void set_video_mode ( Vector2 size, bool fullscreen, bool resizable, int screen=0 )

Change the video mode.

get_video_mode_size

Vector2 get_video_mode_size ( int screen=0 ) const

Return the current video mode size.

is_video_mode_fullscreen

bool is_video_mode_fullscreen ( int screen=0 ) const

Return true if the current video mode is fullscreen.

is_video_mode_resizable

bool is_video_mode_resizable ( int screen=0 ) const

Return true if the window is resizable.

get_fullscreen_mode_list

Array get_fullscreen_mode_list ( int screen=0 ) const

Return the list of fullscreen modes.

set_iterations_per_second

void set_iterations_per_second ( int iterations_per_second )

Set the amount of fixed iterations per second (for fixed process and physics).

get_iterations_per_second

int get_iterations_per_second ( ) const

Return the amount of fixed iterations per second (for fixed process and physics).

set_low_processor_usage_mode

void set_low_processor_usage_mode ( bool enable )

Set to true to enable the low cpu usage mode. In this mode, the screen only redraws when there are changes, and a considerable sleep time is inserted between frames. This way, editors using the engine UI only use very little cpu.