(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_MostSignificantBitIndex32

Get the index of the most significant (set) bit in a 32-bit number.

Header File

Defined in SDL_bits.h, but apps should use #include <SDL3/SDL.h>

Syntax

SDL_FORCE_INLINE int SDL_MostSignificantBitIndex32(Uint32 x);

Function Parameters

x	the 32-bit value to examine

Return Value

Returns the index of the most significant bit, or -1 if the value is 0.

Remarks

Result is undefined when called with 0. This operation can also be stated as "count leading zeroes" and "log base 2".

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.0.0.

---

CategoryAPI, CategoryAPIFunction

---

[ edit | delete | history | feedback | raw ]

[ 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.