SDL_GetCameraFormat(3)

SDL_GetCameraFormat3

Get the spec that a camera is using when generating images.

Usage

#include "SDL3/SDL.h"

bool SDL_GetCameraFormat(SDL_Camera *camera, SDL_CameraSpec *spec);

Header file

Defined in SDL3/SDL_camera.h

Overview

Note that this might not be the native format of the hardware, as SDL might be converting to this format behind the scenes.

If the system is waiting for the user to approve access to the camera, as some platforms require, this will return false, but this isn't necessarily a fatal error; you should either wait for an

SDL_EVENT_CAMERA_DEVICE_APPROVED
(or

SDL_EVENT_CAMERA_DEVICE_DENIED ) event, or poll SDL_GetCameraPermissionState () occasionally until it returns non-zero.

Function parameters

camera

opened camera device.

spec

the SDL_CameraSpec
to be initialized by this function.

Return value

Returns true on success or false on failure; call

SDL_GetError () for more information.

Thread safety

It is safe to call this function from any thread.

Availability

This function 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.