Documentation

Use this function to create a new SDL_IOStream structure for reading from and/or writing to a named file.

The mode string is treated roughly the same as in a call to the C library's fopen(), even if SDL doesn't happen to use fopen() behind the scenes.

Available mode strings:

• "r": Open a file for reading. The file must exist.
• "w": Create an empty file for writing. If a file with the same name already exists its content is erased and the file is treated as a new empty file.
• "wx": Create an empty file for writing. If a file with the same name already exists, the call fails.
• "a": Append to a file. Writing operations append data at the end of the file. The file is created if it does not exist.
• "r+": Open a file for update both reading and writing. The file must exist.
• "w+": Create an empty file for both reading and writing. If a file with the same name already exists its content is erased and the file is treated as a new empty file.
• "w+x": Create an empty file for both reading and writing. If a file with the same name already exists, the call fails.
• "a+": Open a file for reading and appending. All writing operations are performed at the end of the file, protecting the previous content to be overwritten. You can reposition (fseek, rewind) the internal pointer to anywhere in the file for reading, but writing operations will move it back to the end of file. The file is created if it does not exist.

NOTE: In order to open a file as a binary file, a "b" character has to be included in the mode string. This additional "b" character can either be appended at the end of the string (thus making the following compound modes: "rb", "wb", "ab", "r+b", "w+b", "a+b") or be inserted between the letter and the "+" sign for the mixed modes ("rb+", "wb+", "ab+"). Additional characters may follow the sequence, although they should have no effect. For example, "t" is sometimes appended to make explicit the file is a text file.

This function supports Unicode filenames, but they must be encoded in UTF-8 format, regardless of the underlying operating system.

In Android, SDL_IOFromFile() can be used to open content:// URIs. As a fallback, SDL_IOFromFile() will transparently open a matching filename in the app's assets.

Closing the SDL_IOStream will close SDL's internal file handle.

The following properties may be set at creation time by SDL:

• sDL_PROP_IOSTREAM_WINDOWS_HANDLE_POINTER: a pointer, that can be cast to a win32 HANDLE, that this SDL_IOStream is using to access the filesystem. If the program isn't running on Windows, or SDL used some other method to access the filesystem, this property will not be set.
• sDL_PROP_IOSTREAM_STDIO_FILE_POINTER: a pointer, that can be cast to a stdio FILE *, that this SDL_IOStream is using to access the filesystem. If SDL used some other method to access the filesystem, this property will not be set. PLEASE NOTE that if SDL is using a different C runtime than your app, trying to use this pointer will almost certainly result in a crash! This is mostly a problem on Windows; make sure you build SDL and your app with the same compiler and settings to avoid it.
• sDL_PROP_IOSTREAM_FILE_DESCRIPTOR_NUMBER: a file descriptor that this SDL_IOStream is using to access the filesystem.
• sDL_PROP_IOSTREAM_ANDROID_AASSET_POINTER: a pointer, that can be cast to an Android NDK AAsset *, that this SDL_IOStream is using to access the filesystem. If SDL used some other method to access the filesystem, this property will not be set.

file

a UTF-8 string representing the filename to open.

mode

an ASCII string representing the mode to be used for opening the file.

Returns

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

Thread safety

It is safe to call this function from any thread.

See also

sDL_CloseIO, sDL_FlushIO, sDL_ReadIO, sDL_SeekIO, sDL_TellIO, sDL_WriteIO

C declaration

SDL_IOFromFile, defined at SDL3/SDL_iostream.h 278:44

Since: 3.2.0

Use this function to prepare a read-write memory buffer for use with SDL_IOStream.

This function sets up an SDL_IOStream struct based on a memory area of a certain size, for both read and write access.

This memory buffer is not copied by the SDL_IOStream; the pointer you provide must remain valid until you close the stream.

If you need to make sure the SDL_IOStream never writes to the memory buffer, you should use SDL_IOFromConstMem() with a read-only buffer of memory instead.

The following properties will be set at creation time by SDL:

• sDL_PROP_IOSTREAM_MEMORY_POINTER: this will be the mem parameter that was passed to this function.
• sDL_PROP_IOSTREAM_MEMORY_SIZE_NUMBER: this will be the size parameter that was passed to this function.

Additionally, the following properties are recognized:

