A serialized protobuf containing the fidelity parameters to be uploaded for training.
Set this to nullptr if you are not using training mode. Note that these are used instead of the default parameters loaded from the APK, if they are present and there are neither a successful download nor saved parameters.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2020-05-05 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2020-05-05 UTC."],[],[],null,["# TFSettings Struct Reference\n\nTFSettings\n==========\n\n`#include \u003ctuningfork.h\u003e`\n\nInitialization settings Zero any values that are not being used.\n\nSummary\n-------\n\n| ### Public attributes ||\n|-------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [endpoint_uri_override](#struct_t_f_settings_1a88e9ace6b6d25dfdf6ee281f1840ace3) | `const char *` A null-terminated string containing the endpoint that Tuning Fork will connect to for parameter, upload and debug requests. |\n| [fidelity_params_callback](#struct_t_f_settings_1a89cd30d7f2359b54c20ac53aca6aa629) | [ProtoCallback](/games/sdk/reference/performance-tuner/custom-engine/group/tuningfork#group__tuningfork_1gaf780faded2692da73f8d7ee37499d171) Callback If set, this is called with the fidelity parameters that are downloaded. |\n| [persistent_cache](#struct_t_f_settings_1a25e55876c9296aaec34b4dbb8772ceba) | `const `[TFCache](/games/sdk/reference/performance-tuner/custom-engine/struct/t-f-cache#struct_t_f_cache)` *` Cache object to be used for upload data persistence. |\n| [swappy_tracer_fn](#struct_t_f_settings_1a3ca27ab14efce1c40d4b70f8e567da33) | [SwappyTracerFn](/games/sdk/reference/performance-tuner/custom-engine/group/tuningfork#group__tuningfork_1ga43b1819af457676a72f228c08068fed4) The address of the Swappy_injectTracers function. |\n| [swappy_version](#struct_t_f_settings_1a5c2d98b44ddf8084bc7ef9eff516d451) | `uint32_t` The version of Swappy that swappy_tracer_fn comes from. |\n| [training_fidelity_params](#struct_t_f_settings_1a3ab649a2ec035694d4b035b742d56dd9) | `const `[CProtobufSerialization](/games/sdk/reference/performance-tuner/custom-engine/struct/c-protobuf-serialization#struct_c_protobuf_serialization)` *` A serialized protobuf containing the fidelity parameters to be uploaded for training. |\n\nPublic attributes\n-----------------\n\n### endpoint_uri_override\n\n```gdscript\nconst char * TFSettings::endpoint_uri_override\n``` \nA null-terminated string containing the endpoint that Tuning Fork will connect to for parameter, upload and debug requests.\n\nThis overrides the value in base_uri in the settings proto and is intended for debugging purposes only. \n\n### fidelity_params_callback\n\n```scdoc\nProtoCallback TFSettings::fidelity_params_callback\n``` \nCallback If set, this is called with the fidelity parameters that are downloaded.\n\nIf unset, you need to call TuningFork_getFidelityParameters yourself. \n\n### persistent_cache\n\n```gdscript\nconst TFCache * TFSettings::persistent_cache\n``` \nCache object to be used for upload data persistence.\n\nIf unset, data is persisted to /data/local/tmp/tuningfork \n\n### swappy_tracer_fn\n\n```scdoc\nSwappyTracerFn TFSettings::swappy_tracer_fn\n``` \nThe address of the Swappy_injectTracers function.\n\nIf this is unset, you need to call TuningFork_tick yourself. If it is set, telemetry for 4 instrument keys is automatically recorded. \n\n### swappy_version\n\n```scdoc\nuint32_t TFSettings::swappy_version\n``` \nThe version of Swappy that swappy_tracer_fn comes from. \n\n### training_fidelity_params\n\n```gdscript\nconst CProtobufSerialization * TFSettings::training_fidelity_params\n``` \nA serialized protobuf containing the fidelity parameters to be uploaded for training.\n\nSet this to nullptr if you are not using training mode. Note that these are used instead of the default parameters loaded from the APK, if they are present and there are neither a successful download nor saved parameters."]]
