SDL_IN_BYTECAP(3)

SDL_IN_BYTECAP3

Macro that annotates function params with input buffer size.

Usage

#include "SDL3/SDL.h"

#define SDL_IN_BYTECAP(x) _In_bytecount_(x)

Header file

Defined in SDL3/SDL_stdinc.h

Overview

If we were to annotate memcpy :

void *memcpy(void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);

This notes that src should be len bytes in size and is only read 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.

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.