My Project
Public Member Functions | Public Attributes | List of all members
SDL_RWops Struct Reference

#include <SDL_rwops.h>

Public Member Functions

 Sint64 (SDLCALL *size)(struct SDL_RWops *context)
 
 Sint64 (SDLCALL *seek)(struct SDL_RWops *context
 
 size_t (SDLCALL *read)(struct SDL_RWops *context
 
 size_t (SDLCALL *write)(struct SDL_RWops *context
 
 int (SDLCALL *close)(struct SDL_RWops *context)
 

Public Attributes

Sint64 offset
 
Sint64 int whence
 
void * ptr
 
void size_t size
 
void size_t size_t maxnum
 
const void * ptr
 
const void size_t size
 
const void size_t size_t num
 
Uint32 type
 
union {
   struct {
      SDL_bool   autoclose
 
      FILE *   fp
 
   }   stdio
 
   struct {
      Uint8 *   base
 
      Uint8 *   here
 
      Uint8 *   stop
 
   }   mem
 
   struct {
      void *   data1
 
      void *   data2
 
   }   unknown
 
hidden
 

Detailed Description

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

Member Function Documentation

◆ int()

SDL_RWops::int ( SDLCALL *  close)

Close and free an allocated SDL_RWops structure.

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

◆ Sint64() [1/2]

SDL_RWops::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() [2/2]

SDL_RWops::Sint64 ( SDLCALL *  size)

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

◆ size_t() [1/2]

SDL_RWops::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() [2/2]

SDL_RWops::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.

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