SDL_RWFromFP

Use this function to create an SDL_RWops structure from a standard I/O file pointer (stdio.h's FILE*).

Header File

Syntax

SDL_RWops* SDL_RWFromFP(void * fp,
                        SDL_bool autoclose);

Function Parameters

void *	fp	the `FILE*` that feeds the SDL_RWops stream.
SDL_bool	autoclose	SDL_TRUE to close the `FILE` when closing the SDL_RWops, SDL_FALSE to leave the `FILE` open when the RWops is closed.

Return Value

(SDL_RWops *) Returns a pointer to the SDL_RWops structure that is created, or NULL on failure; call SDL_GetError() for more information.

Remarks

This function is not available on Windows, since files opened in an application on that platform cannot be used by a dynamically linked library.

On some platforms, the first parameter is a void*, on others, it's a FILE*, depending on what system headers are available to SDL. It is always intended to be the FILE* type from the C runtime's stdio.h.

Version

This function is available since SDL 2.0.0.