devela::_dep::sdl3::sys::stdinc

Function SDL_utf8strlcpy

pub unsafe extern "C" fn SDL_utf8strlcpy(
    dst: *mut i8,
    src: *const i8,
    dst_bytes: usize,
) -> usize
Available on crate feature dep_sdl3 only.
Expand description

Copy an UTF-8 string.

This function copies up to dst_bytes - 1 bytes from src to dst while also ensuring that the string written to dst does not end in a truncated multi-byte sequence. Finally, it appends a null terminator.

src and dst must not overlap.

Note that unlike SDL_strlcpy(), this function returns the number of bytes written, not the length of src.

§Parameters

  • dst: The destination buffer. Must not be NULL, and must not overlap with src.
  • src: The null-terminated UTF-8 string to copy. Must not be NULL, and must not overlap with dst.
  • dst_bytes: The length (in bytes) of the destination buffer. Must not be 0.

§Return value

Returns the number of bytes written, excluding the null terminator.

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.

§See also