SDL_utf8strlcpy(3)

SDL_utf8strlcpy 💖

okay bestie, this is a SDL3 FUNCTIONS page, and it's genuinely one of the good ones. sit down, hydrate, let's go ✨

---

✨ NAME ✨

SDL_utf8strlcpy — copy a UTF-8 string, but make it safe 💅

---

✨ SYNOPSIS ✨

#include <SDL3/SDL_stdinc.h>

size_t SDL_utf8strlcpy(char *dst, const char *src, size_t dst_bytes);

---

✨ DESCRIPTION ✨

so the way this works is: it copies up to dst_bytes - 1 bytes from src to dst, and it also makes sure the string it writes into dst doesn't end in a truncated multi-byte sequence. like, no half-characters left dangling, we don't do that here 🫶. then it appends a null terminator, as one does.

src and dst must not overlap. no cap, they just can't.

heads up bestie: unlike SDL_strlcpy(), this function returns the number of bytes written, not the length of src. it's giving "similar name, different vibe" 😭

---

✨ FUNCTION PARAMETERS ✨

• dst — the destination buffer. must not be NULL, and must not overlap with src. 💀
• src — the null-terminated UTF-8 string you're copying. must not be NULL, and must not overlap with dst. 🦋
• dst_bytes — the length (in bytes) of the destination buffer. must not be 0. zero is not the move, babe.

---

✨ RETURN VALUE ✨

returns the number of bytes written, excluding the null terminator. that's it, that's the tea 🍓

---

✨ THREAD SAFETY ✨

it is safe to call this function from any thread. queen behavior, honestly 👑

---

✨ AVAILABILITY ✨

this function is available since SDL 3.2.0. if you're on something older, it's simply not there, sorry babe 🙈

---

✨ SEE ALSO ✨

• SDL_strlcpy(3)

---

Simple Directmedia Layer 🎀 SDL 3.4.18 — mwah, that's the whole page, go forth and copy your UTF-8 strings responsibly, bestie 💖✨🌈