Merge pull request #111 from Vertexwahn/spelling

Fix some spelling mistakes

CMakeLists.txt

@@ -67,7 +67,7 @@ option(ramses-sdk_ENABLE_FLATBUFFERS_GENERATION         "Enable generation of fl
 option(ramses-sdk_USE_IMAGEMAGICK                       "Enable tests depending on image magick compare" OFF)
 
 # find options
-option(ramses-sdk_ALLOW_PLATFORM_GLM                    "Enable to search for platform provided OpenGL Math libary (glm)." ON)
+option(ramses-sdk_ALLOW_PLATFORM_GLM                    "Enable to search for platform provided OpenGL Math library (glm)." ON)
 option(ramses-sdk_ALLOW_PLATFORM_FREETYPE               "Enable to search for platform provided freetype and harfbuzz." ON)
 option(ramses-sdk_ALLOW_CUSTOM_FREETYPE                 "Allow usage of custom freetype and harfbuzz if platform provided one was not found." ON)
 option(ramses-sdk_ALLOW_PLATFORM_LZ4                    "Enable to search for platform provided lz4" ON)

cmake/modules/FindEGL.cmake

@@ -9,7 +9,7 @@
 set( EGL_FOUND FALSE )
 
 if (CMAKE_SYSTEM_NAME MATCHES "Windows")
-    # Windows does not suppot EGL natively
+    # Windows does not support EGL natively
 
 elseif(CMAKE_SYSTEM_NAME MATCHES "Linux" OR CMAKE_SYSTEM_NAME MATCHES "Android")
     find_path(EGL_INCLUDE_DIRS EGL/egl.h

cmake/ramses/getGitInformation.cmake

@@ -6,7 +6,7 @@
 #  file, You can obtain one at https://mozilla.org/MPL/2.0/.
 #  -------------------------------------------------------------------------
 
-# use predefined values in dependant repositories
+# use predefined values in dependent repositories
 if (EXISTS "${PROJECT_SOURCE_DIR}/originalGitInformation.txt")
     file(READ "${PROJECT_SOURCE_DIR}/originalGitInformation.txt" GIT_INFO_FILE_CONTENT)
     string(REGEX REPLACE "\n" ";" GIT_INFO_FILE_CONTENT "${GIT_INFO_FILE_CONTENT}")
@@ -47,7 +47,7 @@ else()
 endif()
 
 if (NOT GIT_COMMIT_HASH OR NOT GIT_COMMIT_COUNT)
-    message(STATUS "Could not determin git info. Use default values.")
+    message(STATUS "Could not determine git info. Use default values.")
     set(GIT_COMMIT_HASH "(unknown)")
     set(GIT_COMMIT_COUNT "0")
 endif()

cmake/templates/ramses-shared-libTemplate.cmake.in

@@ -64,7 +64,7 @@ ELSEIF(${CMAKE_SYSTEM_NAME} STREQUAL "Android")
     )
 
 ELSE()
-    MESSAGE(FATAL_ERROR "Unsupported system: ${CMAKE_SYSTEM_NAME}, cant find shared lib")
+    MESSAGE(FATAL_ERROR "Unsupported system: ${CMAKE_SYSTEM_NAME}, can't find shared lib")
 ENDIF()
 
 

include/ramses/client/ArrayBuffer.h

@@ -68,7 +68,7 @@ namespace ramses
         * @brief Returns the used number of data elements.
         *
         * @details If data buffer fully set by #updateData, then used and maximum number of elements are equal. For #ArrayBuffer objects
-        *          of type #ramses::EDataType::ByteBlob this function returns the used size of buffer data in bytes becuase element is defined
+        *          of type #ramses::EDataType::ByteBlob this function returns the used size of buffer data in bytes because element is defined
         *          as byte for this type.
         *
         * @return Used size in number of elements

include/ramses/client/SaveFileConfig.h

@@ -65,7 +65,7 @@ namespace ramses
         * Sets saving mode for all #ramses::LuaScript and/or #ramses::LuaModule instances.
         * See #ramses::ELuaSavingMode for the available options and their implications.
         * Note that this is just a hint and the export logic will decide what to actually export,
-        * depending on availabilty of Lua source code or bytecode:
+        * depending on availability of Lua source code or bytecode:
         *  - if only source code is available
         *    then only source code is exported regardless of the selected saving \c mode
         *  - if only byte code is available then only bytecode is exported regardless of the selected saving \c mode

include/ramses/framework/RamsesObject.h

@@ -84,7 +84,7 @@ namespace ramses
         *
         * validate() may append issues to the provided report object, classified by warning or error:
         * - errors need to be fixed, otherwise the object's behaviour will be undefined
-        * - warnings indicate issues that are undesireable, but not necessarily cause problems
+        * - warnings indicate issues that are undesirable, but not necessarily cause problems
         *   (e.g. unused resources, performance issues)
         *
         * @note validate() will skip objects that are already part of the provided report. (Provide an empty report to force re-validation)

include/ramses/renderer/IRendererEventHandler.h

@@ -84,7 +84,7 @@ namespace ramses
 
 
         /**
-        * @brief This method will be called when a mouse event action has occured while a display's window was focused
+        * @brief This method will be called when a mouse event action has occurred while a display's window was focused
         * @param displayId The display on which the event occurred
         * @param eventType Specifies which kind of mouse action has occurred
         * @param mousePosX Horizontal mouse position related to window (left = 0)

tests/integration/render-backend-tests/PlatformTest.cpp

@@ -307,7 +307,7 @@ namespace ramses::internal
                 const bool enableStatus = resourceUploadRenderBackend->getContext().enable();
                 successResourceUploadThread.set_value(enableStatus);
 
-                //block till main context is enabled, to make sure both got enabled succesfully at the same time
+                //block till main context is enabled, to make sure both got enabled successfully at the same time
                 //before the resource upload render backend gets destroyed
                 EXPECT_TRUE(successMainThread.get_future().get());
                 platform->destroyResourceUploadRenderBackend();
@@ -380,7 +380,7 @@ namespace ramses::internal
                     return;
                 }
 
-                //unblock enalbe context in main thread
+                //unblock enable context in main thread
                 successCreation.set_value(true);
 
                 //block till main thread enables context

tests/integration/render-backend-tests/ShaderUploadTest.cpp

@@ -209,7 +209,7 @@ namespace ramses::internal
     {
         const std::unique_ptr<EffectResource> templateEffect(CreateTestEffectResource());
         const EffectResource invalidEffect(
-            "--this is some invalide shader source code--",
+            "--this is some invalid shader source code--",
             templateEffect->getFragmentShader(),
             "", {},
             templateEffect->getUniformInputs(),
@@ -224,7 +224,7 @@ namespace ramses::internal
         const std::unique_ptr<EffectResource> templateEffect(CreateTestEffectResource());
         const EffectResource invalidEffect(
             templateEffect->getVertexShader(),
-            "--this is some invalide shader source code--",
+            "--this is some invalid shader source code--",
             "", {},
             templateEffect->getUniformInputs(),
             templateEffect->getAttributeInputs(),
@@ -570,7 +570,7 @@ namespace ramses::internal
             }
         });
 
-        const auto invalidShader{"--this is some invalide shader source code--"};
+        const auto invalidShader{"--this is some invalid shader source code--"};
         const std::unique_ptr<EffectResource> templateEffect(CreateTestEffectResource());
         {
             const EffectResource invalidEffect(invalidShader,

tests/integration/resource-stress-tests/StressTestRenderer.cpp

@@ -41,10 +41,10 @@ namespace ramses::internal
         return displayId;
     }
 
-    displayBufferId_t StressTestRenderer::createOffscreenBuffer(displayId_t displayId, uint32_t width, uint32_t height, bool interruptable)
+    displayBufferId_t StressTestRenderer::createOffscreenBuffer(displayId_t displayId, uint32_t width, uint32_t height, bool interruptible)
     {
         displayBufferId_t offscreenBufferId;
-        if (interruptable)
+        if (interruptible)
         {
             offscreenBufferId = m_renderer.createInterruptibleOffscreenBuffer(displayId, width, height);
         }

tests/integration/resource-stress-tests/StressTestRenderer.h

@@ -26,7 +26,7 @@ namespace ramses::internal
         ~StressTestRenderer();
 
         displayId_t createDisplay(uint32_t offsetX, uint32_t width, uint32_t height, uint32_t displayIndex, const ramses::DisplayConfig& config);
-        displayBufferId_t createOffscreenBuffer(displayId_t displayId, uint32_t width, uint32_t height, bool interruptable);
+        displayBufferId_t createOffscreenBuffer(displayId_t displayId, uint32_t width, uint32_t height, bool interruptible);
         void startLooping();
         void setFPS(displayId_t display, uint32_t fpsAsInteger);
         void setFrameTimerLimits(uint64_t limitForClientResourcesUpload, uint64_t limitForOffscreenBufferRender);

tests/integration/test-content/Texture2DAnisotropicTextureFilteringScene.cpp

@@ -28,7 +28,7 @@
 //
 // Mip-level 1 is completely red, mip-level 2 is blue, but not used in rendering.
 //
-// One pixel maps to 2x1 texel of mip-level 0, thus we have minification. Without anisotropic filtering, mip-level 1 is choosen, so the bottom half is red.
+// One pixel maps to 2x1 texel of mip-level 0, thus we have minification. Without anisotropic filtering, mip-level 1 is chosen, so the bottom half is red.
 // With anisotropic filtering mip-level 0 is used and the blue and green pixels are averaged by multiple samples. This gives the checkerboard pattern with
 // colors (0,127,127) and (0,0,0).
 

tests/integration/test-content/Texture2DSamplingScene.cpp

@@ -21,7 +21,7 @@
 // The magic of these tests is that they must show a significant difference in the output picture, when the wrong sampling mode is
 // enabled. On the other side they must be stable across different OpenGL implementations in different platforms.
 // Testing the minification modes, means that multiple texels must map to a single pixel, so the difference between right and wrong
-// really lies in single pixels values. This tests are solely 2D, and are carefully choosen for stable output, although dealing in
+// really lies in single pixels values. This tests are solely 2D, and are carefully chosen for stable output, although dealing in
 // the sub-pixel ranges.
 // The output picture of the tests are looking quite synthetic - stripes and dotted pixel patterns - so not trivial to see
 // why it must look like that, that's why the expected result is explained in the createGeometry methods for the different modes.

tests/integration/test-content/TextureCubeAnisotropicTextureFilteringScene.cpp

@@ -29,7 +29,7 @@
 //
 // Mip-level 1 is completely red, mip-levels above are all blue, but not used in rendering.
 //
-// One pixel maps to 2x1 texel of mip-level 0, thus we have minification. Without anisotropic filtering, mip-level 1 is choosen, so the bottom half is red.
+// One pixel maps to 2x1 texel of mip-level 0, thus we have minification. Without anisotropic filtering, mip-level 1 is chosen, so the bottom half is red.
 // With anisotropic filtering mip-level 0 is used and the blue and green pixels are averaged by multiple samples. This gives the checkerboard pattern with
 // colors (0,127,127) and (0,0,0).
 

tools/ramses-scene-viewer/src/SceneViewerGui.cpp

@@ -749,15 +749,15 @@ namespace ramses::internal
 
         if (obj.isFrustumPlanesBound())
         {
-            ImGui::Text("Frustrum (l,r,b,t):");
-            auto frustrum = const_cast<ramses::DataObject*>(findDataObject(obj.getFrustrumPlanesHandle()));
-            if (frustrum != nullptr)
+            ImGui::Text("Frustum (l,r,b,t):");
+            auto frustum = const_cast<ramses::DataObject*>(findDataObject(obj.getFrustrumPlanesHandle()));
+            if (frustum != nullptr)
             {
                 ImGui::SameLine();
-                draw(frustrum->impl());
+                draw(frustum->impl());
             }
 
-            ImGui::Text("Frustrum (n,f):");
+            ImGui::Text("Frustum (n,f):");
             auto nearFar = const_cast<ramses::DataObject*>(findDataObject(obj.getFrustrumNearFarPlanesHandle()));
             if (nearFar != nullptr)
             {
@@ -775,9 +775,9 @@ namespace ramses::internal
             std::array<float, 2> nf{};
             nf[0] = obj.getNearPlane();
             nf[1] = obj.getFarPlane();
-            if (ImGui::DragFloat4("Frustrum (l,r,b,t)", lrbp.data(), 0.001f))
+            if (ImGui::DragFloat4("Frustum (l,r,b,t)", lrbp.data(), 0.001f))
                 obj.setFrustum(lrbp[0], lrbp[1], lrbp[2], lrbp[3], nf[0], nf[1]);
-            if (ImGui::DragFloat2("Frustrum (n,f)", nf.data(), 0.1f))
+            if (ImGui::DragFloat2("Frustum (n,f)", nf.data(), 0.1f))
                 obj.setFrustum(lrbp[0], lrbp[1], lrbp[2], lrbp[3], nf[0], nf[1]);
             if (obj.getType() == ramses::ERamsesObjectType::PerspectiveCamera)
             {
@@ -1921,7 +1921,7 @@ namespace ramses::internal
             {
                 m_resourceInfo->setDisplayLimit(displayLimit);
             }
-            ImGui::TextUnformatted(fmt::format("Resources sorted by {} (decending):", m_resourceInfo->orderCriteriaItems[m_resourceInfo->getOrderCriteriaIndex()]).c_str());
+            ImGui::TextUnformatted(fmt::format("Resources sorted by {} (descending):", m_resourceInfo->orderCriteriaItems[m_resourceInfo->getOrderCriteriaIndex()]).c_str());
             for (auto it : *m_resourceInfo)
             {
                 draw(it->impl());
@@ -2143,7 +2143,7 @@ namespace ramses::internal
 
         if (m_nodeVisibilityChanged)
         {
-            // refresh resource information in next interation
+            // refresh resource information in next iteration
             m_nodeVisibilityChanged = false;
             m_resourceInfo->clear();
         }