Man page - sdl_releasecameraframe(3)

Packages contains this manual

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

Documentations in package:

Manual

SDL_ReleaseCameraFrame

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
THREAD SAFETY
AVAILABILITY
SEE ALSO

NAME

SDL_ReleaseCameraFrame - Release a frame of video acquired from a camera.

HEADER FILE

Defined in SDL3/SDL_camera.h

SYNOPSIS

#include "SDL3/SDL.h"

void SDL_ReleaseCameraFrame(SDL_Camera *camera, SDL_Surface *frame);

DESCRIPTION

Let the back-end re-use the internal buffer for camera.

This function _must_ be called only on surface objects returned by

SDL_AcquireCameraFrame (). This function should be called as quickly as possible after acquisition, as SDL keeps a small FIFO queue of surfaces for video frames; if surfaces aren’t released in a timely manner, SDL may drop upcoming video frames from the camera.

If the app needs to keep the surface for a significant time, they should make a copy of it and release the original.

The app should not use the surface again after calling this function; assume the surface is freed and the pointer is invalid.

FUNCTION PARAMETERS

	camera		opened camera device.
	frame		the video frame surface to release.

THREAD SAFETY

It is safe to call this function from any thread.

AVAILABILITY

This function is available since SDL 3.2.0.