Performance profiling in Unity - Mini Project: Build & Apply

Performance Profiling in Unity

📖 Scenario: You are developing a simple Unity game where you want to check how long certain actions take to run. This helps you find slow parts and make your game faster.

🎯 Goal: You will create a script that measures the time taken by a simple loop operation using Unity's Stopwatch class. You will then display the elapsed time in the console.

📋 What You'll Learn

Create a Unity C# script with a Stopwatch to measure time

Use a loop to simulate work

Calculate elapsed time in milliseconds

Print the elapsed time to the Unity console

💡 Why This Matters

🌍 Real World

Game developers use performance profiling to find slow parts of their games and improve player experience by making games run smoothly.

💼 Career

Knowing how to profile and optimize code is important for game programmers and software engineers to create efficient and responsive applications.

1

Create a Stopwatch variable

In a new C# script, create a Stopwatch variable called stopwatch and initialize it with new Stopwatch().

Unity

using System.Diagnostics;
using UnityEngine;

public class PerformanceProfiler : MonoBehaviour
{
    // Create a Stopwatch variable called stopwatch
    // Your code here
}

Hint

Remember to include using System.Diagnostics; at the top to use Stopwatch.

2

Start the Stopwatch and run a loop

Inside the Start() method, start the stopwatch using stopwatch.Start(). Then write a for loop that runs from i = 0 to i < 1000000 and does nothing inside the loop.

Unity

using System.Diagnostics;
using UnityEngine;

public class PerformanceProfiler : MonoBehaviour
{
    Stopwatch stopwatch = new Stopwatch();

    void Start()
    {
        // Start the stopwatch
        // Run a for loop from i = 0 to i < 1000000
        // Your code here
    }
}

Hint

Use stopwatch.Start() to begin timing before the loop.

3

Stop the Stopwatch and get elapsed time

After the loop, stop the stopwatch using stopwatch.Stop(). Then create a variable elapsedMs and set it to stopwatch.ElapsedMilliseconds.

Unity

using System.Diagnostics;
using UnityEngine;

public class PerformanceProfiler : MonoBehaviour
{
    Stopwatch stopwatch = new Stopwatch();

    void Start()
    {
        stopwatch.Start();
        for (int i = 0; i < 1000000; i++)
        {
            // Do nothing
        }
        // Stop the stopwatch and get elapsed milliseconds
        // Your code here
    }
}

Hint

Use stopwatch.Stop() to end timing and ElapsedMilliseconds to get the time.

4

Print the elapsed time to the console

Use Debug.Log to print the message "Elapsed time: " plus the elapsedMs variable and " ms" inside the Start() method.

Unity

using System.Diagnostics;
using UnityEngine;

public class PerformanceProfiler : MonoBehaviour
{
    Stopwatch stopwatch = new Stopwatch();

    void Start()
    {
        stopwatch.Start();
        for (int i = 0; i < 1000000; i++)
        {
            // Do nothing
        }
        stopwatch.Stop();
        long elapsedMs = stopwatch.ElapsedMilliseconds;
        // Print elapsed time to console
        // Your code here
    }
}

Hint

Use Debug.Log("Elapsed time: " + elapsedMs + " ms") to show the time in Unity's console.

Practice

1. What is the main purpose of using performance profiling in Unity?

easy

A. To write story scripts for the game

B. To add new game features quickly

C. To find slow or heavy parts in your game code

D. To create game art and animations

Solution

1. Step 1: Understand performance profiling

   Performance profiling is used to check which parts of the game code take the most time or resources.

2. Step 2: Match purpose with options

   Only To find slow or heavy parts in your game code talks about finding slow or heavy parts, which matches the purpose of profiling.

3. Final Answer:

   To find slow or heavy parts in your game code -> Option C

4. Quick Check:

   Profiling purpose = find slow code [OK]

Hint: Profiling finds slow code parts to improve performance [OK]

Common Mistakes:

• Confusing profiling with adding features
• Thinking profiling creates art or story
• Mixing profiling with gameplay design

2. Which of the following is the correct way to mark a code section for profiling in Unity?

easy

A. Profiler.BeginSample("MyCode") and Profiler.EndSample()

B. Profiler.MarkStart("MyCode") and Profiler.MarkEnd()

C. Profiler.StartSample("MyCode") and Profiler.StopSample()

D. Profiler.Profile("MyCode")

Solution

1. Step 1: Recall Unity profiling API

   Unity uses Profiler.BeginSample and Profiler.EndSample to mark code sections.

