table of contents
SDL_GetCameraPermissionState(3) | SDL3 FUNCTIONS | SDL_GetCameraPermissionState(3) |
NAME¶
SDL_GetCameraPermissionState - Query if camera access has been approved by the user.
HEADER FILE¶
Defined in SDL3/SDL_camera.h
SYNOPSIS¶
#include "SDL3/SDL.h"
int SDL_GetCameraPermissionState(SDL_Camera *camera);
DESCRIPTION¶
Cameras will not function between when the device is opened by the app and when the user permits access to the hardware. On some platforms, this presents as a popup dialog where the user has to explicitly approve access; on others the approval might be implicit and not alert the user at all.
This function can be used to check the status of that approval. It will return 0 if still waiting for user response, 1 if the camera is approved for use, and -1 if the user denied access.
Instead of polling with this function, you can wait for a
SDL_EVENT_CAMERA_DEVICE_APPROVED
(or
SDL_EVENT_CAMERA_DEVICE_DENIED ) event in the standard SDL event loop, which is guaranteed to be sent once when permission to use the camera is decided.
If a camera is declined, there's nothing to be done but call
SDL_CloseCamera () to dispose of it.
FUNCTION PARAMETERS¶
- camera
- the opened camera device to query
RETURN VALUE¶
Returns -1 if user denied access to the camera, 1 if user approved access, 0 if no decision has been made yet.
THREAD SAFETY¶
It is safe to call this function from any thread.
AVAILABILITY¶
This function is available since SDL 3.0.0.
SEE ALSO¶
SDL 3.1.2 | Simple Directmedia Layer |