• sDL_PROP_IOSTREAM_MEMORY_FREE_FUNC_POINTER: if this property is set to a non-NULL value it will be interpreted as a function of SDL_free_func type and called with the passed mem pointer when closing the stream. By default it is unset, i.e., the memory will not be freed.

mem

a pointer to a buffer to feed an SDL_IOStream stream.

size

the buffer size, in bytes.

Returns

a pointer to a new SDL_IOStream structure or NULL on failure; call SDL_GetError() for more information.

Thread safety

It is safe to call this function from any thread.

See also

sDL_IOFromConstMem, sDL_CloseIO, sDL_FlushIO, sDL_ReadIO, sDL_SeekIO, sDL_TellIO, sDL_WriteIO

C declaration

SDL_IOFromMem, defined at SDL3/SDL_iostream.h 330:44

Since: 3.2.0

Use this function to prepare a read-only memory buffer for use with SDL_IOStream.

This function sets up an SDL_IOStream struct based on a memory area of a certain size. It assumes the memory area is not writable.

Attempting to write to this SDL_IOStream stream will report an error without writing to the memory buffer.

This memory buffer is not copied by the SDL_IOStream; the pointer you provide must remain valid until you close the stream.

If you need to write to a memory buffer, you should use SDL_IOFromMem() with a writable buffer of memory instead.

The following properties will be set at creation time by SDL:

• sDL_PROP_IOSTREAM_MEMORY_POINTER: this will be the mem parameter that was passed to this function.
• sDL_PROP_IOSTREAM_MEMORY_SIZE_NUMBER: this will be the size parameter that was passed to this function.

Additionally, the following properties are recognized:

• sDL_PROP_IOSTREAM_MEMORY_FREE_FUNC_POINTER: if this property is set to a non-NULL value it will be interpreted as a function of SDL_free_func type and called with the passed mem pointer when closing the stream. By default it is unset, i.e., the memory will not be freed.

mem

a pointer to a read-only buffer to feed an SDL_IOStream stream.

size

the buffer size, in bytes.

Returns

a pointer to a new SDL_IOStream structure or NULL on failure; call SDL_GetError() for more information.

Thread safety

It is safe to call this function from any thread.

See also

sDL_IOFromMem, sDL_CloseIO, sDL_ReadIO, sDL_SeekIO, sDL_TellIO

C declaration

SDL_IOFromConstMem, defined at SDL3/SDL_iostream.h 381:44

Since: 3.2.0

Use this function to create an SDL_IOStream that is backed by dynamically allocated memory.

This supports the following properties to provide access to the memory and control over allocations:

• sDL_PROP_IOSTREAM_DYNAMIC_MEMORY_POINTER: a pointer to the internal memory of the stream. This can be set to NULL to transfer ownership of the memory to the application, which should free the memory with SDL_free(). If this is done, the next operation on the stream must be SDL_CloseIO().
• sDL_PROP_IOSTREAM_DYNAMIC_CHUNKSIZE_NUMBER: memory will be allocated in multiples of this size, defaulting to 1024.

Returns

a pointer to a new SDL_IOStream structure or NULL on failure; call SDL_GetError() for more information.

Thread safety

It is safe to call this function from any thread.

See also

sDL_CloseIO, sDL_ReadIO, sDL_SeekIO, sDL_TellIO, sDL_WriteIO

C declaration

SDL_IOFromDynamicMem, defined at SDL3/SDL_iostream.h 411:44

Since: 3.2.0

Create a custom SDL_IOStream.

Applications do not need to use this function unless they are providing their own SDL_IOStream implementation. If you just need an SDL_IOStream to read/write a common data source, you should use the built-in implementations in SDL, like SDL_IOFromFile() or SDL_IOFromMem(), etc.

This function makes a copy of iface and the caller does not need to keep it around after this call.

iface

the interface that implements this SDL_IOStream, initialized using SDL_INIT_INTERFACE().

userdata

the pointer that will be passed to the interface functions.

Returns

a pointer to the allocated memory on success or NULL on failure; call SDL_GetError() for more information.

Thread safety

It is safe to call this function from any thread.

See also

sDL_CloseIO, SDL_INIT_INTERFACE, sDL_IOFromConstMem, sDL_IOFromFile, sDL_IOFromMem

C declaration

SDL_OpenIO, defined at SDL3/SDL_iostream.h 446:44

Since: 3.2.0

Close and free an allocated SDL_IOStream structure.

