(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_ReadU8

Use this function to read a byte from an SDL_IOStream.

Header File

Defined in <SDL3/SDL_iostream.h>

Syntax

bool SDL_ReadU8(SDL_IOStream *src, Uint8 *value);

Function Parameters

SDL_IOStream *	src	the SDL_IOStream to read from.
Uint8 *	value	a pointer filled in with the data read.

Return Value

(bool) Returns true on success or false on failure or EOF; call SDL_GetError() for more information.

Remarks

This function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned and the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message.

Version

This function is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIFunction, CategoryIOStream

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.