Man page - sdl_closeio(3)

Packages contains this manual

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

Documentations in package:

Manual

SDL_CloseIO

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

NAME

SDL_CloseIO - Close and free an allocated SDL_IOStream
structure.

HEADER FILE

Defined in SDL3/SDL_iostream.h

SYNOPSIS

#include "SDL3/SDL.h"

bool SDL_CloseIO(SDL_IOStream *context);

DESCRIPTION

SDL_CloseIO () closes and cleans up the

SDL_IOStream
stream. It releases any resources used by the stream and frees the SDL_IOStream
itself. This returns true on success, or false if the stream failed to flush to its output (e.g. to disk).

Note that if this fails to flush the stream for any reason, this function reports an error, but the SDL_IOStream
is still invalid once this function returns.

This call flushes any buffered writes to the operating system, but there are no guarantees that those writes have gone to physical media; they might be in the OS’s file cache, waiting to go to disk later. If it’s absolutely crucial that writes go to disk immediately, so they are definitely stored even if the power fails before the file cache would have caught up, one should call SDL_FlushIO () before closing. Note that flushing takes time and makes the system and your app operate less efficiently, so do so sparingly.

FUNCTION PARAMETERS

context

SDL_IOStream
structure to close.

RETURN VALUE

Returns true on success or false on failure; call

SDL_GetError () for more information.

THREAD SAFETY

This function is not thread safe.

AVAILABILITY

This function is available since SDL 3.2.0.