Fix many typos (#29)

Summary:
This revision includes:
- Fix many typos
  - sufficent -> sufficient
  - udpate -> update
  - Comapre -> Compare
  - failes -> fails
  - funcion/funtion -> function
  - Tesselation -> Tessellation
  - dimensonal -> dimensional
  - frambuffer -> framebuffer
  - individial -> individual
  - verfy -> verify
  - Soure -> Source
  - convertions -> conversions
  - Artifically -> Artificially
  - Expectd -> Expected
  - Attatchment -> Attachment
  - Pipline -> Pipeline
  - referes -> refers
  - existance -> existence
  - infomation -> information
  - Maxium -> Maximum
  - Whenver -> Whenever
  - asssociated -> associated
  - WARNIGNS -> WARNINGS
  - completetion -> completion
  - Derivate -> Derivative
  - intented -> intended
  - intialized -> initialized
  - decriptor -> descriptor
  - uesd -> used
  - relavent -> relevant
  - platfrom -> platform

Pull Request resolved: #29

Reviewed By: nlutsenko

Differential Revision: D47579138

Pulled By: corporateshark

fbshipit-source-id: 827ed2540304c8e8f6fde7934599c684228212aa

IGLU/imgui/Session.cpp

@@ -294,7 +294,7 @@ void Session::Renderer::newFrame(const igl::FramebufferDesc& desc) {
 }
 
 namespace {
-// push constant structure for Vulkan, containing all the relavent data
+// push constant structure for Vulkan, containing all the relevant data
 struct VulkanImguiBindData {
   iglu::simdtypes::float4x4 proj;
   uint32_t textureId;

IGLU/managedUniformBuffer/ManagedUniformBuffer.cpp

@@ -107,7 +107,7 @@ ManagedUniformBuffer::ManagedUniformBuffer(igl::IDevice& device,
 ManagedUniformBuffer::~ManagedUniformBuffer() {
 #if IGL_PLATFORM_IOS_SIMULATOR
   if (vmAllocLength_) {
-    // if vmAllocLength_ is nonzero it implies we uesd vm_alloc to allocate the memory
+    // if vmAllocLength_ is nonzero it implies we used vm_alloc to allocate the memory
     vm_deallocate((vm_map_t)mach_task_self(), (vm_address_t)data_, vmAllocLength_);
   } else {
 #endif

IGLU/simple_renderer/Material.h

@@ -94,7 +94,7 @@ class Material final {
   DepthTestConfig depthTestConfig() const;
   void setDepthTestConfig(igl::IDevice& device, const DepthTestConfig& config);
 
-  /// Populates a pipeline decriptor for drawing using this Material.
+  /// Populates a pipeline descriptor for drawing using this Material.
   void populatePipelineDescriptor(igl::RenderPipelineDesc& pipelineDesc) const;
 
   /// Binds all relevant states in 'encoder' in preparation for drawing.

IGLU/simple_renderer/ShaderProgram.h

@@ -23,7 +23,7 @@ class ShaderProgram final {
   /// layout of the uniforms within a shader.
   const igl::IRenderPipelineReflection& renderPipelineReflection() const;
 
-  /// Populates a pipeline decriptor for drawing using this shader program.
+  /// Populates a pipeline descriptor for drawing using this shader program.
   void populatePipelineDescriptor(igl::RenderPipelineDesc& pipelineDesc) const;
 
   ShaderProgram(igl::IDevice& device,

getting-started.md

@@ -20,7 +20,7 @@ A complex example demonstrating most of IGL features and rendering the Lumberyar
 
 # RenderSessions
 
-RenderSessions use iglshell functionality that provides platfrom abstraction and basic application functionality.
+RenderSessions use iglshell functionality that provides platform abstraction and basic application functionality.
 We provide some basic examples that you can use in your projects
 
 1)  [EmptySession](./shell/renderSessions/EmptySession.cpp)

shell/openxr/mobile/XrApp.h

@@ -33,7 +33,7 @@ class XrApp {
   XrApp(std::unique_ptr<impl::XrAppImpl>&& impl);
   ~XrApp();
 
-  inline bool intialized() const {
+  inline bool initialized() const {
     return initialized_;
   }
   bool initialize(const struct android_app* app);

shell/renderSessions/ImguiSession.cpp

@@ -28,12 +28,12 @@ void ImguiSession::update(igl::SurfaceTextures surfaceTextures) noexcept {
 
   auto cmdBuffer = _commandQueue->createCommandBuffer(igl::CommandBufferDesc(), nullptr);
 
-  igl::FramebufferDesc frambufferDesc;
-  frambufferDesc.colorAttachments[0].texture = surfaceTextures.color;
+  igl::FramebufferDesc framebufferDesc;
+  framebufferDesc.colorAttachments[0].texture = surfaceTextures.color;
   if (_outputFramebuffer) {
     _outputFramebuffer->updateDrawable(surfaceTextures.color);
   } else {
-    _outputFramebuffer = getPlatform().getDevice().createFramebuffer(frambufferDesc, nullptr);
+    _outputFramebuffer = getPlatform().getDevice().createFramebuffer(framebufferDesc, nullptr);
   }
 
   igl::RenderPassDesc renderPassDesc;
@@ -44,7 +44,7 @@ void ImguiSession::update(igl::SurfaceTextures surfaceTextures) noexcept {
   auto encoder = cmdBuffer->createRenderCommandEncoder(renderPassDesc, _outputFramebuffer);
 
   { // Draw using ImGui every frame
-    _imguiSession->beginFrame(frambufferDesc, getPlatform().getDisplayContext().scale);
+    _imguiSession->beginFrame(framebufferDesc, getPlatform().getDisplayContext().scale);
     ImGui::ShowDemoWindow();
     _imguiSession->endFrame(getPlatform().getDevice(), *encoder);
   }

shell/renderSessions/MRTSession.cpp

@@ -474,10 +474,10 @@ void MRTSession::createOrUpdateFramebufferDisplayLast(const igl::SurfaceTextures
   }
 
   // Framebuffer & Texture
-  FramebufferDesc frambufferDesc;
-  frambufferDesc.colorAttachments[0].texture = surfaceTextures.color;
+  FramebufferDesc framebufferDesc;
+  framebufferDesc.colorAttachments[0].texture = surfaceTextures.color;
 
-  framebufferDisplayLast_ = getPlatform().getDevice().createFramebuffer(frambufferDesc, nullptr);
+  framebufferDisplayLast_ = getPlatform().getDevice().createFramebuffer(framebufferDesc, nullptr);
 }
 
 void MRTSession::createOrUpdateFramebufferMRT(const igl::SurfaceTextures& surfaceTextures) {
@@ -492,12 +492,12 @@ void MRTSession::createOrUpdateFramebufferMRT(const igl::SurfaceTextures& surfac
     tex2_ = createTexture2D(surfaceTextures.color);
   }
   // Framebuffer & Texture
-  FramebufferDesc frambufferDesc;
+  FramebufferDesc framebufferDesc;
 
-  frambufferDesc.colorAttachments[0].texture = tex1_;
-  frambufferDesc.colorAttachments[1].texture = tex2_;
+  framebufferDesc.colorAttachments[0].texture = tex1_;
+  framebufferDesc.colorAttachments[1].texture = tex2_;
 
-  framebufferMRT_ = getPlatform().getDevice().createFramebuffer(frambufferDesc, nullptr);
+  framebufferMRT_ = getPlatform().getDevice().createFramebuffer(framebufferDesc, nullptr);
 }
 
 } // namespace shell

src/igl/Buffer.h

@@ -123,7 +123,7 @@ class IBuffer : public ITrackedResource<IBuffer> {
   virtual Result upload(const void* IGL_NULLABLE data, const BufferRange& range) = 0;
 
   /**
-   * @brief Map a portion of the contents of a GPU Buffer into memory. Not efficient; intented
+   * @brief Map a portion of the contents of a GPU Buffer into memory. Not efficient; intended
    * primarily for debug and test use. unmap() must be called before the buffer is used again in any
    * GPU operations.
    *

src/igl/CommandQueue.h

@@ -37,7 +37,7 @@ struct CommandQueueDesc {
 /**
  * Contains the current frame's draw count and last frame's draw count.
  * ICommandQueue controls these values and moves current draw count to last frame draw count through
- * the endFrame funcion.
+ * the endFrame function.
  */
 struct CommandQueueStatistics {
   uint32_t currentDrawCount = 0;

src/igl/DeviceFeatures.h

@@ -109,7 +109,7 @@ enum class DeviceFeatures {
  * @brief DeviceRequirement denotes capturing specific requirements for a feature to be enabled.
  * These should be used in combination with DeviceFeatures to understand how to take advantage of
  * the feature.
- * For example, using the StandardDerivate feature with an OpenGL ES 2.0 device requires using an
+ * For example, using the StandardDerivative feature with an OpenGL ES 2.0 device requires using an
  * extension whereas it can be used without an extension for an OpenGL or OpenGL ES 3+ device.
  * If a device returns true for hasFeature(DeviceFeatures::ShaderTextureLod) and returns true for
  * hasRequirement(DeviceRequirement::ShaderTextureLodExtReq), then shader code wishing to use the

src/igl/RenderCommandEncoder.h

@@ -49,7 +49,7 @@ class IRenderCommandEncoder : public ICommandEncoder {
   // Binds the buffer to a shader
   //
   // For metal, the index parameter is the buffer index specified in the shader, for opengl index
-  // referes to the location of uniform. The index value can be found by using
+  // refers to the location of uniform. The index value can be found by using
   // igl::RenderPipelineState::getIndexByName
   //
   // target is the igl::BindTarget type

src/igl/Texture.h

@@ -21,7 +21,7 @@ namespace igl {
  * texture. For example, TwoD corresponds to 2-dimensional textures.
  *
  *  Invalid          - Undefined,
- *  TwoD             - Single layer, two dimensonal: (Width, Height)
+ *  TwoD             - Single layer, two dimensional: (Width, Height)
  *  TwoDArray        - Multiple layers, two dimensional: (Width, Height)
  *  ThreeD           - 3 dimensional textures: (Width, Height, Depth)
  *  Cube             - Special case of 3 dimensional textures: (Width, Height, Depth), along with 6

src/igl/VertexInputState.h

@@ -82,7 +82,7 @@ enum class VertexSampleFunction {
   PerVertex,
   Instance,
 
-  // Missing Tesselation support
+  // Missing Tessellation support
 };
 
 /**

src/igl/metal/BufferSynchronizationManager.mm

@@ -28,7 +28,7 @@
 
 void BufferSynchronizationManager::markCommandBufferAsEndOfFrame(
     const igl::ICommandBuffer& commandBuffer) {
-  // Set a completetion handler for this cmd buffer
+  // Set a completion handler for this cmd buffer
   __weak dispatch_semaphore_t semaphore = frameBoundarySemaphore_;
   [static_cast<const CommandBuffer&>(commandBuffer).get()
       addCompletedHandler:^(id<MTLCommandBuffer> mtlCommandBuffer) {

src/igl/metal/CMakeLists.txt

@@ -28,7 +28,7 @@ igl_set_cxxstd(IGLMetal 17)
 igl_set_folder(IGLMetal "IGL")
 
 set(OBJC_EXTRA_FLAGS -fobjc-arc -fobjc-weak)
-set(OBJC_DISABLE_WARNIGNS -Wno-objc-designated-initializers -Wno-objc-missing-super-calls -Wno-objc-property-no-attribute)
+set(OBJC_DISABLE_WARNINGS -Wno-objc-designated-initializers -Wno-objc-missing-super-calls -Wno-objc-property-no-attribute)
 
 if(CMAKE_GENERATOR MATCHES "Xcode")
   set_target_properties(IGLMetal PROPERTIES XCODE_ATTRIBUTE_CLANG_ENABLE_OBJC_WEAK YES)
@@ -38,6 +38,6 @@ else()
   target_compile_options(IGLMetal PRIVATE $<$<COMPILE_LANGUAGE:OBJCXX>:${OBJC_EXTRA_FLAGS}>)
 endif()
 
-target_compile_options(IGLMetal PRIVATE $<$<COMPILE_LANGUAGE:OBJC>:${OBJC_DISABLE_WARNIGNS}>)
-target_compile_options(IGLMetal PRIVATE $<$<COMPILE_LANGUAGE:OBJCXX>:${OBJC_DISABLE_WARNIGNS}>)
+target_compile_options(IGLMetal PRIVATE $<$<COMPILE_LANGUAGE:OBJC>:${OBJC_DISABLE_WARNINGS}>)
+target_compile_options(IGLMetal PRIVATE $<$<COMPILE_LANGUAGE:OBJCXX>:${OBJC_DISABLE_WARNINGS}>)
 target_compile_options(IGLMetal PRIVATE "-Wno-deprecated-declarations")

src/igl/opengl/RenderPipelineState.cpp

@@ -257,7 +257,7 @@ void RenderPipelineState::unbind() {
 }
 
 // A buffer can be shared by multiple attributes. So bind all the attributes
-// asssociated with the associated buffer.
+// associated with the associated buffer.
 // bufferOffset is an offset in bytes to the start of the vertex attributes in the buffer.
 void RenderPipelineState::bindVertexAttributes(size_t bufferIndex, size_t bufferOffset) {
 #if IGL_DEBUG

src/igl/opengl/Texture.cpp

@@ -172,7 +172,7 @@ GLenum Texture::toGLTarget(TextureType type, size_t samples) const {
   return 0;
 }
 
-// Whenver possible the caller should have the incoming format in
+// Whenever possible the caller should have the incoming format in
 // igl::TextureFormat thus not use this function. For the cases when this
 // is not possible, e.g. dictated by a file header, then this function
 // can convert GL Texture format into IGL Texture Format

src/igl/opengl/UniformAdapter.cpp

@@ -19,8 +19,8 @@ UniformAdapter::UniformAdapter(const IContext& context, PipelineType type) : pip
 
   // NOTE: 32 "feels" right and yielded good results in MobileLab. Goal here is to minimize
   // number of resize's in the vector but not be unreasonably large.
-  constexpr size_t kLikelyMaxiumNumUniforms = 32;
-  uniforms_.reserve(kLikelyMaxiumNumUniforms);
+  constexpr size_t kLikelyMaximumNumUniforms = 32;
+  uniforms_.reserve(kLikelyMaximumNumUniforms);
 
   if (pipelineType_ == Render) {
     maxUniforms_ = deviceFeatures.getMaxVertexUniforms() + deviceFeatures.getMaxFragmentUniforms();

src/igl/opengl/UniformBuffer.h

@@ -46,7 +46,7 @@ class UniformBuffer final : public Buffer {
     return Type::Uniform;
   }
 
-  // For openGL, additional infomation required to bind the uniform is provided when the buffer is
+  // For openGL, additional information required to bind the uniform is provided when the buffer is
   // created within the igl::BufferDesc and igl::UniformBufferEntry (eg. offset, type, elementStride
   // and number of elements).
   //

src/igl/opengl/wgl/Context.h

@@ -27,7 +27,7 @@ class Context : public IContext {
   Context(HDC deviceContext, HGLRC renderContext);
   /// Create a new context with existing HGLRC and share contexts the share context's
   /// must be setup ahead of calling this constructor. (eg. via QOpenGLContext->setShareContext) and
-  /// should not be modified during the existance of this IContext
+  /// should not be modified during the existence of this IContext
   Context(HDC deviceContext, HGLRC renderContext, std::vector<HGLRC> shareContexts);
 
   ~Context() override;

src/igl/tests/Backend.cpp

@@ -71,10 +71,10 @@ class BackendTest : public ::testing::Test {
     ASSERT_TRUE(offscreenTexture_ != nullptr);
 
     // Create framebuffer using the offscreen texture
-    FramebufferDesc frambufferDesc;
+    FramebufferDesc framebufferDesc;
 
-    frambufferDesc.colorAttachments[0].texture = offscreenTexture_;
-    framebuffer_ = iglDev_->createFramebuffer(frambufferDesc, &ret);
+    framebufferDesc.colorAttachments[0].texture = offscreenTexture_;
+    framebuffer_ = iglDev_->createFramebuffer(framebufferDesc, &ret);
     ASSERT_EQ(ret.code, Result::Code::Ok);
     ASSERT_TRUE(framebuffer_ != nullptr);
 
@@ -172,7 +172,7 @@ class BackendTest : public ::testing::Test {
   std::shared_ptr<ITexture> offscreenTexture_;
   std::shared_ptr<IFramebuffer> framebuffer_;
 
-  // Currently it is left to individial tests to initialize this
+  // Currently it is left to individual tests to initialize this
   std::shared_ptr<ITexture> inputTexture_;
 
   std::shared_ptr<IShaderStages> shaderStages_;

src/igl/tests/Blending.cpp

@@ -66,10 +66,10 @@ class BlendingTest : public ::testing::Test {
     ASSERT_TRUE(offscreenTexture_ != nullptr);
 
     // Create framebuffer using the offscreen texture
-    FramebufferDesc frambufferDesc;
+    FramebufferDesc framebufferDesc;
 
-    frambufferDesc.colorAttachments[0].texture = offscreenTexture_;
-    framebuffer_ = iglDev_->createFramebuffer(frambufferDesc, &ret);
+    framebufferDesc.colorAttachments[0].texture = offscreenTexture_;
+    framebuffer_ = iglDev_->createFramebuffer(framebufferDesc, &ret);
     ASSERT_EQ(ret.code, Result::Code::Ok);
     ASSERT_TRUE(framebuffer_ != nullptr);
 

src/igl/tests/ComputeCommandEncoder.cpp

@@ -91,7 +91,7 @@ class ComputeCommandEncoderTest : public ::testing::Test {
   }
 
   /**
-   * @brief This function binds bufferIn and bufferOut to a new computePiplineState and encodes the
+   * @brief This function binds bufferIn and bufferOut to a new computePipelineState and encodes the
    * computePipelineState to a new computeCommandEncoder.
    */
   void encodeCompute(const std::shared_ptr<igl::ICommandBuffer>& cmdBuffer,

src/igl/tests/Device.cpp

@@ -52,10 +52,10 @@ class DeviceTest : public ::testing::Test {
     ASSERT_TRUE(offscreenTexture_ != nullptr);
 
     // Create framebuffer using the offscreen texture
-    FramebufferDesc frambufferDesc;
+    FramebufferDesc framebufferDesc;
 
-    frambufferDesc.colorAttachments[0].texture = offscreenTexture_;
-    framebuffer_ = iglDev_->createFramebuffer(frambufferDesc, &ret);
+    framebufferDesc.colorAttachments[0].texture = offscreenTexture_;
+    framebuffer_ = iglDev_->createFramebuffer(framebufferDesc, &ret);
     ASSERT_EQ(ret.code, Result::Code::Ok);
     ASSERT_TRUE(framebuffer_ != nullptr);
 

src/igl/tests/Framebuffer.cpp

@@ -268,7 +268,7 @@ TEST_F(FramebufferTest, Clear) {
   framebuffer_->copyBytesColorAttachment(*cmdQueue_, 0, pixels.data(), rangeDesc);
   ASSERT_EQ(pixels[0], 0x80808080);
 
-  // TODO: copyBytesDepthAttatchment is not functioning property under Metal
+  // TODO: copyBytesDepthAttachment is not functioning property under Metal
   // due to unimplemented blitting
   // Refer to igl/metal/Framebuffer.mm
   framebuffer_->copyBytesDepthAttachment(*cmdQueue_, pixels_depth.data(), rangeDesc);
@@ -319,7 +319,7 @@ TEST_F(FramebufferTest, Clear) {
   framebuffer_->copyBytesColorAttachment(*cmdQueue_, 0, pixels.data(), rangeDesc);
   ASSERT_EQ(pixels[0], 0);
 
-  // TODO: copyBytesDepthAttatchment is not functioning property under Metal
+  // TODO: copyBytesDepthAttachment is not functioning property under Metal
   // due to unimplemented blitting
   // Refer to igl/metal/Framebuffer.mm
   framebuffer_->copyBytesDepthAttachment(*cmdQueue_, pixels_depth.data(), rangeDesc);
@@ -404,10 +404,10 @@ TEST_F(FramebufferTest, blitFramebufferColor) {
     //-------------------------------------------------------------
     // Create second IFramebuffer framebuffer2 by offscreenTexture2
     //-------------------------------------------------------------
-    FramebufferDesc frambufferDesc;
+    FramebufferDesc framebufferDesc;
 
-    frambufferDesc.colorAttachments[0].texture = offscreenTexture2;
-    std::shared_ptr<IFramebuffer> framebuffer2 = iglDev_->createFramebuffer(frambufferDesc, &ret);
+    framebufferDesc.colorAttachments[0].texture = offscreenTexture2;
+    std::shared_ptr<IFramebuffer> framebuffer2 = iglDev_->createFramebuffer(framebufferDesc, &ret);
     ASSERT_TRUE(ret.isOk());
     ASSERT_TRUE(framebuffer2 != nullptr);
 

src/igl/tests/ShaderLibrary.cpp

@@ -64,7 +64,7 @@ TEST_F(ShaderLibraryTest, CreateFromSource) {
   ASSERT_TRUE(vertShaderModule);
 }
 
-TEST_F(ShaderLibraryTest, CreateFromSoureReturnNullWithNullInput) {
+TEST_F(ShaderLibraryTest, CreateFromSourceReturnNullWithNullInput) {
   Result ret;
   if (!iglDev_->hasFeature(DeviceFeatures::ShaderLibrary)) {
     GTEST_SKIP() << "Shader Libraries are unsupported for this platform.";

src/igl/tests/Texture.cpp

@@ -70,10 +70,10 @@ class TextureTest : public ::testing::Test {
     ASSERT_TRUE(offscreenTexture_ != nullptr);
 
     // Create framebuffer using the offscreen texture
-    FramebufferDesc frambufferDesc;
+    FramebufferDesc framebufferDesc;
 
-    frambufferDesc.colorAttachments[0].texture = offscreenTexture_;
-    framebuffer_ = iglDev_->createFramebuffer(frambufferDesc, &ret);
+    framebufferDesc.colorAttachments[0].texture = offscreenTexture_;
+    framebuffer_ = iglDev_->createFramebuffer(framebufferDesc, &ret);
     ASSERT_EQ(ret.code, Result::Code::Ok);
     ASSERT_TRUE(framebuffer_ != nullptr);
 
@@ -172,7 +172,7 @@ class TextureTest : public ::testing::Test {
   std::shared_ptr<ITexture> offscreenTexture_;
   std::shared_ptr<IFramebuffer> framebuffer_;
 
-  // Currently it is left to individial tests to initialize this
+  // Currently it is left to individual tests to initialize this
   std::shared_ptr<ITexture> inputTexture_;
 
   std::shared_ptr<IShaderStages> shaderStages_;
@@ -548,7 +548,7 @@ TEST_F(TextureTest, PassthroughSubTexture) {
 // This test will exercise the copy functionality via the following steps:
 //   1. clear FB to (0.5, 0.5, 0.5, 0.5)
 //   2. Copy content to a texture
-//   3. clear FB to (0, 0, 0, 0) and verfy it is cleared
+//   3. clear FB to (0, 0, 0, 0) and verify it is cleared
 //   4. Copy texture content to FB
 //   5. Verify that the FB is back to (0.5, 0.5, 0.5, 0.5)
 //
@@ -703,9 +703,9 @@ TEST_F(TextureTest, PIXEL_UPLOAD_ALIGNMENT) {
   ASSERT_EQ(ret.code, Result::Code::Ok);
   ASSERT_TRUE(customOffscreenTexture != nullptr);
 
-  FramebufferDesc frambufferDesc;
-  frambufferDesc.colorAttachments[0].texture = customOffscreenTexture;
-  auto customFramebuffer = iglDev_->createFramebuffer(frambufferDesc, &ret);
+  FramebufferDesc framebufferDesc;
+  framebufferDesc.colorAttachments[0].texture = customOffscreenTexture;
+  auto customFramebuffer = iglDev_->createFramebuffer(framebufferDesc, &ret);
   ASSERT_EQ(ret.code, Result::Code::Ok);
   ASSERT_TRUE(customFramebuffer != nullptr);
 
@@ -863,10 +863,10 @@ TEST_F(TextureTest, Resize) {
   ASSERT_TRUE(outputTex != nullptr);
 
   // Create framebuffer using the output texture
-  FramebufferDesc frambufferDesc;
+  FramebufferDesc framebufferDesc;
 
-  frambufferDesc.colorAttachments[0].texture = outputTex;
-  auto fb = iglDev_->createFramebuffer(frambufferDesc, &ret);
+  framebufferDesc.colorAttachments[0].texture = outputTex;
+  auto fb = iglDev_->createFramebuffer(framebufferDesc, &ret);
   ASSERT_EQ(ret.code, Result::Code::Ok);
   ASSERT_TRUE(fb != nullptr);