Merge pull request #53 from Interrupt/fixes/font-example-cleanup

Getting the stresstest example to run cleanly without leaks

Author: Interrupt

src/examples/collision.zig

@@ -36,7 +36,8 @@ pub fn main() !void {
         // See https://github.com/ziglang/zig/issues/19072
         try delve.init(std.heap.c_allocator);
     } else {
-        try delve.init(gpa.allocator());
+        // Using the default allocator will let us detect memory leaks
+        try delve.init(delve.mem.createDefaultAllocator());
     }
 
     try registerModule();

src/examples/debugdraw.zig

@@ -29,7 +29,8 @@ pub fn main() !void {
         // See https://github.com/ziglang/zig/issues/19072
         try delve.init(std.heap.c_allocator);
     } else {
-        try delve.init(gpa.allocator());
+        // Using the default allocator will let us detect memory leaks
+        try delve.init(delve.mem.createDefaultAllocator());
     }
 
     try registerModule();

src/examples/easing.zig

@@ -36,7 +36,8 @@ pub fn main() !void {
         // See https://github.com/ziglang/zig/issues/19072
         try delve.init(std.heap.c_allocator);
     } else {
-        try delve.init(gpa.allocator());
+        // Using the default allocator will let us detect memory leaks
+        try delve.init(delve.mem.createDefaultAllocator());
     }
 
     try registerModule();

src/examples/fonts.zig

@@ -28,7 +28,8 @@ pub fn main() !void {
         // See https://github.com/ziglang/zig/issues/19072
         try delve.init(std.heap.c_allocator);
     } else {
-        try delve.init(gpa.allocator());
+        // Using the default allocator will let us detect memory leaks
+        try delve.init(delve.mem.createDefaultAllocator());
     }
 
     try registerModule();
