SDL_SeekIO(3)

SDL_SeekIO3

Seek within an sdl_iostream data stream.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_iostream.h

Overview

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

( Sint64 ) 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.

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