कॉन्टेंट लोड होने में लगने वाले समय को रिकॉर्ड करने वाले फ़ंक्शन जोड़ें

गेम में लोड होने वाले इवेंट को रिकॉर्ड करना ज़रूरी है. इसकी दो वजहें हैं:

1. लोडिंग के दौरान, फ़्रेम टाइम डेटा को खराब होने से बचाने के लिए.
2. लोड होने में लगने वाले समय का विश्लेषण करने के लिए, ताकि यह पता चल सके कि कब और कहां लोड होने में लगने वाला समय, तय सीमा से ज़्यादा है.

लोडिंग इवेंट से जुड़ा मेटाडेटा हो सकता है:

typedef struct TuningFork_LoadingTimeMetadata {
    enum LoadingState {
        UNKNOWN_STATE = 0,
        // The first time the game is run
        FIRST_RUN = 1,
        // App is not backgrounded
        COLD_START = 2,
        // App is backgrounded
        WARM_START = 3,
        // App is backgrounded, least work needed
        HOT_START = 4,
        // Asset loading between levels
        INTER_LEVEL = 5
    } state;
    enum LoadingSource {
        UNKNOWN_SOURCE = 0,
        // Uncompressing data.
        MEMORY = 1,
        // Reading assets from APK bundle.
        APK = 2,
        // Reading assets from device storage.
        DEVICE_STORAGE = 3,
        // Reading assets from external storage, e.g. SD card.
        EXTERNAL_STORAGE = 4,
        // Loading assets from the network.
        NETWORK = 5,
        // Shader compilation.
        SHADER_COMPILATION = 6,
        // Time spent between process starting and onCreate.
        PRE_ACTIVITY = 7,
        // Total time spent between process starting and first render frame.
        FIRST_TOUCH_TO_FIRST_FRAME = 8
    } source;
    int32_t compression_level;  // 0 = no compression, 100 = max compression
    enum NetworkConnectivity {
        UNKNOWN = 0,
        WIFI = 1,
        CELLULAR_NETWORK = 2
    } network_connectivity;
    uint64_t network_transfer_speed_bps;  // bandwidth in bits per second
    uint64_t network_latency_ns;          // latency in nanoseconds
} TuningFork_LoadingTimeMetadata;

आपकी ज़रूरतों के हिसाब से काम के न होने वाले फ़ील्ड के लिए, शून्य वैल्यू का इस्तेमाल किया जा सकता है.

लोडिंग इवेंट से जुड़ा एनोटेशन भी हो सकता है. इसे फ़्रेम टाइम एनोटेशन की तरह ही तय किया जाता है. इसके लिए, dev_tuningfork.proto फ़ाइल में मौजूद Annotation मैसेज में एक या उससे ज़्यादा फ़ील्ड का इस्तेमाल किया जाता है.

TuningFork_ErrorCode TuningFork_startRecordingLoadingTime( const TuningFork_LoadingTimeMetadata* eventMetadata, uint32_t eventMetadataSize, const TuningFork_CProtobufSerialization* annotation, TuningFork_LoadingEventHandle* handle);

यह फ़ंक्शन, दिए गए मेटाडेटा और एनोटेशन से जुड़े लोडिंग टाइम इवेंट को रिकॉर्ड करना शुरू करता है. साथ ही, handle को भरता है, ताकि इसका इस्तेमाल TuningFork_stopRecordingLoadingTime() फ़ंक्शन में किया जा सके.

TuningFork_ErrorCode TuningFork_stopRecordingLoadingTime( TuningFork_LoadingEventHandle handle);

यह फ़ंक्शन, TuningFork_startRecordingLoadingTime() की मदद से पहले से रिकॉर्ड किए जा रहे इवेंट को रिकॉर्ड करना बंद कर देता है. इवेंट को अगले सेशन फ़्लश के दौरान अपलोड किया जाता है.

TuningFork_ErrorCode TuningFork_recordLoadingTime( uint64_t time_ns, const TuningFork_LoadingTimeMetadata* eventMetadata, uint32_t eventMetadataSize, const TuningFork_CProtobufSerialization* annotation);

हमारा सुझाव है कि आप सीधे तौर पर, पहले बताए गए स्टार्ट और स्टॉप फ़ंक्शन का इस्तेमाल करें. अगर ऐसा नहीं किया जा सकता, तो इस फ़ंक्शन को कॉल करके, अवधि और उससे जुड़े मेटाडेटा और एनोटेशन को रिकॉर्ड किया जा सकता है.

ग्रुप फ़ंक्शन लोड हो रहे हैं

आपके गेम में, उपयोगकर्ता को दिखने वाले कॉन्टेंट को लोड होने में लगने वाले समय के लिए, कई लोडिंग इवेंट रिकॉर्ड किए जा सकते हैं. इसके कुछ उदाहरण यहां दिए गए हैं. इनके अलावा, और भी उदाहरण हो सकते हैं: फ़ाइल लोड करना, डीकंप्रेशन, और शेडर कंपाइलेशन.

Tuning Fork को यह बताना ज़रूरी है कि लोडिंग इवेंट, इस तरह के ग्रुप का हिस्सा हैं. इससे वह बेहतर जानकारी दे पाएगा. इसके लिए, अपने लोडिंग इवेंट को यहां दिए गए स्टार्ट और स्टॉप फ़ंक्शन के साथ ब्रैकेट करें.

TuningFork_ErrorCode TuningFork_startLoadingGroup( const TuningFork_LoadingTimeMetadata* eventMetadata, uint32_t eventMetadataSize, const TuningFork_CProtobufSerialization* annotation, TuningFork_LoadingEventHandle* handle);

यह फ़ंक्शन, दिए गए मेटाडेटा और एनोटेशन से जुड़े लोडिंग ग्रुप को शुरू करता है. साथ ही, TuningFork_stopLoadingGroup() फ़ंक्शन में इस्तेमाल किए जाने वाले handle को भरता है. Play के बैकएंड में, फ़िलहाल मेटाडेटा और एनोटेशन का इस्तेमाल नहीं किया जाता. इसलिए, इन्हें nullptr पर सेट किया जा सकता है. इसके बाद, लोड होने वाले सभी इवेंट को एक यूनीक ग्रुप आईडी से टैग किया जाएगा.

TuningFork_ErrorCode TuningFork_stopLoadingGroup( TuningFork_LoadingEventHandle handle);

यह फ़ंक्शन, TuningFork_startLoadingGroup() से पहले शुरू किए गए लोडिंग ग्रुप को बंद कर देता है. TuningFork_startLoadingGroup() को फिर से कॉल किए जाने तक, बाद के लोड होने वाले इवेंट में ग्रुप आईडी नहीं होगा.

पहली इमेज. लोडिंग ग्रुप का उदाहरण.