NAME¶

SDL_AcquireVideoCaptureFrame - Acquire a frame.

SYNOPSIS¶

#include "SDL3/SDL.h"

int SDL_AcquireVideoCaptureFrame(SDL_VideoCaptureDevice *device, SDL_VideoCaptureFrame *frame);

DESCRIPTION¶

The frame is a memory pointer to the image data, whose size and format are given by the the obtained spec.

Non blocking API. If there is a frame available, frame->num_planes is non 0. If frame->num_planes is 0 and returned code is 0, there is no frame at that time.

After used, the frame should be released with

SDL_ReleaseVideoCaptureFrame

FUNCTION PARAMETERS¶

device

opened video capture device

frame

pointer to get the frame

RETURN VALUE¶

Returns 0 on success or a negative error code on failure; call

SDL_GetError () for more information.

AVAILABILITY¶

This function is available since SDL 3.0.0.

SEE ALSO¶

SDL_ReleaseVideoCaptureFrame(3)