(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_Swap16

Byte-swap an unsigned 16-bit number.

Header File

Defined in <SDL3/SDL_endian.h>

Syntax

SDL_FORCE_INLINE Uint16 SDL_Swap16(Uint16 x);

Function Parameters

Uint16

x

the value to byte-swap.

Return Value

(Uint16) Returns x, with its bytes in the opposite endian order.

Remarks

This will always byte-swap the value, whether it's currently in the native byteorder of the system or not. You should use SDL_Swap16LE or SDL_Swap16BE instead, in most cases.

Note that this is a forced-inline function in a header, and not a public API function available in the SDL library (which is to say, the code is embedded in the calling program and the linker and dynamic loader will not be able to find this function inside SDL itself).

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIFunction, CategoryEndian

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.