Stay organized with collections
Save and categorize content based on your preferences.
TuningFork_Settings
#include <tuningfork.h>
Initialization settings Zero any values that are not being used.
Summary
Public attributes
|
api_key
|
const char *
If non-null, this value overrides the api_key field in the app's tuningfork_settings.bin file.
|
endpoint_uri_override
|
const char *
A null-terminated UTF-8 string containing the endpoint that Tuning Fork will connect to for parameter, upload and debug requests.
|
fidelity_params_callback
|
Callback If set, this is called with the fidelity parameters that are downloaded.
|
max_num_metrics
|
The number of each metric that is allowed to be allocated at any given time.
|
persistent_cache
|
Cache object to be used for upload data persistence.
|
swappy_tracer_fn
|
The address of the Swappy_injectTracers function.
|
swappy_version
|
uint32_t
The version of Swappy that swappy_tracer_fn comes from.
|
training_fidelity_params
|
A serialized protobuf containing the fidelity parameters to be uploaded for training.
|
verbose_logging_enabled
|
bool
If false, sensitive information is removed from logging.
|
Public attributes
api_key
const char * TuningFork_Settings::api_key
If non-null, this value overrides the api_key field in the app's tuningfork_settings.bin file.
See tuningfork.proto for more information.
endpoint_uri_override
const char * TuningFork_Settings::endpoint_uri_override
A null-terminated UTF-8 string containing the endpoint that Tuning Fork will connect to for parameter, upload and debug requests.
This overrides the value in base_uri in the settings proto and is intended for debugging purposes only.
fidelity_params_callback
TuningFork_FidelityParamsCallback TuningFork_Settings::fidelity_params_callback
Callback If set, this is called with the fidelity parameters that are downloaded.
If null, you need to call TuningFork_getFidelityParameters yourself.
max_num_metrics
TuningFork_MetricLimits TuningFork_Settings::max_num_metrics
The number of each metric that is allowed to be allocated at any given time.
If any element is zero, the default for that metric type will be used. Memory for all metrics is allocated up-front at initialization. When all metrics of a given type are allocated, further requested metrics will not be added and data will be lost.
persistent_cache
const TuningFork_Cache * TuningFork_Settings::persistent_cache
Cache object to be used for upload data persistence.
If null, data is persisted to /data/local/tmp/tuningfork
swappy_tracer_fn
SwappyTracerFn TuningFork_Settings::swappy_tracer_fn
The address of the Swappy_injectTracers function.
If this is null, you need to call TuningFork_tick yourself. If it is set, telemetry for 4 instrument keys is automatically recorded.
swappy_version
uint32_t TuningFork_Settings::swappy_version
The version of Swappy that swappy_tracer_fn comes from.
training_fidelity_params
const TuningFork_CProtobufSerialization * TuningFork_Settings::training_fidelity_params
A serialized protobuf containing the fidelity parameters to be uploaded for training.
Set this to nullptr if you are not using training mode. In training mode, these parameters are taken to be the parameters used within the game and they are used to help suggest parameter changes for different devices. Note that these override the default parameters loaded from the APK at startup.
verbose_logging_enabled
bool TuningFork_Settings::verbose_logging_enabled
If false, sensitive information is removed from logging.
Default is false.
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 2023-03-10 UTC.
[null,null,["Last updated 2023-03-10 UTC."],[],[],null,["# TuningFork_Settings Struct Reference\n\nTuningFork_Settings\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| [api_key](#struct_tuning_fork___settings_1a28c92f57bbc38c25b2615f63b6ec309b) | `const char *` If non-null, this value overrides the api_key field in the app's tuningfork_settings.bin file. |\n| [endpoint_uri_override](#struct_tuning_fork___settings_1a06e586714307a347736b14a54cfcf906) | `const char *` A null-terminated UTF-8 string containing the endpoint that Tuning Fork will connect to for parameter, upload and debug requests. |\n| [fidelity_params_callback](#struct_tuning_fork___settings_1a5b60ba7d9bb38b2eefe0332dce919037) | [TuningFork_FidelityParamsCallback](/games/sdk/reference/performance-tuner/custom-engine/group/tuningfork#group__tuningfork_1ga1a8f1743f180343c029abb264f9ad20b) Callback If set, this is called with the fidelity parameters that are downloaded. |\n| [max_num_metrics](#struct_tuning_fork___settings_1a5bbca8f21012e21d3b362801f7eba28a) | [TuningFork_MetricLimits](/games/sdk/reference/performance-tuner/custom-engine/struct/tuning-fork-metric-limits#struct_tuning_fork___metric_limits) The number of each metric that is allowed to be allocated at any given time. |\n| [persistent_cache](#struct_tuning_fork___settings_1a4accf240624211e17957ed5d7d318441) | `const `[TuningFork_Cache](/games/sdk/reference/performance-tuner/custom-engine/struct/tuning-fork-cache#struct_tuning_fork___cache)` *` Cache object to be used for upload data persistence. |\n| [swappy_tracer_fn](#struct_tuning_fork___settings_1a075dd6f093d9e6f41e07964171e09547) | [SwappyTracerFn](/games/sdk/reference/performance-tuner/custom-engine/group/tuningfork#group__tuningfork_1ga226ceba1a1596ee68717ac2aaedad5ba) The address of the Swappy_injectTracers function. |\n| [swappy_version](#struct_tuning_fork___settings_1a072586921d648c23d280a8aa77bf4889) | `uint32_t` The version of Swappy that swappy_tracer_fn comes from. |\n| [training_fidelity_params](#struct_tuning_fork___settings_1a764406c0611ffc2bdb9fafae6a8e66c7) | `const `[TuningFork_CProtobufSerialization](/games/sdk/reference/performance-tuner/custom-engine/struct/tuning-fork-c-protobuf-serialization#struct_tuning_fork___c_protobuf_serialization)` *` A serialized protobuf containing the fidelity parameters to be uploaded for training. |\n| [verbose_logging_enabled](#struct_tuning_fork___settings_1a9eb6af1db4b6bbcb1fa6b3c1c4224ff5) | `bool` If false, sensitive information is removed from logging. |\n\nPublic attributes\n-----------------\n\n### api_key\n\n```gdscript\nconst char * TuningFork_Settings::api_key\n``` \nIf non-null, this value overrides the api_key field in the app's tuningfork_settings.bin file.\n\nSee tuningfork.proto for more information. \n\n### endpoint_uri_override\n\n```gdscript\nconst char * TuningFork_Settings::endpoint_uri_override\n``` \nA null-terminated UTF-8 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\nTuningFork_FidelityParamsCallback TuningFork_Settings::fidelity_params_callback\n``` \nCallback If set, this is called with the fidelity parameters that are downloaded.\n\nIf null, you need to call TuningFork_getFidelityParameters yourself. \n\n### max_num_metrics\n\n```scdoc\nTuningFork_MetricLimits TuningFork_Settings::max_num_metrics\n``` \nThe number of each metric that is allowed to be allocated at any given time.\n\nIf any element is zero, the default for that metric type will be used. Memory for all metrics is allocated up-front at initialization. When all metrics of a given type are allocated, further requested metrics will not be added and data will be lost. \n\n### persistent_cache\n\n```gdscript\nconst TuningFork_Cache * TuningFork_Settings::persistent_cache\n``` \nCache object to be used for upload data persistence.\n\nIf null, data is persisted to /data/local/tmp/tuningfork \n\n### swappy_tracer_fn\n\n```scdoc\nSwappyTracerFn TuningFork_Settings::swappy_tracer_fn\n``` \nThe address of the Swappy_injectTracers function.\n\nIf this is null, 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 TuningFork_Settings::swappy_version\n``` \nThe version of Swappy that swappy_tracer_fn comes from. \n\n### training_fidelity_params\n\n```gdscript\nconst TuningFork_CProtobufSerialization * TuningFork_Settings::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. In training mode, these parameters are taken to be the parameters used within the game and they are used to help suggest parameter changes for different devices. Note that these override the default parameters loaded from the APK at startup. \n\n### verbose_logging_enabled\n\n```scdoc\nbool TuningFork_Settings::verbose_logging_enabled\n``` \nIf false, sensitive information is removed from logging.\n\nDefault is false."]]
