Fix typos (#131)

Co-authored-by: st0rmbtw <orangebtw@orangebtws-Mac-Pro.local>

.gitignore

@@ -23,3 +23,6 @@ tests/Output
 
 # RenderDoc .cap capture files
 *.cap
+
+# VS Code folder
+.vscode

CMakeLists.txt

@@ -63,7 +63,7 @@ endif()
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 
-# XCODE_SCHEME_WORKING_DIRECTORY (used per target) requries CMake 3.17.5
+# XCODE_SCHEME_WORKING_DIRECTORY (used per target) requires CMake 3.17.5
 if(APPLE AND ${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.17.5")
     # Once Xcode schemes are generated for example, we also have to enable them globally or the main projects will disappear
     set(CMAKE_XCODE_GENERATE_SCHEME TRUE)
@@ -117,7 +117,7 @@ endmacro()
 # Example:
 #   find_source_files(OutputFiles "*.h;*.cpp" ${MyProjectDir}/Base ${MyProjectDir}/Extensions)
 function(find_source_files OUTPUT_LIST FILTERS)
-    # Substitue predefined filters
+    # Substitute predefined filters
     if("${FILTERS}" STREQUAL "C")
         set(FILTERS "*.c;*.h;*.inl")
     elseif("${FILTERS}" STREQUAL "CXX")
@@ -253,7 +253,7 @@ function(set_project_working_dir PROJECT_NAME WORKING_DIR)
         endif()
     elseif(APPLE)
         if(${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.17.5")
-            # XCODE_SCHEME_WORKING_DIRECTORY requries CMake 3.17.5
+            # XCODE_SCHEME_WORKING_DIRECTORY requires CMake 3.17.5
             set_target_properties(
                 ${PROJECT_NAME} PROPERTIES
                 XCODE_GENERATE_SCHEME           TRUE
@@ -321,7 +321,7 @@ function(add_llgl_example_project PROJECT_NAME LINKER_LANG SRC_FILES LIB_FILES)
             RESOURCE                            "${BundleResourceFiles}"
         )
     elseif(LLGL_ANDROID_PLATFORM)
-        # Android project configuratons
+        # Android project configurations
         add_library(${PROJECT_NAME} SHARED ${SRC_FILES})
         target_link_libraries(${PROJECT_NAME} ${LIB_FILES} android_native_app_glue log)
     else()

examples/CSharp/ExampleBase/ExampleBase.cs

@@ -123,7 +123,7 @@ public int Run(string title, string[] args)
             // Main loop
             while (LLGL.Surface.ProcessEvents() && !window.HasQuit)
             {
-                //Debugger.TimgRecording = true;
+                //Debugger.TimeRecording = true;
 
                 OnDrawFrame();
                 SwapChain.Present();

examples/CSharp/HelloTriangle/HelloTriangle.cs

@@ -199,7 +199,7 @@ private int Run()
             // Main loop
             while (LLGL.Surface.ProcessEvents() && !window.HasQuit)
             {
-                //Debugger.TimgRecording = true;
+                //Debugger.TimeRecording = true;
 
                 RenderFrame();
                 SwapChain.Present();

examples/Cpp/ClothPhysics/Example.cpp

@@ -163,7 +163,7 @@ class Example_ClothPhysics : public ExampleBase
             {
                 const auto idx = v * (clothSegmentsU + 1) + u;
 
-                // Set mass for left and righ top particles to infinity to create suspension points
+                // Set mass for left and right top particles to infinity to create suspension points
                 bool isSuspensionPoint = (v == 0 && (u == 0 || u == clothSegmentsU));
 
                 // Initialize base attributes

examples/Cpp/ExampleBase/DDSImageReader.cpp

@@ -146,7 +146,7 @@ bool DDSImageReader::LoadFromFile(const std::string& filename)
         return false;
     }
 
-    // Rerad DDS header
+    // Read DDS header
     DDSHeader header = reader.Read<DDSHeader>();
 
     DDSHeaderDX10 headerDX10;

examples/Cpp/ExampleBase/DDSImageReader.h

@@ -24,7 +24,7 @@ class DDSImageReader
         // Loads the specified DDS image from file.
         bool LoadFromFile(const std::string& filename);
 
-        // Returns the image view for the sepcified MIP-map that can be passed to RenderSystem::CreateTexture or RenderSystem::WriteTexture.
+        // Returns the image view for the specified MIP-map that can be passed to RenderSystem::CreateTexture or RenderSystem::WriteTexture.
         LLGL::ImageView GetImageView(std::uint32_t mipLevel = 0) const;
 
         // Returns the texture descriptor.

examples/Cpp/ExampleBase/ExampleBase.cpp

@@ -647,7 +647,7 @@ ExampleBase::ExampleBase(const LLGL::UTF8String& title)
     loadingDone_ = true;
 }
 
-void ExampleBase::OnResize(const LLGL::Extent2D& resoluion)
+void ExampleBase::OnResize(const LLGL::Extent2D& resolution)
 {
     // dummy
 }

examples/Cpp/ExampleBase/ExampleBase.h

@@ -192,7 +192,7 @@ class ExampleBase
     virtual void OnDrawFrame() = 0;
 
     // Callback when the window has been resized. Can also be detected by using a custom window event listener.
-    virtual void OnResize(const LLGL::Extent2D& resoluion);
+    virtual void OnResize(const LLGL::Extent2D& resolution);
 
 private:
 
@@ -272,16 +272,16 @@ class ExampleBase
     // Returns the aspect ratio of the swap-chain resolution (X:Y).
     float GetAspectRatio() const;
 
-    // Returns ture if OpenGL is used as rendering API.
+    // Returns true if OpenGL is used as rendering API.
     bool IsOpenGL() const;
 
-    // Returns ture if Vulkan is used as rendering API.
+    // Returns true if Vulkan is used as rendering API.
     bool IsVulkan() const;
 
-    // Returns ture if Direct3D is used as rendering API.
+    // Returns true if Direct3D is used as rendering API.
     bool IsDirect3D() const;
 
-    // Returns ture if Metal is used as rendering API.
+    // Returns true if Metal is used as rendering API.
     bool IsMetal() const;
 
     // Used by the window resize handler
@@ -293,7 +293,7 @@ class ExampleBase
     // Returns a perspective projection with the specified parameters for the respective renderer.
     Gs::Matrix4f PerspectiveProjection(float aspectRatio, float near, float far, float fov) const;
 
-    // Returns an orthogonal projection with the speciifed parameters for the respective renderer.
+    // Returns an orthogonal projection with the specified parameters for the respective renderer.
     Gs::Matrix4f OrthogonalProjection(float width, float height, float near, float far) const;
 
     // Returns a quoternion for the specified rotation

examples/Cpp/Fonts/Example.cpp

@@ -210,7 +210,7 @@ class Example_Fonts : public ExampleBase
         // Build glyph set with font meta data
         BuildGlyphSet(' ', '~', font.atlasWidth, font.atlasHeight, font.numGlyphsX, font.numGlyphsY);
 
-        // Store font height to render approriately for the loaded font
+        // Store font height to render appropriately for the loaded font
         fontHeight = font.atlasHeight / font.numGlyphsY;
     }
 
@@ -308,7 +308,7 @@ class Example_Fonts : public ExampleBase
         if (currentBatchSize + 6 >= maxGlyphsPerBatch*6)
             FlushGlyphBatch();
 
-        // Glyph vertex to batch vertex index permuation
+        // Glyph vertex to batch vertex index permutation
         constexpr int vertexPerm[6] = { 0, 1, 2, 0, 2, 3 };
 
         // Copy vertices from glyph into batch

examples/Cpp/Instancing/Example.cpp

@@ -43,7 +43,7 @@ class Example_Instancing : public ExampleBase
     struct Settings
     {
         Gs::Matrix4f    vpMatrix;                           // View-projection matrix
-        Gs::Vector4f    viewPos;                            // Camera view position (in world spce)
+        Gs::Vector4f    viewPos;                            // Camera view position (in world space)
         float           fogColor[3] = { 0.3f, 0.3f, 0.3f };
         float           fogDensity  = 0.04f;
         float           animVec[2]  = { 0.0f, 0.0f };       // Animation vector to make the plants wave in the wind
@@ -364,7 +364,7 @@ class Example_Instancing : public ExampleBase
 
     void OnDrawFrame() override
     {
-        // Update scene animationa and user input
+        // Update scene animation and user input
         UpdateAnimation();
 
         static bool alphaToCoverageEnabled = true;

examples/Cpp/PBR/Example.cpp

@@ -324,7 +324,7 @@ class Example_PBR : public ExampleBase
         numSkyboxes = 1;
         numMaterials = 4;
 
-        // Load skybox texutres
+        // Load skybox textures
         skyboxArray = LoadTextureArray(
             LLGL::TextureType::TextureCubeArray,
             {

examples/Cpp/Queries/Example.cpp

@@ -289,7 +289,7 @@ class Example_Queries : public ExampleBase
                 // Set buffers
                 commands->SetVertexBuffer(*vertexBuffer);
 
-                // Start with qeometry query
+                // Start with geometry query
                 commands->BeginQuery(*geometryQuery);
                 {
                     commands->SetViewport(swapChain->GetResolution());

examples/Cpp/RenderTarget/Example.cpp

@@ -118,7 +118,7 @@ class Example_RenderTarget : public ExampleBase
         vertexFormat.AppendAttribute({ "normal",   LLGL::Format::RGB32Float });
         vertexFormat.AppendAttribute({ "texCoord", LLGL::Format::RG32Float  });
 
-        // Initialize vertices (scale texture-coordiantes a little bit, to show the texture border)
+        // Initialize vertices (scale texture-coordinates a little bit, to show the texture border)
         auto vertices = GenerateTexturedCubeVertices();
 
         constexpr float borderSize = 0.02f;

examples/Cpp/Tessellation/Example.cpp

@@ -172,7 +172,7 @@ class Example_Tessellation : public ExampleBase
             #endif
             pipelineDesc.pipelineLayout                 = pipelineLayout;
 
-            // Set input-assembler state (draw pachtes with 4 control points with 32-bit indices)
+            // Set input-assembler state (draw patches with 4 control points with 32-bit indices)
             pipelineDesc.indexFormat                    = LLGL::Format::R32UInt;
             pipelineDesc.primitiveTopology              = LLGL::PrimitiveTopology::Patches4;
 

include/LLGL/CommandBuffer.h

@@ -574,7 +574,7 @@ class LLGL_EXPORT CommandBuffer : public RenderSystemChild
         To clear only a specific render-target color buffer, use the \c ClearAttachments function.
         Clearing a depth-stencil attachment while the active render target has no depth-stencil buffer is allowed but has no effect.
         For efficiency reasons, it is recommended to clear the render target attachments when a new render pass begins,
-        i.e. the clear values of the \c BeginRenderPass function should be prefered over this function.
+        i.e. the clear values of the \c BeginRenderPass function should be preferred over this function.
         For some render systems (e.g. Metal) this function forces the current render pass to stop and start again in order to clear the attachments.
 
         \see ClearFlags
@@ -593,7 +593,7 @@ class LLGL_EXPORT CommandBuffer : public RenderSystemChild
         \remarks To clear all color buffers with the same value, use the \c Clear function.
         Clearing a depth-stencil attachment while the active render target has no depth-stencil buffer is allowed but has no effect.
         For efficiency reasons, it is recommended to clear the render target attachments when a new render pass begins,
-        i.e. the clear values of the \c BeginRenderPass function should be prefered over this function.
+        i.e. the clear values of the \c BeginRenderPass function should be preferred over this function.
         For some render systems (e.g. Metal) this function forces the current render pass to stop and start again in order to clear the attachments.
 
         \see Clear
@@ -853,8 +853,8 @@ class LLGL_EXPORT CommandBuffer : public RenderSystemChild
         \param[in] buffer Specifies the buffer from which the draw command arguments are taken. This buffer must have been created with the BindFlags::IndirectBuffer binding flag.
         \param[in] offset Specifies an offset within the argument buffer from which the arguments are to be taken. This offset must be a multiple of 4.
         \param[in] numCommands Specifies the number of draw commands that are to be taken from the argument buffer.
-        \param[in] stride Specifies the stride (in bytes) betweeen consecutive sets of arguments,
-        which is commonly greater than or euqal to <code>sizeof(DrawIndirectArguments)</code>. This stride must be a multiple of 4.
+        \param[in] stride Specifies the stride (in bytes) between consecutive sets of arguments,
+        which is commonly greater than or equal to <code>sizeof(DrawIndirectArguments)</code>. This stride must be a multiple of 4.
 
         \remarks This is also known as a "multi draw command" which is only natively supported by OpenGL and Vulkan.
         For other rendering APIs, the recording of multiple draw commands is emulated with a simple loop, which is equivalent to the following example:
@@ -885,8 +885,8 @@ class LLGL_EXPORT CommandBuffer : public RenderSystemChild
         \param[in] buffer Specifies the buffer from which the draw command arguments are taken. This buffer must have been created with the BindFlags::IndirectBuffer binding flag.
         \param[in] offset Specifies an offset within the argument buffer from which the arguments are to be taken. This offset must be a multiple of 4.
         \param[in] numCommands Specifies the number of draw commands that are to be taken from the argument buffer.
-        \param[in] stride Specifies the stride (in bytes) betweeen consecutive sets of arguments,
-        which is commonly greater than or euqal to <code>sizeof(DrawIndexedIndirectArguments)</code>. This stride must be a multiple of 4.
+        \param[in] stride Specifies the stride (in bytes) between consecutive sets of arguments,
+        which is commonly greater than or equal to <code>sizeof(DrawIndexedIndirectArguments)</code>. This stride must be a multiple of 4.
 
         \remarks This is also known as a "multi draw command" which is only natively supported by OpenGL and Vulkan.
         For other rendering APIs, the recording of multiple draw commands is emulated with a simple loop, which is equivalent to the following example:
@@ -961,7 +961,7 @@ class LLGL_EXPORT CommandBuffer : public RenderSystemChild
         \brief Performs a native command that is backend specific.
 
         \param[out] nativeCommand Raw pointer to the backend specific structure to store the native command.
-        Optain the respective structure from <code>#include <LLGL/Backend/BACKEND/NativeCommand.h></code>
+        Obtain the respective structure from <code>#include <LLGL/Backend/BACKEND/NativeCommand.h></code>
         where \c BACKEND must be either \c Direct3D12, \c Direct3D11, \c Vulkan, \c Metal, or \c OpenGL.
 
         \param[in] nativeCommandSize Specifies the size (in bytes) of the native command structure for robustness.
@@ -989,7 +989,7 @@ class LLGL_EXPORT CommandBuffer : public RenderSystemChild
         \brief Returns the native command buffer handle.
 
         \param[out] nativeHandle Raw pointer to the backend specific structure to store the native handle.
-        Optain the respective structure from <code>#include <LLGL/Backend/BACKEND/NativeHandle.h></code>
+        Obtain the respective structure from <code>#include <LLGL/Backend/BACKEND/NativeHandle.h></code>
         where \c BACKEND must be either \c Direct3D12, \c Direct3D11, \c Vulkan, or \c Metal.
         OpenGL does not have a native handle as it uses the current platform specific GL context.
 

include/LLGL/Constants.h

@@ -30,7 +30,7 @@
 
 /**
 \brief Indicates to use the maximum number of threads the host system supports.
-\remarks This value does not itself specifiy the maximum number, but tells the associated functions to use the maximum number.
+\remarks This value does not itself specify the maximum number, but tells the associated functions to use the maximum number.
 \see ConvertImageBuffer
 \see RenderSystem::CreateTexture
 \see RenderSystem::WriteTexture

include/LLGL/Container/DynamicArray.h

@@ -26,7 +26,7 @@ namespace LLGL
 
 /**
 \brief Generic container class for dynamic arrays that usually do not change in size.
-\remarks Because this container does not support \c push_back, \c pop_back, or \c insert functionallity,
+\remarks Because this container does not support \c push_back, \c pop_back, or \c insert functionality,
 it only supports trivially constructible and trivially copyable types.
 \tparam T Specifies the array element type.
 \tparam Allocator Specifies the memory allocator. This has to be compatible with std::allocator. By default std::allocator<T>.
@@ -90,7 +90,7 @@ class LLGL_EXPORT DynamicArray
                 *it = *from;
         }
 
-        //! Initializes the array with the specified number of elements and uninitial default value.
+        //! Initializes the array with the specified number of elements and initial default value.
         explicit DynamicArray(size_type count, UninitializeTag) :
             data_ { Allocator{}.allocate(count) },
             size_ { count                       }
@@ -228,7 +228,7 @@ class LLGL_EXPORT DynamicArray
         }
 
         /**
-        \brief Release the ownershuip of the internally allocated memory.
+        \brief Release the ownership of the internally allocated memory.
         \remarks This must later be deallocated with Allocator::deallocate().
         */
         pointer release()

include/LLGL/Format.h

@@ -331,7 +331,7 @@ struct FormatFlags
         /**
         \brief Specifies whether the format supports to automatically generate MIP-maps.
         \remarks This implies that the flags \c SupportsMips and \c SupportsRenderTarget are also enabled.
-        \see MiscFlgas::GenerateMips
+        \see MiscFlags::GenerateMips
         \see CommandBuffer::GenerateMips
         */
         SupportsGenerateMips    = (1 << 10),

include/LLGL/Key.h

@@ -96,7 +96,7 @@ enum class Key
     Z,                  //!< Letter Z.
 
     LWin,               //!< Left Windows key.
-    RWin,               //!< Rigth Windows key.
+    RWin,               //!< Right Windows key.
     Apps,               //!< Application key.
     Sleep,              //!< Sleep key.
 

include/LLGL/Log.h

@@ -115,7 +115,7 @@ this function only returns the previously registered handle that is associated w
 LLGL_EXPORT LogHandle RegisterCallbackStd();
 
 /**
-\brief Unregisteres the specified handle from the log output.
+\brief Unregisters the specified handle from the log output.
 \param[in] handle Specifies the opaque handle that was returned from a previous call to RegisterCallback, RegisterCallbackReport, or RegisterCallbackStd.
 \see RegisterCallback
 \see RegisterCallbackReport

include/LLGL/PipelineCache.h

@@ -31,7 +31,7 @@ class LLGL_EXPORT PipelineCache : public RenderSystemChild
 
         /**
         \brief Returns the cached blob representing a pipeline state.
-        \remarks This blob can be safed to file and reused to speedup PSO creation on next application launch or reused during the same application run.
+        \remarks This blob can be saved to file and reused to speedup PSO creation on next application launch or reused during the same application run.
         If the backend does not support pipeline caching, the return value is an empty blob.
         */
         virtual Blob GetBlob() const = 0;