(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_SetRenderDrawColor

Set the color used for drawing operations.

Header File

Defined in <SDL3/SDL_render.h>

Syntax

bool SDL_SetRenderDrawColor(SDL_Renderer *renderer, Uint8 r, Uint8 g, Uint8 b, Uint8 a);

Function Parameters

SDL_Renderer *	renderer	the rendering context.
Uint8	r	the red value used to draw on the rendering target.
Uint8	g	the green value used to draw on the rendering target.
Uint8	b	the blue value used to draw on the rendering target.
Uint8	a	the alpha value used to draw on the rendering target; usually SDL_ALPHA_OPAQUE (255). Use SDL_SetRenderDrawBlendMode to specify how the alpha channel is used.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

Set the color for drawing or filling rectangles, lines, and points, and for SDL_RenderClear().

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_GetRenderDrawColor
• SDL_SetRenderDrawColorFloat

---

CategoryAPI, CategoryAPIFunction, CategoryRender

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.