Добавить функции записи времени загрузки

Важно регистрировать, когда ваша игра выполняет события загрузки, по двум причинам:

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;

Любые поля, которые не соответствуют вашим потребностям, могут быть равны нулю.

Событие загрузки также может иметь связанную аннотацию. Она определяется так же, как аннотации времени кадра, с использованием одного или нескольких полей в сообщении Annotation в файле dev_tuningfork.proto .

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

Эта функция запускает группу загрузки, связанную с заданными метаданными и аннотацией, и заполняет handle для использования в функции TuningFork_stopLoadingGroup() . Метаданные и аннотация в настоящее время не используются бэкендом Play и могут быть установлены в nullptr . Все последующие события загрузки будут помечены уникальным идентификатором группы.

TuningFork_ErrorCode TuningFork_stopLoadingGroup( TuningFork_LoadingEventHandle handle);

Эта функция останавливает группу загрузки, ранее запущенную функцией TuningFork_startLoadingGroup() . Последующие события загрузки не будут иметь идентификатор группы, пока TuningFork_startLoadingGroup() не будет вызвана снова.

Рисунок 1. Пример группы загрузки.