(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_RWwrite

Write to an SDL_RWops data stream.

Header File

Syntax

size_t SDL_RWwrite(SDL_RWops *context,
                   const void *ptr, size_t size,
                   size_t num);

Function Parameters

SDL_RWops *	context	a pointer to an SDL_RWops structure.
const void *	ptr	a pointer to a buffer containing data to write.
size_t	size	the size of an object to write, in bytes.
size_t	num	the number of objects to write.

Return Value

(size_t) Returns the number of objects written, which will be less than num on error; call SDL_GetError() for more information.

Remarks

This function writes exactly num objects each of size size from the area pointed at by ptr to the stream. If this fails for any reason, it'll return less than num to demonstrate how far the write progressed. On success, it returns num.

SDL_RWwrite is actually a function wrapper that calls the SDL_RWops's write method appropriately, to simplify application development.

Prior to SDL 2.0.10, this function was a macro.

Version

This function is available since SDL 2.0.10.