# CategoryRender

Header file for SDL 2D rendering functions.

This API supports the following features:

- single pixel points
- single pixel lines
- filled rectangles
- texture images
- 2D polygons

The primitives may be drawn in opaque, blended, or additive modes.

The texture images may be drawn in opaque, blended, or additive modes. They
can have an additional color tint or alpha modulation applied to them, and
may also be stretched with linear interpolation.

This API is designed to accelerate simple 2D operations. You may want more
functionality such as polygons and particle effects and in that case you
should use SDL's OpenGL/Direct3D support, the SDL3 GPU API, or one of the
many good 3D engines.

These functions must be called from the main thread. See this bug for
details: https://github.com/libsdl-org/SDL/issues/986

<!-- END CATEGORY DOCUMENTATION -->

## Functions

<!-- DO NOT HAND-EDIT CATEGORY LISTS, THEY ARE AUTOGENERATED AND WILL BE OVERWRITTEN, BASED ON TAGS IN INDIVIDUAL PAGE FOOTERS. EDIT THOSE INSTEAD. -->
<!-- BEGIN CATEGORY LIST: CategoryRender, CategoryAPIFunction -->
- [SDL_AddVulkanRenderSemaphores](SDL_AddVulkanRenderSemaphores)
- [SDL_ConvertEventToRenderCoordinates](SDL_ConvertEventToRenderCoordinates)
- [SDL_CreateRenderer](SDL_CreateRenderer)
- [SDL_CreateRendererWithProperties](SDL_CreateRendererWithProperties)
- [SDL_CreateSoftwareRenderer](SDL_CreateSoftwareRenderer)
- [SDL_CreateTexture](SDL_CreateTexture)
- [SDL_CreateTextureFromSurface](SDL_CreateTextureFromSurface)
- [SDL_CreateTextureWithProperties](SDL_CreateTextureWithProperties)
- [SDL_CreateWindowAndRenderer](SDL_CreateWindowAndRenderer)
- [SDL_DestroyRenderer](SDL_DestroyRenderer)
- [SDL_DestroyTexture](SDL_DestroyTexture)
- [SDL_FlushRenderer](SDL_FlushRenderer)
- [SDL_GetCurrentRenderOutputSize](SDL_GetCurrentRenderOutputSize)
- [SDL_GetNumRenderDrivers](SDL_GetNumRenderDrivers)
- [SDL_GetRenderClipRect](SDL_GetRenderClipRect)
- [SDL_GetRenderColorScale](SDL_GetRenderColorScale)
- [SDL_GetRenderDrawBlendMode](SDL_GetRenderDrawBlendMode)
- [SDL_GetRenderDrawColor](SDL_GetRenderDrawColor)
- [SDL_GetRenderDrawColorFloat](SDL_GetRenderDrawColorFloat)
- [SDL_GetRenderDriver](SDL_GetRenderDriver)
- [SDL_GetRenderer](SDL_GetRenderer)
- [SDL_GetRendererFromTexture](SDL_GetRendererFromTexture)
- [SDL_GetRendererName](SDL_GetRendererName)
- [SDL_GetRendererProperties](SDL_GetRendererProperties)
- [SDL_GetRenderLogicalPresentation](SDL_GetRenderLogicalPresentation)
- [SDL_GetRenderLogicalPresentationRect](SDL_GetRenderLogicalPresentationRect)
- [SDL_GetRenderMetalCommandEncoder](SDL_GetRenderMetalCommandEncoder)
- [SDL_GetRenderMetalLayer](SDL_GetRenderMetalLayer)
- [SDL_GetRenderOutputSize](SDL_GetRenderOutputSize)
- [SDL_GetRenderSafeArea](SDL_GetRenderSafeArea)
- [SDL_GetRenderScale](SDL_GetRenderScale)
- [SDL_GetRenderTarget](SDL_GetRenderTarget)
- [SDL_GetRenderViewport](SDL_GetRenderViewport)
- [SDL_GetRenderVSync](SDL_GetRenderVSync)
- [SDL_GetRenderWindow](SDL_GetRenderWindow)
- [SDL_GetTextureAlphaMod](SDL_GetTextureAlphaMod)
- [SDL_GetTextureAlphaModFloat](SDL_GetTextureAlphaModFloat)
- [SDL_GetTextureBlendMode](SDL_GetTextureBlendMode)
- [SDL_GetTextureColorMod](SDL_GetTextureColorMod)
- [SDL_GetTextureColorModFloat](SDL_GetTextureColorModFloat)
- [SDL_GetTextureProperties](SDL_GetTextureProperties)
- [SDL_GetTextureScaleMode](SDL_GetTextureScaleMode)
- [SDL_GetTextureSize](SDL_GetTextureSize)
- [SDL_LockTexture](SDL_LockTexture)
- [SDL_LockTextureToSurface](SDL_LockTextureToSurface)
- [SDL_RenderClear](SDL_RenderClear)
- [SDL_RenderClipEnabled](SDL_RenderClipEnabled)
- [SDL_RenderCoordinatesFromWindow](SDL_RenderCoordinatesFromWindow)
- [SDL_RenderCoordinatesToWindow](SDL_RenderCoordinatesToWindow)
- [SDL_RenderDebugText](SDL_RenderDebugText)
- [SDL_RenderFillRect](SDL_RenderFillRect)
- [SDL_RenderFillRects](SDL_RenderFillRects)
- [SDL_RenderGeometry](SDL_RenderGeometry)
- [SDL_RenderGeometryRaw](SDL_RenderGeometryRaw)
- [SDL_RenderLine](SDL_RenderLine)
- [SDL_RenderLines](SDL_RenderLines)
- [SDL_RenderPoint](SDL_RenderPoint)
- [SDL_RenderPoints](SDL_RenderPoints)
- [SDL_RenderPresent](SDL_RenderPresent)
- [SDL_RenderReadPixels](SDL_RenderReadPixels)
- [SDL_RenderRect](SDL_RenderRect)
- [SDL_RenderRects](SDL_RenderRects)
- [SDL_RenderTexture](SDL_RenderTexture)
- [SDL_RenderTexture9Grid](SDL_RenderTexture9Grid)
- [SDL_RenderTextureAffine](SDL_RenderTextureAffine)
- [SDL_RenderTextureRotated](SDL_RenderTextureRotated)
- [SDL_RenderTextureTiled](SDL_RenderTextureTiled)
- [SDL_RenderViewportSet](SDL_RenderViewportSet)
- [SDL_SetRenderClipRect](SDL_SetRenderClipRect)
- [SDL_SetRenderColorScale](SDL_SetRenderColorScale)
- [SDL_SetRenderDrawBlendMode](SDL_SetRenderDrawBlendMode)
- [SDL_SetRenderDrawColor](SDL_SetRenderDrawColor)
- [SDL_SetRenderDrawColorFloat](SDL_SetRenderDrawColorFloat)
- [SDL_SetRenderLogicalPresentation](SDL_SetRenderLogicalPresentation)
- [SDL_SetRenderScale](SDL_SetRenderScale)
- [SDL_SetRenderTarget](SDL_SetRenderTarget)
- [SDL_SetRenderViewport](SDL_SetRenderViewport)
- [SDL_SetRenderVSync](SDL_SetRenderVSync)
- [SDL_SetTextureAlphaMod](SDL_SetTextureAlphaMod)
- [SDL_SetTextureAlphaModFloat](SDL_SetTextureAlphaModFloat)
- [SDL_SetTextureBlendMode](SDL_SetTextureBlendMode)
- [SDL_SetTextureColorMod](SDL_SetTextureColorMod)
- [SDL_SetTextureColorModFloat](SDL_SetTextureColorModFloat)
- [SDL_SetTextureScaleMode](SDL_SetTextureScaleMode)
- [SDL_UnlockTexture](SDL_UnlockTexture)
- [SDL_UpdateNVTexture](SDL_UpdateNVTexture)
- [SDL_UpdateTexture](SDL_UpdateTexture)
- [SDL_UpdateYUVTexture](SDL_UpdateYUVTexture)
<!-- END CATEGORY LIST -->