@@ -132,4 +133,6 @@ fn on_draw() void {
 
 fn on_cleanup() !void {
     debug.log("Fonts example module cleaning up", .{});
+    font_batch.deinit();
+    shader_blend.destroy();
 }

src/examples/forest.zig

@@ -50,7 +50,8 @@ pub fn main() !void {
         // See https://github.com/ziglang/zig/issues/19072
         try delve.init(std.heap.c_allocator);
     } else {
-        try delve.init(gpa.allocator());
+        // Using the default allocator will let us detect memory leaks
+        try delve.init(delve.mem.createDefaultAllocator());
     }
 
     try registerModule();
@@ -408,4 +409,8 @@ fn on_draw() void {
 
 fn on_cleanup() !void {
     debug.log("Forest example module cleaning up", .{});
+    sprite_batch.deinit();
+    cloud_batch.deinit();
+    grass_batch.deinit();
+    shader_blend.destroy();
 }

src/examples/framepacing.zig

@@ -38,7 +38,8 @@ pub fn main() !void {
         // See https://github.com/ziglang/zig/issues/19072
         try delve.init(std.heap.c_allocator);
     } else {
-        try delve.init(gpa.allocator());
+        // Using the default allocator will let us detect memory leaks
+        try delve.init(delve.mem.createDefaultAllocator());
     }
 
     try registerModule();

src/examples/frustums.zig

@@ -7,6 +7,8 @@ var gpa = std.heap.GeneralPurposeAllocator(.{}){};
 var primary_camera: delve.graphics.camera.Camera = undefined;
 var secondary_camera: delve.graphics.camera.Camera = undefined;
 
+var shader: delve.platform.graphics.Shader = undefined;
+
 var material_frustum: delve.platform.graphics.Material = undefined;
 var material_cube: delve.platform.graphics.Material = undefined;
 var material_highlight: delve.platform.graphics.Material = undefined;
@@ -24,14 +26,16 @@ pub fn main() !void {
         // See https://github.com/ziglang/zig/issues/19072
         try delve.init(std.heap.c_allocator);
     } else {
-        try delve.init(gpa.allocator());
+        // Using the default allocator will let us detect memory leaks
+        try delve.init(delve.mem.createDefaultAllocator());
     }
 
     const example = delve.modules.Module{
         .name = "frustums_example",
         .init_fn = on_init,
         .tick_fn = on_tick,
         .draw_fn = on_draw,
+        .cleanup_fn = on_cleanup,
     };
 
     try delve.modules.registerModule(example);
@@ -41,7 +45,7 @@ pub fn main() !void {
 }
 
 pub fn on_init() !void {
-    const shader = delve.platform.graphics.Shader.initFromBuiltin(.{ .vertex_attributes = delve.graphics.mesh.getShaderAttributes() }, delve.shaders.default_mesh);
+    shader = delve.platform.graphics.Shader.initFromBuiltin(.{ .vertex_attributes = delve.graphics.mesh.getShaderAttributes() }, delve.shaders.default_mesh).?;
 
     // Create some materials
     material_frustum = try delve.platform.graphics.Material.init(.{
@@ -121,6 +125,14 @@ pub fn on_draw() void {
     frustum_mesh.draw(view_mats, frustum_model_matrix);
 }
 
+pub fn on_cleanup() !void {
+    frustum_mesh.deinit();
+    material_highlight.deinit();
+    material_cube.deinit();
+    material_frustum.deinit();
+    shader.destroy();
+}
+
 pub fn createFrustumMesh() !delve.graphics.mesh.Mesh {
     var builder = delve.graphics.mesh.MeshBuilder.init(delve.mem.getAllocator());
     defer builder.deinit();

src/examples/imgui.zig

@@ -25,7 +25,8 @@ pub fn main() !void {
         // See https://github.com/ziglang/zig/issues/19072
         try delve.init(std.heap.c_allocator);
     } else {
-        try delve.init(gpa.allocator());
+        // Using the default allocator will let us detect memory leaks
+        try delve.init(delve.mem.createDefaultAllocator());
     }
 
     try registerModule();

src/examples/lighting.zig

@@ -24,6 +24,9 @@ const Color = colors.Color;
 const lit_shader = delve.shaders.default_basic_lighting;
 const skinned_lit_shader = delve.shaders.default_skinned_basic_lighting;
 
+var skinned_shader: graphics.Shader = undefined;
+var static_shader: graphics.Shader = undefined;
+
 var animated_mesh: skinned_mesh.SkinnedMesh = undefined;
 var animation: skinned_mesh.PlayingAnimation = undefined;
 
@@ -51,7 +54,8 @@ pub fn main() !void {
         // See https://github.com/ziglang/zig/issues/19072
         try delve.init(std.heap.c_allocator);
     } else {
-        try delve.init(gpa.allocator());
+        // Using the default allocator will let us detect memory leaks
+        try delve.init(delve.mem.createDefaultAllocator());
     }
 
     try registerModule();
@@ -81,17 +85,16 @@ fn on_init() !void {
     camera.direction = Vec3.new(0.0, 0.0, 1.0);
 
     // make shaders for skinned and unskinned meshes
-    const skinned_shader = graphics.Shader.initFromBuiltin(.{ .vertex_attributes = skinned_mesh.getSkinnedShaderAttributes() }, skinned_lit_shader);
-
-    const static_shader = graphics.Shader.initFromBuiltin(.{ .vertex_attributes = delve.graphics.mesh.getShaderAttributes() }, lit_shader);
+    skinned_shader = graphics.Shader.initFromBuiltin(.{ .vertex_attributes = skinned_mesh.getSkinnedShaderAttributes() }, skinned_lit_shader).?;
+    static_shader = graphics.Shader.initFromBuiltin(.{ .vertex_attributes = delve.graphics.mesh.getShaderAttributes() }, lit_shader).?;
 
     var base_img: images.Image = try images.loadFile(mesh_texture_file);
     defer base_img.deinit();
     const tex_base = graphics.Texture.init(&base_img);
 
     // Create a material out of our shader and textures
     skinned_mesh_material = try delve.platform.graphics.Material.init(.{
-        .shader = skinned_shader.?,
+        .shader = skinned_shader,
         .texture_0 = tex_base,
         .texture_1 = delve.platform.graphics.createSolidTexture(0x00000000),
 
@@ -104,7 +107,7 @@ fn on_init() !void {
 
     // Create a material out of the texture
     static_mesh_material = try graphics.Material.init(.{
-        .shader = static_shader.?,
+        .shader = static_shader,
         .texture_0 = delve.platform.graphics.createSolidTexture(0xFFFFFFFF),
         .texture_1 = delve.platform.graphics.createSolidTexture(0x00000000),
 
@@ -176,6 +179,12 @@ fn on_draw() void {
 fn on_cleanup() !void {
     debug.log("Lighting example module cleaning up", .{});
 
+    skinned_shader.destroy();
+    static_shader.destroy();
+
+    skinned_mesh_material.deinit();
+    static_mesh_material.deinit();
+
     animation.deinit();
     animated_mesh.deinit();
 }

src/examples/lua.zig

@@ -17,7 +17,8 @@ pub fn main() !void {
         // See https://github.com/ziglang/zig/issues/19072
         try delve.init(std.heap.c_allocator);
     } else {
-        try delve.init(gpa.allocator());
+        // Using the default allocator will let us detect memory leaks
+        try delve.init(delve.mem.createDefaultAllocator());
     }
 
     try lua_module.registerModule();