.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_CreateRendererWithProperties:
.\"   https://wiki.libsdl.org/SDL_CreateRendererWithProperties
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_CreateRendererWithProperties
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_CreateRendererWithProperties 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_CreateRendererWithProperties \- Create a 2D rendering context for a window, with the specified properties\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "SDL_Renderer * SDL_CreateRendererWithProperties(SDL_PropertiesID props);
.fi
.SH DESCRIPTION
These are the supported properties:


\(bu 
.BR
.BR SDL_PROP_RENDERER_CREATE_NAME_STRING
:
  the name of the rendering driver to use, if a specific one is desired

\(bu 
.BR
.BR SDL_PROP_RENDERER_CREATE_WINDOW_POINTER
:
  the window where rendering is displayed, required if this isn't a
  software renderer using a surface

\(bu 
.BR
.BR SDL_PROP_RENDERER_CREATE_SURFACE_POINTER
:
  the surface where rendering is displayed, if you want a software renderer
  without a window

\(bu 
.BR
.BR SDL_PROP_RENDERER_CREATE_OUTPUT_COLORSPACE_NUMBER
:
  an 
.BR SDL_ColorSpace
 value describing the colorspace for
  output to the display, defaults to
  
.BR SDL_COLORSPACE_SRGB
\[char46] The direct3d11, direct3d12,
  and metal renderers support
  
.BR SDL_COLORSPACE_SRGB_LINEAR
, which is a
  linear color space and supports HDR output\[char46] If you select
  
.BR SDL_COLORSPACE_SRGB_LINEAR
, drawing still
  uses the sRGB colorspace, but values can go beyond 1\[char46]0 and float (linear)
  format textures can be used for HDR content\[char46]

\(bu 
.BR
.BR SDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_BOOLEAN
:
  true if you want present synchronized with the refresh rate

With the vulkan renderer:


\(bu 
.BR
.BR SDL_PROP_RENDERER_CREATE_VULKAN_INSTANCE_POINTER
:
  the VkInstance to use with the renderer, optional\[char46]

\(bu 
.BR
.BR SDL_PROP_RENDERER_CREATE_VULKAN_SURFACE_NUMBER
:
  the VkSurfaceKHR to use with the renderer, optional\[char46]

\(bu 
.BR
.BR SDL_PROP_RENDERER_CREATE_VULKAN_PHYSICAL_DEVICE_POINTER
:
  the VkPhysicalDevice to use with the renderer, optional\[char46]

\(bu 
.BR
.BR SDL_PROP_RENDERER_CREATE_VULKAN_DEVICE_POINTER
:
  the VkDevice to use with the renderer, optional\[char46]

\(bu 
.BR
.BR SDL_PROP_RENDERER_CREATE_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER
:
  the queue family index used for rendering\[char46]

\(bu 
.BR
.BR SDL_PROP_RENDERER_CREATE_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER
:
  the queue family index used for presentation\[char46]

.SH FUNCTION PARAMETERS
.TP
.I props
the properties to use
.SH RETURN VALUE
Returns a valid rendering context or NULL if there was an error; call

.BR SDL_GetError
() for more information\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_CreateProperties (3),
.BR SDL_CreateRenderer (3),
.BR SDL_CreateSoftwareRenderer (3),
.BR SDL_DestroyRenderer (3),
.BR SDL_GetRendererInfo (3)