Man page - sdl_triggerbreakpoint(3)

Packages contains this manual

Package: libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:

Manual

SDL_TriggerBreakpoint

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
THREAD SAFETY
AVAILABILITY

NAME

SDL_TriggerBreakpoint - Attempt to tell an attached debugger to pause.

HEADER FILE

Defined in SDL3/SDL_assert.h

SYNOPSIS

#include "SDL3/SDL.h"

#define SDL_TriggerBreakpoint() TriggerABreakpointInAPlatformSpecificManner

DESCRIPTION

This allows an app to programmatically halt ("break") the debugger as if it had hit a breakpoint, allowing the developer to examine program state, etc.

This is a macro--not a function--so that the debugger breaks on the source code line that used SDL_TriggerBreakpoint
and not in some random guts of SDL. SDL_assert
uses this macro for the same reason.

If the program is not running under a debugger,

SDL_TriggerBreakpoint
will likely terminate the app, possibly without warning. If the current platform isn’t supported, this macro is left undefined.

THREAD SAFETY

It is safe to call this macro from any thread.

AVAILABILITY

This macro is available since SDL 3.2.0.