VXR Release 0.1.1. Bugfixes. Removed some misleading error messages. Added documentation to examples. Cleaned up some code. Added Math Utility class. Added more colors to Colors class. Started development on biomes for Planet Editor. Removed Release configuration from genie.lua. Removed some warnings.

Author: avilapa

assets/shaders/glsl/standard.frag

@@ -43,8 +43,6 @@ vec3 lightColor = vec3(1,1,1);
 
 void main()
 {
-  //fragColor = vec4((n * 0.5 + 0.5) * texture(u_tex0, uv).rgb, 1.0);
-
   // ambient
   float ambientStrength = 0.1;
   vec3 ambient = ambientStrength * lightColor;

assets/shaders/glsl/unlit.frag

@@ -0,0 +1,43 @@
+// ----------------------------------------------------------------------------------------
+// MIT License
+// 
+// Copyright(c) 2018 Víctor Ávila
+// 
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files(the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions :
+// 
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+// 
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+// ----------------------------------------------------------------------------------------
+
+#version 330
+
+in vec3 position;
+in vec3 normal;
+in vec2 uv;
+
+layout(std140) uniform Uniforms
+{
+  vec4 color;
+};
+
+uniform sampler2D u_tex0;
+
+out vec4 fragColor;
+
+void main()
+{
+  fragColor = vec4(color);
+}

assets/shaders/glsl/unlit.vert

@@ -0,0 +1,58 @@
+// ----------------------------------------------------------------------------------------
+// MIT License
+// 
+// Copyright(c) 2018 Víctor Ávila
+// 
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files(the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions :
+// 
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+// 
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+// ----------------------------------------------------------------------------------------
+
+#version 330
+
+in vec3 a_position;
+in vec3 a_normal;
+in vec2 a_uv;
+
+uniform mat4 u_model;
+layout(std140) uniform Common
+{
+  mat4 u_proj;
+  mat4 u_view;
+
+  vec2 resolution;
+  vec2 xy;
+
+  vec4 u_clear_color;
+};
+
+layout(std140) uniform Uniforms
+{
+  vec4 color;
+};
+
+out vec3 position;
+out vec3 normal;
+out vec2 uv;
+
+void main()
+{
+  gl_Position = u_proj * u_view * u_model * vec4(a_position, 1.0);
+  position = a_position;
+  normal = a_normal;
+  uv = a_uv;
+}

examples/01-HelloWorld/hello_world.cpp

@@ -25,6 +25,7 @@
 #include "hello_world.h"
 #include "../../include/graphics/display_list.h"
 
+// 0. Define the entry point.
 VXR_DEFINE_APP_MAIN(vxr::Main)
 
 #define GLSL(...) "#version 330\n" #__VA_ARGS__
@@ -43,11 +44,11 @@ namespace vxr
 
   void Main::start()
   {
-    window_title_ = (char*)malloc(512 + strlen("VXR Hello World Test"));
-
+    // 1. Create vertex and index buffer for the triangle.
     vertex_buffer_ = Engine::ref().gpu()->createBuffer({ BufferType::Vertex, sizeof(vertex_data), Usage::Static });
     index_buffer_  = Engine::ref().gpu()->createBuffer({ BufferType::Index,  sizeof(index_data),  Usage::Static });
 
+    // 2. Initialize shader data and vertex attributes data and create material for the triangle.
     gpu::Material::Info mat_info;
     mat_info.shader.vert = GLSL(
       in vec3 a_position;
@@ -66,6 +67,7 @@ namespace vxr
 
     material_ = Engine::ref().gpu()->createMaterial(mat_info);
 
+    // 3. Create a render command display list to fill the index and vertex buffers with the appropriate data once.
     DisplayList frame;
     frame.fillBufferCommand()
       .set_buffer(vertex_buffer_)
@@ -75,24 +77,22 @@ namespace vxr
       .set_buffer(index_buffer_)
       .set_data(index_data)
       .set_size(sizeof(index_data));
+
+    // 4. Submit display list to be rendered on the GPU.
     Engine::ref().submitDisplayList(std::move(frame));
   }
 
   void Main::renderUpdate()
   {
-    sprintf(window_title_,
-      "%s: %d FPS @ 1280 x 720, Rendering time: %f ms",
-      "VXR Hello World Test",
-      fps(), 1.0 / (double)fps());
-
-    Engine::ref().window()->set_title(window_title_);
-    
     DisplayList frame;
+    // 5. Clear the screen.
     frame.clearCommand()
       .set_color(Color::Black);
+    // 6. Setup the material for rendering with the vertex buffer attached.
     frame.setupMaterialCommand()
       .set_material(material_)
       .set_buffer(0, vertex_buffer_);
+    // 7. Create render command and submit display list to accummulate with previous commands.
     frame.renderCommand()
       .set_index_buffer(index_buffer_)
       .set_count(sizeof(index_data) / sizeof(uint16))

examples/01-HelloWorld/hello_world.h

@@ -47,8 +47,6 @@ namespace vxr
     virtual void renderUpdate() override;
 
   private:
-    char* window_title_;
-
     gpu::Buffer vertex_buffer_;
     gpu::Buffer index_buffer_;
     gpu::Material material_;

examples/02-Instancing/instancing.cpp

@@ -25,6 +25,7 @@
 #include "instancing.h"
 #include "../../include/graphics/display_list.h"
 
+// 0. Define the entry point.
 VXR_DEFINE_APP_MAIN(vxr::Main)
 
 #define GLSL(...) "#version 330\n" #__VA_ARGS__
@@ -80,14 +81,16 @@ namespace vxr
 
   void Main::start()
   {
-    window_title_ = (char*)malloc(512 + strlen("VXR Instancing Test"));
-
+    // 1. Create vertex and index buffer to render a cube.
     vertex_buffer_             = Engine::ref().gpu()->createBuffer({ BufferType::Vertex,  sizeof(vertex_data), Usage::Static });
-    index_buffer_              = Engine::ref().gpu()->createBuffer({ BufferType::Index,   sizeof(index_data), Usage::Static });
-    instance_positions_buffer_ = Engine::ref().gpu()->createBuffer({ BufferType::Vertex,  sizeof(instance_positions_), Usage::Stream });
-    instance_colors_buffer_    = Engine::ref().gpu()->createBuffer({ BufferType::Vertex,  sizeof(instance_colors_), Usage::Static });
+    index_buffer_              = Engine::ref().gpu()->createBuffer({ BufferType::Index,   sizeof(index_data),  Usage::Static });
+    // 2. Create instance data for positions and colors of each cube.
+    instance_positions_buffer_ = Engine::ref().gpu()->createBuffer({ BufferType::Vertex,  sizeof(instance_positions_), Usage::Dynamic });
+    instance_colors_buffer_    = Engine::ref().gpu()->createBuffer({ BufferType::Vertex,  sizeof(instance_colors_),    Usage::Static });
+    // 3. Create uniform buffer to store the static data of a cube.
     uniform_buffer_            = Engine::ref().gpu()->createBuffer({ BufferType::Uniform, sizeof(UniformState_Static), Usage::Static, "UniformState_Static" });
 
+    // 4. Initialize shader data. The engine uses UBO for the objects, so the correct syntax to use custom uniforms can be found below. 
     gpu::Material::Info mat_info;
     mat_info.shader.vert = GLSL(
       in vec3 a_position;
@@ -121,34 +124,41 @@ namespace vxr
       }
     );
 
+    // 5. Initialize vertex attributes. This time, we'll pass three different buffers. One with positions normals and uvs data, another with the instance positions and a last one with instance colors.
     mat_info.attribs[0] = { "a_position",          VertexFormat::Float3 };
     mat_info.attribs[1] = { "a_normal",            VertexFormat::Float3 };
     mat_info.attribs[2] = { "a_uv",                VertexFormat::Float2 };
     mat_info.attribs[3] = { "a_instance_position", VertexFormat::Float3, 1, VertexStep::PerInstance };
     mat_info.attribs[4] = { "a_instance_color",    VertexFormat::Float3, 2, VertexStep::PerInstance };
 
+    // 6. Add a texture to the material.
     mat_info.textures[0] = TextureType::T2D;
 
+    // 7. Load the texture and create the asset.
     gpu::Texture::Info tex_info;
     tex_data_ = gpu::Texture::loadFromFile("../../assets/textures/image.tga", tex_info);
     tex_info.magnification_filter = SamplerFiltering::Nearest;
     tex_info.minification_filter = SamplerFiltering::Nearest;
     texture_ = Engine::ref().gpu()->createTexture(tex_info);
 
+    // 8. Initialize instance data.
     for (int i = 0; i < kNUM_INSTANCES; ++i)
     {
       instance_colors_[i] = vec3(rand() % 255 / 255.0f, rand() % 255 / 255.0f, rand() % 255 / 255.0f);
     }
 
+    // 9. And finally create the material for rendering the cubes with the information.
     material_ = Engine::ref().gpu()->createMaterial(mat_info);
 
+    // 10. Set camera view and perspective matrices of the uniform buffer.
     vec3 position = vec3(57.5f, 15.0f, -5.0f), forward = vec3(0.0f, -0.5f, 1.0f), up = vec3(0.0f, 1.0f, 1.0f);
     float fov = 70.0f;
 
     u_state_static_.model = mat4(1);
     u_state_static_.view = glm::lookAt(position, position + forward, up);
     u_state_static_.proj = glm::perspective(glm::radians(fov), 1280.0f / 720.0f, 0.5f, 900.0f);
 
+    // 11. Create a render command display list to fill the index and vertex buffers with the appropriate data once.
     DisplayList frame;
     frame.fillBufferCommand()
       .set_buffer(vertex_buffer_)
@@ -158,14 +168,17 @@ namespace vxr
       .set_buffer(index_buffer_)
       .set_data(index_data)
       .set_size(sizeof(index_data));
+    // 12. Fill the instance colors buffer (we will be filling the positions in the update, as the buffer requires a dynamic update).
     frame.fillBufferCommand()
       .set_buffer(instance_colors_buffer_)
       .set_data(instance_colors_)
       .set_size(sizeof(instance_colors_));
+    // 13. Fill the uniform data once.
     frame.fillBufferCommand()
       .set_buffer(uniform_buffer_)
       .set_data(&u_state_static_)
       .set_size(sizeof(UniformState_Static));
+    // 14. Upload texture data to the GPU.
     frame.fillTextureCommand()
       .set_texture(texture_)
       .set_data(tex_data_);
@@ -174,6 +187,7 @@ namespace vxr
 
   void Main::update()
   {
+    // 15. Update instances position. This operations are performed in the update() instead of the renderUpdate() for them to take into account deltaTime() and be framerate independent.
     static float v = 0;
     for (int i = 0; i < kNUM_INSTANCES; ++i)
     {
@@ -191,27 +205,23 @@ namespace vxr
 
   void Main::renderUpdate()
   {
-    sprintf(window_title_,
-      "%s: %d FPS @ 1280 x 720, Number of instances: %d",
-      "VXR Instancing Test",
-      fps(), kNUM_INSTANCES);
-
-    Engine::ref().window()->set_title(window_title_);
-
     DisplayList frame;
     frame.clearCommand()
       .set_color({ 0.1f, 0.1f, 0.1f, 1.0f });
+    // 16. Re-upload instance position data to the GPU once each frame.
     frame.fillBufferCommand()
       .set_buffer(instance_positions_buffer_)
       .set_data(instance_positions_)
       .set_size(sizeof(instance_positions_));
+    // 17. Setup material for rendering. This time, all the buffers and textures need to be set as parameters.
     frame.setupMaterialCommand()
       .set_material(material_)
       .set_buffer(0, vertex_buffer_)
       .set_buffer(1, instance_positions_buffer_)
       .set_buffer(2, instance_colors_buffer_)
       .set_uniform_buffer(0, uniform_buffer_)
       .set_texture(0, texture_);
+    // 18. Add render command with the number of instances to be rendered.
     frame.renderCommand()
       .set_index_buffer(index_buffer_)
       .set_count(sizeof(index_data) / sizeof(uint16))
@@ -224,6 +234,7 @@ namespace vxr
 
   void Main::stop() 
   {
+    // 19. Free the texture data at the end of the application.
     if (tex_data_)
     {
       free(tex_data_);

examples/02-Instancing/instancing.h

@@ -49,8 +49,6 @@ namespace vxr
     virtual void stop() override;
 
   private:
-    char* window_title_;
-
     gpu::Buffer vertex_buffer_;
     gpu::Buffer index_buffer_;
     gpu::Buffer instance_positions_buffer_;