godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
81fd48eb1e
godot/core/os/os.h

514 lines
17 KiB
C++
Raw Normal View History

Remove get_default_video_mode definition on OSX/iOS It had been missed in d09160a8b67fdc60e8108962c4e9bd4c0bc7f13e and broke compilation for those platforms. Took the opportunity to run clang-format on the code base to fix some corner cases that went through our static tests/were overlooked recently.
2017-11-09 22:36:08 +00:00
/*************************************************************************/
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* os.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
Use HTTPS URL for Godot's website in the headers
2017-08-27 12:16:55 +00:00
/* https://godotengine.org */
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/*************************************************************************/
Update copyright statements to 2018 Happy new year to the wonderful Godot community!
2018-01-01 13:40:08 +00:00
/* Copyright (c) 2007-2018 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2018 Godot Engine contributors (cf. AUTHORS.md) */
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
Add missing copyright headers and fix formatting Using `misc/scripts/fix_headers.py` on all Godot files. Some missing header guards were added, and the header inclusion order was fixed in the Bullet module.
2018-01-04 23:50:27 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#ifndef OS_H
#define OS_H
Created new Engine singleton, and moved engine related OS functions to it.
2017-01-13 15:51:14 +00:00
#include "engine.h"
Removal of Image from Variant, converted to a Resource.
2017-05-17 10:36:47 +00:00
#include "image.h"
Extract logging logic Previously logging logic was scattered over OS class implementations with plenty of duplication. Major changes in this commit: - Extracted logging logic into a separate Logger hierarchy. It allows easy configuration of logging mechanism depending on compile-time or run-time configuration. - Implemented RotatedFileLogger which is usually used with StdLogger, providing persistency of logs. It is often important to be able to obtain logs of the game even in production to be able to understand what happened prior to some problem. On mobile there previously was no way to obtain the logs aside from having the device connected to your machine. - flush() is not performed in release mode for every logged line. It is only performed for errors.
2017-09-22 05:56:02 +00:00
#include "io/logger.h"
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
#include "list.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#include "os/main_loop.h"
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
#include "ustring.h"
#include "vector.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#include <stdarg.h>
-WIP to add proper key swapping according to keyboard layout -fix with non working removal of collision exception in 3D physics
2015-01-05 00:16:40 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/**
@author Juan Linietsky <reduzio@gmail.com>
*/
Clean and expose get_audio/video_driver_* funcs on OS class
2018-03-04 17:18:05 +00:00
enum VideoDriver {
VIDEO_DRIVER_GLES3,
Reinstate WebGL 1.0 driver in HTML5 platform
2018-03-07 18:53:13 +00:00
VIDEO_DRIVER_GLES2,
VIDEO_DRIVER_MAX,
Clean and expose get_audio/video_driver_* funcs on OS class
2018-03-04 17:18:05 +00:00
};
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
class OS {
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
static OS *singleton;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
String _execpath;
List<String> _cmdline;
Add ability to set "keep screen on" for android
2015-11-27 14:40:04 +00:00
bool _keep_screen_on;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
bool low_processor_usage_mode;
Modified low processor sleep to 8000 and made it customizable (should be customizable for editor too)
2017-11-22 17:40:43 +00:00
int low_processor_usage_mode_sleep_usec;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
bool _verbose_stdout;
String _local_clipboard;
-Changed bootsplash option to use a file, fixes #1539 -Added OS.get_splash_tick_msec() to query when splash appeared
2015-04-12 20:55:01 +00:00
uint64_t _msec_splash;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
bool _no_window;
int _exit_code;
int _orientation;
-Some fixes to OSX retina scaling for window functions -Implemented HiDPI detection and support for Godot Editor!
2016-05-30 03:28:29 +00:00
bool _allow_hidpi;
Experimental support for windows with per-pixel transparency (macOS, X11 and Windows).
2017-12-10 18:38:26 +00:00
bool _allow_layered;
Add epic hack so vsync can be toggled in run-time from script. Fixes #14458. Call needs to be routed via visual server to reach the proper thread.
2017-12-16 20:09:25 +00:00
bool _use_vsync;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
char *last_error;
Add a way to retrieve stack bottom of the main thread I'm working on Nim bindings and Nim GC needs to know the stack boundaries to check whether certain pointers are located on the stack or in the heap. This commit adds godot_get_stack_bottom procedure to gdnative module which returns pointer to the stack bottom of the main thread. Later on this may be improved to return stack bottom of the current thread.
2017-07-19 11:49:19 +00:00
void *_stack_bottom;
Return and repair file logging And make it configurable, too.
2017-11-21 09:35:01 +00:00
CompositeLogger *_logger;
Extract logging logic Previously logging logic was scattered over OS class implementations with plenty of duplication. Major changes in this commit: - Extracted logging logic into a separate Logger hierarchy. It allows easy configuration of logging mechanism depending on compile-time or run-time configuration. - Implemented RotatedFileLogger which is usually used with StdLogger, providing persistency of logs. It is often important to be able to obtain logs of the game even in production to be able to understand what happened prior to some problem. On mobile there previously was no way to obtain the logs aside from having the device connected to your machine. - flush() is not performed in release mode for every logged line. It is only performed for errors.
2017-09-22 05:56:02 +00:00
-Project/Editor settings now use new inspector -Project/Editor settings now show tooltips properly -Settings thar require restart now will show a restart warning -Video driver is now visible all the time, can be changed easily -Added function to request current video driver
2018-07-19 21:58:15 +00:00
bool restart_on_exit;
List<String> restart_commandline;
Extract logging logic Previously logging logic was scattered over OS class implementations with plenty of duplication. Major changes in this commit: - Extracted logging logic into a separate Logger hierarchy. It allows easy configuration of logging mechanism depending on compile-time or run-time configuration. - Implemented RotatedFileLogger which is usually used with StdLogger, providing persistency of logs. It is often important to be able to obtain logs of the game even in production to be able to understand what happened prior to some problem. On mobile there previously was no way to obtain the logs aside from having the device connected to your machine. - flush() is not performed in release mode for every logged line. It is only performed for errors.
2017-09-22 05:56:02 +00:00
protected:
Return and repair file logging And make it configurable, too.
2017-11-21 09:35:01 +00:00
void _set_logger(CompositeLogger *p_logger);
Extract logging logic Previously logging logic was scattered over OS class implementations with plenty of duplication. Major changes in this commit: - Extracted logging logic into a separate Logger hierarchy. It allows easy configuration of logging mechanism depending on compile-time or run-time configuration. - Implemented RotatedFileLogger which is usually used with StdLogger, providing persistency of logs. It is often important to be able to obtain logs of the game even in production to be able to understand what happened prior to some problem. On mobile there previously was no way to obtain the logs aside from having the device connected to your machine. - flush() is not performed in release mode for every logged line. It is only performed for errors.
2017-09-22 05:56:02 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
public:
Implement NSTextInputClient protocol for IME
2017-08-07 11:09:56 +00:00
typedef void (*ImeCallback)(void *p_inp, String p_text, Point2 p_selection);
Fix enums bindings Add missed bindings for enums Move some enums to class to have correct output of api.json
2017-09-12 19:09:06 +00:00
enum PowerState {
POWERSTATE_UNKNOWN, /**< cannot determine power status */
POWERSTATE_ON_BATTERY, /**< Not plugged in, running on the battery */
POWERSTATE_NO_BATTERY, /**< Plugged in, no battery available */
POWERSTATE_CHARGING, /**< Plugged in, charging battery */
POWERSTATE_CHARGED /**< Plugged in, battery charged */
};
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
enum RenderThreadMode {
RENDER_THREAD_UNSAFE,
RENDER_THREAD_SAFE,
RENDER_SEPARATE_THREAD
};
struct VideoMode {
remove trailing whitespace
2016-03-08 23:00:52 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
int width, height;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
bool fullscreen;
bool resizable;
Borderless window support for the Win32 build. Default window position is now also centred.
2016-01-03 04:18:28 +00:00
bool borderless_window;
Fix x11 boot logo position in fullscreen and in maximized
2017-10-24 19:35:28 +00:00
bool maximized;
Add new window setting: always on top Implemented for Windows and Linux.
2017-12-27 19:51:19 +00:00
bool always_on_top;
Fixes vsync setting ignored when using a separate thread for rendering Setting the vsync in the main thread, after the rendering thread starts and takes the OpenGL context fails, so we need to do that before. Also, for some reason, the main thread cannot make current the context anymore. Fixes #13447
2017-12-08 16:58:28 +00:00
bool use_vsync;
Experimental support for windows with per-pixel transparency (macOS, X11 and Windows).
2017-12-10 18:38:26 +00:00
bool layered_splash;
bool layered;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
float get_aspect() const { return (float)width / (float)height; }
Add new window setting: always on top Implemented for Windows and Linux.
2017-12-27 19:51:19 +00:00
VideoMode(int p_width = 1024, int p_height = 600, bool p_fullscreen = false, bool p_resizable = true, bool p_borderless_window = false, bool p_maximized = false, bool p_always_on_top = false, bool p_use_vsync = false) {
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
width = p_width;
height = p_height;
fullscreen = p_fullscreen;
resizable = p_resizable;
borderless_window = p_borderless_window;
Fix x11 boot logo position in fullscreen and in maximized
2017-10-24 19:35:28 +00:00
maximized = p_maximized;
Add new window setting: always on top Implemented for Windows and Linux.
2017-12-27 19:51:19 +00:00
always_on_top = p_always_on_top;
Fixes vsync setting ignored when using a separate thread for rendering Setting the vsync in the main thread, after the rendering thread starts and takes the OpenGL context fails, so we need to do that before. Also, for some reason, the main thread cannot make current the context anymore. Fixes #13447
2017-12-08 16:58:28 +00:00
use_vsync = p_use_vsync;
Experimental support for windows with per-pixel transparency (macOS, X11 and Windows).
2017-12-10 18:38:26 +00:00
layered = false;
layered_splash = false;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
protected:
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
friend class Main;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
RenderThreadMode _render_thread_mode;
// functions used by main to initialize/deintialize the OS
Return and repair file logging And make it configurable, too.
2017-11-21 09:35:01 +00:00
void add_logger(Logger *p_logger);
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void initialize_core() = 0;
Change OS::initialize signature to return Error (fix segfault on x11)
2018-01-03 17:26:44 +00:00
virtual Error initialize(const VideoMode &p_desired, int p_video_driver, int p_audio_driver) = 0;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void set_main_loop(MainLoop *p_main_loop) = 0;
virtual void delete_main_loop() = 0;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void finalize() = 0;
virtual void finalize_core() = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void set_cmdline(const char *p_execpath, const List<String> &p_args);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Rename OS::get_data_dir to OS::get_user_data_dir Will be needed to avoid confusion with system data path (XDG_DATA_HOME) and editor data dir in upcoming refactoring.
2017-11-17 14:25:22 +00:00
void _ensure_user_data_dir();
-Renamed GlobalConfig to ProjectSettings, makes more sense. -Added system for feature overrides, it's pretty cool :)
2017-07-19 20:00:46 +00:00
virtual bool _check_internal_feature_support(const String &p_feature) = 0;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
public:
typedef int64_t ProcessID;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
static OS *get_singleton();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Extract logging logic Previously logging logic was scattered over OS class implementations with plenty of duplication. Major changes in this commit: - Extracted logging logic into a separate Logger hierarchy. It allows easy configuration of logging mechanism depending on compile-time or run-time configuration. - Implemented RotatedFileLogger which is usually used with StdLogger, providing persistency of logs. It is often important to be able to obtain logs of the game even in production to be able to understand what happened prior to some problem. On mobile there previously was no way to obtain the logs aside from having the device connected to your machine. - flush() is not performed in release mode for every logged line. It is only performed for errors.
2017-09-22 05:56:02 +00:00
void print_error(const char *p_function, const char *p_file, int p_line, const char *p_code, const char *p_rationale, Logger::ErrorType p_type = Logger::ERR_ERROR);
void print(const char *p_format, ...);
void printerr(const char *p_format, ...);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void alert(const String &p_alert, const String &p_title = "ALERT!") = 0;
virtual String get_stdin_string(bool p_block = true) = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void set_last_error(const char *p_error);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual const char *get_last_error() const;
virtual void clear_last_error();
enum MouseMode {
MOUSE_MODE_VISIBLE,
MOUSE_MODE_HIDDEN,
Added focus tracking in X11 and Windows classes, added new confined mouse mode (#7162)
2017-01-25 18:21:41 +00:00
MOUSE_MODE_CAPTURED,
MOUSE_MODE_CONFINED
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
virtual void set_mouse_mode(MouseMode p_mode);
virtual MouseMode get_mouse_mode() const;
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
virtual void warp_mouse_position(const Point2 &p_to) {}
Rename [gs]et_pos to [gs]et_position for Controls Control set_pos -> set_position Control set_global_pos -> set_global_position [gs]et_mouse_pos -> [gs]et_mouse_position [gs]et_global_mouse_pos -> [gs]et_global_mouse_position fixes #8005
2017-03-29 15:29:38 +00:00
virtual Point2 get_mouse_position() const = 0;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual int get_mouse_button_state() const = 0;
virtual void set_window_title(const String &p_title) = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void set_clipboard(const String &p_text);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual String get_clipboard() const;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void set_video_mode(const VideoMode &p_video_mode, int p_screen = 0) = 0;
virtual VideoMode get_video_mode(int p_screen = 0) const = 0;
virtual void get_fullscreen_mode_list(List<VideoMode> *p_list, int p_screen = 0) const = 0;
x11-fullscreen support through GDScript( OS.set_fullscreen(bool) )
2015-01-10 07:47:34 +00:00
Clean and expose get_audio/video_driver_* funcs on OS class
2018-03-04 17:18:05 +00:00
virtual int get_video_driver_count() const;
virtual const char *get_video_driver_name(int p_driver) const;
-Project/Editor settings now use new inspector -Project/Editor settings now show tooltips properly -Settings thar require restart now will show a restart warning -Video driver is now visible all the time, can be changed easily -Added function to request current video driver
2018-07-19 21:58:15 +00:00
virtual int get_current_video_driver() const = 0;
Clean and expose get_audio/video_driver_* funcs on OS class
2018-03-04 17:18:05 +00:00
virtual int get_audio_driver_count() const;
virtual const char *get_audio_driver_name(int p_driver) const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual int get_screen_count() const { return 1; }
fixes to new window management API -needs testing on Linux -needs testing on Windows -NEED SOMEONE TO IMPLEMENT IT ON OSX!! PLEASE HELP!
2015-03-22 22:00:50 +00:00
virtual int get_current_screen() const { return 0; }
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void set_current_screen(int p_screen) {}
p_screen param from get_screen_* funcs now default to the current screen
2017-08-20 19:12:29 +00:00
virtual Point2 get_screen_position(int p_screen = -1) const { return Point2(); }
virtual Size2 get_screen_size(int p_screen = -1) const { return get_window_size(); }
virtual int get_screen_dpi(int p_screen = -1) const { return 72; }
fixes to new window management API -needs testing on Linux -needs testing on Windows -NEED SOMEONE TO IMPLEMENT IT ON OSX!! PLEASE HELP!
2015-03-22 22:00:50 +00:00
virtual Point2 get_window_position() const { return Vector2(); }
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void set_window_position(const Point2 &p_position) {}
virtual Size2 get_window_size() const = 0;
Added OS::center_window to center the window precisely on desktop platforms
2018-02-12 17:17:29 +00:00
virtual Size2 get_real_window_size() const { return get_window_size(); }
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void set_window_size(const Size2 p_size) {}
fixes to new window management API -needs testing on Linux -needs testing on Windows -NEED SOMEONE TO IMPLEMENT IT ON OSX!! PLEASE HELP!
2015-03-22 22:00:50 +00:00
virtual void set_window_fullscreen(bool p_enabled) {}
virtual bool is_window_fullscreen() const { return true; }
virtual void set_window_resizable(bool p_enabled) {}
virtual bool is_window_resizable() const { return false; }
virtual void set_window_minimized(bool p_enabled) {}
virtual bool is_window_minimized() const { return false; }
virtual void set_window_maximized(bool p_enabled) {}
virtual bool is_window_maximized() const { return true; }
Add new window setting: always on top Implemented for Windows and Linux.
2017-12-27 19:51:19 +00:00
virtual void set_window_always_on_top(bool p_enabled) {}
virtual bool is_window_always_on_top() const { return false; }
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void request_attention() {}
Added OS::center_window to center the window precisely on desktop platforms
2018-02-12 17:17:29 +00:00
virtual void center_window();
fixes to new window management API -needs testing on Linux -needs testing on Windows -NEED SOMEONE TO IMPLEMENT IT ON OSX!! PLEASE HELP!
2015-03-22 22:00:50 +00:00
iPhone X support and iOS-related fixes Starting from April 2018 Apple no longer accepts apps that do not support iPhone X. For games this mainly means respecting the safe area, unobstructed by notch and virtual home button. UI controls must be placed within the safe area so that users can interact with them. This commit: - Adds OS::get_window_safe_area method that returns unobscured area of the window, where interactive controls should be rendered. - Reorganizes how launch screens are exported - the previous way was incorrect and modern iPhones did not pick up the correct screens and because of that used a non-native resolution to render the game. - Adds launch screen options for iPhone X. - Makes launch screens optional in the export template. If not specified, a white screen will be used. - Adds App Store icon (1024x1024) export option as it now has to be bundled with the app instead of being provided in iTunes Connect. - Fixes crash when launching games in iOS Simulator. It happened because controllerWasConnected callback came before the engine was initialized. Now in such case the controllers will be queued up and registered after initialization is done. - Fixes issue with the virtual keyboard where for some reason autocorrection panel would intersect with the keyboard itself and not allow you to use the top row of the keyboard. This is fixed by disabling autocorrection altogether. Closes #17358. Fixes #17428. Fixes #17331.
2018-04-10 10:35:30 +00:00
// Returns window area free of hardware controls and other obstacles.
// The application should use this to determine where to place UI elements.
//
// Keep in mind the area returned is in window coordinates rather than
// viewport coordinates - you should perform the conversion on your own.
//
// The maximum size of the area is Rect2(0, 0, window_size.width, window_size.height).
virtual Rect2 get_window_safe_area() const {
Size2 window_size = get_window_size();
return Rect2(0, 0, window_size.width, window_size.height);
}
Fix type mismatch in OS::set_borderless_window Closes #14663.
2017-12-14 18:15:46 +00:00
virtual void set_borderless_window(bool p_borderless) {}
Borderless window support for the Win32 build. Default window position is now also centred.
2016-01-03 04:18:28 +00:00
virtual bool get_borderless_window() { return 0; }
introduced the scons experimental_wm_api switch: ================================================ Usage: scons p=x11 experimental_wm_api=yes
2015-01-13 07:44:39 +00:00
Experimental support for windows with per-pixel transparency (macOS, X11 and Windows).
2017-12-10 18:38:26 +00:00
virtual bool get_window_per_pixel_transparency_enabled() const { return false; }
virtual void set_window_per_pixel_transparency_enabled(bool p_enabled) {}
virtual uint8_t *get_layered_buffer_data() { return NULL; }
virtual Size2 get_layered_buffer_size() { return Size2(0, 0); }
virtual void swap_layered_buffer() {}
IME context detection.
2018-06-07 20:16:57 +00:00
virtual void set_ime_active(const bool p_active) {}
IME window follow the input cursor. Abstruct set_ime_position to OS class. Update ime position for LineEdit and TextEdit.
2017-06-25 15:50:45 +00:00
virtual void set_ime_position(const Point2 &p_pos) {}
Implement NSTextInputClient protocol for IME
2017-08-07 11:09:56 +00:00
virtual void set_ime_intermediate_text_callback(ImeCallback p_callback, void *p_inp) {}
IME window follow the input cursor. Abstruct set_ime_position to OS class. Update ime position for LineEdit and TextEdit.
2017-06-25 15:50:45 +00:00
Style: Apply clang-format again on all files Fixes issues introduced by newer clang-format versions or commits pushed directly without using the clang-format pre-commit hook.
2017-12-06 18:54:22 +00:00
virtual Error open_dynamic_library(const String p_path, void *&p_library_handle, bool p_also_set_library_path = false) { return ERR_UNAVAILABLE; }
added an optional parameter to OS symbol lookup When looking up a symbol from a library, previously an error was shown when the symbol did not exist. That caused confusion when the lookup was completely optional. This adds a new parameter to that method so that those errors can be handled manually if needed.
2017-07-27 07:23:21 +00:00
virtual Error close_dynamic_library(void *p_library_handle) { return ERR_UNAVAILABLE; }
virtual Error get_dynamic_library_symbol_handle(void *p_library_handle, const String p_name, void *&p_symbol_handle, bool p_optional = false) { return ERR_UNAVAILABLE; }
Added methods for opening dynamic libraries to OS
2017-03-08 01:50:13 +00:00
Add ability to set "keep screen on" for android
2015-11-27 14:40:04 +00:00
virtual void set_keep_screen_on(bool p_enabled);
virtual bool is_keep_screen_on() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual void set_low_processor_usage_mode(bool p_enabled);
virtual bool is_in_low_processor_usage_mode() const;
Modified low processor sleep to 8000 and made it customizable (should be customizable for editor too)
2017-11-22 17:40:43 +00:00
virtual void set_low_processor_usage_mode_sleep_usec(int p_usec);
virtual int get_low_processor_usage_mode_sleep_usec() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual String get_executable_path() const;
OS::execute can now read from stderr too when executing with a pipe
2017-10-03 18:09:04 +00:00
virtual Error execute(const String &p_path, const List<String> &p_arguments, bool p_blocking, ProcessID *r_child_id = NULL, String *r_pipe = NULL, int *r_exitcode = NULL, bool read_stderr = false) = 0;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual Error kill(const ProcessID &p_pid) = 0;
Makes all Godot API's methods Lower Case
2017-08-07 10:17:31 +00:00
virtual int get_process_id() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual Error shell_open(String p_uri);
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual Error set_cwd(const String &p_cwd);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual bool has_environment(const String &p_var) const = 0;
virtual String get_environment(const String &p_var) const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual String get_name() = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual List<String> get_cmdline_args() const { return _cmdline; }
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual String get_model_name() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual MainLoop *get_main_loop() const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual void yield();
enum Weekday {
DAY_SUNDAY,
DAY_MONDAY,
DAY_TUESDAY,
DAY_WEDNESDAY,
DAY_THURSDAY,
DAY_FRIDAY,
DAY_SATURDAY
};
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
enum Month {
Fixes the month consistency issue in enums and get_date etc - Also updated the docs to reflect this. - Added some vim temp files to gitignore - Changed NaCL to be consistent with the other OS_Unix::get_date implementation (added 1 to month to map to 1-12) Ticket: https://github.com/godotengine/godot/issues/4025
2016-03-13 02:13:57 +00:00
/// Start at 1 to follow Windows SYSTEMTIME structure
/// https://msdn.microsoft.com/en-us/library/windows/desktop/ms724950(v=vs.85).aspx
MONTH_JANUARY = 1,
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
MONTH_FEBRUARY,
MONTH_MARCH,
MONTH_APRIL,
MONTH_MAY,
MONTH_JUNE,
MONTH_JULY,
MONTH_AUGUST,
MONTH_SEPTEMBER,
MONTH_OCTOBER,
MONTH_NOVEMBER,
MONTH_DECEMBER
};
struct Date {
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
int year;
Month month;
int day;
Weekday weekday;
bool dst;
};
struct Time {
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
int hour;
int min;
int sec;
};
Add OS.get_time_zone_info function The returned dictionary maps "name" to the name of the current time zone, and "bias" to a bias from UTC in minutes.
2015-06-06 03:35:38 +00:00
struct TimeZoneInfo {
int bias;
String name;
};
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual Date get_date(bool local = false) const = 0;
virtual Time get_time(bool local = false) const = 0;
virtual TimeZoneInfo get_time_zone_info() const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual uint64_t get_unix_time() const;
-Removed OS.get_system_time_msec(), this is undoable on Windows and also unusable from GDscript due to precision. -Added, instead an OS.get_system_time_secs(), which is 32 bits friendly, fixes #3143
2016-01-10 21:24:55 +00:00
virtual uint64_t get_system_time_secs() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void delay_usec(uint32_t p_usec) const = 0;
virtual uint64_t get_ticks_usec() const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
uint32_t get_ticks_msec() const;
-Changed bootsplash option to use a file, fixes #1539 -Added OS.get_splash_tick_msec() to query when splash appeared
2015-04-12 20:55:01 +00:00
uint64_t get_splash_tick_msec() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual bool can_draw() const = 0;
Add OS::is_userfs_persistent to check user:// persistence Allows starting HTML5 export when IndexedDB is not available.
2017-10-02 14:09:24 +00:00
virtual bool is_userfs_persistent() const { return true; }
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
bool is_stdout_verbose() const;
Added a crash handler to dump the backtrace on Windows, Linux and OS X
2017-09-08 01:01:49 +00:00
virtual void disable_crash_handler() {}
virtual bool is_disable_crash_handler() const { return false; }
Local debugger fixes and extensions - Adds q/quit option to console debugging - Adds options (variable_prefix) - Breaks into debugger with Ctrl-C in local debug mode (Unix/Windows) - Added option to list all breakpoints - Fixes add/remove breakpoint bug (invalid path parsing) - Minor cleanup
2018-02-11 11:08:37 +00:00
virtual void initialize_debugging() {}
Added a crash handler to dump the backtrace on Windows, Linux and OS X
2017-09-08 01:01:49 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
enum CursorShape {
CURSOR_ARROW,
CURSOR_IBEAM,
CURSOR_POINTING_HAND,
CURSOR_CROSS,
CURSOR_WAIT,
CURSOR_BUSY,
CURSOR_DRAG,
CURSOR_CAN_DROP,
CURSOR_FORBIDDEN,
CURSOR_VSIZE,
CURSOR_HSIZE,
CURSOR_BDIAGSIZE,
CURSOR_FDIAGSIZE,
CURSOR_MOVE,
CURSOR_VSPLIT,
CURSOR_HSPLIT,
CURSOR_HELP,
CURSOR_MAX
};
virtual bool has_virtual_keyboard() const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void show_virtual_keyboard(const String &p_existing_text, const Rect2 &p_screen_rect = Rect2());
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual void hide_virtual_keyboard();
Allow to obtain virtual keyboard height On mobile platforms virtual keyboards take up significant amount of screen space and UI containing a text box may need to be adjusted after the keyboard appears to keep the text box visible to user. This commit adds a way to obtain virtual keyabord height so that controls are aware of how much they need to move.
2017-10-04 08:39:31 +00:00
// returns height of the currently shown virtual keyboard (0 if keyboard is hidden)
virtual int get_virtual_keyboard_height() const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void set_cursor_shape(CursorShape p_shape) = 0;
Add implementation for custom hardware cursor
2017-11-10 10:50:11 +00:00
virtual void set_custom_mouse_cursor(const RES &p_cursor, CursorShape p_shape, const Vector2 &p_hotspot) = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual bool get_swap_ok_cancel() { return false; }
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void dump_memory_to_file(const char *p_file);
virtual void dump_resources_to_file(const char *p_file);
virtual void print_resources_in_use(bool p_short = false);
virtual void print_all_resources(String p_to_file = "");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual int get_static_memory_usage() const;
virtual int get_static_memory_peak_usage() const;
virtual int get_dynamic_memory_usage() const;
virtual int get_free_static_memory() const;
RenderThreadMode get_render_thread_mode() const { return _render_thread_mode; }
virtual String get_locale() const;
Allow customizing user:// path (folder in OS::get_data_path()) This allows to specify any valid folder name (including with subfolders) to use as user:// on all platforms. The folder is constrained to the platform-specific OS::get_data_path() (typically what `XDG_DATA_HOME` resolves to). Fixes #13236.
2017-11-26 18:00:53 +00:00
String get_safe_dir_name(const String &p_dir_name, bool p_allow_dir_separator = false) const;
Add initial support for the XDG Base Directory spec Spec version 0.7 from https://standards.freedesktop.org/basedir-spec/basedir-spec-0.7.html (latest as of this commit). Three virtual methods are added to OS for the various XDG paths we will use: - OS::get_data_path gives XDG_DATA_HOME, or if missing: ~/.local/share on X11, ~/Library/Application Support/ on macOS and %APPDATA% on Windows - OS::get_config_path gives XDG_CONFIG_HOME, or if missing: ~/.config on X11, ~/Library/Application Support/ on macOS and %APPDATA% on Windows - OS::get_cache_path gives XDG_CACHE_HOME, or if missing: ~/.cache on X11, ~/Library/Caches on macOS and %APPDATA% on Windows So for Windows there are no changes, for Linux we follow the full split spec and for macOS stuff will move from ~/.godot to ~/Library/Application Support/Godot. Support for system-wide installation of templates on Unix was removed for now, as it's a bit hackish and I don't think anyone uses it. user:// will still be OS::get_data_path() + "/godot/app_userdata/$name" by default, but when using the application/config/use_shared_user_dir option it will now use XDG_DATA_HOME/$name, e.g. ~/.local/share/MyGame. For now everything still goes in EditorSettings::get_settings_dir(), but this will be changed in a later commit to make use of the new splitting where relevant. Part of #3513.
2017-11-17 16:11:41 +00:00
virtual String get_godot_dir_name() const;
virtual String get_data_path() const;
virtual String get_config_path() const;
virtual String get_cache_path() const;
Rename OS::get_data_dir to OS::get_user_data_dir Will be needed to avoid confusion with system data path (XDG_DATA_HOME) and editor data dir in upcoming refactoring.
2017-11-17 14:25:22 +00:00
virtual String get_user_data_dir() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual String get_resource_dir() const;
-Ability to ask for documents/pictures/etc system dirs. -Fixes to animationplayer -fixes to collada importer
2014-12-02 17:02:41 +00:00
enum SystemDir {
SYSTEM_DIR_DESKTOP,
SYSTEM_DIR_DCIM,
SYSTEM_DIR_DOCUMENTS,
SYSTEM_DIR_DOWNLOADS,
SYSTEM_DIR_MOVIES,
SYSTEM_DIR_MUSIC,
SYSTEM_DIR_PICTURES,
SYSTEM_DIR_RINGTONES,
};
virtual String get_system_dir(SystemDir p_dir) const;
Add initial support for the XDG Base Directory spec Spec version 0.7 from https://standards.freedesktop.org/basedir-spec/basedir-spec-0.7.html (latest as of this commit). Three virtual methods are added to OS for the various XDG paths we will use: - OS::get_data_path gives XDG_DATA_HOME, or if missing: ~/.local/share on X11, ~/Library/Application Support/ on macOS and %APPDATA% on Windows - OS::get_config_path gives XDG_CONFIG_HOME, or if missing: ~/.config on X11, ~/Library/Application Support/ on macOS and %APPDATA% on Windows - OS::get_cache_path gives XDG_CACHE_HOME, or if missing: ~/.cache on X11, ~/Library/Caches on macOS and %APPDATA% on Windows So for Windows there are no changes, for Linux we follow the full split spec and for macOS stuff will move from ~/.godot to ~/Library/Application Support/Godot. Support for system-wide installation of templates on Unix was removed for now, as it's a bit hackish and I don't think anyone uses it. user:// will still be OS::get_data_path() + "/godot/app_userdata/$name" by default, but when using the application/config/use_shared_user_dir option it will now use XDG_DATA_HOME/$name, e.g. ~/.local/share/MyGame. For now everything still goes in EditorSettings::get_settings_dir(), but this will be changed in a later commit to make use of the new splitting where relevant. Part of #3513.
2017-11-17 16:11:41 +00:00
virtual Error move_to_trash(const String &p_path) { return FAILED; }
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual void set_no_window_mode(bool p_enable);
virtual bool is_no_window_mode_enabled() const;
virtual bool has_touchscreen_ui_hint() const;
enum ScreenOrientation {
SCREEN_LANDSCAPE,
SCREEN_PORTRAIT,
SCREEN_REVERSE_LANDSCAPE,
SCREEN_REVERSE_PORTRAIT,
SCREEN_SENSOR_LANDSCAPE,
SCREEN_SENSOR_PORTRAIT,
SCREEN_SENSOR,
};
virtual void set_screen_orientation(ScreenOrientation p_orientation);
ScreenOrientation get_screen_orientation() const;
Improve debug focus behavior Fix focusing debugged game on Windows Add re-focusing editor on continue
2016-09-14 02:02:18 +00:00
virtual void enable_for_stealing_focus(ProcessID pid) {}
OS: Add get_engine_version method Fixes #5693.
2016-07-14 22:34:56 +00:00
virtual void move_window_to_foreground() {}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual void debug_break();
virtual void release_rendering_thread();
virtual void make_rendering_thread();
virtual void swap_buffers();
Removal of Image from Variant, converted to a Resource.
2017-05-17 10:36:47 +00:00
virtual void set_icon(const Ref<Image> &p_icon);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual int get_exit_code() const;
virtual void set_exit_code(int p_code);
virtual int get_processor_count() const;
Makes all Godot API's methods Lower Case
2017-08-07 10:17:31 +00:00
virtual String get_unique_id() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
NavMesh -=-=-=- -Fixed NavMesh API -New NavMesh demo -Support for animated Particles2D -Fixes for native video playback on iOS
2014-11-17 10:46:11 +00:00
virtual Error native_video_play(String p_path, float p_volume, String p_audio_track, String p_subtitle_track);
-fix bug in cache for atlas import/export -fix some menus -fixed bug in out transition curves -detect and remove file:/// in collada -remove multiscript for now -remove dependencies on mouse in OS, moved to Input -avoid fscache from screwing up (fix might make it slower, but it works) -funcref was missing, it's there now
2014-03-14 01:57:24 +00:00
virtual bool native_video_is_playing() const;
-fixed export templates not loading/exporting on Windows -fixed TouchScreenButton with stretch2d -fixed(?) OSX crash on startup (test!!) -compilation fixes on windows -CollisionPolygon editor works again -find buttons en find dialog -TileMap editor cleanup (removed "error", made nicer) -viewport flicker fixed -make .scn default extension for saving scenes -export the rest of the network classes to gdscript
2014-02-13 21:03:28 +00:00
virtual void native_video_pause();
Reject any native video player calls on iOS that point to files within .pck archives. Fix the paths for both res:// and user:// specified video files.
2016-02-19 04:09:06 +00:00
virtual void native_video_unpause();
-fixed export templates not loading/exporting on Windows -fixed TouchScreenButton with stretch2d -fixed(?) OSX crash on startup (test!!) -compilation fixes on windows -CollisionPolygon editor works again -find buttons en find dialog -TileMap editor cleanup (removed "error", made nicer) -viewport flicker fixed -make .scn default extension for saving scenes -export the rest of the network classes to gdscript
2014-02-13 21:03:28 +00:00
virtual void native_video_stop();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
-fix bug in cache for atlas import/export -fix some menus -fixed bug in out transition curves -detect and remove file:/// in collada -remove multiscript for now -remove dependencies on mouse in OS, moved to Input -avoid fscache from screwing up (fix might make it slower, but it works) -funcref was missing, it's there now
2014-03-14 01:57:24 +00:00
virtual bool can_use_threads() const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual Error dialog_show(String p_title, String p_description, Vector<String> p_buttons, Object *p_obj, String p_callback);
virtual Error dialog_input_text(String p_title, String p_description, String p_partial, Object *p_obj, String p_callback);
Fixed too many little issues, check the issues closed today.
2014-09-21 04:43:42 +00:00
-WIP to add proper key swapping according to keyboard layout -fix with non working removal of collision exception in 3D physics
2015-01-05 00:16:40 +00:00
enum LatinKeyboardVariant {
LATIN_KEYBOARD_QWERTY,
LATIN_KEYBOARD_QWERTZ,
LATIN_KEYBOARD_AZERTY,
LATIN_KEYBOARD_QZERTY,
LATIN_KEYBOARD_DVORAK,
LATIN_KEYBOARD_NEO,
Add Colemak keybindings to editor for osx
2017-10-24 17:32:40 +00:00
LATIN_KEYBOARD_COLEMAK,
-WIP to add proper key swapping according to keyboard layout -fix with non working removal of collision exception in 3D physics
2015-01-05 00:16:40 +00:00
};
virtual LatinKeyboardVariant get_latin_keyboard_variant() const;
Add some joystick functions to input. Enables manipulation of mappings at runtime
2016-01-07 23:40:41 +00:00
virtual bool is_joy_known(int p_device);
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual String get_joy_guid(int p_device) const;
Add some joystick functions to input. Enables manipulation of mappings at runtime
2016-01-07 23:40:41 +00:00
x11: use different strings for WM_CLASS depending on context
2016-01-27 20:53:37 +00:00
enum EngineContext {
CONTEXT_EDITOR,
CONTEXT_PROJECTMAN,
};
virtual void set_context(int p_context);
Add epic hack so vsync can be toggled in run-time from script. Fixes #14458. Call needs to be routed via visual server to reach the proper thread.
2017-12-16 20:09:25 +00:00
//amazing hack because OpenGL needs this to be set on a separate thread..
//also core can't access servers, so a callback must be used
typedef void (*SwitchVSyncCallbackInThread)(bool);
static SwitchVSyncCallbackInThread switch_vsync_function;
void set_use_vsync(bool p_enable);
bool is_vsync_enabled() const;
//real, actual overridable function to switch vsync, which needs to be called from graphics thread if needed
virtual void _set_use_vsync(bool p_enable) {}
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
Fix enums bindings Add missed bindings for enums Move some enums to class to have correct output of api.json
2017-09-12 19:09:06 +00:00
virtual OS::PowerState get_power_state();
Add API to access battery power state Done: - X11, server (tested) - Windows (developed, would be nice to retest) - OSX (not tested) Prepared (not developed): - Android (code is here, but may not compile) - iphone - winrt - bb10 - haiku - javascript
2016-07-23 11:15:55 +00:00
virtual int get_power_seconds_left();
virtual int get_power_percent_left();
vsync support -works on windows -may not work on X11, if so please fix -OSX does not seem to support disabling vsync
2016-06-05 22:14:33 +00:00
-Add lightmapper -Fixes to unwrapper (remove degenerates), makes Thekla not crash -Added optional cancel button in EditorProgress -Added function to force processing of events (needed for cancel button)
2017-12-14 11:59:46 +00:00
virtual void force_process_input(){};
fixed the OS.has_feature() API, and added support for 32 and 64.
2017-10-02 19:38:39 +00:00
bool has_feature(const String &p_feature);
Several bugfixes, improving the import workflow
2017-02-06 03:38:39 +00:00
Experimental support for windows with per-pixel transparency (macOS, X11 and Windows).
2017-12-10 18:38:26 +00:00
bool is_layered_allowed() const { return _allow_layered; }
-Some fixes to OSX retina scaling for window functions -Implemented HiDPI detection and support for Godot Editor!
2016-05-30 03:28:29 +00:00
bool is_hidpi_allowed() const { return _allow_hidpi; }
-Project/Editor settings now use new inspector -Project/Editor settings now show tooltips properly -Settings thar require restart now will show a restart warning -Video driver is now visible all the time, can be changed easily -Added function to request current video driver
2018-07-19 21:58:15 +00:00
void set_restart_on_exit(bool p_restart, const List<String> &p_restart_arguments);
bool is_restart_on_exit_set() const;
Fix build issues and typos after c69de2ba4
2018-07-20 06:37:10 +00:00
List<String> get_restart_on_exit_arguments() const;
-Project/Editor settings now use new inspector -Project/Editor settings now show tooltips properly -Settings thar require restart now will show a restart warning -Video driver is now visible all the time, can be changed easily -Added function to request current video driver
2018-07-19 21:58:15 +00:00
remove trailing whitespace
2016-03-08 23:00:52 +00:00
OS();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual ~OS();
};
Fix enums bindings Add missed bindings for enums Move some enums to class to have correct output of api.json
2017-09-12 19:09:06 +00:00
VARIANT_ENUM_CAST(OS::PowerState);
fixed PowerState enum cast Quite a while ago I made a commit (131631b) where I did a weird thing to fix compilation with PTRCALL_ENABLED. And I couldn't sleep because of this after all these months. So here is the proper version.
2017-05-31 22:16:33 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#endif
Reference in New Issue Copy Permalink