Reference
This section contains a reference for attributes and classes the Performance Testing Package supports.
Test Attributes
[Performance] - Use this with Test
and UnityTest
attributes. It will initialize necessary test setup for performance tests.
[Test] - Non-yielding test. This type of test starts and ends within the same frame.
[UnityTest] - Yielding test. This is a good choice if you want to sample measurements across multiple frames. For more on the difference between [Test]
and [UnityTest]
, see the Unity Test Framework documentation.
[Version(string version)] - Performance tests should be versioned with every change. If not specified, the default used is 1. This is essential when comparing results as results will vary any time the test changes.
SampleGroup
class SampleGroup - represents a group of samples with the same purpose that share a name, sample unit and whether an increase is better.
Optional parameters
- Name : Name of the measurement. If unspecified, "Time" is used as the default name.
- Unit : Unit of the measurement to report samples in. Possible values are:
Nanosecond, Microsecond, Millisecond, Second, Byte, Kilobyte, Megabyte, Gigabyte
- IncreaseIsBetter : If true, an increase in the measurement value is considered a performance improvement (progression). If false, an increase is treated as a performance regression. False by default.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.