UmbraInputStream struct

Interface to a readable stream.

Public variables

void* userData
An arbitrary pointer that Umbra passes to read.
UmbraReadFunc read
A user provided function to read data from a stream.

Variable details

UmbraReadFunc UmbraInputStream::read

A user provided function to read data from a stream.

This function should read up to numBytes bytes from the stream and advance it by the same amount. Umbra will call this function repeatedly until the stream has been exhausted, which is signalled by returning zero.

See UmbraReadFunc for a complete description of the function arguments.