Ważne jest, aby rejestrować czas, w którym gra wykonuje zdarzenia wczytywania dla z 2 powodów:
- Aby uniknąć zanieczyszczenia danych o czasie renderowania klatki podczas wczytywania.
- Aby przeanalizować czasy wczytywania i sprawdzić, kiedy i gdzie czas wczytywania jest dłuższy niż jest akceptowalna.
Zdarzenie wczytywania może mieć powiązane metadane:
public class LoadingTimeMetadata
{
public enum LoadingState
{
Unknown = 0,
/// <summary>
/// The first time the game is run.
/// </summary>
FirstRun = 1,
/// <summary>
/// App is not backgrounded.
/// </summary>
ColdStart = 2,
/// <summary>
/// App is backgrounded.
/// </summary>
WarmStart = 3,
/// <summary>
/// App is backgrounded, least work needed.
/// </summary>
HotStart = 4,
/// <summary>
/// Asset loading between levels.
/// </summary>
InterLevel = 5
}
public LoadingState state;
public enum LoadingSource
{
UnknownSource = 0,
/// <summary>
/// Uncompressing data.
/// </summary>
Memory = 1,
/// <summary>
/// Reading assets from APK bundle.
/// </summary>
Apk = 2,
/// <summary>
/// Reading assets from device storage.
/// </summary>
DeviceStorage = 3,
/// <summary>
/// Reading assets from external storage, e.g. SD card.
/// </summary>
ExternalStorage = 4,
/// <summary>
/// Loading assets from the network.
/// </summary>
Network = 5,
/// <summary>
/// Shader compilation.
/// </summary>
ShaderCompilation = 6,
/// <summary>
/// Time spent between process starting and onCreate.
/// </summary>
PreActivity = 7,
/// <summary>
/// Total time spent between process starting and first render frame.
/// </summary>
FirstTouchToFirstFrame = 8,
/// <summary>
/// Time from start to end of a group of events.
/// </summary>
TotalUserWaitForGroup = 9
}
public LoadingSource source;
/// <summary>
/// 0 = no compression, 100 = max compression
/// </summary>
public int compression_level;
public enum NetworkConnectivity
{
Unknown = 0,
Wifi = 1,
CellularNetwork = 2
}
public NetworkConnectivity network_connectivity;
/// <summary>
/// Bandwidth in bits per second.
/// </summary>
public ulong network_transfer_speed_bps;
/// <summary>
/// Latency in nanoseconds.
/// </summary>
public ulong network_latency_ns;
}
Wartość wszystkich pól, które nie są związane z Twoimi potrzebami, może wynosić zero.
Zdarzenie wczytywania może też mieć powiązaną adnotację. Możesz zdefiniować w
tak samo jak w przypadku adnotacji o czasie renderowania klatki, używając co najmniej 1 pola w panelu Annotation
.
Result<ulong> StartRecordingLoadingTime(LoadingTimeMetadata eventMetadata,
TAnnotation
annotation);
Ta funkcja rozpoczyna rejestrowanie zdarzenia wczytywania powiązanego z danym
metadanych i adnotacji oraz wypełnia pole Result<ulong>.value, które ma być używane
StopRecordingLoadingTime().
ErrorCode StopRecordingLoadingTime(ulong handle);
Ta funkcja zatrzymuje rejestrowanie zdarzenia, które zostało wcześniej rozpoczęte przez
StartRecordingLoadingTime() Zdarzenie zostanie przesłane przy następnym usunięciu sesji.
Wczytuję funkcje grupy
W jednym okresie wczytywania w grze możesz zarejestrować kilka zdarzeń wczytywania widoczne dla użytkownika. wczytywanie pliku, scene; wczytywanie, dekompresję i kompilację programu do cieniowania.
Ważne jest, aby poinformować narzędzie Android Performance Tuner, że zdarzenia wczytywania są częścią aby uzyskać lepsze statystyki. Dodaj ładunek zdarzeń z podanymi niżej funkcjami uruchamiania i zatrzymywania.
Result<ulong> StartLoadingGroup(LoadingTimeMetadata eventMetadata, TAnnotation
annotation);
Ta funkcja uruchamia grupę wczytywania powiązaną z danymi metadanymi i
i wypełnia pole Result<ulong>.value, które będzie używane w
StopLoadingGroup(). Metadane i adnotacja nie są obecnie
używane przez backend Google Play, ale tylko adnotacja może mieć ustawienie null. Wszystkie kolejne zdarzenia wczytywania
są otagowane unikalnym identyfikatorem grupy.
ErrorCode StopLoadingGroup(ulong handle);
Ta funkcja zatrzymuje grupę wczytywania, która została uruchomiona wcześniej przez zasadę StartLoadingGroup().
Kolejne zdarzenia wczytywania nie będą miały identyfikatora grupy aż do StartLoadingGroup()
jest wywoływany ponownie.
Rysunek 1. Przykład grupy wczytywanej.
Przykłady
Oto kilka przykładów, jak dodać do gry funkcje czasu wczytywania.
Zdarzenia wczytywania pliku
Poniższy przykładowy kod pokazuje, jak rejestrować w grze zdarzenia wczytywania plików.
public RawImage image;
IEnumerator LoadImageFromStreamingAssets(string imageName)
{
string imagePath = "file://" + Path.Combine(Application.streamingAssetsPath, imageName);
using (var r = UnityWebRequestTexture.GetTexture(imagePath))
{
LoadingTimeMetadata fileLoadingMetadata = new LoadingTimeMetadata()
{
state = LoadingTimeMetadata.LoadingState.InterLevel,
source = LoadingTimeMetadata.LoadingSource.DeviceStorage,
// Fields are zero by default but they could be set as follows
compression_level = 0,
network_connectivity = 0,
network_transfer_speed_bps = 0,
network_latency_ns = 0
};
Annotation annotation = new Annotation()
{
Scene = Scene.MagicalForest
};
// Start recording loading time.
Result<ulong> result = performanceTuner.StartRecordingLoadingTime(fileLoadingMetadata, annotation);
yield return r.SendWebRequest();
// Stop recording loading time.
performanceTuner.StopRecordingLoadingTime(result.value);
if (r.isNetworkError || r.isHttpError)
{
Debug.Log(r.error);
}
else
{
Texture2D tex = DownloadHandlerTexture.GetContent(r);
image.texture = tex;
}
}
}
Zdarzenia wczytywania sceny
Poniższy przykładowy kod pokazuje, jak rejestrować zdarzenia wczytywania sceny w tę grę.
IEnumerator LoadScene(int sceneIndex)
{
LoadingTimeMetadata metadata = new LoadingTimeMetadata()
{state = LoadingTimeMetadata.LoadingState.InterLevel};
Annotation annotation = new Annotation() {Scene = (Scene) (sceneIndex + 1)};
Result<ulong> result = performanceTuner.StartRecordingLoadingTime(metadata, annotation);
AsyncOperation asyncSceneLoad = SceneManager.LoadSceneAsync(sceneIndex, LoadSceneMode.Single);
while (!asyncSceneLoad.isDone)
{
yield return null;
}
performanceTuner.StopRecordingLoadingTime(result.value);
}
Wczytuję funkcje grupy
Poniższy przykładowy kod pokazuje, jak dodać funkcje grup wczytywania do tę grę.
IEnumerator LoadImages()
{
LoadingTimeMetadata groupMetadata = new LoadingTimeMetadata()
{
state = LoadingTimeMetadata.LoadingState.InterLevel,
source = LoadingTimeMetadata.LoadingSource.DeviceStorage,
};
Result<ulong> result = performanceTuner.StartLoadingGroup(groupMetadata, null);
yield return StartCoroutine(LoadImageFromStreamingAssets("image1.jpeg"));
yield return StartCoroutine(LoadImageFromStreamingAssets("image2.jpeg"));
yield return StartCoroutine(LoadImageFromStreamingAssets("image3.jpeg"));
yield return StartCoroutine(LoadImageFromStreamingAssets("image4.jpeg"));
var stopErrorCode = performanceTuner.StopLoadingGroup(0);
}