sdl.iostream

SDL IOStream

Members

Enums

SDL_IOStatus
enum SDL_IOStatus

SDL_IOStream status, set by a read or write operation.

SDL_IOWhence
enum SDL_IOWhence

Possible whence values for SDL_IOStream seeking.

Functions

SDL_CloseIO
bool SDL_CloseIO(SDL_IOStream* context)

Close and free an allocated SDL_IOStream structure.

SDL_FlushIO
bool SDL_FlushIO(SDL_IOStream* context)

Flush any buffered data in the stream.

SDL_GetIOProperties
SDL_PropertiesID SDL_GetIOProperties(SDL_IOStream* context)

Get the properties associated with an SDL_IOStream.

SDL_GetIOSize
Sint64 SDL_GetIOSize(SDL_IOStream* context)

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

SDL_GetIOStatus
SDL_IOStatus SDL_GetIOStatus(SDL_IOStream* context)

Query the stream status of an SDL_IOStream.

SDL_IOFromConstMem
SDL_IOStream* SDL_IOFromConstMem(const(void)* mem, size_t size)

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

SDL_IOFromDynamicMem
SDL_IOStream* SDL_IOFromDynamicMem()

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

SDL_IOFromFile
SDL_IOStream* SDL_IOFromFile(const(char)* file, const(char)* mode)

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

SDL_IOFromMem
SDL_IOStream* SDL_IOFromMem(void* mem, size_t size)

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

SDL_IOprintf
size_t SDL_IOprintf(SDL_IOStream* context, const(char)* fmt, ...)

Print to an SDL_IOStream data stream.

SDL_LoadFile
void* SDL_LoadFile(const(char)* file, size_t* datasize)

Load all the data from a file path.

SDL_LoadFile_IO
void* SDL_LoadFile_IO(SDL_IOStream* src, size_t* datasize, bool closeio)

Load all the data from an SDL data stream.

SDL_OpenIO
SDL_IOStream* SDL_OpenIO(const(SDL_IOStreamInterface)* iface, void* userdata)

Create a custom SDL_IOStream.

SDL_ReadIO
size_t SDL_ReadIO(SDL_IOStream* context, void* ptr, size_t size)

Read from a data source.

SDL_ReadS16BE
bool SDL_ReadS16BE(SDL_IOStream* src, Sint16* value)

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

SDL_ReadS16LE
bool SDL_ReadS16LE(SDL_IOStream* src, Sint16* value)

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

SDL_ReadS32BE
bool SDL_ReadS32BE(SDL_IOStream* src, Sint32* value)

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

SDL_ReadS32LE
bool SDL_ReadS32LE(SDL_IOStream* src, Sint32* value)

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

SDL_ReadS64BE
bool SDL_ReadS64BE(SDL_IOStream* src, Sint64* value)

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

SDL_ReadS64LE
bool SDL_ReadS64LE(SDL_IOStream* src, Sint64* value)

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

SDL_ReadS8
bool SDL_ReadS8(SDL_IOStream* src, Sint8* value)

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

SDL_ReadU16BE
bool SDL_ReadU16BE(SDL_IOStream* src, Uint16* value)

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

SDL_ReadU16LE
bool SDL_ReadU16LE(SDL_IOStream* src, Uint16* value)

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

SDL_ReadU32BE
bool SDL_ReadU32BE(SDL_IOStream* src, Uint32* value)

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

SDL_ReadU32LE
bool SDL_ReadU32LE(SDL_IOStream* src, Uint32* value)

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

SDL_ReadU64BE
bool SDL_ReadU64BE(SDL_IOStream* src, Uint64* value)

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

SDL_ReadU64LE
bool SDL_ReadU64LE(SDL_IOStream* src, Uint64* value)

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

SDL_ReadU8
bool SDL_ReadU8(SDL_IOStream* src, Uint8* value)

Use this function to read a byte from an SDL_IOStream.

SDL_SaveFile
bool SDL_SaveFile(const(char)* file, const(void)* data, size_t datasize)

