SDL_RenderCo...tesFromWindow(3)

📦
version 3.4.18 · 9 versions
, in fedora 43, fedora 44

✨ SDL_RenderCoordinatesFromWindow ✨

okay bestie so we're in the SDL3 FUNCTIONS section of the manual and today's main character is SDL_RenderCoordinatesFromWindow 💅 she's the one who tells you where a point on your window actually lands in render-land. no cap.

🌸 NAME 🌸

SDL_RenderCoordinatesFromWindow — get a point in render coordinates when given a point in window coordinates. fr fr, that's the whole job. 🎀

🦋 SYNOPSIS 🦋

#include <SDL3/SDL_render.h>

bool SDL_RenderCoordinatesFromWindow(SDL_Renderer *renderer, float window_x, float window_y, float *x, float *y);

💖 DESCRIPTION 💖

so you hand her a point in window coordinates and she hands you back that same point translated into render coordinates. it's giving translator, it's giving glow-up for your numbers ✨

and the way she does it?? she takes several states into account, literally all of them:

  • the window dimensions 👑
  • the logical presentation settings (that's SDL_SetRenderLogicalPresentation)
  • the scale (that's SDL_SetRenderScale)
  • the viewport (that's SDL_SetRenderViewport)

so like. don't think you can just vibe and skip those. she's accounting for all of it, periodt.

🎀 FUNCTION PARAMETERS 🎀

  • renderer — the rendering context. your girl. the whole operation runs through her 💜
  • window_x — the x coordinate in window coordinates. the input, the origin story 🫶
  • window_y — the y coordinate in window coordinates. the other half of the input 💜
  • x — a pointer filled with the x coordinate in render coordinates. she writes it for you, you don't lift a finger ✨
  • y — a pointer filled with the y coordinate in render coordinates. same deal, filled right up 💖

🌈 RETURN VALUE 🌈

returns true on success or false on failure 😭 and if it's a fail bestie, do NOT just sit there — call SDL_GetError() for more information. that's where the tea is ☕

🔥 THREAD SAFETY 🔥

this function should only be called on the main thread. no side-quests on other threads, i'm so serious 💀

⭐ AVAILABILITY ⭐

this function is available since SDL 3.2.0. so if you're on something older... not her problem, upgrade bestie 🧚

👑 SEE ALSO 👑

and that's the page!! 💖 written under the Simple Directmedia Layer name, version SDL 3.4.18 — mwah, slay, go render something gorgeous 🎀✨🦋

📦 where this page comes from