SDL_CREATERENDERERWITHPROPERTIES(3)

✨ SDL_CreateRendererWithProperties ✨

okay bestie, welcome to the SDL3 function zone 💖 this one lives in SDL_CreateRendererWithProperties(3) and it's literally the glow-up version of making a 2D rendering context for a window — except you get to hand it a whole lil bag of properties instead of boring positional args. main character energy fr fr 🎀

---

🌸 NAME 🌸

SDL_CreateRendererWithProperties — Create a 2D rendering context for a window, with the specified properties. ✨

---

🦋 SYNOPSIS 🦋

#include <SDL3/SDL_render.h>

SDL_Renderer * SDL_CreateRendererWithProperties(SDL_PropertiesID props);

---

💅 DESCRIPTION 💅

so basically you pass in a props ID and it reads a whole vibe board of properties off it. here's the full list, no skipping, no gatekeeping 🫶

• SDL_PROP_RENDERER_CREATE_NAME_STRING — the name of the rendering driver to use, if you want a specific one 👑
• SDL_PROP_RENDERER_CREATE_WINDOW_POINTER — the window where rendering is displayed. required if this isn't a software renderer using a surface 🪟
• SDL_PROP_RENDERER_CREATE_SURFACE_POINTER — the surface where rendering is displayed, if you want a software renderer without a window 🎨
• SDL_PROP_RENDERER_CREATE_OUTPUT_COLORSPACE_NUMBER — an SDL_Colorspace value describing the colorspace for output to the display, defaults to SDL_COLORSPACE_SRGB. the direct3d11, direct3d12, and metal renderers support SDL_COLORSPACE_SRGB_LINEAR, which is a linear color space and supports HDR output 🌈. if you select SDL_COLORSPACE_SRGB_LINEAR, drawing still uses the sRGB colorspace, but values can go beyond 1.0 and float (linear) format textures can be used for HDR content. it's giving ✨extra range✨
• SDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_NUMBER — non-zero if you want present synchronized with the refresh rate. this property can take any value that is supported by SDL_SetRenderVSync() for the renderer 🧊

---

🎮 With the SDL GPU renderer (since SDL 3.4.0) 🎮

• SDL_PROP_RENDERER_CREATE_GPU_DEVICE_POINTER — the device to use with the renderer, optional.
• SDL_PROP_RENDERER_CREATE_GPU_SHADERS_SPIRV_BOOLEAN — the app is able to provide SPIR-V shaders to SDL_GPURenderState, optional.
• SDL_PROP_RENDERER_CREATE_GPU_SHADERS_DXIL_BOOLEAN — the app is able to provide DXIL shaders to SDL_GPURenderState, optional.
• SDL_PROP_RENDERER_CREATE_GPU_SHADERS_MSL_BOOLEAN — the app is able to provide MSL shaders to SDL_GPURenderState, optional.

---

🌋 With the vulkan renderer 🌋

• SDL_PROP_RENDERER_CREATE_VULKAN_INSTANCE_POINTER — the VkInstance to use with the renderer, optional.
• SDL_PROP_RENDERER_CREATE_VULKAN_SURFACE_NUMBER — the VkSurfaceKHR to use with the renderer, optional.
• SDL_PROP_RENDERER_CREATE_VULKAN_PHYSICAL_DEVICE_POINTER — the VkPhysicalDevice to use with the renderer, optional.
• SDL_PROP_RENDERER_CREATE_VULKAN_DEVICE_POINTER — the VkDevice to use with the renderer, optional.
• SDL_PROP_RENDERER_CREATE_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER — the queue family index used for rendering.
• SDL_PROP_RENDERER_CREATE_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER — the queue family index used for presentation.

---

🍓 FUNCTION PARAMETERS 🍓

• props — the properties to use.

---

💜 RETURN VALUE 💜

Returns a valid rendering context, or NULL if there was an error 😭 (we hate to see it). call SDL_GetError() for more information — she'll tell you what went wrong, no cap.

---

🧚 THREAD SAFETY 🧚

This function should only be called on the main thread. do not try to be sneaky with it on another thread bestie, it's not built for that 💀

---

⭐ AVAILABILITY ⭐

This function is available since SDL 3.2.0. ✨

---

👑 SEE ALSO 👑

• SDL_CreateProperties(3)
• SDL_CreateRenderer(3)
• SDL_CreateSoftwareRenderer(3)
• SDL_DestroyRenderer(3)
• SDL_GetRendererName(3)

---

Simple Directmedia Layer · SDL 3.4.18 · that's the whole page babes, go forth and create renderers 💖🦋🌸🎀 periodt ✨