devela::_dep::sdl3::sys::iostream

Function SDL_WriteIO

pub unsafe extern "C" fn SDL_WriteIO(
    context: *mut SDL_IOStream,
    ptr: *const c_void,
    size: usize,
) -> usize
Available on crate feature dep_sdl3 only.
Expand description

Write to an SDL_IOStream data stream.

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

On error, this function still attempts to write as much as possible, so it might return a positive value less than the requested write size.

The caller can use SDL_GetIOStatus() to determine if the problem is recoverable, such as a non-blocking write that can simply be retried later, or a fatal error.

§Parameters

  • context: a pointer to an SDL_IOStream structure.
  • ptr: a pointer to a buffer containing data to write.
  • size: the number of bytes to write.

§Return value

Returns the number of bytes written, which will be less than size on failure; call SDL_GetError() for more information.

§Thread safety

This function is not thread safe.

§Availability

This function is available since SDL 3.2.0.

§See also