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

Function SDL_snprintf

pub unsafe extern "C" fn SDL_snprintf(
    text: *mut i8,
    maxlen: usize,
    fmt: *const i8,
    ...
) -> i32
Available on crate feature dep_sdl3 only.
Expand description

This works exactly like snprintf() but doesn’t require access to a C runtime.

Format a string of up to maxlen-1 bytes, converting each ‘%’ item with values provided through variable arguments.

While some C runtimes differ on how to deal with too-large strings, this function null-terminates the output, by treating the null-terminator as part of the maxlen count. Note that if maxlen is zero, however, no bytes will be written at all.

This function returns the number of bytes (not characters) that should be written, excluding the null-terminator character. If this returns a number >= maxlen, it means the output string was truncated. A negative return value means an error occurred.

Referencing the output string’s pointer with a format item is undefined behavior.

§Parameters

  • text: the buffer to write the string into. Must not be NULL.
  • maxlen: the maximum bytes to write, including the null-terminator.
  • fmt: a printf-style format string. Must not be NULL.
  • ...: a list of values to be used with the format string.

§Return value

Returns the number of bytes that should be written, not counting the null-terminator char, or a negative value on error.

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.