mirrors
/
SDL
mirror of https://github.com/libsdl-org/SDL
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

This commit is contained in:
SDL Wiki Bot 2023-05-15 18:21:14 +00:00
parent 4de7433a9e
commit e2b7b9b91c
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
include/SDL3/SDL_render.h
View File

@ -235,9 +235,9 @@ extern DECLSPEC int SDLCALL SDL_CreateWindowAndRenderer(int width, int height, U
* need a specific renderer, specify NULL and SDL will attempt to chooes the * need a specific renderer, specify NULL and SDL will attempt to chooes the
* best option for you, based on what is available on the user's system. * best option for you, based on what is available on the user's system.
* *
* By default the rendering size matches the window size in points, * By default the rendering size matches the window size in points, but you
* but you can call SDL_SetRenderLogicalPresentation() to enable * can call SDL_SetRenderLogicalPresentation() to enable high DPI rendering or
* high DPI rendering or change the content size and scaling options. * change the content size and scaling options.
* *
* \param window the window where rendering is displayed * \param window the window where rendering is displayed
* \param name the name of the rendering driver to initialize, or NULL to * \param name the name of the rendering driver to initialize, or NULL to
@ -319,8 +319,8 @@ extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_Renderer *renderer, SDL_Rend
/** /**
* Get the output size in points of a rendering context. * Get the output size in points of a rendering context.
* *
* This returns the true output size in points, ignoring any * This returns the true output size in points, ignoring any render targets or
* render targets or logical size and presentation. * logical size and presentation.
* *
* \param renderer the rendering context * \param renderer the rendering context
* \param w a pointer filled in with the width in points * \param w a pointer filled in with the width in points
@ -841,7 +841,8 @@ extern DECLSPEC SDL_Texture *SDLCALL SDL_GetRenderTarget(SDL_Renderer *renderer)
* then copied to the output during presentation. * then copied to the output during presentation.
* *
* When a renderer is created, the logical size is set to match the window * When a renderer is created, the logical size is set to match the window
* size in points. The actual output size may be higher pixel density, and can be queried with SDL_GetRenderOutputSize(). * size in points. The actual output size may be higher pixel density, and can
* be queried with SDL_GetRenderOutputSize().
* *
* You can disable logical coordinates by setting the mode to * You can disable logical coordinates by setting the mode to
* SDL_LOGICAL_PRESENTATION_DISABLED, and in that case you get the full * SDL_LOGICAL_PRESENTATION_DISABLED, and in that case you get the full
@ -886,7 +887,8 @@ extern DECLSPEC int SDLCALL SDL_SetRenderLogicalPresentation(SDL_Renderer *rende
extern DECLSPEC int SDLCALL SDL_GetRenderLogicalPresentation(SDL_Renderer *renderer, int *w, int *h, SDL_RendererLogicalPresentation *mode, SDL_ScaleMode *scale_mode); extern DECLSPEC int SDLCALL SDL_GetRenderLogicalPresentation(SDL_Renderer *renderer, int *w, int *h, SDL_RendererLogicalPresentation *mode, SDL_ScaleMode *scale_mode);
/** /**
* Get a point in render coordinates when given a point in window coordinates (points). * Get a point in render coordinates when given a point in window coordinates
* (points).
* *
* \param renderer the rendering context * \param renderer the rendering context
* \param window_x the x coordinate in window coordinates * \param window_x the x coordinate in window coordinates
@ -904,7 +906,8 @@ extern DECLSPEC int SDLCALL SDL_GetRenderLogicalPresentation(SDL_Renderer *rende
extern DECLSPEC int SDLCALL SDL_RenderCoordinatesFromWindow(SDL_Renderer *renderer, float window_x, float window_y, float *x, float *y); extern DECLSPEC int SDLCALL SDL_RenderCoordinatesFromWindow(SDL_Renderer *renderer, float window_x, float window_y, float *x, float *y);
/** /**
* Get a point in window coordinates (points) when given a point in render coordinates. * Get a point in window coordinates (points) when given a point in render
* coordinates.
* *
* \param renderer the rendering context * \param renderer the rendering context
* \param x the x coordinate in render coordinates * \param x the x coordinate in render coordinates