|
Size: 2067
Comment: Fixed argument count in example; added more examples in 'remarks'
|
Size: 2065
Comment: Fixed argument order in examples.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 31: | Line 31: |
| SDL_RWread(rw, buf, 1, sizeof (buf)); | SDL_RWread(rw, buf, sizeof (buf), 1); |
| Line 44: | Line 44: |
| SDL_RWread(rwop, buffer, 4, sizeof(buffer) ) | SDL_RWread(rwop, buffer, sizeof(buffer), 4) |
| Line 52: | Line 52: |
| SDL_RWread(rwop, buffer, 8, sizeof(buffer) ) | SDL_RWread(rwop, buffer, sizeof(buffer), 8) |
SDL_RWread
Use this function to read from a data source.
Syntax
size_t SDL_RWread(struct SDL_RWops* context,
void* ptr,
size_t size,
size_t maxnum)
Function Parameters
context |
a pointer to an SDL_RWops structure |
ptr |
a pointer to a buffer to read data into |
size |
the size of each object to read, in bytes |
maxnum |
the maximum number of objects to be read |
Return Value
Returns the number of objects read, or 0 at error or end of file; call SDL_GetError() for more information.
Code Examples
SDL_RWops *rw = SDL_RWFromFile("test.bin","r");
if (rw != NULL) {
extern Uint8 buf[256];
SDL_RWread(rw, buf, sizeof (buf), 1);
SDL_RWclose(rw);
}
Remarks
This function reads up to maxnum objects each of size size from the data source to the area pointed at by ptr. This function may read less objects than requested. It will return zero when there has been an error or the data stream is completely read.
SDL_RWread is actually a macro that calls the SDL_RWops's read method appropriately, to simplify application development.
More Examples
int buffer[10] SDL_RWread(rwop, buffer, sizeof(buffer), 4)
This will read 40 bytes of data, and put it into 'buffer', which is intended to hold 32-bit integers. Each int is 4 bytes, or 32-bits.
long buffer[10] SDL_RWread(rwop, buffer, sizeof(buffer), 8)
This will read 80 bytes of data, and place them into 'buffer', which is now designed for 64-bit integers (long values). Each int (long) is 8 bytes, and we are reading 10 of them (as shown by buffer[10] when we make it).