2. Step 2: Compare options with correct API

   Only Profiler.BeginSample("MyCode") and Profiler.EndSample() matches the exact method names used in Unity.

3. Final Answer:

   Profiler.BeginSample("MyCode") and Profiler.EndSample() -> Option A

4. Quick Check:

   Correct API = BeginSample and EndSample [OK]

Hint: Use BeginSample and EndSample to mark profiling code [OK]

Common Mistakes:

• Using StartSample/StopSample instead of BeginSample/EndSample
• Using non-existent Profiler methods
• Forgetting to call EndSample after BeginSample

3. What will be the output in the Unity Profiler if you run this code snippet?

Profiler.BeginSample("HeavyTask");
for (int i = 0; i < 1000000; i++) { var x = Mathf.Sqrt(i); }
Profiler.EndSample();

medium

A. The Profiler shows a sample named 'HeavyTask' with time taken for the loop

B. The Profiler shows an error because of missing Profiler.StopSample()

C. No profiling data is recorded because Profiler.BeginSample is inside a loop

D. The Profiler shows a sample named 'HeavyTask' but with zero time

Solution

1. Step 1: Understand Profiler.BeginSample and EndSample usage

   The code marks the start and end of a heavy task loop, so the Profiler records the time spent inside.

2. Step 2: Analyze Profiler output

   The Profiler will show a sample named 'HeavyTask' with the time taken to run the loop, which is significant.

3. Final Answer:

   The Profiler shows a sample named 'HeavyTask' with time taken for the loop -> Option A

4. Quick Check:

   Profiler records marked code time = The Profiler shows a sample named 'HeavyTask' with time taken for the loop [OK]

Hint: Profiler shows time for code between BeginSample and EndSample [OK]

Common Mistakes:

• Confusing EndSample with StopSample
• Thinking profiler needs to be inside the loop
• Assuming profiler shows zero time for heavy code

4. Identify the error in this profiling code snippet:

Profiler.BeginSample("UpdateLoop");
UpdateGameObjects();
// Missing Profiler.EndSample()

medium

A. Profiler.BeginSample() should be called after UpdateGameObjects()

B. No error, the code is correct

C. Profiler.BeginSample() and EndSample() cannot be used in Update()

D. Profiler.EndSample() is missing, causing incorrect profiling data

Solution

1. Step 1: Check profiling code structure

   Profiler.BeginSample must be paired with Profiler.EndSample to mark the code section properly.

2. Step 2: Identify missing EndSample call

   The code is missing Profiler.EndSample(), which causes the Profiler to not close the sample and gives wrong data.

3. Final Answer:

   Profiler.EndSample() is missing, causing incorrect profiling data -> Option D

4. Quick Check:

   Missing EndSample causes profiling errors [OK]

Hint: Always pair BeginSample with EndSample to avoid errors [OK]

Common Mistakes:

• Forgetting to call EndSample after BeginSample
• Calling BeginSample after the code instead of before
• Thinking profiling can't be used in Update()

5. You want to profile two different parts of your game code separately: physics calculations and AI updates. How should you use the Profiler API to get clear timing for both?

hard

A. Call Profiler.BeginSample("Physics") once at game start and Profiler.EndSample() at game end, same for AI

B. Call Profiler.BeginSample("Physics") before physics code and Profiler.EndSample(), then Profiler.BeginSample("AI") before AI code and Profiler.EndSample()

C. Use Profiler.BeginSample("Physics") and Profiler.BeginSample("AI") at the same time without EndSample()

D. Only use Profiler.EndSample() after both physics and AI code without BeginSample()

Solution

1. Step 1: Understand separate profiling sections

   To profile two parts separately, you must mark each section with its own BeginSample and EndSample calls.

2. Step 2: Apply correct usage for both parts

   Call Profiler.BeginSample("Physics") before physics code and Profiler.EndSample(), then Profiler.BeginSample("AI") before AI code and Profiler.EndSample() correctly calls BeginSample and EndSample around physics code, then again around AI code, giving clear timing for each.

3. Final Answer:

   Call Profiler.BeginSample("Physics") before physics code and Profiler.EndSample(), then Profiler.BeginSample("AI") before AI code and Profiler.EndSample() -> Option B

4. Quick Check:

   Separate samples need separate BeginSample/EndSample pairs [OK]

Hint: Use separate BeginSample/EndSample pairs for each code section [OK]

Common Mistakes:

• Calling BeginSample once for whole game session
• Starting two samples without ending them
• Using EndSample without matching BeginSample