SDL_CloseIO() closes and cleans up the SDL_IOStream stream. It releases any resources used by the stream and frees the SDL_IOStream itself. This returns true on success, or false if the stream failed to flush to its output (e.g. to disk).

Note that if this fails to flush the stream for any reason, this function reports an error, but the SDL_IOStream is still invalid once this function returns.

This call flushes any buffered writes to the operating system, but there are no guarantees that those writes have gone to physical media; they might be in the OS's file cache, waiting to go to disk later. If it's absolutely crucial that writes go to disk immediately, so they are definitely stored even if the power fails before the file cache would have caught up, one should call SDL_FlushIO() before closing. Note that flushing takes time and makes the system and your app operate less efficiently, so do so sparingly.

context

SDL_IOStream structure to close.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

See also

sDL_OpenIO

C declaration

SDL_CloseIO, defined at SDL3/SDL_iostream.h 478:34

Since: 3.2.0

Get the properties associated with an SDL_IOStream.

context

a pointer to an SDL_IOStream structure.

Returns

a valid property ID on success or 0 on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_GetIOProperties, defined at SDL3/SDL_iostream.h 491:46

Since: 3.2.0

Query the stream status of an SDL_IOStream.

This information can be useful to decide if a short read or write was due to an error, an EOF, or a non-blocking operation that isn't yet ready to complete.

An SDL_IOStream 's status is only expected to change after a SDL_ReadIO or SDL_WriteIO call; don't expect it to change if you just call this query function in a tight loop.

context

the SDL_IOStream to query.

Returns

an SDL_IOStatus enum with the current state.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_GetIOStatus, defined at SDL3/SDL_iostream.h 511:42

Since: 3.2.0

Use this function to get the size of the data stream in an SDL_IOStream.

context

the SDL_IOStream to get the size of the data stream from.

Returns

the size of the data stream in the SDL_IOStream on success or a negative error code on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_GetIOSize, defined at SDL3/SDL_iostream.h 525:36

Since: 3.2.0

Seek within an SDL_IOStream data stream.

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.

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.

Returns

the final offset in the data stream after the seek or -1 on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

See also

sDL_TellIO

C declaration

SDL_SeekIO, defined at SDL3/SDL_iostream.h 554:36

Since: 3.2.0

Determine the current read/write offset in an SDL_IOStream data stream.

SDL_TellIO is actually a wrapper function that calls the SDL_IOStream 's seek method, with an offset of 0 bytes from SDL_IO_SEEK_CUR, to simplify application development.

context

an SDL_IOStream data stream object from which to get the current offset.

Returns

the current offset in the stream, or -1 if the information can not be determined.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

See also

sDL_SeekIO

C declaration

SDL_TellIO, defined at SDL3/SDL_iostream.h 574:36

Since: 3.2.0

Read from a data source.

This function reads up size bytes from the data source to the area pointed at by ptr. This function may read less bytes than requested.

This function will return zero when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If zero is returned and the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message.

A request for zero bytes on a valid stream will return zero immediately without accessing the stream, so the stream status (EOF, err, etc) will not change.

context

a pointer to an SDL_IOStream structure.

ptr

a pointer to a buffer to read data into.

size

the number of bytes to read from the data source.

Returns

the number of bytes read, or 0 on end of file or other failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

See also

sDL_WriteIO, sDL_GetIOStatus

C declaration

SDL_ReadIO, defined at SDL3/SDL_iostream.h 604:36

Since: 3.2.0

Write to an SDL_IOStream data stream.

This function writes exactly size bytes from the area pointed at by ptr to the stream. If this fails for any reason, it'll return less than size to demonstrate how far the write progressed. On success, it returns size.

On error, this function still attempts to write as much as possible, so it might return a positive value less than the requested write size.

The caller can use SDL_GetIOStatus() to determine if the problem is recoverable, such as a non-blocking write that can simply be retried later, or a fatal error.

A request for zero bytes on a valid stream will return zero immediately without accessing the stream, so the stream status (EOF, err, etc) will not change.

context

a pointer to an SDL_IOStream structure.

ptr

a pointer to a buffer containing data to write.

size

the number of bytes to write.

Returns

the number of bytes written, which will be less than size on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

See also

SDL_IOprintf, sDL_ReadIO, sDL_SeekIO, sDL_FlushIO, sDL_GetIOStatus

C declaration

