SDL_CPUPauseInstruction(3)

SDL_CPUPauseInstruction3

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

Usage

#include "SDL3/SDL.h"

#define SDL_CPUPauseInstruction() DoACPUPauseInACompilerAndArchitectureSpecificWay

Header file

Defined in SDL3/SDL_atomic.h

Overview

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

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.