Stay organized with collections
Save and categorize content based on your preferences.
SwappyThreadFunctions
#include <swappy_common.h>
A structure enabling you to set how Swappy starts and joins threads by calling Swappy_setThreadFunctions.
Summary
Usage of this functionality is optional.
Public attributes
|
join)(SwappyThreadId thread_id)
|
void(*
Thread join callback.
|
joinable)(SwappyThreadId thread_id)
|
bool(*
Thread joinable callback.
|
start)(SwappyThreadId *thread_id, void *(*thread_func)(void *), void *user_data)
|
int(*
Thread start callback.
|
Public attributes
join
void(* SwappyThreadFunctions::join)(SwappyThreadId thread_id)
Thread join callback.
This function is called by Swappy to join the thread with given id.
joinable
bool(* SwappyThreadFunctions::joinable)(SwappyThreadId thread_id)
Thread joinable callback.
This function is called by Swappy to discover whether the thread with the given id is joinable.
start
int(* SwappyThreadFunctions::start)(SwappyThreadId *thread_id, void *(*thread_func)(void *), void *user_data)
Thread start callback.
This function is called by Swappy to start thread_func on a new thread.
| Details |
| Parameters |
user_data
|
A value to be passed the thread function. If the thread was started, this function should set the thread_id and return 0. If the thread was not started, this function should return a non-zero value.
|
|
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 2021-07-12 UTC.
[null,null,["Last updated 2021-07-12 UTC."],[],[],null,["# SwappyThreadFunctions Struct Reference\n\nSwappyThreadFunctions\n=====================\n\n`#include \u003cswappy_common.h\u003e`\n\nA structure enabling you to set how Swappy starts and joins threads by calling [Swappy_setThreadFunctions](/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1gabf904a592bd36137613b842e651642f4).\n\nSummary\n-------\n\nUsage of this functionality is optional.\n\n| ### Public attributes ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|\n| [join](#struct_swappy_thread_functions_1a4ff08dc0fa2b076510065b56c3756f68)`)(SwappyThreadId thread_id)` | `void(*` Thread join callback. |\n| [joinable](#struct_swappy_thread_functions_1a6720f73704f616d2cbf38ed8b7e11ae5)`)(SwappyThreadId thread_id)` | `bool(*` Thread joinable callback. |\n| [start](#struct_swappy_thread_functions_1ad3a1a180041a33d160bcff014d61b12d)`)(SwappyThreadId *thread_id, void *(*thread_func)(void *), void *user_data)` | `int(*` Thread start callback. |\n\nPublic attributes\n-----------------\n\n### join\n\n```scdoc\nvoid(* SwappyThreadFunctions::join)(SwappyThreadId thread_id)\n``` \nThread join callback.\n\nThis function is called by Swappy to join the thread with given id. \n\n### joinable\n\n```scdoc\nbool(* SwappyThreadFunctions::joinable)(SwappyThreadId thread_id)\n``` \nThread joinable callback.\n\nThis function is called by Swappy to discover whether the thread with the given id is joinable. \n\n### start\n\n```scdoc\nint(* SwappyThreadFunctions::start)(SwappyThreadId *thread_id, void *(*thread_func)(void *), void *user_data)\n``` \nThread start callback.\n\nThis function is called by Swappy to start thread_func on a new thread.\n\n| Details ||\n|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Parameters | |-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `user_data` | A value to be passed the thread function. If the thread was started, this function should set the thread_id and return 0. If the thread was not started, this function should return a non-zero value. | |"]]
