better documentation

Author: josephbk117

NormalMapGeneratorTool/NormalMapGeneratorTool.vcxproj

@@ -35,7 +35,7 @@
     <ConfigurationType>Application</ConfigurationType>
     <UseDebugLibraries>false</UseDebugLibraries>
     <PlatformToolset>v141</PlatformToolset>
-    <WholeProgramOptimization>true</WholeProgramOptimization>
+    <WholeProgramOptimization>false</WholeProgramOptimization>
     <CharacterSet>MultiByte</CharacterSet>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
@@ -109,7 +109,7 @@
       <Optimization>MaxSpeed</Optimization>
       <FunctionLevelLinking>true</FunctionLevelLinking>
       <IntrinsicFunctions>true</IntrinsicFunctions>
-      <SDLCheck>true</SDLCheck>
+      <SDLCheck>false</SDLCheck>
       <ConformanceMode>true</ConformanceMode>
       <AdditionalIncludeDirectories>$(SolutionDir)\includes;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <InlineFunctionExpansion>AnySuitable</InlineFunctionExpansion>
@@ -122,7 +122,7 @@
       <OptimizeReferences>true</OptimizeReferences>
       <AdditionalDependencies>glew32.lib;glew32s.lib;glfw3.lib;Opengl32.lib;assimp.lib;%(AdditionalDependencies)</AdditionalDependencies>
       <AdditionalLibraryDirectories>$(SolutionDir)\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
-      <SubSystem>NotSet</SubSystem>
+      <SubSystem>Windows</SubSystem>
       <EntryPointSymbol>mainCRTStartup</EntryPointSymbol>
     </Link>
   </ItemDefinitionGroup>

NormalMapGeneratorTool/Resources/Shaders/modelView.fs

@@ -283,7 +283,6 @@ void main()
 			vec3 diffuseAndAmbient = diffuse + ambient;
 			vec3 reflectionCol = textureLod(skybox, reflect(-viewDir, norm), _Roughness).rgb;
 			vec3 result = mix(diffuseAndAmbient, reflectionCol, _Reflectivity) + specular;
-			//result = result/(result + vec3(1.0));
 			result = pow(result, vec3(1.0/2.2));
 			FragColor = vec4(result, 1.0);//PBR_Colour(norm, _CameraPosition, FragPos, vec3(1,1,1), 1.0, 0.4, lightPos);
 		}

NormalMapGeneratorTool/src/MainApp.cpp

@@ -428,11 +428,13 @@ int main(void)
 		glClearColor(0.1f, 0.1f, 0.1f, 1.0);
 		glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
 
+		// Draw the frame by using the frame buffer texture
 		frameShader.use();
 		frameShader.applyShaderUniformMatrix(frameModelMatrixUniform, frameDrawingPanel.getTransform()->getMatrix());
 		frameDrawingPanel.setTextureID(fbs.getColourTexture());
 		frameDrawingPanel.draw();
 
+		// Set up the preview frame buffer and then render the 3d model
 		previewFbs.BindFrameBuffer();
 
 		glEnable(GL_DEPTH_TEST);
@@ -459,6 +461,7 @@ int main(void)
 		}
 		prevMcord = windowSys.GetCursorPos();
 
+		// Set up preview model uniforms
 		modelViewShader.use();
 		modelViewShader.applyShaderUniformMatrix(modelPreviewModelUniform, glm::mat4());
 		modelViewShader.applyShaderUniformMatrix(modelPreviewViewUniform, glm::lookAt(cameraPosition, glm::vec3(0), glm::vec3(0, 1, 0)));
@@ -504,12 +507,14 @@ int main(void)
 			modelPreviewObj->draw();
 		glActiveTexture(GL_TEXTURE0);
 
+		// Set up preview shader uniforms
 		gridLineShader.use();
 		gridLineShader.applyShaderUniformMatrix(gridLineModelMatrixUniform, glm::scale(glm::mat4(), glm::vec3(100, 0, 100)));
 		gridLineShader.applyShaderUniformMatrix(gridLineViewMatrixUniform, glm::lookAt(cameraPosition, glm::vec3(0), glm::vec3(0, 1, 0)));
 		gridLineShader.applyShaderUniformMatrix(gridLineProjectionMatrixUniform, glm::perspective(glm::radians(45.0f), 1.0f, 0.1f, 100.0f));
 		previewPlane->draw();
 
+		// Set up the default framebuffer
 		glBindFramebuffer(GL_FRAMEBUFFER, 0);
 
 		if (windowSys.GetWindowRes().x < windowSys.GetWindowRes().y)

NormalMapGeneratorTool/src/WindowSystem.cpp

@@ -17,6 +17,7 @@ void WindowSystem::Init(const std::string windowTitle, int windowWidth, int wind
 	/*glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 3);
 	glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 3);
 	glfwWindowHint(GLFW_OPENGL_PROFILE, GLFW_OPENGL_CORE_PROFILE);*/
+
 	window = glfwCreateWindow(windowRes.x, windowRes.y, windowTitle.c_str(), NULL, NULL);
 	videoMode = glfwGetVideoMode(glfwGetPrimaryMonitor());
 	maxWindowRes.x = videoMode->width;