SDL_SeekIO - Man Page

Seek within an SDL_IOStream data stream.

Synopsis

#include <SDL3/SDL_iostream.h>

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

Description

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.

Function Parameters

context

a pointer to an SDL_IOStream structure.

offset

an offset in bytes, relative to whence location; can be negative.

whence

any of SDL_IO_SEEK_SET, SDL_IO_SEEK_CUR, SDL_IO_SEEK_END.

Return Value

Returns the final offset in the data stream after the seek or -1 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.

See Also

SDL_TellIO(3)

Referenced By

SDL_IOFromConstMem(3), SDL_IOFromDynamicMem(3), SDL_IOFromFile(3), SDL_IOFromMem(3), SDL_TellIO(3), SDL_WriteIO(3).

SDL 3.2.16 Simple Directmedia Layer SDL3 FUNCTIONS