SDL_WriteIO, defined at SDL3/SDL_iostream.h 640:36

Since: 3.2.0

Flush any buffered data in the stream.

This function makes sure that any buffered data is written to the stream. Normally this isn't necessary but if the stream is a pipe or socket it guarantees that any pending data is sent.

context

SDL_IOStream structure to flush.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

See also

sDL_OpenIO, sDL_WriteIO

C declaration

SDL_FlushIO, defined at SDL3/SDL_iostream.h 701:34

Since: 3.2.0

Load all the data from an SDL data stream.

The data is allocated with a zero byte at the end (null terminated) for convenience. This extra byte is not included in the value reported via datasize.

The data should be freed with SDL_free().

src

the SDL_IOStream to read all available data from.

datasize

a pointer filled in with the number of bytes read, may be NULL.

closeio

if true, calls SDL_CloseIO() on src before returning, even in the case of an error.

Returns

the data or NULL on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

See also

sDL_LoadFile, sDL_SaveFile_IO

C declaration

SDL_LoadFile_IO, defined at SDL3/SDL_iostream.h 727:36

Since: 3.2.0

Load all the data from a file path.

The data is allocated with a zero byte at the end (null terminated) for convenience. This extra byte is not included in the value reported via datasize.

The data should be freed with SDL_free().

file

the path to read all available data from.

datasize

if not NULL, will store the number of bytes read.

Returns

the data or NULL on failure; call SDL_GetError() for more information.

Thread safety

It is safe to call this function from any thread.

See also

sDL_LoadFile_IO, sDL_SaveFile

C declaration

SDL_LoadFile, defined at SDL3/SDL_iostream.h 750:36

Since: 3.2.0

Save all the data into an SDL data stream.

src

the SDL_IOStream to write all data to.

data

the data to be written. If datasize is 0, may be NULL or a invalid pointer.

datasize

the number of bytes to be written.

closeio

if true, calls SDL_CloseIO() on src before returning, even in the case of an error.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

See also

sDL_SaveFile, sDL_LoadFile_IO

C declaration

SDL_SaveFile_IO, defined at SDL3/SDL_iostream.h 771:34

Since: 3.2.0

Save all the data into a file path.

file

the path to write all available data into.

data

the data to be written. If datasize is 0, may be NULL or a invalid pointer.

datasize

the number of bytes to be written.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

It is safe to call this function from any thread.

See also

sDL_SaveFile_IO, sDL_LoadFile

C declaration

SDL_SaveFile, defined at SDL3/SDL_iostream.h 790:34

Since: 3.2.0

Use this function to read a byte from an SDL_IOStream.

This function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned and the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message.

src

the SDL_IOStream to read from.

value

a pointer filled in with the data read.

Returns

true on success or false on failure or EOF; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_ReadU8, defined at SDL3/SDL_iostream.h 816:34

Since: 3.2.0

Use this function to read a signed byte from an SDL_IOStream.

This function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned and the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message.

src

the SDL_IOStream to read from.

value

a pointer filled in with the data read.

Returns

true on success or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_ReadS8, defined at SDL3/SDL_iostream.h 835:34

Since: 3.2.0

Use this function to read 16 bits of little-endian data from an SDL_IOStream and return in native format.

SDL byteswaps the data only if necessary, so the data returned will be in the native byte order.

This function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned and the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message.

src

the stream from which to read data.

value

a pointer filled in with the data read.

Returns

true on successful read or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_ReadU16LE, defined at SDL3/SDL_iostream.h 858:34

Since: 3.2.0

Use this function to read 16 bits of little-endian data from an SDL_IOStream and return in native format.

SDL byteswaps the data only if necessary, so the data returned will be in the native byte order.

This function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned and the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message.

src

the stream from which to read data.

value

a pointer filled in with the data read.

Returns

true on successful read or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_ReadS16LE, defined at SDL3/SDL_iostream.h 881:34

Since: 3.2.0

Use this function to read 16 bits of big-endian data from an SDL_IOStream and return in native format.

SDL byteswaps the data only if necessary, so the data returned will be in the native byte order.

This function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned and the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message.

src

the stream from which to read data.

value

a pointer filled in with the data read.

Returns

true on successful read or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_ReadU16BE, defined at SDL3/SDL_iostream.h 904:34

Since: 3.2.0

Use this function to read 16 bits of big-endian data from an SDL_IOStream and return in native format.

