การบันทึกเมื่อเกมกำลังโหลดเหตุการณ์เป็นสิ่งสำคัญด้วยเหตุผล 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;
ช่องที่ไม่เกี่ยวข้องกับความต้องการของคุณสามารถเป็นศูนย์ได้
เหตุการณ์การโหลดอาจมีคำอธิบายประกอบที่เกี่ยวข้องด้วย ซึ่งกำหนดในลักษณะเดียวกับคำอธิบายประกอบเวลาที่ใช้ในการแสดงผลเฟรม โดยใช้ช่องอย่างน้อย 1 ช่องในข้อความ Annotation ในไฟล์ dev_tuningfork.proto
ฟังก์ชันนี้จะเริ่มบันทึกเหตุการณ์เวลาในการโหลดที่เชื่อมโยงกับข้อมูลเมตาและคำอธิบายประกอบที่ระบุ และกรอก handle เพื่อใช้ในฟังก์ชัน TuningFork_stopRecordingLoadingTime()
TuningFork_ErrorCode TuningFork_stopRecordingLoadingTime(
TuningFork_LoadingEventHandle handle);
ฟังก์ชันนี้จะหยุดบันทึกเหตุการณ์ที่เริ่มก่อนหน้านี้โดย TuningFork_startRecordingLoadingTime() ระบบจะอัปโหลดเหตุการณ์เมื่อมีการล้างเซสชันครั้งถัดไป
เราขอแนะนำอย่างยิ่งให้ใช้ฟังก์ชัน start และ stop ที่อธิบายไว้ก่อนหน้านี้โดยตรง แต่หากทำไม่ได้ คุณสามารถเรียกใช้ฟังก์ชันนี้เพื่อบันทึกระยะเวลาและข้อมูลเมตา รวมถึงคำอธิบายประกอบที่เกี่ยวข้อง
กำลังโหลดฟังก์ชันกลุ่ม
ในเกม คุณอาจบันทึกเหตุการณ์การโหลดหลายรายการสำหรับระยะเวลาการโหลดเดียวที่ผู้ใช้เห็น ตัวอย่างเช่น (แต่ไม่จำกัดเพียง) การโหลดไฟล์ การคลายการบีบอัด และการคอมไพล์ตัวปรับเฉดสี
คุณต้องแจ้ง Tuning Fork ว่าเหตุการณ์การโหลดเป็นส่วนหนึ่งของกลุ่มดังกล่าวเพื่อให้ Tuning Fork ให้ข้อมูลเชิงลึกที่ดียิ่งขึ้นได้ โดยให้คร่อมเหตุการณ์การโหลดด้วยฟังก์ชันเริ่มต้นและหยุดต่อไปนี้เพื่อดำเนินการดังกล่าว
ฟังก์ชันนี้จะเริ่มกลุ่มการโหลดที่เชื่อมโยงกับข้อมูลเมตาและคำอธิบายประกอบที่ระบุ และกรอก handle เพื่อใช้ในฟังก์ชัน TuningFork_stopLoadingGroup แบ็กเอนด์ของ Play ไม่ได้ใช้ข้อมูลเมตาและคำอธิบายประกอบ และสามารถตั้งค่าเป็น nullptr ได้ เหตุการณ์การโหลดที่ตามมาทั้งหมด
จะได้รับการติดแท็กด้วยรหัสกลุ่มที่ไม่ซ้ำกัน
TuningFork_ErrorCode TuningFork_stopLoadingGroup(
TuningFork_LoadingEventHandle handle);
ฟังก์ชันนี้จะหยุดกลุ่มการโหลดที่เริ่มก่อนหน้านี้โดย TuningFork_startLoadingGroup() เหตุการณ์การโหลดที่ตามมาจะไม่มีรหัสกลุ่มจนกว่าจะมีการเรียก TuningFork_startLoadingGroup() อีกครั้ง