SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_RWseek

Seek within an SDL_RWops data stream.

Syntax

Sint64 SDL_RWseek(SDL_RWops *context, Sint64 offset, int whence);

Function Parameters

context a pointer to an SDL_RWops structure
offset an offset in bytes, relative to whence location; can be negative
whence any of SDL_RW_SEEK_SET, SDL_RW_SEEK_CUR, SDL_RW_SEEK_END

Return Value

Returns the final offset in the data stream after the seek or a negative error code 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:

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

SDL_RWseek() is actually a wrapper function that calls the SDL_RWops's seek method appropriately, to simplify application development.

Version

This function is available since SDL 3.0.0.

Code Examples

SDL_RWops *rw = SDL_RWFromFile("myfile.bin", "rb");
if (rw != NULL) {
    /* Seek to 0 bytes from the end of the file */
    Sint64 length = SDL_RWseek(rw, 0, SDL_RW_SEEK_END);
    SDL_RWclose(rw);
    if (length < 0) {
        printf("Could not seek inside myfile.bin\n");
    } else {
        printf("myfile.bin is %d bytes long\n", length);
    }
}

CategoryAPI, CategoryIO


[ edit | delete | history | feedback | raw ]

[ 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.