SDL byteswaps the data only if necessary, so the data returned will be in the native byte order.

This function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned and the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message.

src

the stream from which to read data.

value

a pointer filled in with the data read.

Returns

true on successful read or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_ReadS16BE, defined at SDL3/SDL_iostream.h 927:34

Since: 3.2.0

Use this function to read 32 bits of little-endian data from an SDL_IOStream and return in native format.

SDL byteswaps the data only if necessary, so the data returned will be in the native byte order.

This function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned and the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message.

src

the stream from which to read data.

value

a pointer filled in with the data read.

Returns

true on successful read or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_ReadU32LE, defined at SDL3/SDL_iostream.h 950:34

Since: 3.2.0

Use this function to read 32 bits of little-endian data from an SDL_IOStream and return in native format.

SDL byteswaps the data only if necessary, so the data returned will be in the native byte order.

This function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned and the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message.

src

the stream from which to read data.

value

a pointer filled in with the data read.

Returns

true on successful read or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_ReadS32LE, defined at SDL3/SDL_iostream.h 973:34

Since: 3.2.0

Use this function to read 32 bits of big-endian data from an SDL_IOStream and return in native format.

SDL byteswaps the data only if necessary, so the data returned will be in the native byte order.

This function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned and the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message.

src

the stream from which to read data.

value

a pointer filled in with the data read.

Returns

true on successful read or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_ReadU32BE, defined at SDL3/SDL_iostream.h 996:34

Since: 3.2.0

Use this function to read 32 bits of big-endian data from an SDL_IOStream and return in native format.

SDL byteswaps the data only if necessary, so the data returned will be in the native byte order.

This function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned and the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message.

src

the stream from which to read data.

value

a pointer filled in with the data read.

Returns

true on successful read or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_ReadS32BE, defined at SDL3/SDL_iostream.h 1019:34

Since: 3.2.0

Use this function to read 64 bits of little-endian data from an SDL_IOStream and return in native format.

SDL byteswaps the data only if necessary, so the data returned will be in the native byte order.

This function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned and the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message.

src

the stream from which to read data.

value

a pointer filled in with the data read.

Returns

true on successful read or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_ReadU64LE, defined at SDL3/SDL_iostream.h 1042:34

Since: 3.2.0

Use this function to read 64 bits of little-endian data from an SDL_IOStream and return in native format.

SDL byteswaps the data only if necessary, so the data returned will be in the native byte order.

This function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned and the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message.

src

the stream from which to read data.

value

a pointer filled in with the data read.

Returns

true on successful read or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_ReadS64LE, defined at SDL3/SDL_iostream.h 1065:34

Since: 3.2.0

Use this function to read 64 bits of big-endian data from an SDL_IOStream and return in native format.

SDL byteswaps the data only if necessary, so the data returned will be in the native byte order.

This function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned and the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message.

src

the stream from which to read data.

value

a pointer filled in with the data read.

Returns

true on successful read or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_ReadU64BE, defined at SDL3/SDL_iostream.h 1088:34

Since: 3.2.0

Use this function to read 64 bits of big-endian data from an SDL_IOStream and return in native format.

SDL byteswaps the data only if necessary, so the data returned will be in the native byte order.

This function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned and the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message.

src

the stream from which to read data.

value

a pointer filled in with the data read.

Returns

true on successful read or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_ReadS64BE, defined at SDL3/SDL_iostream.h 1111:34

Since: 3.2.0

Use this function to write a byte to an SDL_IOStream.

dst

the SDL_IOStream to write to.

value

the byte value to write.

Returns

true on successful write or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_WriteU8, defined at SDL3/SDL_iostream.h 1133:34

Since: 3.2.0

Use this function to write a signed byte to an SDL_IOStream.

dst

the SDL_IOStream to write to.

value

the byte value to write.

Returns

true on successful write or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_WriteS8, defined at SDL3/SDL_iostream.h 1147:34

Since: 3.2.0

Use this function to write 16 bits in native format to an SDL_IOStream as little-endian data.

SDL byteswaps the data only if necessary, so the application always specifies native format, and the data written will be in little-endian format.

dst

the stream to which data will be written.

value

the data to be written, in native format.

Returns

true on successful write or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_WriteU16LE, defined at SDL3/SDL_iostream.h 1166:34

Since: 3.2.0

