ALmixer  0.0.5
Data Fields
ALmixer_RWops Struct Reference

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

#include <ALmixer_RWops.h>

Data Fields

int64_t(* size )(struct ALmixer_RWops *context)
 Return the size of the file in this rwops, or -1 if unknown. More...
 
int64_t(* seek )(struct ALmixer_RWops *context, int64_t offset, int whence)
 Seek to offset relative to whence, one of stdio's whence values: RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END. More...
 
size_t(* read )(struct ALmixer_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. More...
 
size_t(* write )(struct ALmixer_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. More...
 
int(* close )(struct ALmixer_RWops *context)
 Close and free an allocated ALmixer_RWops structure. More...
 
uint32_t type
 
union {
   struct {
      ALmixer_bool   autoclose
 
      FILE *   fp
 
   }   stdio
 
   struct {
      uint8_t *   base
 
      uint8_t *   here
 
      uint8_t *   stop
 
   }   mem
 
   struct {
      void *   data1
 
      void *   data2
 
   }   unknown
 
hidden
 

Detailed Description

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

Field Documentation

◆ autoclose

ALmixer_bool ALmixer_RWops::autoclose

◆ base

uint8_t* ALmixer_RWops::base

◆ close

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

Close and free an allocated ALmixer_RWops structure.

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

◆ data1

void* ALmixer_RWops::data1

◆ data2

void* ALmixer_RWops::data2

◆ fp

FILE* ALmixer_RWops::fp

◆ here

uint8_t* ALmixer_RWops::here

◆ hidden

union { ... } ALmixer_RWops::hidden

◆ mem

struct { ... } ALmixer_RWops::mem

◆ read

size_t( * ALmixer_RWops::read) (struct ALmixer_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.

◆ seek

int64_t( * ALmixer_RWops::seek) (struct ALmixer_RWops *context, int64_t 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.

◆ size

int64_t( * ALmixer_RWops::size) (struct ALmixer_RWops *context)

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

◆ stdio

struct { ... } ALmixer_RWops::stdio

◆ stop

uint8_t* ALmixer_RWops::stop

◆ type

uint32_t ALmixer_RWops::type

◆ unknown

struct { ... } ALmixer_RWops::unknown

◆ write

size_t( * ALmixer_RWops::write) (struct ALmixer_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.

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