Scroll to navigation

SDL_Swap16(3) SDL3 FUNCTIONS SDL_Swap16(3)

NAME

SDL_Swap16 - Byte-swap an unsigned 16-bit number.

HEADER FILE

Defined in SDL3/SDL_endian.h

SYNOPSIS

#include "SDL3/SDL.h"
SDL_FORCE_INLINE Uint16 SDL_Swap16(Uint16 x);

DESCRIPTION

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

or SDL_SwapBE16
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).

FUNCTION PARAMETERS

the value to byte-swap.

RETURN VALUE

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

THREAD SAFETY

It is safe to call this function from any thread.

AVAILABILITY

This function is available since SDL 3.0.0.

SDL 3.1.2 Simple Directmedia Layer