Include more docs in effect templates

Author: einarf

demosys/effect_templates/cube_simple/dependencies.py

@@ -4,7 +4,10 @@
 
 
 def local(path):
-    """Get the effect package name"""
+    """
+    Prepend the effect package name to a path so resources
+    can still be loaded when copied into a new effect package.
+    """
     return os.path.join(__name__.split('.')[-2], path)
 
 

demosys/effect_templates/cube_simple/effects.py

@@ -8,25 +8,30 @@ class SimpleCubeEffect(effect.Effect):
     runnable = True
 
     def __init__(self):
+        # Obtain the shader program using its label
         self.program = self.get_program('cube_plain')
+        # Create a 4x4x4 cube with center in (0, 0, 0)
         self.cube = geometry.cube(4.0, 4.0, 4.0)
 
     def draw(self, time, frametime, target):
-        self.ctx.enable(moderngl.DEPTH_TEST)
+        # Enable depth testing and face fulling
+        self.ctx.enable(moderngl.DEPTH_TEST | moderngl.CULL_FACE)
 
-        # Rotate and translate
+        # Rotate and translate (modelview matrix)
         m_mv = self.create_transformation(rotation=(time * 1.2, time * 2.1, time * 0.25),
                                           translation=(0.0, 0.0, -8.0))
 
-        # Apply the rotation and translation from the system camera
+        # Uncomment to Apply the rotation and translation from the system camera
         # m_mv = matrix44.multiply(m_mv, self.sys_camera.view_matrix)
 
         # Create normal matrix from model-view
         m_normal = self.create_normal_matrix(m_mv)
 
-        # Draw the cube
+        # Write to the shader programs uniforms
         self.program["m_proj"].write(self.sys_camera.projection.tobytes())
         self.program["m_mv"].write(m_mv.astype('f4').tobytes())
         self.program["m_normal"].write(m_normal.astype('f4').tobytes())
         self.program["time"].value = time
+
+        # Render the cube
         self.cube.render(self.program)

demosys/effect_templates/raymarching_simple/dependencies.py

@@ -4,7 +4,10 @@
 
 
 def local(path):
-    """Get the effect package name"""
+    """
+    Prepend the effect package name to a path so resources
+    can still be loaded when copied into a new effect package.
+    """
     return os.path.join(__name__.split('.')[-2], path)
 
 

demosys/project_template/project/settings.py

@@ -16,7 +16,7 @@
 
 # Window / context properties
 WINDOW = {
-    "class": "demosys.context.pyqt.GLFW_Window",
+    "class": "demosys.context.pyqt.Window",
     "size": (1280, 720),
     "aspect_ratio": 16 / 9,
     "fullscreen": False,