SDL: Clarified the use of SDL_RENDERER_SOFTWARE when creating a renderer

From 8a4284b7df20e9bf082791b61be42d736323855b Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Sat, 27 Jan 2024 12:45:25 -0800
Subject: [PATCH] Clarified the use of SDL_RENDERER_SOFTWARE when creating a
 renderer

Fixes https://github.com/libsdl-org/sdlwiki/issues/458
---
 include/SDL3/SDL_render.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/include/SDL3/SDL_render.h b/include/SDL3/SDL_render.h
index 46485183b9df..e714f7091d16 100644
--- a/include/SDL3/SDL_render.h
+++ b/include/SDL3/SDL_render.h
@@ -203,6 +203,8 @@ extern DECLSPEC int SDLCALL SDL_CreateWindowAndRenderer(int width, int height, U
  * need a specific renderer, specify NULL and SDL will attempt to choose the
  * best option for you, based on what is available on the user's system.
  *
+ * If you pass SDL_RENDERER_SOFTWARE in the flags, you will get a software renderer, otherwise you will get a hardware accelerated renderer if available.
+ *
  * By default the rendering size matches the window size in pixels, but you
  * can call SDL_SetRenderLogicalPresentation() to change the content size and
  * scaling options.