#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "begin_code.h"
#include "close_code.h"

Classes
struct	SDL_RWops

Macros
#define	SDL_RWOPS_UNKNOWN 0U

#define	SDL_RWOPS_WINFILE 1U

#define	SDL_RWOPS_STDFILE 2U

#define	SDL_RWOPS_JNIFILE 3U

#define	SDL_RWOPS_MEMORY 4U

#define	SDL_RWOPS_MEMORY_RO 5U

Typedefs
typedef struct SDL_RWops	SDL_RWops

Functions
Read endian functions
Read an item of the specified endianness and return in native format.
DECLSPEC Uint8 SDLCALL	SDL_ReadU8 (SDL_RWops *src)

DECLSPEC Uint16 SDLCALL	SDL_ReadLE16 (SDL_RWops *src)

DECLSPEC Uint16 SDLCALL	SDL_ReadBE16 (SDL_RWops *src)

DECLSPEC Uint32 SDLCALL	SDL_ReadLE32 (SDL_RWops *src)

DECLSPEC Uint32 SDLCALL	SDL_ReadBE32 (SDL_RWops *src)

DECLSPEC Uint64 SDLCALL	SDL_ReadLE64 (SDL_RWops *src)

DECLSPEC Uint64 SDLCALL	SDL_ReadBE64 (SDL_RWops *src)

Write endian functions
Write an item of native format to the specified endianness.
DECLSPEC size_t SDLCALL	SDL_WriteU8 (SDL_RWops *dst, Uint8 value)

DECLSPEC size_t SDLCALL	SDL_WriteLE16 (SDL_RWops *dst, Uint16 value)

DECLSPEC size_t SDLCALL	SDL_WriteBE16 (SDL_RWops *dst, Uint16 value)

DECLSPEC size_t SDLCALL	SDL_WriteLE32 (SDL_RWops *dst, Uint32 value)

DECLSPEC size_t SDLCALL	SDL_WriteBE32 (SDL_RWops *dst, Uint32 value)

DECLSPEC size_t SDLCALL	SDL_WriteLE64 (SDL_RWops *dst, Uint64 value)

DECLSPEC size_t SDLCALL	SDL_WriteBE64 (SDL_RWops *dst, Uint64 value)

RWFrom functions
Functions to create SDL_RWops structures from various data streams.
#define	RW_SEEK_SET 0

#define	RW_SEEK_CUR 1

#define	RW_SEEK_END 2

DECLSPEC SDL_RWops *SDLCALL	SDL_RWFromFile (const char file, const char mode)

DECLSPEC SDL_RWops *SDLCALL	SDL_RWFromFP (FILE *fp, SDL_bool autoclose)

DECLSPEC SDL_RWops *SDLCALL	SDL_RWFromMem (void *mem, int size)

DECLSPEC SDL_RWops *SDLCALL	SDL_RWFromConstMem (const void *mem, int size)

DECLSPEC SDL_RWops *SDLCALL	SDL_AllocRW (void)

DECLSPEC void SDLCALL	SDL_FreeRW (SDL_RWops *area)

DECLSPEC Sint64 SDLCALL	SDL_RWsize (SDL_RWops *context)

DECLSPEC Sint64 SDLCALL	SDL_RWseek (SDL_RWops *context, Sint64 offset, int whence)

DECLSPEC Sint64 SDLCALL	SDL_RWtell (SDL_RWops *context)

DECLSPEC size_t SDLCALL	SDL_RWread (SDL_RWops context, void ptr, size_t size, size_t maxnum)

DECLSPEC size_t SDLCALL	SDL_RWwrite (SDL_RWops context, const void ptr, size_t size, size_t num)

DECLSPEC int SDLCALL	SDL_RWclose (SDL_RWops *context)

DECLSPEC void *SDLCALL	SDL_LoadFile_RW (SDL_RWops src, size_t datasize, int freesrc)

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

Detailed Description

This file provides a general interface for SDL to read and write data streams. It can easily be extended to files, memory, etc.

Macro Definition Documentation

◆ RW_SEEK_CUR

#define RW_SEEK_CUR 1

Seek relative to current read point

◆ RW_SEEK_END

#define RW_SEEK_END 2

Seek relative to the end of data

◆ RW_SEEK_SET

#define RW_SEEK_SET 0

Seek from the beginning of data

◆ SDL_RWOPS_JNIFILE

#define SDL_RWOPS_JNIFILE 3U

Android asset

◆ SDL_RWOPS_MEMORY

#define SDL_RWOPS_MEMORY 4U

Memory stream

◆ SDL_RWOPS_MEMORY_RO

#define SDL_RWOPS_MEMORY_RO 5U

Read-Only memory stream

◆ SDL_RWOPS_STDFILE

#define SDL_RWOPS_STDFILE 2U

Stdio file

◆ SDL_RWOPS_UNKNOWN

#define SDL_RWOPS_UNKNOWN 0U

Unknown stream type

◆ SDL_RWOPS_WINFILE

#define SDL_RWOPS_WINFILE 1U

Win32 file

Typedef Documentation

◆ SDL_RWops

typedef struct SDL_RWops SDL_RWops

This is the read/write operation structure – very basic.

Function Documentation

◆ SDL_LoadFile()

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

Load an entire file.

The data is allocated with a zero byte at the end (null terminated)

If datasize is not NULL, it is filled with the size of the data read.

If freesrc is non-zero, the stream will be closed after being read.

The data should be freed with SDL_free().

Returns: the data, or NULL if there was an error.

◆ SDL_LoadFile_RW()

DECLSPEC void* SDLCALL SDL_LoadFile_RW	(	SDL_RWops *	src,
		size_t *	datasize,
		int	freesrc
	)

Load all the data from an SDL data stream.

The data is allocated with a zero byte at the end (null terminated)

If datasize is not NULL, it is filled with the size of the data read.

If freesrc is non-zero, the stream will be closed after being read.

The data should be freed with SDL_free().

Returns: the data, or NULL if there was an error.

◆ SDL_RWclose()

DECLSPEC int SDLCALL SDL_RWclose ( SDL_RWops * context )

Close and free an allocated SDL_RWops structure.

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

◆ SDL_RWread()

DECLSPEC size_t SDLCALL SDL_RWread	(	SDL_RWops *	context,
		void *	ptr,
		size_t	size,
		size_t	maxnum
	)

Read up to maxnum objects each of size size from the data stream to the area pointed at by ptr.

Returns: the number of objects read, or 0 at error or end of file.

◆ SDL_RWseek()

DECLSPEC Sint64 SDLCALL SDL_RWseek	(	SDL_RWops *	context,
		Sint64	offset,
		int	whence
	)

Seek to offset relative to whence, one of stdio's whence values: RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END

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

◆ SDL_RWsize()

DECLSPEC Sint64 SDLCALL SDL_RWsize ( SDL_RWops * context )

Return the size of the file in this rwops, or -1 if unknown

◆ SDL_RWtell()

DECLSPEC Sint64 SDLCALL SDL_RWtell ( SDL_RWops * context )

Return the current offset in the data stream, or -1 on error.

◆ SDL_RWwrite()

DECLSPEC size_t SDLCALL SDL_RWwrite	(	SDL_RWops *	context,
		const void *	ptr,
		size_t	size,
		size_t	num
	)

Write exactly num objects each of size size from the area pointed at by ptr to data stream.

Returns: the number of objects written, or 0 at error or end of file.

Classes

Macros

Typedefs

Functions

RWFrom functions