summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2022-02-16 09:34:53 +0100
committerGitHub <noreply@github.com>2022-02-16 09:34:53 +0100
commitf6f1593db43219e337817463bc02ebce38d95838 (patch)
treeeb92fa07830d91965888042c0b36026194eae4ba /doc
parent7989149b917c096af67a0566398bee4de83993ac (diff)
parentee7cd9a3a14415722c1086a3bde02c2e4d0fd0eb (diff)
Merge pull request #44716 from Calinou/os-add-get-processor-name
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/OS.xml9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index 13a19206b3..bc9bfc9676 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -343,7 +343,14 @@
<method name="get_processor_count" qualifiers="const">
<return type="int" />
<description>
- Returns the number of threads available on the host machine.
+ Returns the number of [i]logical[/i] CPU cores available on the host machine. On CPUs with HyperThreading enabled, this number will be greater than the number of [i]physical[/i] CPU cores.
+ </description>
+ </method>
+ <method name="get_processor_name" qualifiers="const">
+ <return type="String" />
+ <description>
+ Returns the name of the CPU model on the host machine (e.g. "Intel(R) Core(TM) i7-6700K CPU @ 4.00GHz").
+ [b]Note:[/b] This method is only implemented on Windows, macOS, Linux and iOS. On Android, HTML5 and UWP, [method get_processor_name] returns an empty string.
</description>
</method>
<method name="get_static_memory_peak_usage" qualifiers="const">