.\" 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_GetRendererProperties:
.\"   https://wiki.libsdl.org/SDL_GetRendererProperties
.\" 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_GetRendererProperties
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_GetRendererProperties 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_GetRendererProperties \- Get the properties associated with a renderer\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "SDL_PropertiesID SDL_GetRendererProperties(SDL_Renderer *renderer);
.fi
.SH DESCRIPTION
The following read-only properties are provided by SDL:


\(bu 
.BR
.BR SDL_PROP_RENDERER_NAME_STRING
: the
  name of the rendering driver

\(bu 
.BR
.BR SDL_PROP_RENDERER_WINDOW_POINTER
:
  the window where rendering is displayed, if any

\(bu 
.BR
.BR SDL_PROP_RENDERER_SURFACE_POINTER
:
  the surface where rendering is displayed, if this is a software renderer
  without a window

\(bu 
.BR
.BR SDL_PROP_RENDERER_OUTPUT_COLORSPACE_NUMBER
:
  an 
.BR SDL_ColorSpace
 value describing the colorspace for
  output to the display, defaults to
  
.BR SDL_COLORSPACE_SRGB
\[char46]

\(bu 
.BR
.BR SDL_PROP_RENDERER_HDR_ENABLED_BOOLEAN
:
  true if the output colorspace is
  
.BR SDL_COLORSPACE_SRGB_LINEAR
 and the renderer
  is showing on a display with HDR enabled\[char46] This property can change
  dynamically when
  
.BR SDL_EVENT_DISPLAY_HDR_STATE_CHANGED

  is sent\[char46]

\(bu 
.BR
.BR SDL_PROP_RENDERER_SDR_WHITE_POINT_FLOAT
:
  the value of SDR white in the
  
.BR SDL_COLORSPACE_SRGB_LINEAR
 colorspace\[char46] When
  HDR is enabled, this value is automatically multiplied into the color
  scale\[char46] This property can change dynamically when
  
.BR SDL_EVENT_DISPLAY_HDR_STATE_CHANGED

  is sent\[char46]

\(bu 
.BR
.BR SDL_PROP_RENDERER_HDR_HEADROOM_FLOAT
:
  the additional high dynamic range that can be displayed, in terms of the
  SDR white point\[char46] When HDR is not enabled, this will be 1\[char46]0\[char46] This property
  can change dynamically when
  
.BR SDL_EVENT_DISPLAY_HDR_STATE_CHANGED

  is sent\[char46]

With the direct3d renderer:


\(bu 
.BR
.BR SDL_PROP_RENDERER_D3D9_DEVICE_POINTER
:
  the IDirect3DDevice9 associated with the renderer

With the direct3d11 renderer:


\(bu 
.BR
.BR SDL_PROP_RENDERER_D3D11_DEVICE_POINTER
:
  the ID3D11Device associated with the renderer

With the direct3d12 renderer:


\(bu 
.BR
.BR SDL_PROP_RENDERER_D3D12_DEVICE_POINTER
:
  the ID3D12Device associated with the renderer

\(bu 
.BR
.BR SDL_PROP_RENDERER_D3D12_COMMAND_QUEUE_POINTER
:
  the ID3D12CommandQueue associated with the renderer

With the vulkan renderer:


\(bu 
.BR
.BR SDL_PROP_RENDERER_VULKAN_INSTANCE_POINTER
:
  the VkInstance associated with the renderer

\(bu 
.BR
.BR SDL_PROP_RENDERER_VULKAN_SURFACE_NUMBER
:
  the VkSurfaceKHR associated with the renderer

\(bu 
.BR
.BR SDL_PROP_RENDERER_VULKAN_PHYSICAL_DEVICE_POINTER
:
  the VkPhysicalDevice associated with the renderer

\(bu 
.BR
.BR SDL_PROP_RENDERER_VULKAN_DEVICE_POINTER
:
  the VkDevice associated with the renderer

\(bu 
.BR
.BR SDL_PROP_RENDERER_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER
:
  the queue family index used for rendering

\(bu 
.BR
.BR SDL_PROP_RENDERER_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER
:
  the queue family index used for presentation

\(bu 
.BR
.BR SDL_PROP_RENDERER_VULKAN_SWAPCHAIN_IMAGE_COUNT_NUMBER
:
  the number of swapchain images, or potential frames in flight, used by
  the Vulkan renderer

.SH FUNCTION PARAMETERS
.TP
.I renderer
the rendering context
.SH RETURN VALUE
Returns a valid property ID on success or 0 on failure; 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_GetProperty (3),
.BR SDL_SetProperty (3)