devela::_dep::sdl3::sys::bits

Function SDL_HasExactlyOneBitSet32

pub const fn SDL_HasExactlyOneBitSet32(x: u32) -> bool
Available on crate feature dep_sdl3 only.
Expand description

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

If there are no bits set (x is zero), or more than one bit set, this returns false. If any one bit is exclusively set, this returns 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).

§Parameters

  • x: the 32-bit value to examine.

§Return value

Returns true if exactly one bit is set in x, false otherwise.

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.