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

Function SDL_OpenIO

pub unsafe extern "C" fn SDL_OpenIO(
    iface: *const SDL_IOStreamInterface,
    userdata: *mut c_void,
) -> *mut SDL_IOStream
Available on crate feature dep_sdl3 only.
Expand description

Create a custom SDL_IOStream.

Applications do not need to use this function unless they are providing their own SDL_IOStream implementation. If you just need an SDL_IOStream to read/write a common data source, you should use the built-in implementations in SDL, like SDL_IOFromFile() or SDL_IOFromMem(), etc.

This function makes a copy of iface and the caller does not need to keep it around after this call.

§Parameters

  • iface: the interface that implements this SDL_IOStream, initialized using SDL_INIT_INTERFACE().
  • userdata: the pointer that will be passed to the interface functions.

§Return value

Returns a pointer to the allocated memory on success or NULL on failure; call SDL_GetError() for more information.

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.

§See also