eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-31 08:57:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

include: Remove string literals from properties documentation.

Browse source 
I'm going to let the wiki bridge clean up the word wrapping for me, here. :)
This commit is contained in:
Ryan C. Gordon 2024-01-08 12:33:29 -05:00
parent e8c595af5c
commit e056f52f7d
No known key found for this signature in database
GPG key ID: FA148B892AB48044
2 changed files with 104 additions and 152 deletions
Download patch file Download diff file Expand all files Collapse all files

126
include/SDL3/SDL_render.h
View file

@ -240,14 +240,14 @@ extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window *window, co
*
* These are the supported properties:
*
* - `SDL_PROPERTY_RENDERER_CREATE_WINDOW_POINTER` ("window"): the window
* - `SDL_PROPERTY_RENDERER_CREATE_WINDOW_POINTER`: the window
* where rendering is displayed
* - `SDL_PROPERTY_RENDERER_CREATE_SURFACE_POINTER` ("surface"): the surface
* - `SDL_PROPERTY_RENDERER_CREATE_SURFACE_POINTER`: the surface
* where rendering is displayed, if you want a software renderer without a
* window
* - `SDL_PROPERTY_RENDERER_CREATE_NAME_STRING` ("name"): the name of the
* - `SDL_PROPERTY_RENDERER_CREATE_NAME_STRING`: the name of the
* rendering driver to use, if a specific one is desired
* - `SDL_PROPERTY_RENDERER_CREATE_PRESENT_VSYNC_BOOLEAN` ("present_vsync"):
* - `SDL_PROPERTY_RENDERER_CREATE_PRESENT_VSYNC_BOOLEAN`:
* true if you want present synchronized with the refresh rate
*
* \param props the properties to use
@ -333,17 +333,14 @@ extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_Renderer *renderer, SDL_Rend
*
* The following read-only properties are provided by SDL:
*
* - `SDL_PROPERTY_RENDERER_D3D9_DEVICE_POINTER` ("SDL.renderer.d3d9.device"):
* the IDirect3DDevice9 associated with the renderer
* - `SDL_PROPERTY_RENDERER_D3D11_DEVICE_POINTER`
* ("SDL.renderer.d3d11.device"): the ID3D11Device associated with the
* renderer
* - `SDL_PROPERTY_RENDERER_D3D12_DEVICE_POINTER`
* ("SDL.renderer.d3d12.device"): the ID3D12Device associated with the
* renderer
* - `SDL_PROPERTY_RENDERER_D3D12_COMMAND_QUEUE_POINTER`
* ("SDL.renderer.d3d12.command_queue"): the ID3D12CommandQueue associated
* with the renderer /*
* - `SDL_PROPERTY_RENDERER_D3D9_DEVICE_POINTER`: the IDirect3DDevice9
* associated with the renderer
* - `SDL_PROPERTY_RENDERER_D3D11_DEVICE_POINTER`: the ID3D11Device
* associated with the renderer
* - `SDL_PROPERTY_RENDERER_D3D12_DEVICE_POINTER`: the ID3D12Device
* associated with the renderer
* - `SDL_PROPERTY_RENDERER_D3D12_COMMAND_QUEUE_POINTER`: the
* ID3D12CommandQueue associated with the renderer
*
* \param renderer the rendering context
* \returns a valid property ID on success or 0 on failure; call
@ -457,72 +454,61 @@ extern DECLSPEC SDL_Texture *SDLCALL SDL_CreateTextureFromSurface(SDL_Renderer *
*
* These are the supported properties:
*
* - `SDL_PROPERTY_TEXTURE_CREATE_FORMAT_NUMBER` ("format"): one of the
* - `SDL_PROPERTY_TEXTURE_CREATE_FORMAT_NUMBER`: one of the
* enumerated values in SDL_PixelFormatEnum, defaults to the best RGBA
* format for the renderer
* - `SDL_PROPERTY_TEXTURE_CREATE_ACCESS_NUMBER` ("access"): one of the
* - `SDL_PROPERTY_TEXTURE_CREATE_ACCESS_NUMBER`: one of the
* enumerated values in SDL_TextureAccess, defaults to
* SDL_TEXTUREACCESS_STATIC
* - `SDL_PROPERTY_TEXTURE_CREATE_WIDTH_NUMBER` ("width"): the width of the
* texture in pixels, required
* - `SDL_PROPERTY_TEXTURE_CREATE_HEIGHT_NUMBER` ("height"): the height of the
* - `SDL_PROPERTY_TEXTURE_CREATE_WIDTH_NUMBER`: the width of the
* texture in pixels, required
* - `SDL_PROPERTY_TEXTURE_CREATE_HEIGHT_NUMBER`: the height of the texture
* in pixels, required
*
* With the direct3d11 renderer:
*
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_POINTER` ("d3d11.texture"):
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_POINTER`:
* the ID3D11Texture2D associated with the texture, if you want to wrap an
* existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_U_POINTER`
* ("d3d11.texture_u"): the ID3D11Texture2D associated with the U plane of a
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_U_POINTER`: the ID3D11Texture2D associated with the U plane of a
* YUV texture, if you want to wrap an existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_V_POINTER`
* ("d3d11.texture_v"): the ID3D11Texture2D associated with the V plane of a
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_V_POINTER`: the ID3D11Texture2D associated with the V plane of a
* YUV texture, if you want to wrap an existing texture.
*
* With the direct3d12 renderer:
*
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_POINTER` ("d3d12.texture"):
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_POINTER`:
* the ID3D12Resource associated with the texture, if you want to wrap an
* existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_U_POINTER`
* ("d3d12.texture_u"): the ID3D12Resource associated with the U plane of a
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_U_POINTER`: the
* ID3D12Resource associated with the U plane of a
* YUV texture, if you want to wrap an existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_V_POINTER`
* ("d3d12.texture_v"): the ID3D12Resource associated with the V plane of a
* - `SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_V_POINTER`: the ID3D12Resource associated with the V plane of a
* YUV texture, if you want to wrap an existing texture.
*
* With the opengl renderer:
*
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_NUMBER` ("opengl.texture"):
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_NUMBER`:
* the GLuint texture associated with the texture, if you want to wrap an
* existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_UV_NUMBER`
* ("opengl.texture_uv"): the GLuint texture associated with the UV plane of
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_UV_NUMBER`: the GLuint texture associated with the UV plane of
* an NV12 texture, if you want to wrap an existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_U_NUMBER`
* ("opengl.texture_u"): the GLuint texture associated with the U plane of a
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_U_NUMBER`: the GLuint texture associated with the U plane of a
* YUV texture, if you want to wrap an existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_V_NUMBER`
* ("opengl.texture_v"): the GLuint texture associated with the V plane of a
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_V_NUMBER`: the GLuint texture associated with the V plane of a
* YUV texture, if you want to wrap an existing texture.
*
* With the opengles2 renderer:
*
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER`
* ("opengles2.texture"): the GLuint texture associated with the texture, if
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER`: the GLuint texture associated with the texture, if
* you want to wrap an existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER`
* ("opengles2.texture"): the GLuint texture associated with the texture, if
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER`: the GLuint texture associated with the texture, if
* you want to wrap an existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_UV_NUMBER`
* ("opengles2.texture_uv"): the GLuint texture associated with the UV plane
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_UV_NUMBER`: the GLuint texture associated with the UV plane
* of an NV12 texture, if you want to wrap an existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_U_NUMBER`
* ("opengles2.texture_u"): the GLuint texture associated with the U plane
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_U_NUMBER`: the GLuint texture associated with the U plane
* of a YUV texture, if you want to wrap an existing texture.
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_V_NUMBER`
* ("opengles2.texture_v"): the GLuint texture associated with the V plane
* - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_V_NUMBER`: the GLuint texture associated with the V plane
* of a YUV texture, if you want to wrap an existing texture.
*
* \param renderer the rendering context
@ -569,60 +555,46 @@ extern DECLSPEC SDL_Texture *SDLCALL SDL_CreateTextureWithProperties(SDL_Rendere
*
* With the direct3d11 renderer:
*
* - `SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_POINTER`
* ("SDL.texture.d3d11.texture"): the ID3D11Texture2D associated with the
* - `SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_POINTER`: the ID3D11Texture2D associated with the
* texture
* - `SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_U_POINTER`
* ("SDL.texture.d3d11.texture_u"): the ID3D11Texture2D associated with the
* - `SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_U_POINTER`: the ID3D11Texture2D associated with the
* U plane of a YUV texture
* - `SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_V_POINTER`
* ("SDL.texture.d3d11.texture_v"): the ID3D11Texture2D associated with the
* - `SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_V_POINTER`: the ID3D11Texture2D associated with the
* V plane of a YUV texture
*
* With the direct3d12 renderer:
*
* - `SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_POINTER`
* ("SDL.texture.d3d12.texture"): the ID3D12Resource associated with the
* - `SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_POINTER`: the ID3D12Resource associated with the
* texture
* - `SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_U_POINTER`
* ("SDL.texture.d3d12.texture_u"): the ID3D12Resource associated with the U
* - `SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_U_POINTER`: the ID3D12Resource associated with the U
* plane of a YUV texture
* - `SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_V_POINTER`
* ("SDL.texture.d3d12.texture_v"): the ID3D12Resource associated with the V
* - `SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_V_POINTER`: the ID3D12Resource associated with the V
* plane of a YUV texture
*
* With the opengl renderer:
*
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_NUMBER`
* ("SDL.texture.opengl.texture"): the GLuint texture associated with the
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_NUMBER`: the GLuint texture associated with the
* texture
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_UV_NUMBER`
* ("SDL.texture.opengl.texture_uv"): the GLuint texture associated with the
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_UV_NUMBER`: the GLuint texture associated with the
* UV plane of an NV12 texture
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_U_NUMBER`
* ("SDL.texture.opengl.texture_u"): the GLuint texture associated with the
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_U_NUMBER`: the GLuint texture associated with the
* U plane of a YUV texture
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_V_NUMBER`
* ("SDL.texture.opengl.texture_v"): the GLuint texture associated with the
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_V_NUMBER`: the GLuint texture associated with the
* V plane of a YUV texture
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEX_W_FLOAT` ("SDL.texture.opengl.tex_w"):
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEX_W_FLOAT`:
* the texture coordinate width of the texture (0.0 - 1.0)
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEX_H_FLOAT` ("SDL.texture.opengl.tex_h"):
* - `SDL_PROPERTY_TEXTURE_OPENGL_TEX_H_FLOAT`:
* the texture coordinate height of the texture (0.0 - 1.0)
*
* With the opengles2 renderer:
*
* - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_NUMBER`
* ("SDL.texture.opengles2.texture"): the GLuint texture associated with the
* - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_NUMBER`: the GLuint texture associated with the
* texture
* - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_UV_NUMBER`
* ("SDL.texture.opengles2.texture_uv"): the GLuint texture associated with
* - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_UV_NUMBER`: the GLuint texture associated with
* the UV plane of an NV12 texture
* - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_U_NUMBER`
* ("SDL.texture.opengles2.texture_u"): the GLuint texture associated with
* - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_U_NUMBER`: the GLuint texture associated with
* the U plane of a YUV texture
* - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_V_NUMBER`
* ("SDL.texture.opengles2.texture_v"): the GLuint texture associated with
* - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_V_NUMBER`: the GLuint texture associated with
* the V plane of a YUV texture
*
* \param texture the texture to query