Use this function to write 16 bits in native format to an SDL_IOStream as little-endian data.

SDL byteswaps the data only if necessary, so the application always specifies native format, and the data written will be in little-endian format.

dst

the stream to which data will be written.

value

the data to be written, in native format.

Returns

true on successful write or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_WriteS16LE, defined at SDL3/SDL_iostream.h 1185:34

Since: 3.2.0

Use this function to write 16 bits in native format to an SDL_IOStream as big-endian data.

SDL byteswaps the data only if necessary, so the application always specifies native format, and the data written will be in big-endian format.

dst

the stream to which data will be written.

value

the data to be written, in native format.

Returns

true on successful write or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_WriteU16BE, defined at SDL3/SDL_iostream.h 1203:34

Since: 3.2.0

Use this function to write 16 bits in native format to an SDL_IOStream as big-endian data.

SDL byteswaps the data only if necessary, so the application always specifies native format, and the data written will be in big-endian format.

dst

the stream to which data will be written.

value

the data to be written, in native format.

Returns

true on successful write or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_WriteS16BE, defined at SDL3/SDL_iostream.h 1221:34

Since: 3.2.0

Use this function to write 32 bits in native format to an SDL_IOStream as little-endian data.

SDL byteswaps the data only if necessary, so the application always specifies native format, and the data written will be in little-endian format.

dst

the stream to which data will be written.

value

the data to be written, in native format.

Returns

true on successful write or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_WriteU32LE, defined at SDL3/SDL_iostream.h 1240:34

Since: 3.2.0

Use this function to write 32 bits in native format to an SDL_IOStream as little-endian data.

SDL byteswaps the data only if necessary, so the application always specifies native format, and the data written will be in little-endian format.

dst

the stream to which data will be written.

value

the data to be written, in native format.

Returns

true on successful write or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_WriteS32LE, defined at SDL3/SDL_iostream.h 1259:34

Since: 3.2.0

Use this function to write 32 bits in native format to an SDL_IOStream as big-endian data.

SDL byteswaps the data only if necessary, so the application always specifies native format, and the data written will be in big-endian format.

dst

the stream to which data will be written.

value

the data to be written, in native format.

Returns

true on successful write or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_WriteU32BE, defined at SDL3/SDL_iostream.h 1277:34

Since: 3.2.0

Use this function to write 32 bits in native format to an SDL_IOStream as big-endian data.

SDL byteswaps the data only if necessary, so the application always specifies native format, and the data written will be in big-endian format.

dst

the stream to which data will be written.

value

the data to be written, in native format.

Returns

true on successful write or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_WriteS32BE, defined at SDL3/SDL_iostream.h 1295:34

Since: 3.2.0

Use this function to write 64 bits in native format to an SDL_IOStream as little-endian data.

SDL byteswaps the data only if necessary, so the application always specifies native format, and the data written will be in little-endian format.

dst

the stream to which data will be written.

value

the data to be written, in native format.

Returns

true on successful write or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_WriteU64LE, defined at SDL3/SDL_iostream.h 1314:34

Since: 3.2.0

Use this function to write 64 bits in native format to an SDL_IOStream as little-endian data.

SDL byteswaps the data only if necessary, so the application always specifies native format, and the data written will be in little-endian format.

dst

the stream to which data will be written.

value

the data to be written, in native format.

Returns

true on successful write or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_WriteS64LE, defined at SDL3/SDL_iostream.h 1333:34

Since: 3.2.0

Use this function to write 64 bits in native format to an SDL_IOStream as big-endian data.

SDL byteswaps the data only if necessary, so the application always specifies native format, and the data written will be in big-endian format.

dst

the stream to which data will be written.

value

the data to be written, in native format.

Returns

true on successful write or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_WriteU64BE, defined at SDL3/SDL_iostream.h 1351:34

Since: 3.2.0

Use this function to write 64 bits in native format to an SDL_IOStream as big-endian data.

SDL byteswaps the data only if necessary, so the application always specifies native format, and the data written will be in big-endian format.

dst

the stream to which data will be written.

value

the data to be written, in native format.

Returns

true on successful write or false on failure; call SDL_GetError() for more information.

Thread safety

Do not use the same SDL_IOStream from two threads at once.

C declaration

SDL_WriteS64BE, defined at SDL3/SDL_iostream.h 1369:34

Since: 3.2.0