logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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

Availability

       This macro is available since SDL 3.2.0.

Simple Directmedia Layer                           SDL 3.2.20                                     SDL_OUT_CAP(3)

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.

Name

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

Synopsis

#include<SDL3/SDL_stdinc.h>#defineSDL_OUT_CAP(x)_Out_cap_(x)

See Also