NAME¶

SDL_CPUPauseInstruction - A macro to insert a CPU-specific "pause" instruction into the program.

HEADER FILE¶

Defined in SDL3/SDL_atomic.h

SYNOPSIS¶

#include "SDL3/SDL.h"

#define SDL_CPUPauseInstruction() DoACPUPauseInACompilerAndArchitectureSpecificWay

DESCRIPTION¶

This can be useful in busy-wait loops, as it serves as a hint to the CPU as to the program's intent; some CPUs can use this to do more efficient processing. On some platforms, this doesn't do anything, so using this macro might just be a harmless no-op.

Note that if you are busy-waiting, there are often more-efficient approaches with other synchronization primitives: mutexes, semaphores, condition variables, etc.

THREAD SAFETY¶

This macro is safe to use from any thread.

AVAILABILITY¶

This macro is available since SDL 3.1.3.