## Datatypes

<!-- DO NOT HAND-EDIT CATEGORY LISTS, THEY ARE AUTOGENERATED AND WILL BE OVERWRITTEN, BASED ON TAGS IN INDIVIDUAL PAGE FOOTERS. EDIT THOSE INSTEAD. -->
<!-- BEGIN CATEGORY LIST: CategoryRender, CategoryAPIDatatype -->
- [SDL_Renderer](SDL_Renderer)
<!-- END CATEGORY LIST -->

## Structs

<!-- DO NOT HAND-EDIT CATEGORY LISTS, THEY ARE AUTOGENERATED AND WILL BE OVERWRITTEN, BASED ON TAGS IN INDIVIDUAL PAGE FOOTERS. EDIT THOSE INSTEAD. -->
<!-- BEGIN CATEGORY LIST: CategoryRender, CategoryAPIStruct -->
- [SDL_Texture](SDL_Texture)
- [SDL_Vertex](SDL_Vertex)
<!-- END CATEGORY LIST -->

## Enums

<!-- DO NOT HAND-EDIT CATEGORY LISTS, THEY ARE AUTOGENERATED AND WILL BE OVERWRITTEN, BASED ON TAGS IN INDIVIDUAL PAGE FOOTERS. EDIT THOSE INSTEAD. -->
<!-- BEGIN CATEGORY LIST: CategoryRender, CategoryAPIEnum -->
- [SDL_RendererLogicalPresentation](SDL_RendererLogicalPresentation)
- [SDL_TextureAccess](SDL_TextureAccess)
<!-- END CATEGORY LIST -->

## Macros

<!-- DO NOT HAND-EDIT CATEGORY LISTS, THEY ARE AUTOGENERATED AND WILL BE OVERWRITTEN, BASED ON TAGS IN INDIVIDUAL PAGE FOOTERS. EDIT THOSE INSTEAD. -->
<!-- BEGIN CATEGORY LIST: CategoryRender, CategoryAPIMacro -->
- [SDL_DEBUG_TEXT_FONT_CHARACTER_SIZE](SDL_DEBUG_TEXT_FONT_CHARACTER_SIZE)
- [SDL_SOFTWARE_RENDERER](SDL_SOFTWARE_RENDERER)
<!-- END CATEGORY LIST -->


----
[CategoryAPICategory](CategoryAPICategory)