Scroll to navigation

SDL_HasExactlyOneBitSet32(3) SDL3 FUNCTIONS SDL_HasExactlyOneBitSet32(3)

NAME

SDL_HasExactlyOneBitSet32 - Determine if a unsigned 32-bit value has exactly one bit set.

HEADER FILE

Defined in SDL3/SDL_bits.h

SYNOPSIS

#include "SDL3/SDL.h"
SDL_FORCE_INLINE SDL_bool SDL_HasExactlyOneBitSet32(Uint32 x);

DESCRIPTION

If there are no bits set ( x is zero), or more than one bit set, this returns SDL_FALSE . If any one bit is exclusively set, this returns SDL_TRUE .

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 32-bit value to examine

RETURN VALUE

Returns SDL_TRUE
if exactly one bit is set in x ,

SDL_FALSE
otherwise.

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