From db4f7d1e6828e4b4d89584d585b2c3199bd39f7f Mon Sep 17 00:00:00 2001 From: Nathan Lovato Date: Wed, 7 Oct 2020 13:39:20 -0600 Subject: [PATCH] Merge Multi-threading and Optimization into a new Performance section Close #4112 --- classes/class_multimesh.rst | 2 +- classes/class_multimeshinstance.rst | 2 +- classes/class_mutex.rst | 2 +- classes/class_semaphore.rst | 2 +- classes/class_thread.rst | 2 +- classes/class_visualserver.rst | 2 +- index.rst | 3 +-- .../cpu_optimization.rst | 0 .../general_optimization.rst | 0 .../gpu_optimization.rst | 0 .../img/godot_profiler.png | Bin .../img/lights_overlap.png | Bin .../img/lights_separate.png | Bin .../img/overlap1.png | Bin .../img/overlap2.png | Bin .../img/scissoring.png | Bin .../img/valgrind.png | Bin .../{optimization => performance}/index.rst | 15 +++++++++++++-- .../optimizing_3d_performance.rst | 0 .../thread_safe_apis.rst | 0 .../using_multimesh.rst | 0 .../using_multiple_threads.rst | 0 .../using_servers.rst | 0 tutorials/threads/index.rst | 9 --------- 24 files changed, 20 insertions(+), 19 deletions(-) rename tutorials/{optimization => performance}/cpu_optimization.rst (100%) rename tutorials/{optimization => performance}/general_optimization.rst (100%) rename tutorials/{optimization => performance}/gpu_optimization.rst (100%) rename tutorials/{optimization => performance}/img/godot_profiler.png (100%) rename tutorials/{optimization => performance}/img/lights_overlap.png (100%) rename tutorials/{optimization => performance}/img/lights_separate.png (100%) rename tutorials/{optimization => performance}/img/overlap1.png (100%) rename tutorials/{optimization => performance}/img/overlap2.png (100%) rename tutorials/{optimization => performance}/img/scissoring.png (100%) rename tutorials/{optimization => performance}/img/valgrind.png (100%) rename tutorials/{optimization => performance}/index.rst (93%) rename tutorials/{optimization => performance}/optimizing_3d_performance.rst (100%) rename tutorials/{threads => performance}/thread_safe_apis.rst (100%) rename tutorials/{optimization => performance}/using_multimesh.rst (100%) rename tutorials/{threads => performance}/using_multiple_threads.rst (100%) rename tutorials/{optimization => performance}/using_servers.rst (100%) delete mode 100644 tutorials/threads/index.rst diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index 721cc4145..270237f41 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -29,7 +29,7 @@ Tutorials - :doc:`../tutorials/3d/vertex_animation/animating_thousands_of_fish` -- :doc:`../tutorials/optimization/using_multimesh` +- :doc:`../tutorials/performance/using_multimesh` Properties ---------- diff --git a/classes/class_multimeshinstance.rst b/classes/class_multimeshinstance.rst index b34702889..7dac638e2 100644 --- a/classes/class_multimeshinstance.rst +++ b/classes/class_multimeshinstance.rst @@ -27,7 +27,7 @@ Tutorials - :doc:`../tutorials/3d/using_multi_mesh_instance` -- :doc:`../tutorials/optimization/using_multimesh` +- :doc:`../tutorials/performance/using_multimesh` Properties ---------- diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index 570c3bfe3..a0974b813 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -21,7 +21,7 @@ A synchronization mutex (mutual exclusion). This is used to synchronize multiple Tutorials --------- -- :doc:`../tutorials/threads/using_multiple_threads` +- :doc:`../tutorials/performance/using_multiple_threads` Methods ------- diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index d28090888..0af8380be 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -21,7 +21,7 @@ A synchronization semaphore which can be used to synchronize multiple :ref:`Thre Tutorials --------- -- :doc:`../tutorials/threads/using_multiple_threads` +- :doc:`../tutorials/performance/using_multiple_threads` Methods ------- diff --git a/classes/class_thread.rst b/classes/class_thread.rst index 85cda0a48..746191864 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -21,7 +21,7 @@ A unit of execution in a process. Can run methods on :ref:`Object` Tutorials --------- -- :doc:`../tutorials/threads/using_multiple_threads` +- :doc:`../tutorials/performance/using_multiple_threads` Methods ------- diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index e92701e68..f4bac3a30 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -37,7 +37,7 @@ In 2D, all visible objects are some form of canvas item. In order to be visible, Tutorials --------- -- :doc:`../tutorials/optimization/using_servers` +- :doc:`../tutorials/performance/using_servers` Methods ------- diff --git a/index.rst b/index.rst index b4d8c8d3a..3bd3eb1a9 100644 --- a/index.rst +++ b/index.rst @@ -98,9 +98,8 @@ The main documentation for the site is organized into the following sections: tutorials/vr/index tutorials/plugins/index tutorials/platform/index - tutorials/threads/index tutorials/content/index - tutorials/optimization/index + tutorials/performance/index tutorials/misc/index tutorials/debug/index diff --git a/tutorials/optimization/cpu_optimization.rst b/tutorials/performance/cpu_optimization.rst similarity index 100% rename from tutorials/optimization/cpu_optimization.rst rename to tutorials/performance/cpu_optimization.rst diff --git a/tutorials/optimization/general_optimization.rst b/tutorials/performance/general_optimization.rst similarity index 100% rename from tutorials/optimization/general_optimization.rst rename to tutorials/performance/general_optimization.rst diff --git a/tutorials/optimization/gpu_optimization.rst b/tutorials/performance/gpu_optimization.rst similarity index 100% rename from tutorials/optimization/gpu_optimization.rst rename to tutorials/performance/gpu_optimization.rst diff --git a/tutorials/optimization/img/godot_profiler.png b/tutorials/performance/img/godot_profiler.png similarity index 100% rename from tutorials/optimization/img/godot_profiler.png rename to tutorials/performance/img/godot_profiler.png diff --git a/tutorials/optimization/img/lights_overlap.png b/tutorials/performance/img/lights_overlap.png similarity index 100% rename from tutorials/optimization/img/lights_overlap.png rename to tutorials/performance/img/lights_overlap.png diff --git a/tutorials/optimization/img/lights_separate.png b/tutorials/performance/img/lights_separate.png similarity index 100% rename from tutorials/optimization/img/lights_separate.png rename to tutorials/performance/img/lights_separate.png diff --git a/tutorials/optimization/img/overlap1.png b/tutorials/performance/img/overlap1.png similarity index 100% rename from tutorials/optimization/img/overlap1.png rename to tutorials/performance/img/overlap1.png diff --git a/tutorials/optimization/img/overlap2.png b/tutorials/performance/img/overlap2.png similarity index 100% rename from tutorials/optimization/img/overlap2.png rename to tutorials/performance/img/overlap2.png diff --git a/tutorials/optimization/img/scissoring.png b/tutorials/performance/img/scissoring.png similarity index 100% rename from tutorials/optimization/img/scissoring.png rename to tutorials/performance/img/scissoring.png diff --git a/tutorials/optimization/img/valgrind.png b/tutorials/performance/img/valgrind.png similarity index 100% rename from tutorials/optimization/img/valgrind.png rename to tutorials/performance/img/valgrind.png diff --git a/tutorials/optimization/index.rst b/tutorials/performance/index.rst similarity index 93% rename from tutorials/optimization/index.rst rename to tutorials/performance/index.rst index 605d6e550..9af63ae0e 100644 --- a/tutorials/optimization/index.rst +++ b/tutorials/performance/index.rst @@ -1,5 +1,5 @@ -Optimization -============= +Performance +=========== Introduction ------------ @@ -74,3 +74,14 @@ GPU :name: toc-learn-features-3d-optimization optimizing_3d_performance + + +Threads +------- + +.. toctree:: + :maxdepth: 1 + :name: toc-learn-features-threads + + using_multiple_threads + thread_safe_apis diff --git a/tutorials/optimization/optimizing_3d_performance.rst b/tutorials/performance/optimizing_3d_performance.rst similarity index 100% rename from tutorials/optimization/optimizing_3d_performance.rst rename to tutorials/performance/optimizing_3d_performance.rst diff --git a/tutorials/threads/thread_safe_apis.rst b/tutorials/performance/thread_safe_apis.rst similarity index 100% rename from tutorials/threads/thread_safe_apis.rst rename to tutorials/performance/thread_safe_apis.rst diff --git a/tutorials/optimization/using_multimesh.rst b/tutorials/performance/using_multimesh.rst similarity index 100% rename from tutorials/optimization/using_multimesh.rst rename to tutorials/performance/using_multimesh.rst diff --git a/tutorials/threads/using_multiple_threads.rst b/tutorials/performance/using_multiple_threads.rst similarity index 100% rename from tutorials/threads/using_multiple_threads.rst rename to tutorials/performance/using_multiple_threads.rst diff --git a/tutorials/optimization/using_servers.rst b/tutorials/performance/using_servers.rst similarity index 100% rename from tutorials/optimization/using_servers.rst rename to tutorials/performance/using_servers.rst diff --git a/tutorials/threads/index.rst b/tutorials/threads/index.rst deleted file mode 100644 index aafd4f6bd..000000000 --- a/tutorials/threads/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -Multi-threading -=============== - -.. toctree:: - :maxdepth: 1 - :name: toc-learn-features-threads - - using_multiple_threads - thread_safe_apis