SDL Library

Dependents:   H261_decoder

Embed: (wiki syntax)

« Back to documentation index

SDL_RWops Struct Reference

SDL_RWops Struct Reference

This is the read/write operation structure -- very basic. More...

#include <SDL_rwops.h>

Public Member Functions

 Sint64 (SDLCALL *size)(struct SDL_RWops *context)
 Return the size of the file in this rwops, or -1 if unknown.
 Sint64 (SDLCALL *seek)(struct SDL_RWops *context
 Seek to offset relative to whence, one of stdio's whence values: RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END.
 size_t (SDLCALL *read)(struct SDL_RWops *context
 Read up to maxnum objects each of size size from the data stream to the area pointed at by ptr.
 size_t (SDLCALL *write)(struct SDL_RWops *context
 Write exactly num objects each of size size from the area pointed at by ptr to data stream.
 int (SDLCALL *close)(struct SDL_RWops *context)
 Close and free an allocated SDL_RWops structure.

Detailed Description

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

Definition at line 52 of file SDL_rwops.h.


Member Function Documentation

int ( SDLCALL *  close )

Close and free an allocated SDL_RWops structure.

Returns:
0 if successful or -1 on write error when flushing data.
Sint64 ( SDLCALL *  seek )

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.
Sint64 ( SDLCALL *  size )

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

size_t ( SDLCALL *  read )

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.
size_t ( SDLCALL *  write )

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.