লোডিং টাইম রেকর্ডিং ফাংশন যোগ করুন

আপনার গেম কখন লোডিং ইভেন্ট পারফর্ম করছে তা রেকর্ড করা গুরুত্বপূর্ণ, কারণ:

  1. লোড করার সময় আপনার ফ্রেম টাইম ডেটা যাতে দূষিত না হয় তা এড়াতে।
  2. লোড হওয়ার সময় বিশ্লেষণ করে দেখা যে কখন এবং কোথায় লোড হওয়ার সময় গ্রহণযোগ্য সীমার চেয়ে বেশি।

কোনও লোডিং ইভেন্টের সাথে সংশ্লিষ্ট মেটাডেটা থাকতে পারে:

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;
}

আপনার প্রয়োজন নেই এমন যেকোনও ফিল্ডে শূন্য লিখতে পারেন।

লোডিং ইভেন্টের সাথেও একটি অ্যানোটেশন যুক্ত থাকতে পারে। আপনি ফ্রেম টাইম অ্যানোটেশনের মতোই Annotation মেসেজে এক বা একাধিক ফিল্ড ব্যবহার করে এটি নির্ধারণ করতে পারেন।

Result<ulong> StartRecordingLoadingTime(LoadingTimeMetadata eventMetadata, TAnnotation annotation);

এই ফাংশনটি প্রদত্ত মেটাডেটা এবং অ্যানোটেশনের সাথে যুক্ত লোডিং টাইম ইভেন্ট রেকর্ড করা শুরু করে এবং StopRecordingLoadingTime() ফাংশনে ব্যবহার করার জন্য একটি Result<ulong>.value পূরণ করে।

ErrorCode StopRecordingLoadingTime(ulong handle);

এই ফাংশনটি StartRecordingLoadingTime()-এর মাধ্যমে আগে শুরু করা কোনও ইভেন্টের রেকর্ডিং বন্ধ করে দেয়। পরবর্তী সেশন ফ্লাশে ইভেন্ট আপলোড করা হয়।

গ্রুপ ফাংশন লোড করা হচ্ছে

আপনার গেমে, ব্যবহারকারীর দেখা একটি লোডিং পিরিয়ডের জন্য আপনি একাধিক লোডিং ইভেন্ট রেকর্ড করতে পারেন। কিছু উদাহরণের মধ্যে রয়েছে ফাইল লোড করা, দৃশ্য লোড করা, ডিকম্প্রেশন ও শেডার কম্পাইলেশন।

Android Performance Tuner-কে জানানো গুরুত্বপূর্ণ যে লোডিং ইভেন্টগুলি এই ধরনের গ্রুপের অংশ যাতে এটি আরও ভালো ইনসাইট প্রদান করতে পারে। এটি করার জন্য, নিম্নলিখিত স্টার্ট ও স্টপ ফাংশনের মাধ্যমে আপনার লোডিং ইভেন্ট ব্র্যাকেট করুন।

Result<ulong> StartLoadingGroup(LoadingTimeMetadata eventMetadata, TAnnotation annotation);

এই ফাংশন প্রদত্ত মেটাডেটা এবং অ্যানোটেশনের সাথে যুক্ত একটি লোডিং গ্রুপ শুরু করে এবং StopLoadingGroup() ফাংশনে ব্যবহার করার জন্য একটি Result<ulong>.value পূরণ করে। মেটাডেটা এবং অ্যানোটেশন বর্তমানে Play ব্যাকএন্ড দ্বারা ব্যবহৃত হয় না এবং শুধুমাত্র অ্যানোটেশন null-এ সেট করা যেতে পারে। পরবর্তী সব লোডিং ইভেন্ট একটি অনন্য গ্রুপ আইডি দ্বারা ট্যাগ করা হয়।

ErrorCode StopLoadingGroup(ulong handle);

এই ফাংশনটি StartLoadingGroup() দ্বারা আগে শুরু করা একটি লোডিং গ্রুপ বন্ধ করে। StartLoadingGroup() আবার কল না করা পর্যন্ত পরবর্তী লোডিং ইভেন্টে কোনও গ্রুপ আইডি থাকবে না।

StartLoadingGroup এবং StopLoadingGroup ব্র্যাকেটিং অ্যাসেট লোডিং কল দেখানো ফ্লোচার্ট
ছবি ১. লোডিং গ্রুপের উদাহরণ।

উদাহরণ

আপনার গেমে কীভাবে লোডিং টাইম ফাংশন যোগ করবেন তার কিছু উদাহরণ এখানে দেওয়া হল।

ফাইল লোড করার ইভেন্ট

আপনার গেমে ফাইল লোডিং ইভেন্ট কীভাবে রেকর্ড করবেন তা নিম্নলিখিত কোডের উদাহরণ থেকে জানতে পারবেন।

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;
        }
    }
}

দৃশ্য লোড করার ইভেন্ট

আপনার গেমে কীভাবে দৃশ্য লোড হওয়ার ইভেন্ট রেকর্ড করবেন তা নিম্নলিখিত কোডের উদাহরণ থেকে জানতে পারবেন।

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);
}

গ্রুপ ফাংশন লোড করা হচ্ছে

নিম্নলিখিত কোডের উদাহরণ থেকে আপনার গেমে কীভাবে লোডিং গ্রুপ ফাংশন যোগ করতে হয় তা জানতে পারবেন।

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);
}