Provided by: libsdl3-doc_3.2.8+ds-1_all bug

NAME

       SDL_OUT_CAP - Macro that annotates function params with output buffer size.

HEADER FILE

       Defined in SDL3/SDL_stdinc.h

SYNOPSIS

       #include "SDL3/SDL.h"

       #define SDL_OUT_CAP(x) _Out_cap_(x)

DESCRIPTION

       If we were to annotate wcsncpy :

              char *wcscpy(SDL_OUT_CAP(bufsize) wchar_t *dst, const wchar_t *src, size_t bufsize);

       This  notes  that  dst  should  have a capacity of bufsize wchar_t in size, and is only written to by the
       function. The compiler or other analysis tools can warn when this doesn't appear to be the case.

       This operates on counts of objects, not bytes. Use

       SDL_OUT_BYTECAP
        for bytes.

       On compilers without this annotation mechanism, this is defined to nothing.

AVAILABILITY

       This macro is available since SDL 3.2.0.

Simple Directmedia Layer                            SDL 3.2.8                                     SDL_OUT_CAP(3)