# Swappy common tools

Tools to be used with Swappy for OpenGL or Swappy for Vulkan.

## Summary

| ### Typedefs ||
|---|---|
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1ga43b3466def86b5364bc588e3706ac1c6)(void *, int64_t desiredPresentationTimeMillis)` | typedef `void(*` Pointer to a function that can be attached to [SwappyTracer::postSwapBuffers](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1a5b90ffd050550ba2bddf87d3beb1de31). |
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1gaf3c6e6c7e094da4ed0cd23799887d108)(void *, int64_t cpu_time_ns, int64_t gpu_time_ns)` | typedef `void(*` Pointer to a function that can be attached to [SwappyTracer::postWait](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1aff96c754aeeb02dd0056b8960fb28bf6). |
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1ga21947d41c898ef2159b8305f6135000a)(void *)` | typedef `void(*` Pointer to a function that can be attached to [SwappyTracer::preSwapBuffers](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1a7bca44be2bd337dc03df3bd347a866d7). |
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1ga8da48682343efb9c28c6f7e8c0a807e4)(void *)` | typedef `void(*` Pointer to a function that can be attached to [SwappyTracer::preWait](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1ada85e41048b0ae92a862e57e3116b74b). |
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1ga4da61fae71b4f0cd793f3258f630d725)(void *, int currentFrame, int64_t desiredPresentationTimeMillis)` | typedef `void(*` Pointer to a function that can be attached to [SwappyTracer::startFrame](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1a8dd15d901ee45cf62ccb2850d3da394b). |
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1gaf505f878061cdf0755d4d8febd23ff57` | typedef `struct https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-stats#struct_swappy_stats` Swappy frame statistics, collected if toggled on with [SwappyGL_enableStats](https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-g-l-extra#group__swappy_g_l__extra_1ga1191b042d23c0e3d9da59afd94d3c4b9) or [SwappyVk_enableStats](https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-vk#group__swappy_vk_1gac1b42c5baf4f351955df0c027aba14c2). |
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1ga8c875fa65196c9dd2cb5436a55134cfe)(void *)` | typedef `void(*` Pointer to a function that can be attached to [SwappyTracer::swapIntervalChanged](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1ad67a82b14f790d233ef55b231d570548). |
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1ga95b1cf5ade233f4eb761f407ba6676ad` | typedef `struct https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-thread-functions#struct_swappy_thread_functions` A structure enabling you to set how Swappy starts and joins threads by calling [Swappy_setThreadFunctions](https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1gabf904a592bd36137613b842e651642f4). |
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1ga8e9732a11a7c96c865c629beb9e70a50` | typedef `uint64_t` Id of a thread returned by an external thread manager. |
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1gab34306429cb8a85d4af463e42e3e3cf5` | typedef `struct https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer` Collection of callbacks to be called each frame to trace execution. |

| ### Functions ||
|---|---|
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1gabf904a592bd36137613b842e651642f4(const https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-thread-functions#struct_swappy_thread_functions *thread_functions)` | `void` Call this before any other functions in order to use a custom thread manager. |
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1gae27a3e4749292328aab7a33ccaecaffb()` | `uint32_t` Return the version of the Swappy library at runtime. |
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1ga34f8ba7d2fb143e186bde95968709914()` | `const char *` Return the full version of the Swappy library at runtime, e.g. |

| ### Macros ||
|---|---|
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1gacc30fb779651d3edee944bc591085c93 6` | The longest duration, in refresh periods, represented by the statistics. |
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1ga37824f144bffe40a647bb8b72f10601f (50000000L)` | Swap interval for 20fps, in nanoseconds. |
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1ga6d6059d46bce7f1de58b7bef38db2b53 (33333333L)` | Swap interval for 30fps, in nanoseconds. |
| `https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1gae13f01d08b9392742955c9d0a056e144 (16666667L)` | Swap interval for 60fps, in nanoseconds. |

| ### Structs ||
|---|---|
| [SwappyStats](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-stats) | Swappy frame statistics, collected if toggled on with [SwappyGL_enableStats](https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-g-l-extra#group__swappy_g_l__extra_1ga1191b042d23c0e3d9da59afd94d3c4b9) or [SwappyVk_enableStats](https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-vk#group__swappy_vk_1gac1b42c5baf4f351955df0c027aba14c2). |
| [SwappyThreadFunctions](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-thread-functions) | A structure enabling you to set how Swappy starts and joins threads by calling [Swappy_setThreadFunctions](https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1gabf904a592bd36137613b842e651642f4). |
| [SwappyTracer](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer) | Collection of callbacks to be called each frame to trace execution. |

## Typedefs

### SwappyPostSwapBuffersCallback

```scdoc
void(* SwappyPostSwapBuffersCallback)(void *, int64_t desiredPresentationTimeMillis)
```
Pointer to a function that can be attached to [SwappyTracer::postSwapBuffers](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1a5b90ffd050550ba2bddf87d3beb1de31).

<br />

| Details ||
|---|---|
| Parameters | |---|---| | `userData` | Pointer to arbitrary data, see [SwappyTracer::userData](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1acb8c410a25c23172b054a3ea3c62d48a). | | `desiredPresentationTimeMillis` | The target time, in milliseconds, at which the frame would be presented on screen. | |

### SwappyPostWaitCallback

```scdoc
void(* SwappyPostWaitCallback)(void *, int64_t cpu_time_ns, int64_t gpu_time_ns)
```
Pointer to a function that can be attached to [SwappyTracer::postWait](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1aff96c754aeeb02dd0056b8960fb28bf6).

<br />

| Details ||
|---|---|
| Parameters | |---|---| | `userData` | Pointer to arbitrary data, see [SwappyTracer::userData](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1acb8c410a25c23172b054a3ea3c62d48a). | | `cpu_time_ns` | Time for CPU processing of this frame in nanoseconds. | | `gpu_time_ns` | Time for GPU processing of previous frame in nanoseconds. | |

### SwappyPreSwapBuffersCallback

```scdoc
void(* SwappyPreSwapBuffersCallback)(void *)
```
Pointer to a function that can be attached to [SwappyTracer::preSwapBuffers](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1a7bca44be2bd337dc03df3bd347a866d7).

<br />

| Details ||
|---|---|
| Parameters | |---|---| | `userData` | Pointer to arbitrary data, see [SwappyTracer::userData](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1acb8c410a25c23172b054a3ea3c62d48a). | |

### SwappyPreWaitCallback

```scdoc
void(* SwappyPreWaitCallback)(void *)
```
Pointer to a function that can be attached to [SwappyTracer::preWait](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1ada85e41048b0ae92a862e57e3116b74b).

<br />

| Details ||
|---|---|
| Parameters | |---|---| | `userData` | Pointer to arbitrary data, see [SwappyTracer::userData](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1acb8c410a25c23172b054a3ea3c62d48a). | |

### SwappyStartFrameCallback

```scdoc
void(* SwappyStartFrameCallback)(void *, int currentFrame, int64_t desiredPresentationTimeMillis)
```
Pointer to a function that can be attached to [SwappyTracer::startFrame](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1a8dd15d901ee45cf62ccb2850d3da394b).

<br />

| Details ||
|---|---|
| Parameters | |---|---| | `userData` | Pointer to arbitrary data, see [SwappyTracer::userData](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1acb8c410a25c23172b054a3ea3c62d48a). | | `desiredPresentationTimeMillis` | The time, in milliseconds, at which the frame is scheduled to be presented. | |

### SwappyStats

```text
struct SwappyStats SwappyStats
```
Swappy frame statistics, collected if toggled on with [SwappyGL_enableStats](https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-g-l-extra#group__swappy_g_l__extra_1ga1191b042d23c0e3d9da59afd94d3c4b9) or [SwappyVk_enableStats](https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-vk#group__swappy_vk_1gac1b42c5baf4f351955df0c027aba14c2).

### SwappySwapIntervalChangedCallback

```scdoc
void(* SwappySwapIntervalChangedCallback)(void *)
```
Pointer to a function that can be attached to [SwappyTracer::swapIntervalChanged](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1ad67a82b14f790d233ef55b231d570548).

Call [SwappyGL_getSwapIntervalNS](https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-g-l#group__swappy_g_l_1gadbe509e8b27645217de49e21878f68c2) or [SwappyVk_getSwapIntervalNS](https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-vk#group__swappy_vk_1ga6bbb53672fdc846619267a198ad3247f) to get the latest swapInterval.

| Details ||
|---|---|
| Parameters | |---|---| | `userData` | Pointer to arbitrary data, see [SwappyTracer::userData](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-tracer#struct_swappy_tracer_1acb8c410a25c23172b054a3ea3c62d48a). | |

### SwappyThreadFunctions

```text
struct SwappyThreadFunctions SwappyThreadFunctions
```
A structure enabling you to set how Swappy starts and joins threads by calling [Swappy_setThreadFunctions](https://developer.android.com/games/sdk/reference/frame-pacing/group/swappy-common#group__swappy__common_1gabf904a592bd36137613b842e651642f4).

Usage of this functionality is optional.

### SwappyThreadId

```scdoc
uint64_t SwappyThreadId
```
Id of a thread returned by an external thread manager.

### SwappyTracer

```text
struct SwappyTracer SwappyTracer
```
Collection of callbacks to be called each frame to trace execution.

Injection of these is optional.

## Functions

### Swappy_setThreadFunctions

```gdscript
void Swappy_setThreadFunctions(
  const SwappyThreadFunctions *thread_functions
)
```
Call this before any other functions in order to use a custom thread manager.

Usage of this function is entirely optional. Swappy uses std::thread by default.

### Swappy_version

```scdoc
uint32_t Swappy_version()
```
Return the version of the Swappy library at runtime.

### Swappy_versionString

```gdscript
const char * Swappy_versionString()
```
Return the full version of the Swappy library at runtime, e.g.

"1.9.0_8a85ab7c46"

## Macros

### MAX_FRAME_BUCKETS

```scdoc
 MAX_FRAME_BUCKETS 6
```
The longest duration, in refresh periods, represented by the statistics.


**See also:**
[SwappyStats](https://developer.android.com/games/sdk/reference/frame-pacing/struct/swappy-stats#struct_swappy_stats)

### SWAPPY_SWAP_20FPS

```scdoc
 SWAPPY_SWAP_20FPS (50000000L)
```
Swap interval for 20fps, in nanoseconds.

### SWAPPY_SWAP_30FPS

```scdoc
 SWAPPY_SWAP_30FPS (33333333L)
```
Swap interval for 30fps, in nanoseconds.

### SWAPPY_SWAP_60FPS

```scdoc
 SWAPPY_SWAP_60FPS (16666667L)
```
Swap interval for 60fps, in nanoseconds.