Save all the data into a file path.

SDL_SaveFile_IO
bool SDL_SaveFile_IO(SDL_IOStream* src, const(void)* data, size_t datasize, bool closeio)

Save all the data into an SDL data stream.

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

Seek within an SDL_IOStream data stream.

SDL_TellIO
Sint64 SDL_TellIO(SDL_IOStream* context)

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

SDL_WriteIO
size_t SDL_WriteIO(SDL_IOStream* context, const(void)* ptr, size_t size)

Write to an SDL_IOStream data stream.

SDL_WriteS16BE
bool SDL_WriteS16BE(SDL_IOStream* dst, Sint16 value)

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

SDL_WriteS16LE
bool SDL_WriteS16LE(SDL_IOStream* dst, Sint16 value)

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

SDL_WriteS32BE
bool SDL_WriteS32BE(SDL_IOStream* dst, Sint32 value)

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

SDL_WriteS32LE
bool SDL_WriteS32LE(SDL_IOStream* dst, Sint32 value)

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

SDL_WriteS64BE
bool SDL_WriteS64BE(SDL_IOStream* dst, Sint64 value)

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

SDL_WriteS64LE
bool SDL_WriteS64LE(SDL_IOStream* dst, Sint64 value)

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

SDL_WriteS8
bool SDL_WriteS8(SDL_IOStream* dst, Sint8 value)

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

SDL_WriteU16BE
bool SDL_WriteU16BE(SDL_IOStream* dst, Uint16 value)

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

SDL_WriteU16LE
bool SDL_WriteU16LE(SDL_IOStream* dst, Uint16 value)

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

SDL_WriteU32BE
bool SDL_WriteU32BE(SDL_IOStream* dst, Uint32 value)

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

SDL_WriteU32LE
bool SDL_WriteU32LE(SDL_IOStream* dst, Uint32 value)

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

SDL_WriteU64BE
bool SDL_WriteU64BE(SDL_IOStream* dst, Uint64 value)

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

SDL_WriteU64LE
bool SDL_WriteU64LE(SDL_IOStream* dst, Uint64 value)

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

SDL_WriteU8
bool SDL_WriteU8(SDL_IOStream* dst, Uint8 value)

Use this function to write a byte to an SDL_IOStream.

Manifest constants

SDL_PROP_IOSTREAM_ANDROID_AASSET_POINTER
enum SDL_PROP_IOSTREAM_ANDROID_AASSET_POINTER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SDL_PROP_IOSTREAM_DYNAMIC_CHUNKSIZE_NUMBER
enum SDL_PROP_IOSTREAM_DYNAMIC_CHUNKSIZE_NUMBER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SDL_PROP_IOSTREAM_DYNAMIC_MEMORY_POINTER
enum SDL_PROP_IOSTREAM_DYNAMIC_MEMORY_POINTER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SDL_PROP_IOSTREAM_FILE_DESCRIPTOR_NUMBER
enum SDL_PROP_IOSTREAM_FILE_DESCRIPTOR_NUMBER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SDL_PROP_IOSTREAM_MEMORY_POINTER
enum SDL_PROP_IOSTREAM_MEMORY_POINTER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SDL_PROP_IOSTREAM_MEMORY_SIZE_NUMBER
enum SDL_PROP_IOSTREAM_MEMORY_SIZE_NUMBER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SDL_PROP_IOSTREAM_STDIO_FILE_POINTER
enum SDL_PROP_IOSTREAM_STDIO_FILE_POINTER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SDL_PROP_IOSTREAM_WINDOWS_HANDLE_POINTER
enum SDL_PROP_IOSTREAM_WINDOWS_HANDLE_POINTER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Structs

SDL_IOStream
struct SDL_IOStream

The read/write operation structure.

SDL_IOStreamInterface
struct SDL_IOStreamInterface

The function pointers that drive an SDL_IOStream.

See Also

Meta

License

Subject to the terms of the Zlib License, as written in the LICENSE file.

Authors

Luna Nielsen