SDL_LoadFile_IO(3)

SDL_LoadFile_IO3

Load all the data from an sdl data stream.

Usage

#include "SDL3/SDL.h"

void * SDL_LoadFile_IO(SDL_IOStream *src, size_t *datasize, bool closeio);

Header file

Defined in SDL3/SDL_iostream.h

Overview

The data is allocated with a zero byte at the end (null terminated) for convenience. This extra byte is not included in the value reported via datasize .

The data should be freed with SDL_free ().

Function parameters

src

the SDL_IOStream
to read all available data from.

datasize

a pointer filled in with the number of bytes read, may be NULL.

closeio

if true, calls SDL_CloseIO () on src before returning, even in the case of an error.

Return value

Returns the data or NULL 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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.