SDL 3.0
SDL_RWops Struct Reference

#include <SDL_rwops.h>

Data Fields

Sint64(* size )(struct SDL_RWops *context)
 
Sint64(* seek )(struct SDL_RWops *context, Sint64 offset, int whence)
 
size_t(* read )(struct SDL_RWops *context, void *ptr, size_t size)
 
size_t(* write )(struct SDL_RWops *context, const void *ptr, size_t size)
 
int(* close )(struct SDL_RWops *context)
 
Uint32 type
 
Uint32 status
 
union { 
 
   struct { 
 
      SDL_bool   autoclose 
 
      void *   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.

Definition at line 60 of file SDL_rwops.h.

Field Documentation

◆ autoclose

SDL_bool SDL_RWops::autoclose

Definition at line 126 of file SDL_rwops.h.

◆ base

Uint8* SDL_RWops::base

Definition at line 132 of file SDL_rwops.h.

◆ close

int(* SDL_RWops::close) (struct SDL_RWops *context)

Close and free an allocated SDL_RWops structure.

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

Definition at line 98 of file SDL_rwops.h.

◆ data1

void* SDL_RWops::data1

Definition at line 139 of file SDL_rwops.h.

◆ data2

void* SDL_RWops::data2

Definition at line 140 of file SDL_rwops.h.

◆ fp

void* SDL_RWops::fp

Definition at line 127 of file SDL_rwops.h.

◆ here

Uint8* SDL_RWops::here

Definition at line 133 of file SDL_rwops.h.

◆ [union]

union { ... } SDL_RWops::hidden

◆ [struct]

struct { ... } SDL_RWops::mem

◆ read

size_t(* SDL_RWops::read) (struct SDL_RWops *context, void *ptr, size_t size)

Read up to size bytes from the data stream to the area pointed at by ptr.

Returns
the number of bytes read

Definition at line 83 of file SDL_rwops.h.

◆ seek

Sint64(* SDL_RWops::seek) (struct SDL_RWops *context, Sint64 offset, int whence)

Seek to offset relative to whence, one of stdio's whence values: SDL_RW_SEEK_SET, SDL_RW_SEEK_CUR, SDL_RW_SEEK_END

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

Definition at line 75 of file SDL_rwops.h.

◆ size

Sint64(* SDL_RWops::size) (struct SDL_RWops *context)

Return the number of bytes in this rwops

Returns
the total size of the data stream, or -1 on error.

Definition at line 67 of file SDL_rwops.h.

◆ status

Uint32 SDL_RWops::status

Definition at line 101 of file SDL_rwops.h.

◆ [struct]

struct { ... } SDL_RWops::stdio

◆ stop

Uint8* SDL_RWops::stop

Definition at line 134 of file SDL_rwops.h.

◆ type

Uint32 SDL_RWops::type

Definition at line 100 of file SDL_rwops.h.

◆ [struct]

struct { ... } SDL_RWops::unknown

◆ write

size_t(* SDL_RWops::write) (struct SDL_RWops *context, const void *ptr, size_t size)

Write exactly size bytes from the area pointed at by ptr to data stream.

Returns
the number of bytes written

Definition at line 91 of file SDL_rwops.h.


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