#include <SDL_iostream.h>

Data Fields
Sint64(*	size )(void *userdata)

Sint64(*	seek )(void *userdata, Sint64 offset, int whence)

size_t(*	read )(void userdata, void ptr, size_t size, SDL_IOStatus *status)

size_t(*	write )(void userdata, const void ptr, size_t size, SDL_IOStatus *status)

int(*	close )(void *userdata)

Detailed Description

The function pointers that drive an SDL_IOStream.

Applications can provide this struct to SDL_OpenIO() to create their own implementation of SDL_IOStream. This is not necessarily required, as SDL already offers several common types of I/O streams, via functions like SDL_IOFromFile() and SDL_IOFromMem().

Since: This struct is available since SDL 3.0.0.

Definition at line 66 of file SDL_iostream.h.

Field Documentation

◆ close

int(* SDL_IOStreamInterface::close) (void *userdata)

Close and free any allocated resources.

The SDL_IOStream is still destroyed even if this fails, so clean up anything even if flushing to disk returns an error.

Returns: 0 if successful or -1 on write error when flushing data.

Definition at line 115 of file SDL_iostream.h.

◆ read

size_t(* SDL_IOStreamInterface::read) (void *userdata, void *ptr, size_t size, SDL_IOStatus *status)

Read up to size bytes from the data stream to the area pointed at by ptr.

On an incomplete read, you should set *status to a value from the SDL_IOStatus enum. You do not have to explicitly set this on a complete, successful read.

Returns: the number of bytes read

Definition at line 93 of file SDL_iostream.h.

◆ seek

Sint64(* SDL_IOStreamInterface::seek) (void *userdata, Sint64 offset, int whence)

Seek to offset relative to whence, one of stdio's whence values: SDL_IO_SEEK_SET, SDL_IO_SEEK_CUR, SDL_IO_SEEK_END

Returns: the final offset in the data stream, or -1 on error.

Definition at line 81 of file SDL_iostream.h.

◆ size

Sint64(* SDL_IOStreamInterface::size) (void *userdata)

Return the number of bytes in this SDL_IOStream

Returns: the total size of the data stream, or -1 on error.

Definition at line 73 of file SDL_iostream.h.

◆ write

size_t(* SDL_IOStreamInterface::write) (void *userdata, const void *ptr, size_t size, SDL_IOStatus *status)

Write exactly size bytes from the area pointed at by ptr to data stream.

On an incomplete write, you should set *status to a value from the SDL_IOStatus enum. You do not have to explicitly set this on a complete, successful write.

Returns: the number of bytes written

Definition at line 105 of file SDL_iostream.h.

The documentation for this struct was generated from the following file:

SDL_iostream.h