SDL_SeekIO

Seek within an SDL_IOStream data stream.

Header File

Defined in <SDL3/SDL_iostream.h>

Syntax

Sint64 SDL_SeekIO(SDL_IOStream *context, Sint64 offset, SDL_IOWhence whence);

Function Parameters

SDL_IOStream *	context	a pointer to an SDL_IOStream structure.
Sint64	offset	an offset in bytes, relative to whence location; can be negative.
SDL_IOWhence	whence	any of SDL_IO_SEEK_SET, SDL_IO_SEEK_CUR, SDL_IO_SEEK_END.

Return Value

(Sint64) Returns the final offset in the data stream after the seek or -1 on failure; call SDL_GetError() for more information.

Remarks

This function seeks to byte offset, relative to whence.

whence may be any of the following values:

• SDL_IO_SEEK_SET: seek from the beginning of data
• SDL_IO_SEEK_CUR: seek relative to current read point
• SDL_IO_SEEK_END: seek relative to the end of data

If this stream can not seek, it will return -1.

Thread Safety

Do not use the same SDL_IOStream from two threads at once.

Version

This function is available since SDL 3.2.0.

See Also

• SDL_TellIO

---

CategoryAPI, CategoryAPIFunction, CategoryIOStream

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