Blast-Radius Aware AI Code Review for Business-Critical Systems
LiveReview LiveReview Explore LiveReview

SDL_OUT_BYTECAP - 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_BYTECAP(3)

Description

       If we were to annotate memcpy:

              void *memcpy(SDL_OUT_BYTECAP(bufsize) void *dst, const void *src, size_t bufsize);

       This  notes  that  dst  should  have  a  capacity of bufsize bytes 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.

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

Name

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

Synopsis

#include<SDL3/SDL_stdinc.h>#defineSDL_OUT_BYTECAP(x)_Out_bytecap_(x)

See Also