Man page - sdl_getiostatus(3)

Packages contains this manual

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

Documentations in package:
• libsdl3-doc
• libsdl3-dev

Manual

SDL_GetIOStatus

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
RETURN VALUE
THREAD SAFETY
AVAILABILITY

---

NAME

SDL_GetIOStatus - Query the stream status of an SDL_IOStream .

HEADER FILE

Defined in SDL3/SDL_iostream.h

SYNOPSIS

#include "SDL3/SDL.h"

SDL_IOStatus SDL_GetIOStatus(SDL_IOStream *context);

DESCRIPTION

This information can be useful to decide if a short read or write was due to an error, an EOF, or a non-blocking operation that isn’t yet ready to complete.

An SDL_IOStream

SDL_ReadIO
or SDL_WriteIO
call; don’t expect it to change if you just call this query function in a tight loop.

FUNCTION PARAMETERS

context

the SDL_IOStream
to query.

RETURN VALUE

( SDL_IOStatus ) Returns an SDL_IOStatus
enum with the current state.

THREAD SAFETY

This function is not thread safe.

AVAILABILITY

This function is available since SDL 3.2.0.

---