shadps4-emu/ext-SDL
1
0
Fork 0
mirror of https://github.com/shadps4-emu/ext-SDL.git synced 2024-11-23 10:09:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
21411c6418
ext-SDL/include/SDL3/SDL_render.h

2246 lines
93 KiB
C
Raw Normal View History

Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/*
Simple DirectMedia Layer
Updated copyright for 2024
2024-01-01 21:15:26 +00:00
Copyright (C) 1997-2024 Sam Lantinga <slouken@libsdl.org>
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
/**
wikiheaders: bridge wiki Category docs to the headers! Did an initial cleanup on the headers and wrote a few pieces of documentation, but this needs more work to fill out the documentation.
2024-05-16 14:44:37 +00:00
* # CategoryRender
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
wikiheaders: bridge wiki Category docs to the headers! Did an initial cleanup on the headers and wrote a few pieces of documentation, but this needs more work to fill out the documentation.
2024-05-16 14:44:37 +00:00
* Header file for SDL 2D rendering functions.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
wikiheaders: bridge wiki Category docs to the headers! Did an initial cleanup on the headers and wrote a few pieces of documentation, but this needs more work to fill out the documentation.
2024-05-16 14:44:37 +00:00
* This API supports the following features:
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
wikiheaders: bridge wiki Category docs to the headers! Did an initial cleanup on the headers and wrote a few pieces of documentation, but this needs more work to fill out the documentation.
2024-05-16 14:44:37 +00:00
* - single pixel points
* - single pixel lines
* - filled rectangles
* - texture images
* - 2D polygons
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
wikiheaders: bridge wiki Category docs to the headers! Did an initial cleanup on the headers and wrote a few pieces of documentation, but this needs more work to fill out the documentation.
2024-05-16 14:44:37 +00:00
* The primitives may be drawn in opaque, blended, or additive modes.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
wikiheaders: bridge wiki Category docs to the headers! Did an initial cleanup on the headers and wrote a few pieces of documentation, but this needs more work to fill out the documentation.
2024-05-16 14:44:37 +00:00
* 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.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
wikiheaders: bridge wiki Category docs to the headers! Did an initial cleanup on the headers and wrote a few pieces of documentation, but this needs more work to fill out the documentation.
2024-05-16 14:44:37 +00:00
* 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 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
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renaming of guard header names to quiet -Wreserved-id-macro Patch contributed by Sylvain
2016-11-21 05:34:54 +00:00
#ifndef SDL_render_h_
#define SDL_render_h_
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
Switch header convention from `#include "SDL.h"` to `#include <SDL3/SDLh>` I ran this script in the include directory: ```sh sed -i '' -e 's,#include "\(SDL.*\)",#include <SDL3/\1>,' *.h ``` I ran this script in the src directory: ```sh for i in ../include/SDL3/SDL*.h do hdr=$(basename $i) if [ x"$(echo $hdr | egrep 'SDL_main|SDL_name|SDL_test|SDL_syswm|SDL_opengl|SDL_egl|SDL_vulkan')" != x ]; then find . -type f -exec sed -i '' -e 's,#include "\('$hdr'\)",#include <SDL3/\1>,' {} \; else find . -type f -exec sed -i '' -e '/#include "'$hdr'"/d' {} \; fi done ``` Fixes https://github.com/libsdl-org/SDL/issues/6575
2022-11-27 04:43:38 +00:00
#include <SDL3/SDL_stdinc.h>
Including SD_error.h into headers with error-returning functions
2024-04-04 16:38:21 +00:00
#include <SDL3/SDL_error.h>
Include SDL_events.h for SDL_ConvertEventToRenderCoordinates()
2023-02-14 01:50:29 +00:00
#include <SDL3/SDL_events.h>
Added properties to various SDL objects The following objects now have properties that can be user modified: * SDL_AudioStream * SDL_Gamepad * SDL_Joystick * SDL_RWops * SDL_Renderer * SDL_Sensor * SDL_Surface * SDL_Texture * SDL_Window
2023-10-11 23:59:51 +00:00
#include <SDL3/SDL_properties.h>
Switch header convention from `#include "SDL.h"` to `#include <SDL3/SDLh>` I ran this script in the include directory: ```sh sed -i '' -e 's,#include "\(SDL.*\)",#include <SDL3/\1>,' *.h ``` I ran this script in the src directory: ```sh for i in ../include/SDL3/SDL*.h do hdr=$(basename $i) if [ x"$(echo $hdr | egrep 'SDL_main|SDL_name|SDL_test|SDL_syswm|SDL_opengl|SDL_egl|SDL_vulkan')" != x ]; then find . -type f -exec sed -i '' -e 's,#include "\('$hdr'\)",#include <SDL3/\1>,' {} \; else find . -type f -exec sed -i '' -e '/#include "'$hdr'"/d' {} \; fi done ``` Fixes https://github.com/libsdl-org/SDL/issues/6575
2022-11-27 04:43:38 +00:00
#include <SDL3/SDL_rect.h>
#include <SDL3/SDL_video.h>
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
include: Renamed begin_code.h and close_code.h to have SDL_ prefixes. Fixes #6864.
2022-12-22 16:38:59 +00:00
#include <SDL3/SDL_begin_code.h>
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
extern "C" {
#endif
Removed SDL_RENDERER_ACCELERATED and SDL_RENDERER_SOFTWARE These flags are unnecessary and have always been a source of confusion.
2024-04-04 19:39:24 +00:00
/**
include: A ton of little documentation tweaks, fixes, and improvements. This is just stuff I noticed while working on the wikiheaders updates. A thorough pass over all the docs would not be terrible, and maybe a simple script to check for consistency (does everything have a `\since` on it? etc) might be nice, too.
2024-04-09 02:36:57 +00:00
* The name of the software renderer.
include: Add `\since` to all documentation that was missing it.
2024-04-11 17:34:29 +00:00
*
* \since This macro is available since SDL 3.0.0.
Removed SDL_RENDERER_ACCELERATED and SDL_RENDERER_SOFTWARE These flags are unnecessary and have always been a source of confusion.
2024-04-04 19:39:24 +00:00
*/
#define SDL_SOFTWARE_RENDERER "software"
Add SDL_RenderGeometry based on SDL_RenderGeometryRaw
2021-04-01 07:55:00 +00:00
/**
Sync SDL3 wiki -> headers
2024-04-09 04:49:23 +00:00
* Vertex structure.
include: Add `\since` to all documentation that was missing it.
2024-04-11 17:34:29 +00:00
*
* \since This struct is available since SDL 3.0.0.
Add SDL_RenderGeometry based on SDL_RenderGeometryRaw
2021-04-01 07:55:00 +00:00
*/
typedef struct SDL_Vertex
{
SDL_FPoint position; /**< Vertex position, in SDL_Renderer coordinates */
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
SDL_FColor color; /**< Vertex color */
Add SDL_RenderGeometry based on SDL_RenderGeometryRaw
2021-04-01 07:55:00 +00:00
SDL_FPoint tex_coord; /**< Normalized texture coordinates, if needed */
} SDL_Vertex;
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* The access pattern allowed for a texture.
include: Add `\since` to all documentation that was missing it.
2024-04-11 17:34:29 +00:00
*
* \since This enum is available since SDL 3.0.0.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
include: A ton of little documentation tweaks, fixes, and improvements. This is just stuff I noticed while working on the wikiheaders updates. A thorough pass over all the docs would not be terrible, and maybe a simple script to check for consistency (does everything have a `\since` on it? etc) might be nice, too.
2024-04-09 02:36:57 +00:00
typedef enum SDL_TextureAccess
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
{
SDL_TEXTUREACCESS_STATIC, /**< Changes rarely, not lockable */
SDL_TEXTUREACCESS_STREAMING, /**< Changes frequently, lockable */
SDL_TEXTUREACCESS_TARGET /**< Texture can be used as a render target */
} SDL_TextureAccess;
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
/**
include: A ton of little documentation tweaks, fixes, and improvements. This is just stuff I noticed while working on the wikiheaders updates. A thorough pass over all the docs would not be terrible, and maybe a simple script to check for consistency (does everything have a `\since` on it? etc) might be nice, too.
2024-04-09 02:36:57 +00:00
* How the logical size is mapped to the output.
include: Add `\since` to all documentation that was missing it.
2024-04-11 17:34:29 +00:00
*
* \since This enum is available since SDL 3.0.0.
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
*/
include: A ton of little documentation tweaks, fixes, and improvements. This is just stuff I noticed while working on the wikiheaders updates. A thorough pass over all the docs would not be terrible, and maybe a simple script to check for consistency (does everything have a `\since` on it? etc) might be nice, too.
2024-04-09 02:36:57 +00:00
typedef enum SDL_RendererLogicalPresentation
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
{
SDL_LOGICAL_PRESENTATION_DISABLED, /**< There is no logical size in effect */
SDL_LOGICAL_PRESENTATION_STRETCH, /**< The rendered content is stretched to the output resolution */
SDL_LOGICAL_PRESENTATION_LETTERBOX, /**< The rendered content is fit to the largest dimension and the other dimension is letterboxed with black bars */
SDL_LOGICAL_PRESENTATION_OVERSCAN, /**< The rendered content is fit to the smallest dimension and the other dimension extends beyond the output bounds */
Fixed pedantic warning: comma at end of enumerator list Fixes https://github.com/libsdl-org/SDL/issues/7878
2023-06-28 04:52:33 +00:00
SDL_LOGICAL_PRESENTATION_INTEGER_SCALE /**< The rendered content is scaled up by integer multiples to fit the output resolution */
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
} SDL_RendererLogicalPresentation;
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* A structure representing rendering state
include: Add `\since` to all documentation that was missing it.
2024-04-11 17:34:29 +00:00
*
* \since This struct is available since SDL 3.0.0.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
typedef struct SDL_Renderer SDL_Renderer;
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* An efficient driver-specific representation of pixel data
include: Add `\since` to all documentation that was missing it.
2024-04-11 17:34:29 +00:00
*
* \since This struct is available since SDL 3.0.0.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
typedef struct SDL_Texture SDL_Texture;
/* Function prototypes */
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Get the number of 2D rendering drivers available for the current display.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* A render driver is a set of code that handles rendering and texture
* management on a particular display. Normally there is only one, but some
* drivers may have several available with different capabilities.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* There may be none if SDL was compiled without render support.
*
* \returns a number >= 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
* \sa SDL_CreateRenderer
render: Remove SDL_GetRenderDriverInfo and change SDL_CreateRenderer. Fixes #6625.
2022-12-14 04:26:49 +00:00
* \sa SDL_GetRenderDriver
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(void);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
render: Remove SDL_GetRenderDriverInfo and change SDL_CreateRenderer. Fixes #6625.
2022-12-14 04:26:49 +00:00
* Use this function to get the name of a built in 2D rendering driver.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
render: Remove SDL_GetRenderDriverInfo and change SDL_CreateRenderer. Fixes #6625.
2022-12-14 04:26:49 +00:00
* The list of rendering drivers is given in the order that they are normally
* initialized by default; the drivers that seem more reasonable to choose
* first (as far as the SDL developers believe) are earlier in the list.
*
* The names of drivers are all simple, low-ASCII identifiers, like "opengl",
* "direct3d12" or "metal". These never have Unicode characters, and are not
* meant to be proper names.
*
* \param index the index of the rendering driver; the value ranges from 0 to
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* SDL_GetNumRenderDrivers() - 1.
render: Remove SDL_GetRenderDriverInfo and change SDL_CreateRenderer. Fixes #6625.
2022-12-14 04:26:49 +00:00
* \returns the name of the rendering driver at the requested index, or NULL
* if an invalid index was specified.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_GetNumRenderDrivers
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Don't automatically free temporary memory, let the application call SDL_FreeTemporaryMemory() when it's ready. Also mark up all functions that return temporary memory with SDL_DECLSPEC_TEMP, to help people implementing language bindings. Fixes https://github.com/libsdl-org/SDL/issues/10378
2024-07-26 13:05:57 +00:00
extern SDL_DECLSPEC_TEMP const char * SDLCALL SDL_GetRenderDriver(int index);
render: Remove SDL_GetRenderDriverInfo and change SDL_CreateRenderer. Fixes #6625.
2022-12-14 04:26:49 +00:00
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Create a window and default renderer.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param title the title of the window, in UTF-8 encoding.
* \param width the width of the window.
* \param height the height of the window.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param window_flags the flags used to create the window (see
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* SDL_CreateWindow()).
* \param window a pointer filled with the window, or NULL on error.
* \param renderer a pointer filled with the renderer, or NULL on error.
Update `\returns` to the generic form
2023-02-12 09:09:42 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_CreateRenderer
* \sa SDL_CreateWindow
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_CreateWindowAndRenderer(const char *title, int width, int height, SDL_WindowFlags window_flags, SDL_Window **window, SDL_Renderer **renderer);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Create a 2D rendering context for a window.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync wiki -> headers.
2023-01-25 17:58:29 +00:00
* If you want a specific renderer, you can specify its name here. A list of
* available renderers can be obtained by calling SDL_GetRenderDriver multiple
* times, with indices from 0 to SDL_GetNumRenderDrivers()-1. If you don't
Added SDL_CreateRendererWithProperties() and SDL_CreateTextureWithProperties()
2023-11-13 20:13:20 +00:00
* need a specific renderer, specify NULL and SDL will attempt to choose the
Sync wiki -> headers.
2023-01-25 17:58:29 +00:00
* best option for you, based on what is available on the user's system.
render: Remove SDL_GetRenderDriverInfo and change SDL_CreateRenderer. Fixes #6625.
2022-12-14 04:26:49 +00:00
*
Updated SDL high DPI support We have gotten feedback that abstracting the coordinate system based on the display scale is unexpected and it is difficult to adapt existing applications to the proposed API. The new approach is to provide the coordinate systems that people expect, but provide additional information that will help applications properly handle high DPI situations. The concepts needed for high DPI support are documented in README-highdpi.md. An example of automatically adapting the content to display scale changes can be found in SDL_test_common.c, where auto_scale_content is checked. Also, the SDL_WINDOW_ALLOW_HIGHDPI window flag has been replaced by the SDL_HINT_VIDEO_ENABLE_HIGH_PIXEL_DENSITY hint. Fixes https://github.com/libsdl-org/SDL/issues/7709
2023-05-16 23:29:52 +00:00
* By default the rendering size matches the window size in pixels, but you
Sync SDL3 wiki -> header
2023-05-17 19:59:14 +00:00
* can call SDL_SetRenderLogicalPresentation() to change the content size and
* scaling options.
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param window the window where rendering is displayed.
render: Remove SDL_GetRenderDriverInfo and change SDL_CreateRenderer. Fixes #6625.
2022-12-14 04:26:49 +00:00
* \param name the name of the rendering driver to initialize, or NULL to
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* initialize the first one supporting the requested flags.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns a valid rendering context or NULL if there was an error; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Added SDL_CreateRendererWithProperties() and SDL_CreateTextureWithProperties()
2023-11-13 20:13:20 +00:00
* \sa SDL_CreateRendererWithProperties
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_CreateSoftwareRenderer
* \sa SDL_DestroyRenderer
* \sa SDL_GetNumRenderDrivers
render: Remove SDL_GetRenderDriverInfo and change SDL_CreateRenderer. Fixes #6625.
2022-12-14 04:26:49 +00:00
* \sa SDL_GetRenderDriver
Replaced SDL_GetRendererInfo() with SDL_GetRendererName() The texture formats are available via the SDL_PROP_RENDERER_TEXTURE_FORMATS_POINTER property Fixes https://github.com/libsdl-org/SDL/issues/9851
2024-06-04 02:26:43 +00:00
* \sa SDL_GetRendererName
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window *window, const char *name);
Added SDL_CreateRendererWithProperties() and SDL_CreateTextureWithProperties()
2023-11-13 20:13:20 +00:00
/**
* Create a 2D rendering context for a window, with the specified properties.
*
* These are the supported properties:
*
Added HDR display properties and related event Also added an HDR calibration stage to testcolorspace
2024-02-06 09:53:03 +00:00
* - `SDL_PROP_RENDERER_CREATE_NAME_STRING`: the name of the rendering driver
* to use, if a specific one is desired
Sync SDL3 wiki -> header
2024-01-27 21:01:19 +00:00
* - `SDL_PROP_RENDERER_CREATE_WINDOW_POINTER`: the window where rendering is
Added HDR display properties and related event Also added an HDR calibration stage to testcolorspace
2024-02-06 09:53:03 +00:00
* displayed, required if this isn't a software renderer using a surface
Sync SDL3 wiki -> header
2024-01-27 21:01:19 +00:00
* - `SDL_PROP_RENDERER_CREATE_SURFACE_POINTER`: the surface where rendering
* is displayed, if you want a software renderer without a window
Sync SDL3 wiki -> header
2024-01-30 17:49:26 +00:00
* - `SDL_PROP_RENDERER_CREATE_OUTPUT_COLORSPACE_NUMBER`: an SDL_ColorSpace
* value describing the colorspace for output to the display, defaults to
Sync SDL3 wiki -> header
2024-02-22 03:26:22 +00:00
* SDL_COLORSPACE_SRGB. The direct3d11, direct3d12, and metal renderers
* support SDL_COLORSPACE_SRGB_LINEAR, which is a linear color space and
* supports HDR output. If you select SDL_COLORSPACE_SRGB_LINEAR, drawing
* still uses the sRGB colorspace, but values can go beyond 1.0 and float
* (linear) format textures can be used for HDR content.
Removed SDL_RendererFlags The flags parameter has been removed from SDL_CreateRenderer() and SDL_RENDERER_PRESENTVSYNC has been replaced with SDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_NUMBER during window creation and SDL_PROP_RENDERER_VSYNC_NUMBER after renderer creation. SDL_SetRenderVSync() now takes additional values besides 0 and 1. The maximum texture size has been removed from SDL_RendererInfo, replaced with SDL_PROP_RENDERER_MAX_TEXTURE_SIZE_NUMBER.
2024-05-13 17:31:55 +00:00
* - `SDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_NUMBER`: non-zero if you want
Sync SDL3 wiki -> header
2024-05-13 22:07:34 +00:00
* present synchronized with the refresh rate. This property can take any
* value that is supported by SDL_SetRenderVSync() for the renderer.
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
*
Allow using an external Vulkan device with the vulkan renderer
2024-02-28 02:51:08 +00:00
* With the vulkan renderer:
*
Sync SDL3 wiki -> header
2024-02-28 15:13:26 +00:00
* - `SDL_PROP_RENDERER_CREATE_VULKAN_INSTANCE_POINTER`: the VkInstance to use
* with the renderer, optional.
* - `SDL_PROP_RENDERER_CREATE_VULKAN_SURFACE_NUMBER`: the VkSurfaceKHR to use
* with the renderer, optional.
* - `SDL_PROP_RENDERER_CREATE_VULKAN_PHYSICAL_DEVICE_POINTER`: the
* VkPhysicalDevice to use with the renderer, optional.
* - `SDL_PROP_RENDERER_CREATE_VULKAN_DEVICE_POINTER`: the VkDevice to use
* with the renderer, optional.
* - `SDL_PROP_RENDERER_CREATE_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER`: the
* queue family index used for rendering.
* - `SDL_PROP_RENDERER_CREATE_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER`: the
* queue family index used for presentation.
Allow using an external Vulkan device with the vulkan renderer
2024-02-28 02:51:08 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param props the properties to use.
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
* \returns a valid rendering context or NULL if there was an error; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
* \sa SDL_CreateProperties
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
* \sa SDL_CreateRenderer
* \sa SDL_CreateSoftwareRenderer
* \sa SDL_DestroyRenderer
Replaced SDL_GetRendererInfo() with SDL_GetRendererName() The texture formats are available via the SDL_PROP_RENDERER_TEXTURE_FORMATS_POINTER property Fixes https://github.com/libsdl-org/SDL/issues/9851
2024-06-04 02:26:43 +00:00
* \sa SDL_GetRendererName
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRendererWithProperties(SDL_PropertiesID props);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
Allow using an external Vulkan device with the vulkan renderer
2024-02-28 02:51:08 +00:00
#define SDL_PROP_RENDERER_CREATE_NAME_STRING "name"
#define SDL_PROP_RENDERER_CREATE_WINDOW_POINTER "window"
#define SDL_PROP_RENDERER_CREATE_SURFACE_POINTER "surface"
#define SDL_PROP_RENDERER_CREATE_OUTPUT_COLORSPACE_NUMBER "output_colorspace"
Removed SDL_RendererFlags The flags parameter has been removed from SDL_CreateRenderer() and SDL_RENDERER_PRESENTVSYNC has been replaced with SDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_NUMBER during window creation and SDL_PROP_RENDERER_VSYNC_NUMBER after renderer creation. SDL_SetRenderVSync() now takes additional values besides 0 and 1. The maximum texture size has been removed from SDL_RendererInfo, replaced with SDL_PROP_RENDERER_MAX_TEXTURE_SIZE_NUMBER.
2024-05-13 17:31:55 +00:00
#define SDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_NUMBER "present_vsync"
Allow using an external Vulkan device with the vulkan renderer
2024-02-28 02:51:08 +00:00
#define SDL_PROP_RENDERER_CREATE_VULKAN_INSTANCE_POINTER "vulkan.instance"
#define SDL_PROP_RENDERER_CREATE_VULKAN_SURFACE_NUMBER "vulkan.surface"
#define SDL_PROP_RENDERER_CREATE_VULKAN_PHYSICAL_DEVICE_POINTER "vulkan.physical_device"
#define SDL_PROP_RENDERER_CREATE_VULKAN_DEVICE_POINTER "vulkan.device"
#define SDL_PROP_RENDERER_CREATE_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER "vulkan.graphics_queue_family_index"
#define SDL_PROP_RENDERER_CREATE_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER "vulkan.present_queue_family_index"
include: Attempt to make new properties documentation wiki bridge friendly.
2024-01-08 17:13:18 +00:00
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Create a 2D software rendering context for a surface.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Two other API which can be used to create SDL_Renderer:
* SDL_CreateRenderer() and SDL_CreateWindowAndRenderer(). These can _also_
* create a software renderer, but they are intended to be used with an
* SDL_Window as the final destination and not an SDL_Surface.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param surface the SDL_Surface structure representing the surface where
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* rendering is done.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns a valid rendering context or NULL if there was an error; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_DestroyRenderer
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Standardize placement of '*' in function declarations Implemented using these sed commands on the headers: sed -E -i'' '/SDLCALL|;/ s,([a-z])\* ,\1 *,g' * sed -E -i'' 's,(\(.*[^\*])\* ([a-z])(.*\)),\1*\2\3,g' * sed -E -i'' 's,\*const,* const,g' * sed -E -i'' 's,\*SDLCALL,* SDLCALL,g' * sed -E -i'' 's,void\(,void (,g' * git checkout *gl*
2024-07-18 15:54:50 +00:00
extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_CreateSoftwareRenderer(SDL_Surface *surface);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Get the renderer associated with a window.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param window the window to query.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns the rendering context on success or NULL on failure; call
* SDL_GetError() for more information.
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Standardize placement of '*' in function declarations Implemented using these sed commands on the headers: sed -E -i'' '/SDLCALL|;/ s,([a-z])\* ,\1 *,g' * sed -E -i'' 's,(\(.*[^\*])\* ([a-z])(.*\)),\1*\2\3,g' * sed -E -i'' 's,\*const,* const,g' * sed -E -i'' 's,\*SDLCALL,* SDLCALL,g' * sed -E -i'' 's,void\(,void (,g' * git checkout *gl*
2024-07-18 15:54:50 +00:00
extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_GetRenderer(SDL_Window *window);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
Add SDL_RenderGetWindow() API to get the window associated with a renderer (#5440) Add SDL_RenderGetWindow() API to get the window associated with a renderer
2022-03-23 16:07:56 +00:00
/**
* Get the window associated with a renderer.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the renderer to query.
Sync wiki -> header
2022-03-23 16:09:05 +00:00
* \returns the window on success or NULL on failure; call SDL_GetError() for
* more information.
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Add SDL_RenderGetWindow() API to get the window associated with a renderer (#5440) Add SDL_RenderGetWindow() API to get the window associated with a renderer
2022-03-23 16:07:56 +00:00
*/
Standardize placement of '*' in function declarations Implemented using these sed commands on the headers: sed -E -i'' '/SDLCALL|;/ s,([a-z])\* ,\1 *,g' * sed -E -i'' 's,(\(.*[^\*])\* ([a-z])(.*\)),\1*\2\3,g' * sed -E -i'' 's,\*const,* const,g' * sed -E -i'' 's,\*SDLCALL,* SDLCALL,g' * sed -E -i'' 's,void\(,void (,g' * git checkout *gl*
2024-07-18 15:54:50 +00:00
extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetRenderWindow(SDL_Renderer *renderer);
Add SDL_RenderGetWindow() API to get the window associated with a renderer (#5440) Add SDL_RenderGetWindow() API to get the window associated with a renderer
2022-03-23 16:07:56 +00:00
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
Replaced SDL_GetRendererInfo() with SDL_GetRendererName() The texture formats are available via the SDL_PROP_RENDERER_TEXTURE_FORMATS_POINTER property Fixes https://github.com/libsdl-org/SDL/issues/9851
2024-06-04 02:26:43 +00:00
* Get the name of a renderer.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
Sync SDL3 wiki -> header
2024-07-19 19:23:24 +00:00
* \returns the name of the selected renderer, or NULL on failure; call
* SDL_GetError() for more information.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_CreateRenderer
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
* \sa SDL_CreateRendererWithProperties
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Don't automatically free temporary memory, let the application call SDL_FreeTemporaryMemory() when it's ready. Also mark up all functions that return temporary memory with SDL_DECLSPEC_TEMP, to help people implementing language bindings. Fixes https://github.com/libsdl-org/SDL/issues/10378
2024-07-26 13:05:57 +00:00
extern SDL_DECLSPEC_TEMP const char * SDLCALL SDL_GetRendererName(SDL_Renderer *renderer);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
Added properties to various SDL objects The following objects now have properties that can be user modified: * SDL_AudioStream * SDL_Gamepad * SDL_Joystick * SDL_RWops * SDL_Renderer * SDL_Sensor * SDL_Surface * SDL_Texture * SDL_Window
2023-10-11 23:59:51 +00:00
/**
* Get the properties associated with a renderer.
*
Added SDL_CreateRendererWithProperties() and SDL_CreateTextureWithProperties()
2023-11-13 20:13:20 +00:00
* The following read-only properties are provided by SDL:
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
*
Added HDR display properties and related event Also added an HDR calibration stage to testcolorspace
2024-02-06 09:53:03 +00:00
* - `SDL_PROP_RENDERER_NAME_STRING`: the name of the rendering driver
Sync SDL3 wiki -> header
2024-02-06 10:49:24 +00:00
* - `SDL_PROP_RENDERER_WINDOW_POINTER`: the window where rendering is
* displayed, if any
* - `SDL_PROP_RENDERER_SURFACE_POINTER`: the surface where rendering is
* displayed, if this is a software renderer without a window
Removed SDL_RendererFlags The flags parameter has been removed from SDL_CreateRenderer() and SDL_RENDERER_PRESENTVSYNC has been replaced with SDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_NUMBER during window creation and SDL_PROP_RENDERER_VSYNC_NUMBER after renderer creation. SDL_SetRenderVSync() now takes additional values besides 0 and 1. The maximum texture size has been removed from SDL_RendererInfo, replaced with SDL_PROP_RENDERER_MAX_TEXTURE_SIZE_NUMBER.
2024-05-13 17:31:55 +00:00
* - `SDL_PROP_RENDERER_VSYNC_NUMBER`: the current vsync setting
Sync SDL3 wiki -> header
2024-05-13 22:07:34 +00:00
* - `SDL_PROP_RENDERER_MAX_TEXTURE_SIZE_NUMBER`: the maximum texture width
* and height
Sync SDL3 wiki -> header
2024-07-10 07:48:48 +00:00
* - `SDL_PROP_RENDERER_TEXTURE_FORMATS_POINTER`: a (const SDL_PixelFormat *)
* array of pixel formats, terminated with SDL_PIXELFORMAT_UNKNOWN,
Sync SDL3 wiki -> header
2024-06-04 04:11:34 +00:00
* representing the available texture formats for this renderer.
Sync SDL3 wiki -> header
2024-02-06 10:49:24 +00:00
* - `SDL_PROP_RENDERER_OUTPUT_COLORSPACE_NUMBER`: an SDL_ColorSpace value
* describing the colorspace for output to the display, defaults to
* SDL_COLORSPACE_SRGB.
Sync SDL3 wiki -> header
2024-02-22 03:26:22 +00:00
* - `SDL_PROP_RENDERER_HDR_ENABLED_BOOLEAN`: true if the output colorspace is
* SDL_COLORSPACE_SRGB_LINEAR and the renderer is showing on a display with
Sync SDL3 wiki -> header
2024-02-25 23:55:23 +00:00
* HDR enabled. This property can change dynamically when
* SDL_EVENT_DISPLAY_HDR_STATE_CHANGED is sent.
Sync SDL3 wiki -> header
2024-02-22 03:26:22 +00:00
* - `SDL_PROP_RENDERER_SDR_WHITE_POINT_FLOAT`: the value of SDR white in the
* SDL_COLORSPACE_SRGB_LINEAR colorspace. When HDR is enabled, this value is
Sync SDL3 wiki -> header
2024-02-25 23:55:23 +00:00
* automatically multiplied into the color scale. This property can change
* dynamically when SDL_EVENT_DISPLAY_HDR_STATE_CHANGED is sent.
Sync SDL3 wiki -> header
2024-02-22 03:26:22 +00:00
* - `SDL_PROP_RENDERER_HDR_HEADROOM_FLOAT`: the additional high dynamic range
* that can be displayed, in terms of the SDR white point. When HDR is not
Sync SDL3 wiki -> header
2024-02-25 23:55:23 +00:00
* enabled, this will be 1.0. This property can change dynamically when
* SDL_EVENT_DISPLAY_HDR_STATE_CHANGED is sent.
Allow using an external Vulkan device with the vulkan renderer
2024-02-28 02:51:08 +00:00
*
* With the direct3d renderer:
*
Sync SDL3 wiki -> header
2024-01-27 21:01:19 +00:00
* - `SDL_PROP_RENDERER_D3D9_DEVICE_POINTER`: the IDirect3DDevice9 associated
* with the renderer
Allow using an external Vulkan device with the vulkan renderer
2024-02-28 02:51:08 +00:00
*
* With the direct3d11 renderer:
*
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_RENDERER_D3D11_DEVICE_POINTER`: the ID3D11Device associated
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* with the renderer
Sync SDL3 wiki -> header
2024-05-13 16:09:32 +00:00
* - `SDL_PROP_RENDERER_D3D11_SWAPCHAIN_POINTER`: the IDXGISwapChain1
* associated with the renderer. This may change when the window is resized.
Allow using an external Vulkan device with the vulkan renderer
2024-02-28 02:51:08 +00:00
*
* With the direct3d12 renderer:
*
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_RENDERER_D3D12_DEVICE_POINTER`: the ID3D12Device associated
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* with the renderer
Sync SDL3 wiki -> header
2024-05-13 16:09:32 +00:00
* - `SDL_PROP_RENDERER_D3D12_SWAPCHAIN_POINTER`: the IDXGISwapChain4
* associated with the renderer.
Sync SDL3 wiki -> header
2024-01-27 21:01:19 +00:00
* - `SDL_PROP_RENDERER_D3D12_COMMAND_QUEUE_POINTER`: the ID3D12CommandQueue
* associated with the renderer
Sync SDL3 wiki -> header
2024-01-08 17:16:19 +00:00
*
Allow using an external Vulkan device with the vulkan renderer
2024-02-28 02:51:08 +00:00
* With the vulkan renderer:
*
Sync SDL3 wiki -> header
2024-02-28 15:13:26 +00:00
* - `SDL_PROP_RENDERER_VULKAN_INSTANCE_POINTER`: the VkInstance associated
* with the renderer
* - `SDL_PROP_RENDERER_VULKAN_SURFACE_NUMBER`: the VkSurfaceKHR associated
* with the renderer
* - `SDL_PROP_RENDERER_VULKAN_PHYSICAL_DEVICE_POINTER`: the VkPhysicalDevice
* associated with the renderer
* - `SDL_PROP_RENDERER_VULKAN_DEVICE_POINTER`: the VkDevice associated with
* the renderer
* - `SDL_PROP_RENDERER_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER`: the queue
* family index used for rendering
* - `SDL_PROP_RENDERER_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER`: the queue
* family index used for presentation
Sync SDL3 wiki -> header
2024-03-04 17:30:25 +00:00
* - `SDL_PROP_RENDERER_VULKAN_SWAPCHAIN_IMAGE_COUNT_NUMBER`: the number of
* swapchain images, or potential frames in flight, used by the Vulkan
* renderer
Allow using an external Vulkan device with the vulkan renderer
2024-02-28 02:51:08 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
* \returns a valid property ID on success or 0 on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetRendererProperties(SDL_Renderer *renderer);
Added properties to various SDL objects The following objects now have properties that can be user modified: * SDL_AudioStream * SDL_Gamepad * SDL_Joystick * SDL_RWops * SDL_Renderer * SDL_Sensor * SDL_Surface * SDL_Texture * SDL_Window
2023-10-11 23:59:51 +00:00
Allow using an external Vulkan device with the vulkan renderer
2024-02-28 02:51:08 +00:00
#define SDL_PROP_RENDERER_NAME_STRING "SDL.renderer.name"
#define SDL_PROP_RENDERER_WINDOW_POINTER "SDL.renderer.window"
#define SDL_PROP_RENDERER_SURFACE_POINTER "SDL.renderer.surface"
Removed SDL_RendererFlags The flags parameter has been removed from SDL_CreateRenderer() and SDL_RENDERER_PRESENTVSYNC has been replaced with SDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_NUMBER during window creation and SDL_PROP_RENDERER_VSYNC_NUMBER after renderer creation. SDL_SetRenderVSync() now takes additional values besides 0 and 1. The maximum texture size has been removed from SDL_RendererInfo, replaced with SDL_PROP_RENDERER_MAX_TEXTURE_SIZE_NUMBER.
2024-05-13 17:31:55 +00:00
#define SDL_PROP_RENDERER_VSYNC_NUMBER "SDL.renderer.vsync"
#define SDL_PROP_RENDERER_MAX_TEXTURE_SIZE_NUMBER "SDL.renderer.max_texture_size"
Replaced SDL_GetRendererInfo() with SDL_GetRendererName() The texture formats are available via the SDL_PROP_RENDERER_TEXTURE_FORMATS_POINTER property Fixes https://github.com/libsdl-org/SDL/issues/9851
2024-06-04 02:26:43 +00:00
#define SDL_PROP_RENDERER_TEXTURE_FORMATS_POINTER "SDL.renderer.texture_formats"
Allow using an external Vulkan device with the vulkan renderer
2024-02-28 02:51:08 +00:00
#define SDL_PROP_RENDERER_OUTPUT_COLORSPACE_NUMBER "SDL.renderer.output_colorspace"
#define SDL_PROP_RENDERER_HDR_ENABLED_BOOLEAN "SDL.renderer.HDR_enabled"
#define SDL_PROP_RENDERER_SDR_WHITE_POINT_FLOAT "SDL.renderer.SDR_white_point"
#define SDL_PROP_RENDERER_HDR_HEADROOM_FLOAT "SDL.renderer.HDR_headroom"
#define SDL_PROP_RENDERER_D3D9_DEVICE_POINTER "SDL.renderer.d3d9.device"
#define SDL_PROP_RENDERER_D3D11_DEVICE_POINTER "SDL.renderer.d3d11.device"
Added properties for the swap chain in the direct3d11 and direct3d12 renderers Fixes https://github.com/libsdl-org/SDL/issues/9775
2024-05-13 16:02:33 +00:00
#define SDL_PROP_RENDERER_D3D11_SWAPCHAIN_POINTER "SDL.renderer.d3d11.swap_chain"
Allow using an external Vulkan device with the vulkan renderer
2024-02-28 02:51:08 +00:00
#define SDL_PROP_RENDERER_D3D12_DEVICE_POINTER "SDL.renderer.d3d12.device"
Added properties for the swap chain in the direct3d11 and direct3d12 renderers Fixes https://github.com/libsdl-org/SDL/issues/9775
2024-05-13 16:02:33 +00:00
#define SDL_PROP_RENDERER_D3D12_SWAPCHAIN_POINTER "SDL.renderer.d3d12.swap_chain"
Allow using an external Vulkan device with the vulkan renderer
2024-02-28 02:51:08 +00:00
#define SDL_PROP_RENDERER_D3D12_COMMAND_QUEUE_POINTER "SDL.renderer.d3d12.command_queue"
#define SDL_PROP_RENDERER_VULKAN_INSTANCE_POINTER "SDL.renderer.vulkan.instance"
#define SDL_PROP_RENDERER_VULKAN_SURFACE_NUMBER "SDL.renderer.vulkan.surface"
#define SDL_PROP_RENDERER_VULKAN_PHYSICAL_DEVICE_POINTER "SDL.renderer.vulkan.physical_device"
#define SDL_PROP_RENDERER_VULKAN_DEVICE_POINTER "SDL.renderer.vulkan.device"
#define SDL_PROP_RENDERER_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER "SDL.renderer.vulkan.graphics_queue_family_index"
#define SDL_PROP_RENDERER_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER "SDL.renderer.vulkan.present_queue_family_index"
Added SDL_AddVulkanRenderSemaphores() for external synchronization with SDL rendering
2024-03-02 18:03:37 +00:00
#define SDL_PROP_RENDERER_VULKAN_SWAPCHAIN_IMAGE_COUNT_NUMBER "SDL.renderer.vulkan.swapchain_image_count"
include: Attempt to make new properties documentation wiki bridge friendly.
2024-01-08 17:13:18 +00:00
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Get the output size in pixels of a rendering context.
*
Sync wiki -> headers.
2023-02-24 16:49:41 +00:00
* This returns the true output size in pixels, ignoring any render targets or
* logical size and presentation.
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
* \param w a pointer filled in with the width in pixels.
* \param h a pointer filled in with the height in pixels.
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
* \sa SDL_GetCurrentRenderOutputSize
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
*/
Backed out the viewport and cliprect changes in 9fb5a9ccac0a6bb6af02e72644c1c56dc6ab6f3e This ended up being lots of application code churn without any real benefit in practice.
2024-06-13 02:08:06 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetRenderOutputSize(SDL_Renderer *renderer, int *w, int *h);
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
/**
* Get the current output size in pixels of a rendering context.
*
Sync wiki -> headers.
2023-02-24 16:49:41 +00:00
* If a rendering target is active, this will return the size of the rendering
* target in pixels, otherwise if a logical size is set, it will return the
* logical size, otherwise it will return the value of
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* SDL_GetRenderOutputSize().
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
* \param w a pointer filled in with the current width.
* \param h a pointer filled in with the current height.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* \sa SDL_GetRenderOutputSize
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Backed out the viewport and cliprect changes in 9fb5a9ccac0a6bb6af02e72644c1c56dc6ab6f3e This ended up being lots of application code churn without any real benefit in practice.
2024-06-13 02:08:06 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetCurrentRenderOutputSize(SDL_Renderer *renderer, int *w, int *h);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Create a texture for a rendering context.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
Simplified SDL_Surface SDL_Surface has been simplified and internal details are no longer in the public structure. The `format` member of SDL_Surface is now an enumerated pixel format value. You can get the full details of the pixel format by calling `SDL_GetPixelFormatDetails(surface->format)`. You can get the palette associated with the surface by calling SDL_GetSurfacePalette(). You can get the clip rectangle by calling SDL_GetSurfaceClipRect(). SDL_PixelFormat has been renamed SDL_PixelFormatDetails and just describes the pixel format, it does not include a palette for indexed pixel types. SDL_PixelFormatEnum has been renamed SDL_PixelFormat and is used instead of Uint32 for API functions that refer to pixel format by enumerated value. SDL_MapRGB(), SDL_MapRGBA(), SDL_GetRGB(), and SDL_GetRGBA() take an optional palette parameter for indexed color lookups.
2024-07-08 21:59:18 +00:00
* \param format one of the enumerated values in SDL_PixelFormat.
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param access one of the enumerated values in SDL_TextureAccess.
* \param w the width of the texture in pixels.
* \param h the height of the texture in pixels.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns a pointer to the created texture or NULL if no rendering context
* was active, the format was unsupported, or the width or height
* were out of range; call SDL_GetError() for more information.
Note that texture contents are undefined when the texture is created.
2017-08-12 20:05:26 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_CreateTextureFromSurface
Added SDL_CreateRendererWithProperties() and SDL_CreateTextureWithProperties()
2023-11-13 20:13:20 +00:00
* \sa SDL_CreateTextureWithProperties
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_DestroyTexture
Use floating point values for viewport, clip rectangle, and texture sizes These are integer values internally, but the API has been changed to make it easier to mix other render code with querying those values. Fixes https://github.com/libsdl-org/SDL/issues/7519
2024-06-12 16:21:02 +00:00
* \sa SDL_GetTextureSize
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_UpdateTexture
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
SDL_CreateTexture() uses the SDL_TextureAccess type for the access parameter
2024-07-22 00:26:46 +00:00
extern SDL_DECLSPEC SDL_Texture * SDLCALL SDL_CreateTexture(SDL_Renderer *renderer, SDL_PixelFormat format, SDL_TextureAccess access, int w, int h);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Create a texture from an existing surface.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* The surface is not modified or freed by this function.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* The SDL_TextureAccess hint for the created texture is
* `SDL_TEXTUREACCESS_STATIC`.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* The pixel format of the created texture may be different from the pixel
Sync SDL3 wiki -> header
2024-06-13 02:25:45 +00:00
* format of the surface, and can be queried using the
* SDL_PROP_TEXTURE_FORMAT_NUMBER property.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param surface the SDL_Surface structure containing pixel data used to fill
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* the texture.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns the created texture or NULL on failure; call SDL_GetError() for
* more information.
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_CreateTexture
Added SDL_CreateRendererWithProperties() and SDL_CreateTextureWithProperties()
2023-11-13 20:13:20 +00:00
* \sa SDL_CreateTextureWithProperties
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_DestroyTexture
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Standardize placement of '*' in function declarations Implemented using these sed commands on the headers: sed -E -i'' '/SDLCALL|;/ s,([a-z])\* ,\1 *,g' * sed -E -i'' 's,(\(.*[^\*])\* ([a-z])(.*\)),\1*\2\3,g' * sed -E -i'' 's,\*const,* const,g' * sed -E -i'' 's,\*SDLCALL,* SDLCALL,g' * sed -E -i'' 's,void\(,void (,g' * git checkout *gl*
2024-07-18 15:54:50 +00:00
extern SDL_DECLSPEC SDL_Texture * SDLCALL SDL_CreateTextureFromSurface(SDL_Renderer *renderer, SDL_Surface *surface);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
Added SDL_CreateRendererWithProperties() and SDL_CreateTextureWithProperties()
2023-11-13 20:13:20 +00:00
/**
* Create a texture for a rendering context with the specified properties.
*
* These are the supported properties:
*
Sync SDL3 wiki -> header
2024-01-30 17:49:26 +00:00
* - `SDL_PROP_TEXTURE_CREATE_COLORSPACE_NUMBER`: an SDL_ColorSpace value
Sync SDL3 wiki -> header
2024-02-22 03:26:22 +00:00
* describing the texture colorspace, defaults to SDL_COLORSPACE_SRGB_LINEAR
* for floating point textures, SDL_COLORSPACE_HDR10 for 10-bit textures,
Sync SDL3 wiki -> header
2024-02-04 21:10:23 +00:00
* SDL_COLORSPACE_SRGB for other RGB textures and SDL_COLORSPACE_JPEG for
* YUV textures.
Sync SDL3 wiki -> header
2024-01-27 21:01:19 +00:00
* - `SDL_PROP_TEXTURE_CREATE_FORMAT_NUMBER`: one of the enumerated values in
Simplified SDL_Surface SDL_Surface has been simplified and internal details are no longer in the public structure. The `format` member of SDL_Surface is now an enumerated pixel format value. You can get the full details of the pixel format by calling `SDL_GetPixelFormatDetails(surface->format)`. You can get the palette associated with the surface by calling SDL_GetSurfacePalette(). You can get the clip rectangle by calling SDL_GetSurfaceClipRect(). SDL_PixelFormat has been renamed SDL_PixelFormatDetails and just describes the pixel format, it does not include a palette for indexed pixel types. SDL_PixelFormatEnum has been renamed SDL_PixelFormat and is used instead of Uint32 for API functions that refer to pixel format by enumerated value. SDL_MapRGB(), SDL_MapRGBA(), SDL_GetRGB(), and SDL_GetRGBA() take an optional palette parameter for indexed color lookups.
2024-07-08 21:59:18 +00:00
* SDL_PixelFormat, defaults to the best RGBA format for the renderer
Sync SDL3 wiki -> header
2024-01-27 21:01:19 +00:00
* - `SDL_PROP_TEXTURE_CREATE_ACCESS_NUMBER`: one of the enumerated values in
* SDL_TextureAccess, defaults to SDL_TEXTUREACCESS_STATIC
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_TEXTURE_CREATE_WIDTH_NUMBER`: the width of the texture in
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* pixels, required
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_TEXTURE_CREATE_HEIGHT_NUMBER`: the height of the texture in
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* pixels, required
Sync SDL3 wiki -> header
2024-02-22 03:26:22 +00:00
* - `SDL_PROP_TEXTURE_CREATE_SDR_WHITE_POINT_FLOAT`: for HDR10 and floating
* point textures, this defines the value of 100% diffuse white, with higher
* values being displayed in the High Dynamic Range headroom. This defaults
* to 100 for HDR10 textures and 1.0 for floating point textures.
* - `SDL_PROP_TEXTURE_CREATE_HDR_HEADROOM_FLOAT`: for HDR10 and floating
* point textures, this defines the maximum dynamic range used by the
* content, in terms of the SDR white point. This would be equivalent to
* maxCLL / SDL_PROP_TEXTURE_CREATE_SDR_WHITE_POINT_FLOAT for HDR10 content.
* If this is defined, any values outside the range supported by the display
* will be scaled into the available HDR headroom, otherwise they are
* clipped.
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
*
* With the direct3d11 renderer:
*
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_POINTER`: the ID3D11Texture2D
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* associated with the texture, if you want to wrap an existing texture.
Sync SDL3 wiki -> header
2024-01-27 21:01:19 +00:00
* - `SDL_PROP_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_PROP_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.
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
*
* With the direct3d12 renderer:
*
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_POINTER`: the ID3D12Resource
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* associated with the texture, if you want to wrap an existing texture.
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_U_POINTER`: the ID3D12Resource
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* associated with the U plane of a YUV texture, if you want to wrap an
* existing texture.
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_V_POINTER`: the ID3D12Resource
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* associated with the V plane of a YUV texture, if you want to wrap an
Sync SDL3 wiki -> header
2024-01-08 17:16:19 +00:00
* existing texture.
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
*
Added support for creating an SDL texture from a CVPixelBufferRef
2024-02-06 21:54:05 +00:00
* With the metal renderer:
*
Sync SDL3 wiki -> header
2024-02-06 23:41:23 +00:00
* - `SDL_PROP_TEXTURE_CREATE_METAL_PIXELBUFFER_POINTER`: the CVPixelBufferRef
* associated with the texture, if you want to create a texture from an
* existing pixel buffer.
Added support for creating an SDL texture from a CVPixelBufferRef
2024-02-06 21:54:05 +00:00
*
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
* With the opengl renderer:
*
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_NUMBER`: the GLuint texture
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* associated with the texture, if you want to wrap an existing texture.
Sync SDL3 wiki -> header
2024-01-27 21:01:19 +00:00
* - `SDL_PROP_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.
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_U_NUMBER`: the GLuint texture
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* associated with the U plane of a YUV texture, if you want to wrap an
* existing texture.
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_V_NUMBER`: the GLuint texture
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* associated with the V plane of a YUV texture, if you want to wrap an
Sync SDL3 wiki -> header
2024-01-08 17:16:19 +00:00
* existing texture.
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
*
* With the opengles2 renderer:
*
Sync SDL3 wiki -> header
2024-01-27 21:01:19 +00:00
* - `SDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER`: the GLuint texture
* associated with the texture, if you want to wrap an existing texture.
* - `SDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER`: the GLuint texture
* associated with the texture, if you want to wrap an existing texture.
* - `SDL_PROP_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_PROP_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_PROP_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.
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
*
Vulkan: added support for wrapping existing textures
2024-02-29 05:18:17 +00:00
* With the vulkan renderer:
*
Sync SDL3 wiki -> header
2024-03-01 01:39:28 +00:00
* - `SDL_PROP_TEXTURE_CREATE_VULKAN_TEXTURE_NUMBER`: the VkImage with layout
* VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL associated with the texture, if
* you want to wrap an existing texture.
Vulkan: added support for wrapping existing textures
2024-02-29 05:18:17 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
* \param props the properties to use.
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
* \returns a pointer to the created texture or NULL if no rendering context
* was active, the format was unsupported, or the width or height
* were out of range; call SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
* \sa SDL_CreateProperties
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
* \sa SDL_CreateTexture
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
* \sa SDL_CreateTextureFromSurface
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
* \sa SDL_DestroyTexture
Use floating point values for viewport, clip rectangle, and texture sizes These are integer values internally, but the API has been changed to make it easier to mix other render code with querying those values. Fixes https://github.com/libsdl-org/SDL/issues/7519
2024-06-12 16:21:02 +00:00
* \sa SDL_GetTextureSize
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
* \sa SDL_UpdateTexture
*/
Standardize placement of '*' in function declarations Implemented using these sed commands on the headers: sed -E -i'' '/SDLCALL|;/ s,([a-z])\* ,\1 *,g' * sed -E -i'' 's,(\(.*[^\*])\* ([a-z])(.*\)),\1*\2\3,g' * sed -E -i'' 's,\*const,* const,g' * sed -E -i'' 's,\*SDLCALL,* SDLCALL,g' * sed -E -i'' 's,void\(,void (,g' * git checkout *gl*
2024-07-18 15:54:50 +00:00
extern SDL_DECLSPEC SDL_Texture * SDLCALL SDL_CreateTextureWithProperties(SDL_Renderer *renderer, SDL_PropertiesID props);
Added SDL_CreateRendererWithProperties() and SDL_CreateTextureWithProperties()
2023-11-13 20:13:20 +00:00
Added the concept of colorspace to the SDL renderer This allows color operations to happen in linear space between sRGB input and sRGB output. This is currently supported on the direct3d11, direct3d12 and opengl renderers. This is a good resource on blending in linear space vs sRGB space: https://blog.johnnovak.net/2016/09/21/what-every-coder-should-know-about-gamma/ Also added testcolorspace to verify colorspace changes
2024-01-30 02:32:27 +00:00
#define SDL_PROP_TEXTURE_CREATE_COLORSPACE_NUMBER "colorspace"
Shortened SDL property names
2024-01-27 21:00:37 +00:00
#define SDL_PROP_TEXTURE_CREATE_FORMAT_NUMBER "format"
#define SDL_PROP_TEXTURE_CREATE_ACCESS_NUMBER "access"
#define SDL_PROP_TEXTURE_CREATE_WIDTH_NUMBER "width"
#define SDL_PROP_TEXTURE_CREATE_HEIGHT_NUMBER "height"
A second take on HDR support with an SDR white point and HDR headroom This better reflects how HDR content is actually used, e.g. most content is in the SDR range, with specular highlights and bright details beyond the SDR range, in the HDR headroom. This more closely matches how HDR is handled on Apple platforms, as EDR. This also greatly simplifies application code which no longer has to think about color scaling. SDR content is rendered at the appropriate brightness automatically, and HDR content is scaled to the correct range for the display HDR headroom.
2024-02-19 16:45:02 +00:00
#define SDL_PROP_TEXTURE_CREATE_SDR_WHITE_POINT_FLOAT "SDR_white_point"
#define SDL_PROP_TEXTURE_CREATE_HDR_HEADROOM_FLOAT "HDR_headroom"
Shortened SDL property names
2024-01-27 21:00:37 +00:00
#define SDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_POINTER "d3d11.texture"
#define SDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_U_POINTER "d3d11.texture_u"
#define SDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_V_POINTER "d3d11.texture_v"
#define SDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_POINTER "d3d12.texture"
#define SDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_U_POINTER "d3d12.texture_u"
#define SDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_V_POINTER "d3d12.texture_v"
Added support for creating an SDL texture from a CVPixelBufferRef
2024-02-06 21:54:05 +00:00
#define SDL_PROP_TEXTURE_CREATE_METAL_PIXELBUFFER_POINTER "metal.pixelbuffer"
Shortened SDL property names
2024-01-27 21:00:37 +00:00
#define SDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_NUMBER "opengl.texture"
#define SDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_UV_NUMBER "opengl.texture_uv"
#define SDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_U_NUMBER "opengl.texture_u"
#define SDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_V_NUMBER "opengl.texture_v"
#define SDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER "opengles2.texture"
#define SDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_UV_NUMBER "opengles2.texture_uv"
#define SDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_U_NUMBER "opengles2.texture_u"
#define SDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_V_NUMBER "opengles2.texture_v"
Vulkan: added support for wrapping existing textures
2024-02-29 05:18:17 +00:00
#define SDL_PROP_TEXTURE_CREATE_VULKAN_TEXTURE_NUMBER "vulkan.texture"
include: Attempt to make new properties documentation wiki bridge friendly.
2024-01-08 17:13:18 +00:00
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
/**
* Get the properties associated with a texture.
*
* The following read-only properties are provided by SDL:
*
Sync SDL3 wiki -> header
2024-06-13 02:25:45 +00:00
* - `SDL_PROP_TEXTURE_COLORSPACE_NUMBER`: an SDL_ColorSpace value describing
* the texture colorspace.
Use floating point values for viewport, clip rectangle, and texture sizes These are integer values internally, but the API has been changed to make it easier to mix other render code with querying those values. Fixes https://github.com/libsdl-org/SDL/issues/7519
2024-06-12 16:21:02 +00:00
* - `SDL_PROP_TEXTURE_FORMAT_NUMBER`: one of the enumerated values in
Simplified SDL_Surface SDL_Surface has been simplified and internal details are no longer in the public structure. The `format` member of SDL_Surface is now an enumerated pixel format value. You can get the full details of the pixel format by calling `SDL_GetPixelFormatDetails(surface->format)`. You can get the palette associated with the surface by calling SDL_GetSurfacePalette(). You can get the clip rectangle by calling SDL_GetSurfaceClipRect(). SDL_PixelFormat has been renamed SDL_PixelFormatDetails and just describes the pixel format, it does not include a palette for indexed pixel types. SDL_PixelFormatEnum has been renamed SDL_PixelFormat and is used instead of Uint32 for API functions that refer to pixel format by enumerated value. SDL_MapRGB(), SDL_MapRGBA(), SDL_GetRGB(), and SDL_GetRGBA() take an optional palette parameter for indexed color lookups.
2024-07-08 21:59:18 +00:00
* SDL_PixelFormat.
Use floating point values for viewport, clip rectangle, and texture sizes These are integer values internally, but the API has been changed to make it easier to mix other render code with querying those values. Fixes https://github.com/libsdl-org/SDL/issues/7519
2024-06-12 16:21:02 +00:00
* - `SDL_PROP_TEXTURE_ACCESS_NUMBER`: one of the enumerated values in
* SDL_TextureAccess.
* - `SDL_PROP_TEXTURE_WIDTH_NUMBER`: the width of the texture in pixels.
* - `SDL_PROP_TEXTURE_HEIGHT_NUMBER`: the height of the texture in pixels.
Sync SDL3 wiki -> header
2024-02-22 03:26:22 +00:00
* - `SDL_PROP_TEXTURE_SDR_WHITE_POINT_FLOAT`: for HDR10 and floating point
* textures, this defines the value of 100% diffuse white, with higher
* values being displayed in the High Dynamic Range headroom. This defaults
* to 100 for HDR10 textures and 1.0 for other textures.
* - `SDL_PROP_TEXTURE_HDR_HEADROOM_FLOAT`: for HDR10 and floating point
* textures, this defines the maximum dynamic range used by the content, in
* terms of the SDR white point. If this is defined, any values outside the
* range supported by the display will be scaled into the available HDR
* headroom, otherwise they are clipped. This defaults to 1.0 for SDR
* textures, 4.0 for HDR10 textures, and no default for floating point
* textures.
Added the concept of colorspace to the SDL renderer This allows color operations to happen in linear space between sRGB input and sRGB output. This is currently supported on the direct3d11, direct3d12 and opengl renderers. This is a good resource on blending in linear space vs sRGB space: https://blog.johnnovak.net/2016/09/21/what-every-coder-should-know-about-gamma/ Also added testcolorspace to verify colorspace changes
2024-01-30 02:32:27 +00:00
*
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
* With the direct3d11 renderer:
*
Sync SDL3 wiki -> header
2024-01-27 21:01:19 +00:00
* - `SDL_PROP_TEXTURE_D3D11_TEXTURE_POINTER`: the ID3D11Texture2D associated
* with the texture
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_TEXTURE_D3D11_TEXTURE_U_POINTER`: the ID3D11Texture2D
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* associated with the U plane of a YUV texture
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_TEXTURE_D3D11_TEXTURE_V_POINTER`: the ID3D11Texture2D
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* associated with the V plane of a YUV texture
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
*
* With the direct3d12 renderer:
*
Sync SDL3 wiki -> header
2024-01-27 21:01:19 +00:00
* - `SDL_PROP_TEXTURE_D3D12_TEXTURE_POINTER`: the ID3D12Resource associated
* with the texture
* - `SDL_PROP_TEXTURE_D3D12_TEXTURE_U_POINTER`: the ID3D12Resource associated
* with the U plane of a YUV texture
* - `SDL_PROP_TEXTURE_D3D12_TEXTURE_V_POINTER`: the ID3D12Resource associated
* with the V plane of a YUV texture
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
*
Vulkan Renderer (#9114) This pull request adds an implementation of a Vulkan Render backend to SDL. I have so far tested this primarily on Windows, but also smoke tested on Linux and macOS (MoltenVK). I have not tried it yet on Android, but it should be usable there as well (sans any bugs I missed). This began as a port of the SDL Direct3D12 Renderer, which is the closest thing to Vulkan as existed in the SDL codebase. The shaders are more or less identical (with the only differences being in descriptor bindings vs root descriptors). The shaders are built using the HLSL frontend of glslang. Everything in the code is pure Vulkan 1.0 (no extensions), with the exception of HDR support which requires the Vulkan instance extension `VK_EXT_swapchain_colorspace`. The code could have been simplified considerably if I used dynamic rendering, push descriptors, extended dynamic state, and other modern Vulkan-isms, but I felt it was more important to make the code as vanilla Vulkan as possible so that it would run on any Vulkan implementation. The main differences with the Direct3D12 renderer are: * Having to manage renderpasses for performing clears. There is likely some optimization that would still remain for more efficient use of TBDR hardware where there might be some unnecessary load/stores, but it does attempt to do clears using renderpasses. * Constant buffer data couldn't be directly updated in the command buffer since I didn't want to rely on push descriptors, so there is a persistently mapped buffer with increasing offset per swapchain image where CB data gets written. * Many more resources are dependent on the swapchain resizing due to i.e. Vulkan requiring the VkFramebuffer to reference the VkImageView of the swapchain, so there is a bit more code around handling that than was necessary in D3D12. * For NV12/NV21 textures, rather than there being plane data in the texture itself, the UV data is placed in a separate `VkImage`/`VkImageView`. I've verified that `testcolorspace` works with both sRGB and HDR linear. I've tested `testoverlay` works with the various YUV/NV12/NV21 formats. I've tested `testsprite`. I've checked that window resizing and swapchain out-of-date handling when minimizing are working. I've run through `testautomation` with the render tests. I also have run several of the tests with Vulkan validation and synchronization validation. Surely I will have missed some things, but I think it's in a good state to be merged and build out from here.
2024-02-22 22:58:11 +00:00
* With the vulkan renderer:
*
Sync SDL3 wiki -> header
2024-02-22 22:59:24 +00:00
* - `SDL_PROP_TEXTURE_VULKAN_TEXTURE_POINTER`: the VkImage associated with
* the texture
* - `SDL_PROP_TEXTURE_VULKAN_TEXTURE_U_POINTER`: the VkImage associated with
* the U plane of a YUV texture
* - `SDL_PROP_TEXTURE_VULKAN_TEXTURE_V_POINTER`: the VkImage associated with
* the V plane of a YUV texture
* - `SDL_PROP_TEXTURE_VULKAN_TEXTURE_UV_POINTER`: the VkImage associated with
* the UV plane of a NV12/NV21 texture
Vulkan Renderer (#9114) This pull request adds an implementation of a Vulkan Render backend to SDL. I have so far tested this primarily on Windows, but also smoke tested on Linux and macOS (MoltenVK). I have not tried it yet on Android, but it should be usable there as well (sans any bugs I missed). This began as a port of the SDL Direct3D12 Renderer, which is the closest thing to Vulkan as existed in the SDL codebase. The shaders are more or less identical (with the only differences being in descriptor bindings vs root descriptors). The shaders are built using the HLSL frontend of glslang. Everything in the code is pure Vulkan 1.0 (no extensions), with the exception of HDR support which requires the Vulkan instance extension `VK_EXT_swapchain_colorspace`. The code could have been simplified considerably if I used dynamic rendering, push descriptors, extended dynamic state, and other modern Vulkan-isms, but I felt it was more important to make the code as vanilla Vulkan as possible so that it would run on any Vulkan implementation. The main differences with the Direct3D12 renderer are: * Having to manage renderpasses for performing clears. There is likely some optimization that would still remain for more efficient use of TBDR hardware where there might be some unnecessary load/stores, but it does attempt to do clears using renderpasses. * Constant buffer data couldn't be directly updated in the command buffer since I didn't want to rely on push descriptors, so there is a persistently mapped buffer with increasing offset per swapchain image where CB data gets written. * Many more resources are dependent on the swapchain resizing due to i.e. Vulkan requiring the VkFramebuffer to reference the VkImageView of the swapchain, so there is a bit more code around handling that than was necessary in D3D12. * For NV12/NV21 textures, rather than there being plane data in the texture itself, the UV data is placed in a separate `VkImage`/`VkImageView`. I've verified that `testcolorspace` works with both sRGB and HDR linear. I've tested `testoverlay` works with the various YUV/NV12/NV21 formats. I've tested `testsprite`. I've checked that window resizing and swapchain out-of-date handling when minimizing are working. I've run through `testautomation` with the render tests. I also have run several of the tests with Vulkan validation and synchronization validation. Surely I will have missed some things, but I think it's in a good state to be merged and build out from here.
2024-02-22 22:58:11 +00:00
*
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
* With the opengl renderer:
*
Sync SDL3 wiki -> header
2024-01-27 21:01:19 +00:00
* - `SDL_PROP_TEXTURE_OPENGL_TEXTURE_NUMBER`: the GLuint texture associated
* with the texture
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_TEXTURE_OPENGL_TEXTURE_UV_NUMBER`: the GLuint texture
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* associated with the UV plane of an NV12 texture
Sync SDL3 wiki -> header
2024-01-27 21:01:19 +00:00
* - `SDL_PROP_TEXTURE_OPENGL_TEXTURE_U_NUMBER`: the GLuint texture associated
* with the U plane of a YUV texture
* - `SDL_PROP_TEXTURE_OPENGL_TEXTURE_V_NUMBER`: the GLuint texture associated
* with the V plane of a YUV texture
Rename property define names to have a type suffix Renamed the following property define names to have a type suffix to match other property names. SDL_PROP_TEXTURE_OPENGL_TEXTURE_TARGET (number) SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_TARGET (number) SDL_PROP_WINDOW_CREATE_WAYLAND_SCALE_TO_DISPLAY (boolean) SDL_PROP_WINDOW_RENDERER (pointer) SDL_PROP_WINDOW_TEXTUREDATA (pointer)
2024-02-12 05:12:20 +00:00
* - `SDL_PROP_TEXTURE_OPENGL_TEXTURE_TARGET_NUMBER`: the GLenum for the
* texture target (`GL_TEXTURE_2D`, `GL_TEXTURE_RECTANGLE_ARB`, etc)
Sync SDL3 wiki -> header
2024-01-27 21:01:19 +00:00
* - `SDL_PROP_TEXTURE_OPENGL_TEX_W_FLOAT`: the texture coordinate width of
* the texture (0.0 - 1.0)
* - `SDL_PROP_TEXTURE_OPENGL_TEX_H_FLOAT`: the texture coordinate height of
* the texture (0.0 - 1.0)
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
*
* With the opengles2 renderer:
*
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_NUMBER`: the GLuint texture
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* associated with the texture
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_UV_NUMBER`: the GLuint texture
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* associated with the UV plane of an NV12 texture
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_U_NUMBER`: the GLuint texture
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* associated with the U plane of a YUV texture
Shortened SDL property names
2024-01-27 21:00:37 +00:00
* - `SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_V_NUMBER`: the GLuint texture
Sync SDL3 wiki -> header
2024-01-08 17:34:23 +00:00
* associated with the V plane of a YUV texture
Rename property define names to have a type suffix Renamed the following property define names to have a type suffix to match other property names. SDL_PROP_TEXTURE_OPENGL_TEXTURE_TARGET (number) SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_TARGET (number) SDL_PROP_WINDOW_CREATE_WAYLAND_SCALE_TO_DISPLAY (boolean) SDL_PROP_WINDOW_RENDERER (pointer) SDL_PROP_WINDOW_TEXTUREDATA (pointer)
2024-02-12 05:12:20 +00:00
* - `SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_TARGET_NUMBER`: the GLenum for the
* texture target (`GL_TEXTURE_2D`, `GL_TEXTURE_EXTERNAL_OES`, etc)
Sync SDL3 wiki -> header
2024-01-08 01:02:25 +00:00
*
Vulkan: added support for wrapping existing textures
2024-02-29 05:18:17 +00:00
* With the vulkan renderer:
*
Sync SDL3 wiki -> header
2024-03-01 01:39:28 +00:00
* - `SDL_PROP_TEXTURE_VULKAN_TEXTURE_NUMBER`: the VkImage associated with the
* texture
Vulkan: added support for wrapping existing textures
2024-02-29 05:18:17 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to query.
Sync wiki -> headers
2023-10-12 19:20:53 +00:00
* \returns a valid property ID on success or 0 on failure; call
* SDL_GetError() for more information.
Added properties to various SDL objects The following objects now have properties that can be user modified: * SDL_AudioStream * SDL_Gamepad * SDL_Joystick * SDL_RWops * SDL_Renderer * SDL_Sensor * SDL_Surface * SDL_Texture * SDL_Window
2023-10-11 23:59:51 +00:00
*
* \since This function is available since SDL 3.0.0.
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetTextureProperties(SDL_Texture *texture);
Added properties to various SDL objects The following objects now have properties that can be user modified: * SDL_AudioStream * SDL_Gamepad * SDL_Joystick * SDL_RWops * SDL_Renderer * SDL_Sensor * SDL_Surface * SDL_Texture * SDL_Window
2023-10-11 23:59:51 +00:00
Added the concept of colorspace to the SDL renderer This allows color operations to happen in linear space between sRGB input and sRGB output. This is currently supported on the direct3d11, direct3d12 and opengl renderers. This is a good resource on blending in linear space vs sRGB space: https://blog.johnnovak.net/2016/09/21/what-every-coder-should-know-about-gamma/ Also added testcolorspace to verify colorspace changes
2024-01-30 02:32:27 +00:00
#define SDL_PROP_TEXTURE_COLORSPACE_NUMBER "SDL.texture.colorspace"
Use floating point values for viewport, clip rectangle, and texture sizes These are integer values internally, but the API has been changed to make it easier to mix other render code with querying those values. Fixes https://github.com/libsdl-org/SDL/issues/7519
2024-06-12 16:21:02 +00:00
#define SDL_PROP_TEXTURE_FORMAT_NUMBER "SDL.texture.format"
#define SDL_PROP_TEXTURE_ACCESS_NUMBER "SDL.texture.access"
#define SDL_PROP_TEXTURE_WIDTH_NUMBER "SDL.texture.width"
#define SDL_PROP_TEXTURE_HEIGHT_NUMBER "SDL.texture.height"
A second take on HDR support with an SDR white point and HDR headroom This better reflects how HDR content is actually used, e.g. most content is in the SDR range, with specular highlights and bright details beyond the SDR range, in the HDR headroom. This more closely matches how HDR is handled on Apple platforms, as EDR. This also greatly simplifies application code which no longer has to think about color scaling. SDR content is rendered at the appropriate brightness automatically, and HDR content is scaled to the correct range for the display HDR headroom.
2024-02-19 16:45:02 +00:00
#define SDL_PROP_TEXTURE_SDR_WHITE_POINT_FLOAT "SDL.texture.SDR_white_point"
#define SDL_PROP_TEXTURE_HDR_HEADROOM_FLOAT "SDL.texture.HDR_headroom"
Shortened SDL property names
2024-01-27 21:00:37 +00:00
#define SDL_PROP_TEXTURE_D3D11_TEXTURE_POINTER "SDL.texture.d3d11.texture"
#define SDL_PROP_TEXTURE_D3D11_TEXTURE_U_POINTER "SDL.texture.d3d11.texture_u"
#define SDL_PROP_TEXTURE_D3D11_TEXTURE_V_POINTER "SDL.texture.d3d11.texture_v"
#define SDL_PROP_TEXTURE_D3D12_TEXTURE_POINTER "SDL.texture.d3d12.texture"
#define SDL_PROP_TEXTURE_D3D12_TEXTURE_U_POINTER "SDL.texture.d3d12.texture_u"
#define SDL_PROP_TEXTURE_D3D12_TEXTURE_V_POINTER "SDL.texture.d3d12.texture_v"
#define SDL_PROP_TEXTURE_OPENGL_TEXTURE_NUMBER "SDL.texture.opengl.texture"
#define SDL_PROP_TEXTURE_OPENGL_TEXTURE_UV_NUMBER "SDL.texture.opengl.texture_uv"
#define SDL_PROP_TEXTURE_OPENGL_TEXTURE_U_NUMBER "SDL.texture.opengl.texture_u"
#define SDL_PROP_TEXTURE_OPENGL_TEXTURE_V_NUMBER "SDL.texture.opengl.texture_v"
Rename property define names to have a type suffix Renamed the following property define names to have a type suffix to match other property names. SDL_PROP_TEXTURE_OPENGL_TEXTURE_TARGET (number) SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_TARGET (number) SDL_PROP_WINDOW_CREATE_WAYLAND_SCALE_TO_DISPLAY (boolean) SDL_PROP_WINDOW_RENDERER (pointer) SDL_PROP_WINDOW_TEXTUREDATA (pointer)
2024-02-12 05:12:20 +00:00
#define SDL_PROP_TEXTURE_OPENGL_TEXTURE_TARGET_NUMBER "SDL.texture.opengl.target"
Shortened SDL property names
2024-01-27 21:00:37 +00:00
#define SDL_PROP_TEXTURE_OPENGL_TEX_W_FLOAT "SDL.texture.opengl.tex_w"
#define SDL_PROP_TEXTURE_OPENGL_TEX_H_FLOAT "SDL.texture.opengl.tex_h"
#define SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_NUMBER "SDL.texture.opengles2.texture"
#define SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_UV_NUMBER "SDL.texture.opengles2.texture_uv"
#define SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_U_NUMBER "SDL.texture.opengles2.texture_u"
#define SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_V_NUMBER "SDL.texture.opengles2.texture_v"
Rename property define names to have a type suffix Renamed the following property define names to have a type suffix to match other property names. SDL_PROP_TEXTURE_OPENGL_TEXTURE_TARGET (number) SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_TARGET (number) SDL_PROP_WINDOW_CREATE_WAYLAND_SCALE_TO_DISPLAY (boolean) SDL_PROP_WINDOW_RENDERER (pointer) SDL_PROP_WINDOW_TEXTUREDATA (pointer)
2024-02-12 05:12:20 +00:00
#define SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_TARGET_NUMBER "SDL.texture.opengles2.target"
Vulkan: added support for wrapping existing textures
2024-02-29 05:18:17 +00:00
#define SDL_PROP_TEXTURE_VULKAN_TEXTURE_NUMBER "SDL.texture.vulkan.texture"
include: Attempt to make new properties documentation wiki bridge friendly.
2024-01-08 17:13:18 +00:00
render: Added SDL_GetTextureRenderer().
2024-01-08 15:17:38 +00:00
/**
* Get the renderer that created an SDL_Texture.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to query.
Sync SDL3 wiki -> header
2024-01-08 15:18:26 +00:00
* \returns a pointer to the SDL_Renderer that created the texture, or NULL on
* failure; call SDL_GetError() for more information.
render: Added SDL_GetTextureRenderer().
2024-01-08 15:17:38 +00:00
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
*/
Standardize placement of '*' in function declarations Implemented using these sed commands on the headers: sed -E -i'' '/SDLCALL|;/ s,([a-z])\* ,\1 *,g' * sed -E -i'' 's,(\(.*[^\*])\* ([a-z])(.*\)),\1*\2\3,g' * sed -E -i'' 's,\*const,* const,g' * sed -E -i'' 's,\*SDLCALL,* SDLCALL,g' * sed -E -i'' 's,void\(,void (,g' * git checkout *gl*
2024-07-18 15:54:50 +00:00
extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_GetRendererFromTexture(SDL_Texture *texture);
render: Added SDL_GetTextureRenderer().
2024-01-08 15:17:38 +00:00
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
Use floating point values for viewport, clip rectangle, and texture sizes These are integer values internally, but the API has been changed to make it easier to mix other render code with querying those values. Fixes https://github.com/libsdl-org/SDL/issues/7519
2024-06-12 16:21:02 +00:00
* Get the size of a texture, as floating point values.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to query.
Sync wiki -> header
2022-02-01 16:58:05 +00:00
* \param w a pointer filled in with the width of the texture in pixels. This
* argument can be NULL if you don't need this information.
* \param h a pointer filled in with the height of the texture in pixels. This
* argument can be NULL if you don't need this information.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Use floating point values for viewport, clip rectangle, and texture sizes These are integer values internally, but the API has been changed to make it easier to mix other render code with querying those values. Fixes https://github.com/libsdl-org/SDL/issues/7519
2024-06-12 16:21:02 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetTextureSize(SDL_Texture *texture, float *w, float *h);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Set an additional color value multiplied into render copy operations.
*
* When this texture is rendered, during the copy operation each source color
* channel is modulated by the appropriate color value according to the
* following formula:
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* `srcC = srcC * (color / 255)`
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Color modulation is not always supported by the renderer; it will return -1
* if color modulation is not supported.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to update.
* \param r the red color value multiplied into copy operations.
* \param g the green color value multiplied into copy operations.
* \param b the blue color value multiplied into copy operations.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_GetTextureColorMod
* \sa SDL_SetTextureAlphaMod
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
* \sa SDL_SetTextureColorModFloat
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_Texture *texture, Uint8 r, Uint8 g, Uint8 b);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
/**
* Set an additional color value multiplied into render copy operations.
*
* When this texture is rendered, during the copy operation each source color
* channel is modulated by the appropriate color value according to the
* following formula:
*
* `srcC = srcC * color`
*
* Color modulation is not always supported by the renderer; it will return -1
* if color modulation is not supported.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to update.
* \param r the red color value multiplied into copy operations.
* \param g the green color value multiplied into copy operations.
* \param b the blue color value multiplied into copy operations.
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetTextureColorModFloat
* \sa SDL_SetTextureAlphaModFloat
* \sa SDL_SetTextureColorMod
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_SetTextureColorModFloat(SDL_Texture *texture, float r, float g, float b);
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Get the additional color value multiplied into render copy operations.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to query.
* \param r a pointer filled in with the current red color value.
* \param g a pointer filled in with the current green color value.
* \param b a pointer filled in with the current blue color value.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_GetTextureAlphaMod
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
* \sa SDL_GetTextureColorModFloat
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_SetTextureColorMod
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_Texture *texture, Uint8 *r, Uint8 *g, Uint8 *b);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
/**
* Get the additional color value multiplied into render copy operations.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to query.
* \param r a pointer filled in with the current red color value.
* \param g a pointer filled in with the current green color value.
* \param b a pointer filled in with the current blue color value.
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetTextureAlphaModFloat
* \sa SDL_GetTextureColorMod
* \sa SDL_SetTextureColorModFloat
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetTextureColorModFloat(SDL_Texture *texture, float *r, float *g, float *b);
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Set an additional alpha value multiplied into render copy operations.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* When this texture is rendered, during the copy operation the source alpha
* value is modulated by this alpha value according to the following formula:
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* `srcA = srcA * (alpha / 255)`
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Alpha modulation is not always supported by the renderer; it will return -1
* if alpha modulation is not supported.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to update.
* \param alpha the source alpha value multiplied into copy operations.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_GetTextureAlphaMod
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
* \sa SDL_SetTextureAlphaModFloat
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_SetTextureColorMod
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_Texture *texture, Uint8 alpha);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
/**
* Set an additional alpha value multiplied into render copy operations.
*
* When this texture is rendered, during the copy operation the source alpha
* value is modulated by this alpha value according to the following formula:
*
* `srcA = srcA * alpha`
*
* Alpha modulation is not always supported by the renderer; it will return -1
* if alpha modulation is not supported.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to update.
* \param alpha the source alpha value multiplied into copy operations.
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetTextureAlphaModFloat
* \sa SDL_SetTextureAlphaMod
* \sa SDL_SetTextureColorModFloat
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_SetTextureAlphaModFloat(SDL_Texture *texture, float alpha);
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* Get the additional alpha value multiplied into render copy operations.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to query.
* \param alpha a pointer filled in with the current alpha value.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
* \sa SDL_GetTextureAlphaModFloat
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_GetTextureColorMod
* \sa SDL_SetTextureAlphaMod
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetTextureAlphaMod(SDL_Texture *texture, Uint8 *alpha);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
/**
* Get the additional alpha value multiplied into render copy operations.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to query.
* \param alpha a pointer filled in with the current alpha value.
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetTextureAlphaMod
* \sa SDL_GetTextureColorModFloat
* \sa SDL_SetTextureAlphaModFloat
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetTextureAlphaModFloat(SDL_Texture *texture, float *alpha);
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
SDL API renaming: SDL_render.h Fixes https://github.com/libsdl-org/SDL/issues/6883
2022-12-27 14:21:13 +00:00
* Set the blend mode for a texture, used by SDL_RenderTexture().
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* If the blend mode is not supported, the closest supported mode is chosen
* and this function returns -1.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to update.
* \param blendMode the SDL_BlendMode to use for texture blending.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_GetTextureBlendMode
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_Texture *texture, SDL_BlendMode blendMode);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Get the blend mode used for texture copy operations.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to query.
Reverted 3d2e5a0b66eca4ade34f2a4fa81c8f4d8d33dac3 Applying these changes to external code doesn't actually improve anything, and within the context of the other Get* functions for renderers and surfaces, these stand out as outliers, so I'm going to back this change out.
2024-07-17 16:40:25 +00:00
* \param blendMode a pointer filled in with the current SDL_BlendMode.
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_SetTextureBlendMode
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Reverted 3d2e5a0b66eca4ade34f2a4fa81c8f4d8d33dac3 Applying these changes to external code doesn't actually improve anything, and within the context of the other Get* functions for renderers and surfaces, these stand out as outliers, so I'm going to back this change out.
2024-07-17 16:40:25 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_Texture *texture, SDL_BlendMode *blendMode);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
Fixed bug 4914 - Expose SDL_ScaleMode and add SDL_SetTextureScaleMode/SDL_GetTextureScaleMode Konrad This was something rather trivial to add, but asked at least several times before (I did google about it as well). It should be possible to dynamically change scaling mode of the texture. It is actually trivial task, but until now it was only possible with a hint before creating a texture. I needed it for my game as well, so I took the liberty of writing it myself. This patch adds following functions: SDL_SetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode scaleMode); SDL_GetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode *scaleMode); That way you can change texture scaling on the fly.
2019-12-22 21:39:44 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Set the scale mode used for texture scale operations.
Fixed bug 4914 - Expose SDL_ScaleMode and add SDL_SetTextureScaleMode/SDL_GetTextureScaleMode Konrad This was something rather trivial to add, but asked at least several times before (I did google about it as well). It should be possible to dynamically change scaling mode of the texture. It is actually trivial task, but until now it was only possible with a hint before creating a texture. I needed it for my game as well, so I took the liberty of writing it myself. This patch adds following functions: SDL_SetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode scaleMode); SDL_GetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode *scaleMode); That way you can change texture scaling on the fly.
2019-12-22 21:39:44 +00:00
*
Removed SDL_HINT_RENDER_SCALE_QUALITY Textures now default to linear filtering, use SDL_SetTextureScaleMode(texture, SDL_SCALEMODE_NEAREST) if you want nearest pixel mode instead.
2024-02-12 03:07:07 +00:00
* The default texture scale mode is SDL_SCALEMODE_LINEAR.
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* If the scale mode is not supported, the closest supported mode is chosen.
Fixed bug 4914 - Expose SDL_ScaleMode and add SDL_SetTextureScaleMode/SDL_GetTextureScaleMode Konrad This was something rather trivial to add, but asked at least several times before (I did google about it as well). It should be possible to dynamically change scaling mode of the texture. It is actually trivial task, but until now it was only possible with a hint before creating a texture. I needed it for my game as well, so I took the liberty of writing it myself. This patch adds following functions: SDL_SetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode scaleMode); SDL_GetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode *scaleMode); That way you can change texture scaling on the fly.
2019-12-22 21:39:44 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to update.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param scaleMode the SDL_ScaleMode to use for texture scaling.
Update `\returns` to the generic form
2023-02-12 09:09:42 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed bug 4914 - Expose SDL_ScaleMode and add SDL_SetTextureScaleMode/SDL_GetTextureScaleMode Konrad This was something rather trivial to add, but asked at least several times before (I did google about it as well). It should be possible to dynamically change scaling mode of the texture. It is actually trivial task, but until now it was only possible with a hint before creating a texture. I needed it for my game as well, so I took the liberty of writing it myself. This patch adds following functions: SDL_SetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode scaleMode); SDL_GetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode *scaleMode); That way you can change texture scaling on the fly.
2019-12-22 21:39:44 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* \sa SDL_GetTextureScaleMode
Fixed bug 4914 - Expose SDL_ScaleMode and add SDL_SetTextureScaleMode/SDL_GetTextureScaleMode Konrad This was something rather trivial to add, but asked at least several times before (I did google about it as well). It should be possible to dynamically change scaling mode of the texture. It is actually trivial task, but until now it was only possible with a hint before creating a texture. I needed it for my game as well, so I took the liberty of writing it myself. This patch adds following functions: SDL_SetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode scaleMode); SDL_GetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode *scaleMode); That way you can change texture scaling on the fly.
2019-12-22 21:39:44 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_SetTextureScaleMode(SDL_Texture *texture, SDL_ScaleMode scaleMode);
Fixed bug 4914 - Expose SDL_ScaleMode and add SDL_SetTextureScaleMode/SDL_GetTextureScaleMode Konrad This was something rather trivial to add, but asked at least several times before (I did google about it as well). It should be possible to dynamically change scaling mode of the texture. It is actually trivial task, but until now it was only possible with a hint before creating a texture. I needed it for my game as well, so I took the liberty of writing it myself. This patch adds following functions: SDL_SetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode scaleMode); SDL_GetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode *scaleMode); That way you can change texture scaling on the fly.
2019-12-22 21:39:44 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Get the scale mode used for texture scale operations.
Fixed bug 4914 - Expose SDL_ScaleMode and add SDL_SetTextureScaleMode/SDL_GetTextureScaleMode Konrad This was something rather trivial to add, but asked at least several times before (I did google about it as well). It should be possible to dynamically change scaling mode of the texture. It is actually trivial task, but until now it was only possible with a hint before creating a texture. I needed it for my game as well, so I took the liberty of writing it myself. This patch adds following functions: SDL_SetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode scaleMode); SDL_GetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode *scaleMode); That way you can change texture scaling on the fly.
2019-12-22 21:39:44 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param texture the texture to query.
Reverted 3d2e5a0b66eca4ade34f2a4fa81c8f4d8d33dac3 Applying these changes to external code doesn't actually improve anything, and within the context of the other Get* functions for renderers and surfaces, these stand out as outliers, so I'm going to back this change out.
2024-07-17 16:40:25 +00:00
* \param scaleMode a pointer filled in with the current scale mode.
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed bug 4914 - Expose SDL_ScaleMode and add SDL_SetTextureScaleMode/SDL_GetTextureScaleMode Konrad This was something rather trivial to add, but asked at least several times before (I did google about it as well). It should be possible to dynamically change scaling mode of the texture. It is actually trivial task, but until now it was only possible with a hint before creating a texture. I needed it for my game as well, so I took the liberty of writing it myself. This patch adds following functions: SDL_SetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode scaleMode); SDL_GetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode *scaleMode); That way you can change texture scaling on the fly.
2019-12-22 21:39:44 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* \sa SDL_SetTextureScaleMode
Fixed bug 4914 - Expose SDL_ScaleMode and add SDL_SetTextureScaleMode/SDL_GetTextureScaleMode Konrad This was something rather trivial to add, but asked at least several times before (I did google about it as well). It should be possible to dynamically change scaling mode of the texture. It is actually trivial task, but until now it was only possible with a hint before creating a texture. I needed it for my game as well, so I took the liberty of writing it myself. This patch adds following functions: SDL_SetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode scaleMode); SDL_GetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode *scaleMode); That way you can change texture scaling on the fly.
2019-12-22 21:39:44 +00:00
*/
Reverted 3d2e5a0b66eca4ade34f2a4fa81c8f4d8d33dac3 Applying these changes to external code doesn't actually improve anything, and within the context of the other Get* functions for renderers and surfaces, these stand out as outliers, so I'm going to back this change out.
2024-07-17 16:40:25 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetTextureScaleMode(SDL_Texture *texture, SDL_ScaleMode *scaleMode);
Fixed bug 4914 - Expose SDL_ScaleMode and add SDL_SetTextureScaleMode/SDL_GetTextureScaleMode Konrad This was something rather trivial to add, but asked at least several times before (I did google about it as well). It should be possible to dynamically change scaling mode of the texture. It is actually trivial task, but until now it was only possible with a hint before creating a texture. I needed it for my game as well, so I took the liberty of writing it myself. This patch adds following functions: SDL_SetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode scaleMode); SDL_GetTextureScaleMode(SDL_Texture * texture, SDL_ScaleMode *scaleMode); That way you can change texture scaling on the fly.
2019-12-22 21:39:44 +00:00
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Update the given texture rectangle with new pixel data.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL3 wiki -> header
2024-06-13 02:25:45 +00:00
* The pixel data must be in the pixel format of the texture, which can be
* queried using the SDL_PROP_TEXTURE_FORMAT_NUMBER property.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* This is a fairly slow function, intended for use with static textures that
* do not change often.
Fixed bug 3681 - SDL_UpateTexture documentation not specific enough about format requirement Simon Hug The documentation of SDL_UpateTexture does not say that the pixel data has to be in the format of the texture.
2017-08-10 18:57:19 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* If the texture is intended to be updated often, it is preferred to create
* the texture as streaming and use the locking functions referenced below.
* While this function will work with streaming textures, for optimization
* reasons you may not get the pixels back if you lock the texture afterward.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to update.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param rect an SDL_Rect structure representing the area to update, or NULL
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* to update the entire texture.
* \param pixels the raw pixel data in the format of the texture.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param pitch the number of bytes in a row of pixel data, including padding
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* between lines.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_LockTexture
* \sa SDL_UnlockTexture
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
* \sa SDL_UpdateNVTexture
* \sa SDL_UpdateYUVTexture
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_Texture *texture, const SDL_Rect *rect, const void *pixels, int pitch);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* Update a rectangle within a planar YV12 or IYUV texture with new pixel
* data.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
* You can use SDL_UpdateTexture() as long as your pixel data is a contiguous
* block of Y and U/V planes in the proper order, but this function is
* available if your pixel data is not contiguous.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to update.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param rect a pointer to the rectangle of pixels to update, or NULL to
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* update the entire texture.
* \param Yplane the raw pixel data for the Y plane.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param Ypitch the number of bytes between rows of pixel data for the Y
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* plane.
* \param Uplane the raw pixel data for the U plane.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param Upitch the number of bytes between rows of pixel data for the U
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* plane.
* \param Vplane the raw pixel data for the V plane.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param Vpitch the number of bytes between rows of pixel data for the V
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* plane.
Update `\returns` to the generic form
2023-02-12 09:09:42 +00:00
* \returns 0 on success or a negative error code on failure; call
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
* \sa SDL_UpdateNVTexture
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_UpdateTexture
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_UpdateYUVTexture(SDL_Texture *texture,
Removed non-float versions of SDL render API drawing functions This simplifies the API and removes a level of API translation between the int variants of the functions and the float implementation Fixes https://github.com/libsdl-org/SDL/issues/6656
2022-12-31 19:19:32 +00:00
const SDL_Rect *rect,
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
const Uint8 *Yplane, int Ypitch,
const Uint8 *Uplane, int Upitch,
const Uint8 *Vplane, int Vpitch);
Add SDL_UpdateNVTexture() to update NV12/21 Texture (bug #5430) for renderer software, opengl, and opengles2
2021-01-05 10:56:22 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Update a rectangle within a planar NV12 or NV21 texture with new pixels.
Add SDL_UpdateNVTexture() to update NV12/21 Texture (bug #5430) for renderer software, opengl, and opengles2
2021-01-05 10:56:22 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* You can use SDL_UpdateTexture() as long as your pixel data is a contiguous
* block of NV12/21 planes in the proper order, but this function is available
* if your pixel data is not contiguous.
Add SDL_UpdateNVTexture() to update NV12/21 Texture (bug #5430) for renderer software, opengl, and opengles2
2021-01-05 10:56:22 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to update.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param rect a pointer to the rectangle of pixels to update, or NULL to
* update the entire texture.
* \param Yplane the raw pixel data for the Y plane.
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* \param Ypitch the number of bytes between rows of pixel data for the Y
* plane.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param UVplane the raw pixel data for the UV plane.
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* \param UVpitch the number of bytes between rows of pixel data for the UV
* plane.
Update `\returns` to the generic form
2023-02-12 09:09:42 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
*
* \sa SDL_UpdateTexture
* \sa SDL_UpdateYUVTexture
Add SDL_UpdateNVTexture() to update NV12/21 Texture (bug #5430) for renderer software, opengl, and opengles2
2021-01-05 10:56:22 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_UpdateNVTexture(SDL_Texture *texture,
Removed non-float versions of SDL render API drawing functions This simplifies the API and removes a level of API translation between the int variants of the functions and the float implementation Fixes https://github.com/libsdl-org/SDL/issues/6656
2022-12-31 19:19:32 +00:00
const SDL_Rect *rect,
Add SDL_UpdateNVTexture() to update NV12/21 Texture (bug #5430) for renderer software, opengl, and opengles2
2021-01-05 10:56:22 +00:00
const Uint8 *Yplane, int Ypitch,
const Uint8 *UVplane, int UVpitch);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Lock a portion of the texture for **write-only** pixel access.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* As an optimization, the pixels made available for editing don't necessarily
* contain the old texture data. This is a write-only operation, and if you
* need to keep a copy of the texture data you should do that at the
* application level.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* You must use SDL_UnlockTexture() to unlock the pixels and apply any
* changes.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param texture the texture to lock for access, which was created with
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* `SDL_TEXTUREACCESS_STREAMING`.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param rect an SDL_Rect structure representing the area to lock for access;
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* NULL to lock the entire texture.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param pixels this is filled in with a pointer to the locked pixels,
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* appropriately offset by the locked area.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param pitch this is filled in with the pitch of the locked pixels; the
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* pitch is the length of one row in bytes.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code if the texture is not valid
* or was not created with `SDL_TEXTUREACCESS_STREAMING`; call
* SDL_GetError() for more information.
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
* \sa SDL_LockTextureToSurface
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* \sa SDL_UnlockTexture
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_LockTexture(SDL_Texture *texture,
Removed non-float versions of SDL render API drawing functions This simplifies the API and removes a level of API translation between the int variants of the functions and the float implementation Fixes https://github.com/libsdl-org/SDL/issues/6656
2022-12-31 19:19:32 +00:00
const SDL_Rect *rect,
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
void **pixels, int *pitch);
Added a helper function SDL_LockTextureToSurface() Similar to SDL_LockTexture(), except the locked area is exposed as a SDL surface.
2019-09-30 18:58:44 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Lock a portion of the texture for **write-only** pixel access, and expose
* it as a SDL surface.
*
* Besides providing an SDL_Surface instead of raw pixel data, this function
* operates like SDL_LockTexture.
*
* As an optimization, the pixels made available for editing don't necessarily
* contain the old texture data. This is a write-only operation, and if you
* need to keep a copy of the texture data you should do that at the
* application level.
*
* You must use SDL_UnlockTexture() to unlock the pixels and apply any
* changes.
Added a helper function SDL_LockTextureToSurface() Similar to SDL_LockTexture(), except the locked area is exposed as a SDL surface.
2019-09-30 18:58:44 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* The returned surface is freed internally after calling SDL_UnlockTexture()
* or SDL_DestroyTexture(). The caller should not free it.
Added a helper function SDL_LockTextureToSurface() Similar to SDL_LockTexture(), except the locked area is exposed as a SDL surface.
2019-09-30 18:58:44 +00:00
*
Update `\returns` to the generic form
2023-02-12 09:09:42 +00:00
* \param texture the texture to lock for access, which must be created with
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* `SDL_TEXTUREACCESS_STREAMING`.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param rect a pointer to the rectangle to lock for access. If the rect is
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* NULL, the entire texture will be locked.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param surface this is filled in with an SDL surface representing the
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* locked area.
Update `\returns` to the generic form
2023-02-12 09:09:42 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Added a helper function SDL_LockTextureToSurface() Similar to SDL_LockTexture(), except the locked area is exposed as a SDL surface.
2019-09-30 18:58:44 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* \sa SDL_LockTexture
* \sa SDL_UnlockTexture
Added a helper function SDL_LockTextureToSurface() Similar to SDL_LockTexture(), except the locked area is exposed as a SDL surface.
2019-09-30 18:58:44 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_LockTextureToSurface(SDL_Texture *texture,
Added a helper function SDL_LockTextureToSurface() Similar to SDL_LockTexture(), except the locked area is exposed as a SDL surface.
2019-09-30 18:58:44 +00:00
const SDL_Rect *rect,
SDL_Surface **surface);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Unlock a texture, uploading the changes to video memory, if needed.
*
* **Warning**: Please note that SDL_LockTexture() is intended to be
Sync wiki -> header
2021-10-26 15:30:06 +00:00
* write-only; it will not guarantee the previous contents of the texture will
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* be provided. You must fully initialize any area of a texture that you lock
* before unlocking it, as the pixels might otherwise be uninitialized memory.
*
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* Which is to say: locking and immediately unlocking a texture can result in
* corrupted textures, depending on the renderer in use.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture a texture locked by SDL_LockTexture().
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_LockTexture
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_Texture *texture);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Set a texture as the current rendering target.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* The default render target is the window for which the renderer was created.
* To stop rendering to a texture and render to the window again, call this
* function with a NULL `texture`.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param texture the targeted texture, which must be created with the
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* `SDL_TEXTUREACCESS_TARGET` flag, or NULL to render to the
* window instead of a texture.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_GetRenderTarget
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_SetRenderTarget(SDL_Renderer *renderer, SDL_Texture *texture);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Get the current render target.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* The default render target is the window for which the renderer was created,
* and is reported a NULL here.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns the current render target or NULL for the default render target.
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
* \sa SDL_SetRenderTarget
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Standardize placement of '*' in function declarations Implemented using these sed commands on the headers: sed -E -i'' '/SDLCALL|;/ s,([a-z])\* ,\1 *,g' * sed -E -i'' 's,(\(.*[^\*])\* ([a-z])(.*\)),\1*\2\3,g' * sed -E -i'' 's,\*const,* const,g' * sed -E -i'' 's,\*SDLCALL,* SDLCALL,g' * sed -E -i'' 's,void\(,void (,g' * git checkout *gl*
2024-07-18 15:54:50 +00:00
extern SDL_DECLSPEC SDL_Texture * SDLCALL SDL_GetRenderTarget(SDL_Renderer *renderer);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* Set a device independent resolution and presentation mode for rendering.
*
Sync wiki -> headers.
2023-02-24 16:49:41 +00:00
* This function sets the width and height of the logical rendering output. A
* render target is created at the specified size and used for rendering and
* then copied to the output during presentation.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* You can disable logical coordinates by setting the mode to
Sync SDL3 wiki -> header
2023-05-17 19:59:14 +00:00
* SDL_LOGICAL_PRESENTATION_DISABLED, and in that case you get the full pixel
* resolution of the output window.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* You can convert coordinates in an event into rendering coordinates using
* SDL_ConvertEventToRenderCoordinates().
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
* \param w the width of the logical resolution.
* \param h the height of the logical resolution.
* \param mode the presentation mode used.
* \param scale_mode the scale mode used.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* \sa SDL_ConvertEventToRenderCoordinates
* \sa SDL_GetRenderLogicalPresentation
Added SDL_GetRenderLogicalPresentationRect() Fixes https://github.com/libsdl-org/SDL/issues/8815
2024-06-29 21:12:50 +00:00
* \sa SDL_GetRenderLogicalPresentationRect
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Backed out the viewport and cliprect changes in 9fb5a9ccac0a6bb6af02e72644c1c56dc6ab6f3e This ended up being lots of application code churn without any real benefit in practice.
2024-06-13 02:08:06 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_SetRenderLogicalPresentation(SDL_Renderer *renderer, int w, int h, SDL_RendererLogicalPresentation mode, SDL_ScaleMode scale_mode);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* Get device independent resolution and presentation mode for rendering.
Fixed bug #4213 - update documentation to reflect SDL2 behavior of SDL_RenderGetLogicalSize
2022-05-12 07:36:49 +00:00
*
Sync wiki -> headers.
2023-02-24 16:49:41 +00:00
* This function gets the width and height of the logical rendering output, or
* the output size in pixels if a logical resolution is not enabled.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
* \param w an int to be filled with the width.
* \param h an int to be filled with the height.
* \param mode a pointer filled in with the presentation mode.
* \param scale_mode a pointer filled in with the scale mode.
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* \sa SDL_SetRenderLogicalPresentation
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Backed out the viewport and cliprect changes in 9fb5a9ccac0a6bb6af02e72644c1c56dc6ab6f3e This ended up being lots of application code churn without any real benefit in practice.
2024-06-13 02:08:06 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetRenderLogicalPresentation(SDL_Renderer *renderer, int *w, int *h, SDL_RendererLogicalPresentation *mode, SDL_ScaleMode *scale_mode);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
Added SDL_GetRenderLogicalPresentationRect() Fixes https://github.com/libsdl-org/SDL/issues/8815
2024-06-29 21:12:50 +00:00
/**
* Get the final presentation rectangle for rendering.
*
Sync SDL3 wiki -> header
2024-06-29 21:26:31 +00:00
* This function returns the calculated rectangle used for logical
* presentation, based on the presentation mode and output size. If logical
* presentation is disabled, it will fill the rectangle with the output size,
* in pixels.
Added SDL_GetRenderLogicalPresentationRect() Fixes https://github.com/libsdl-org/SDL/issues/8815
2024-06-29 21:12:50 +00:00
*
* \param renderer the rendering context.
Sync SDL3 wiki -> header
2024-06-29 21:26:31 +00:00
* \param rect a pointer filled in with the final presentation rectangle, may
* be NULL.
Added SDL_GetRenderLogicalPresentationRect() Fixes https://github.com/libsdl-org/SDL/issues/8815
2024-06-29 21:12:50 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_SetRenderLogicalPresentation
*/
extern SDL_DECLSPEC int SDLCALL SDL_GetRenderLogicalPresentationRect(SDL_Renderer *renderer, SDL_FRect *rect);
SDL_RenderSetIntegerScale
2016-01-05 21:39:18 +00:00
/**
Updated SDL high DPI support We have gotten feedback that abstracting the coordinate system based on the display scale is unexpected and it is difficult to adapt existing applications to the proposed API. The new approach is to provide the coordinate systems that people expect, but provide additional information that will help applications properly handle high DPI situations. The concepts needed for high DPI support are documented in README-highdpi.md. An example of automatically adapting the content to display scale changes can be found in SDL_test_common.c, where auto_scale_content is checked. Also, the SDL_WINDOW_ALLOW_HIGHDPI window flag has been replaced by the SDL_HINT_VIDEO_ENABLE_HIGH_PIXEL_DENSITY hint. Fixes https://github.com/libsdl-org/SDL/issues/7709
2023-05-16 23:29:52 +00:00
* Get a point in render coordinates when given a point in window coordinates.
SDL_RenderSetIntegerScale
2016-01-05 21:39:18 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
* \param window_x the x coordinate in window coordinates.
* \param window_y the y coordinate in window coordinates.
* \param x a pointer filled with the x coordinate in render coordinates.
* \param y a pointer filled with the y coordinate in render coordinates.
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
SDL_RenderSetIntegerScale
2016-01-05 21:39:18 +00:00
*
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_SetRenderLogicalPresentation
* \sa SDL_SetRenderScale
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_RenderCoordinatesFromWindow(SDL_Renderer *renderer, float window_x, float window_y, float *x, float *y);
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
/**
Updated SDL high DPI support We have gotten feedback that abstracting the coordinate system based on the display scale is unexpected and it is difficult to adapt existing applications to the proposed API. The new approach is to provide the coordinate systems that people expect, but provide additional information that will help applications properly handle high DPI situations. The concepts needed for high DPI support are documented in README-highdpi.md. An example of automatically adapting the content to display scale changes can be found in SDL_test_common.c, where auto_scale_content is checked. Also, the SDL_WINDOW_ALLOW_HIGHDPI window flag has been replaced by the SDL_HINT_VIDEO_ENABLE_HIGH_PIXEL_DENSITY hint. Fixes https://github.com/libsdl-org/SDL/issues/7709
2023-05-16 23:29:52 +00:00
* Get a point in window coordinates when given a point in render coordinates.
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
* \param x the x coordinate in render coordinates.
* \param y the y coordinate in render coordinates.
Sync wiki -> headers.
2023-02-24 16:49:41 +00:00
* \param window_x a pointer filled with the x coordinate in window
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* coordinates.
Sync wiki -> headers.
2023-02-24 16:49:41 +00:00
* \param window_y a pointer filled with the y coordinate in window
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* coordinates.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
SDL_RenderSetIntegerScale
2016-01-05 21:39:18 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* \sa SDL_SetRenderLogicalPresentation
* \sa SDL_SetRenderScale
SDL_RenderSetIntegerScale
2016-01-05 21:39:18 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_RenderCoordinatesToWindow(SDL_Renderer *renderer, float x, float y, float *window_x, float *window_y);
SDL_RenderSetIntegerScale
2016-01-05 21:39:18 +00:00
/**
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* Convert the coordinates in an event to render coordinates.
*
* Touch coordinates are converted from normalized coordinates in the window
* to non-normalized rendering coordinates.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* Once converted, the coordinates may be outside the rendering area.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
* \param event the event to modify.
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
SDL_RenderSetIntegerScale
2016-01-05 21:39:18 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
SDL_RenderSetIntegerScale
2016-01-05 21:39:18 +00:00
*
Renamed old function reference
2024-06-05 05:25:37 +00:00
* \sa SDL_RenderCoordinatesFromWindow
SDL_RenderSetIntegerScale
2016-01-05 21:39:18 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_ConvertEventToRenderCoordinates(SDL_Renderer *renderer, SDL_Event *event);
SDL_RenderSetIntegerScale
2016-01-05 21:39:18 +00:00
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Set the drawing area for rendering on the current target.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
Backed out the viewport and cliprect changes in 9fb5a9ccac0a6bb6af02e72644c1c56dc6ab6f3e This ended up being lots of application code churn without any real benefit in practice.
2024-06-13 02:08:06 +00:00
* \param rect the SDL_Rect structure representing the drawing area, or NULL
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* to set the viewport to the entire target.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
SDL API renaming: SDL_render.h Fixes https://github.com/libsdl-org/SDL/issues/6883
2022-12-27 14:21:13 +00:00
* \sa SDL_GetRenderViewport
Added SDL_RenderViewportSet() to tell whether the viewport was previously set to a specific rectangle. Fixes https://github.com/libsdl-org/SDL/issues/9029
2024-02-10 00:37:04 +00:00
* \sa SDL_RenderViewportSet
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Backed out the viewport and cliprect changes in 9fb5a9ccac0a6bb6af02e72644c1c56dc6ab6f3e This ended up being lots of application code churn without any real benefit in practice.
2024-06-13 02:08:06 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_SetRenderViewport(SDL_Renderer *renderer, const SDL_Rect *rect);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Get the drawing area for the current target.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
* \param rect an SDL_Rect structure filled in with the current drawing area.
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Added SDL_RenderViewportSet() to tell whether the viewport was previously set to a specific rectangle. Fixes https://github.com/libsdl-org/SDL/issues/9029
2024-02-10 00:37:04 +00:00
* \sa SDL_RenderViewportSet
SDL API renaming: SDL_render.h Fixes https://github.com/libsdl-org/SDL/issues/6883
2022-12-27 14:21:13 +00:00
* \sa SDL_SetRenderViewport
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Backed out the viewport and cliprect changes in 9fb5a9ccac0a6bb6af02e72644c1c56dc6ab6f3e This ended up being lots of application code churn without any real benefit in practice.
2024-06-13 02:08:06 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetRenderViewport(SDL_Renderer *renderer, SDL_Rect *rect);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
Added SDL_RenderViewportSet() to tell whether the viewport was previously set to a specific rectangle. Fixes https://github.com/libsdl-org/SDL/issues/9029
2024-02-10 00:37:04 +00:00
/**
* Return whether an explicit rectangle was set as the viewport.
*
Sync SDL3 wiki -> header
2024-02-10 00:38:20 +00:00
* This is useful if you're saving and restoring the viewport and want to know
* whether you should restore a specific rectangle or NULL. Note that the
* viewport is always reset when changing rendering targets.
Added SDL_RenderViewportSet() to tell whether the viewport was previously set to a specific rectangle. Fixes https://github.com/libsdl-org/SDL/issues/9029
2024-02-10 00:37:04 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
Sync SDL3 wiki -> header
2024-02-10 00:38:20 +00:00
* \returns SDL_TRUE if the viewport was set to a specific rectangle, or
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* SDL_FALSE if it was set to NULL (the entire target).
Added SDL_RenderViewportSet() to tell whether the viewport was previously set to a specific rectangle. Fixes https://github.com/libsdl-org/SDL/issues/9029
2024-02-10 00:37:04 +00:00
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetRenderViewport
* \sa SDL_SetRenderViewport
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderViewportSet(SDL_Renderer *renderer);
Added SDL_RenderViewportSet() to tell whether the viewport was previously set to a specific rectangle. Fixes https://github.com/libsdl-org/SDL/issues/9029
2024-02-10 00:37:04 +00:00
Added SDL_GetRenderSafeArea()
2024-07-25 00:14:00 +00:00
/**
* Get the safe area for rendering within the current viewport.
*
* Some devices have portions of the screen which are partially obscured or
* not interactive, possibly due to on-screen controls, curved edges, camera
* notches, TV overscan, etc. This function provides the area of the current
Sync SDL3 wiki -> header
2024-07-25 00:41:44 +00:00
* viewport which is safe to have interactible content. You should continue
* rendering into the rest of the render target, but it should not contain
* visually important or interactible content.
Added SDL_GetRenderSafeArea()
2024-07-25 00:14:00 +00:00
*
* \param renderer the rendering context.
Sync SDL3 wiki -> header
2024-07-25 00:41:44 +00:00
* \param rect a pointer filled in with the area that is safe for interactive
* content.
Added SDL_GetRenderSafeArea()
2024-07-25 00:14:00 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*/
extern SDL_DECLSPEC int SDLCALL SDL_GetRenderSafeArea(SDL_Renderer *renderer, SDL_Rect *rect);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Set the clip rectangle for rendering on the specified target.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
Backed out the viewport and cliprect changes in 9fb5a9ccac0a6bb6af02e72644c1c56dc6ab6f3e This ended up being lots of application code churn without any real benefit in practice.
2024-06-13 02:08:06 +00:00
* \param rect an SDL_Rect structure representing the clip area, relative to
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* the viewport, or NULL to disable clipping.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
SDL API renaming: SDL_render.h Fixes https://github.com/libsdl-org/SDL/issues/6883
2022-12-27 14:21:13 +00:00
* \sa SDL_GetRenderClipRect
SDL API renaming: *Is* functions Feedback from @icculus: "IsTablet" uses "is" as a form of "to be" ...like, the actual question is of its nature. The rest is just a superfluous word in the question and it flows as better English with if (RectEmpty) than if (IsRectEmpty) Fixes https://github.com/libsdl-org/SDL/issues/6932
2022-12-29 03:34:01 +00:00
* \sa SDL_RenderClipEnabled
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Backed out the viewport and cliprect changes in 9fb5a9ccac0a6bb6af02e72644c1c56dc6ab6f3e This ended up being lots of application code churn without any real benefit in practice.
2024-06-13 02:08:06 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_SetRenderClipRect(SDL_Renderer *renderer, const SDL_Rect *rect);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Get the clip rectangle for the current target.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
Backed out the viewport and cliprect changes in 9fb5a9ccac0a6bb6af02e72644c1c56dc6ab6f3e This ended up being lots of application code churn without any real benefit in practice.
2024-06-13 02:08:06 +00:00
* \param rect an SDL_Rect structure filled in with the current clipping area
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* or an empty rectangle if clipping is disabled.
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
SDL API renaming: *Is* functions Feedback from @icculus: "IsTablet" uses "is" as a form of "to be" ...like, the actual question is of its nature. The rest is just a superfluous word in the question and it flows as better English with if (RectEmpty) than if (IsRectEmpty) Fixes https://github.com/libsdl-org/SDL/issues/6932
2022-12-29 03:34:01 +00:00
* \sa SDL_RenderClipEnabled
SDL API renaming: SDL_render.h Fixes https://github.com/libsdl-org/SDL/issues/6883
2022-12-27 14:21:13 +00:00
* \sa SDL_SetRenderClipRect
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Backed out the viewport and cliprect changes in 9fb5a9ccac0a6bb6af02e72644c1c56dc6ab6f3e This ended up being lots of application code churn without any real benefit in practice.
2024-06-13 02:08:06 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetRenderClipRect(SDL_Renderer *renderer, SDL_Rect *rect);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Get whether clipping is enabled on the given renderer.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns SDL_TRUE if clipping is enabled or SDL_FALSE if not; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
SDL API renaming: SDL_render.h Fixes https://github.com/libsdl-org/SDL/issues/6883
2022-12-27 14:21:13 +00:00
* \sa SDL_GetRenderClipRect
* \sa SDL_SetRenderClipRect
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderClipEnabled(SDL_Renderer *renderer);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Set the drawing scale for rendering on the current target.
*
* The drawing coordinates are scaled by the x/y scaling factors before they
* are used by the renderer. This allows resolution independent drawing with a
* single coordinate system.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* If this results in scaling or subpixel drawing by the rendering backend, it
* will be handled using the appropriate quality hints. For best results use
* integer scaling factors.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
* \param scaleX the horizontal scaling factor.
* \param scaleY the vertical scaling factor.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
SDL API renaming: SDL_render.h Fixes https://github.com/libsdl-org/SDL/issues/6883
2022-12-27 14:21:13 +00:00
* \sa SDL_GetRenderScale
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_SetRenderScale(SDL_Renderer *renderer, float scaleX, float scaleY);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Get the drawing scale for the current target.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
* \param scaleX a pointer filled in with the horizontal scaling factor.
* \param scaleY a pointer filled in with the vertical scaling factor.
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
SDL API renaming: SDL_render.h Fixes https://github.com/libsdl-org/SDL/issues/6883
2022-12-27 14:21:13 +00:00
* \sa SDL_SetRenderScale
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetRenderScale(SDL_Renderer *renderer, float *scaleX, float *scaleY);
Sync wiki -> header
2021-11-10 20:21:01 +00:00
Added SDL_SetRenderDrawColorspace() and SDL_GetRenderDrawColorspace()
2024-02-01 05:46:02 +00:00
/**
* Set the color used for drawing operations.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* Set the color for drawing or filling rectangles, lines, and points, and for
* SDL_RenderClear().
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
* \param r the red value used to draw on the rendering target.
* \param g the green value used to draw on the rendering target.
* \param b the blue value used to draw on the rendering target.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param a the alpha value used to draw on the rendering target; usually
* `SDL_ALPHA_OPAQUE` (255). Use SDL_SetRenderDrawBlendMode to
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* specify how the alpha channel is used.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_GetRenderDrawColor
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
* \sa SDL_SetRenderDrawColorFloat
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_SetRenderDrawColor(SDL_Renderer *renderer, Uint8 r, Uint8 g, Uint8 b, Uint8 a);
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
/**
* Set the color used for drawing operations (Rect, Line and Clear).
*
* Set the color for drawing or filling rectangles, lines, and points, and for
* SDL_RenderClear().
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
* \param r the red value used to draw on the rendering target.
* \param g the green value used to draw on the rendering target.
* \param b the blue value used to draw on the rendering target.
Sync SDL3 wiki -> header
2024-01-30 17:49:26 +00:00
* \param a the alpha value used to draw on the rendering target. Use
* SDL_SetRenderDrawBlendMode to specify how the alpha channel is
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* used.
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetRenderDrawColorFloat
* \sa SDL_SetRenderDrawColor
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_SetRenderDrawColorFloat(SDL_Renderer *renderer, float r, float g, float b, float a);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Get the color used for drawing operations (Rect, Line and Clear).
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param r a pointer filled in with the red value used to draw on the
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* rendering target.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param g a pointer filled in with the green value used to draw on the
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* rendering target.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param b a pointer filled in with the blue value used to draw on the
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* rendering target.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \param a a pointer filled in with the alpha value used to draw on the
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* rendering target; usually `SDL_ALPHA_OPAQUE` (255).
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
* \sa SDL_GetRenderDrawColorFloat
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_SetRenderDrawColor
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetRenderDrawColor(SDL_Renderer *renderer, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
/**
* Get the color used for drawing operations (Rect, Line and Clear).
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
* \param r a pointer filled in with the red value used to draw on the
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* rendering target.
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
* \param g a pointer filled in with the green value used to draw on the
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* rendering target.
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
* \param b a pointer filled in with the blue value used to draw on the
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* rendering target.
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
* \param a a pointer filled in with the alpha value used to draw on the
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* rendering target.
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_SetRenderDrawColorFloat
* \sa SDL_GetRenderDrawColor
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetRenderDrawColorFloat(SDL_Renderer *renderer, float *r, float *g, float *b, float *a);
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
Generalize SDR white level handling into a color scale This gives applications better control over how and when light levels are adjusted when working with HDR content and display.
2024-02-06 07:20:43 +00:00
/**
* Set the color scale used for render operations.
*
Sync SDL3 wiki -> header
2024-02-06 10:49:24 +00:00
* The color scale is an additional scale multiplied into the pixel color
* value while rendering. This can be used to adjust the brightness of colors
* during HDR rendering, or changing HDR video brightness when playing on an
* SDR display.
Generalize SDR white level handling into a color scale This gives applications better control over how and when light levels are adjusted when working with HDR content and display.
2024-02-06 07:20:43 +00:00
*
Sync SDL3 wiki -> header
2024-02-06 10:49:24 +00:00
* The color scale does not affect the alpha channel, only the color
* brightness.
Generalize SDR white level handling into a color scale This gives applications better control over how and when light levels are adjusted when working with HDR content and display.
2024-02-06 07:20:43 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
* \param scale the color scale value.
Generalize SDR white level handling into a color scale This gives applications better control over how and when light levels are adjusted when working with HDR content and display.
2024-02-06 07:20:43 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetRenderColorScale
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_SetRenderColorScale(SDL_Renderer *renderer, float scale);
Generalize SDR white level handling into a color scale This gives applications better control over how and when light levels are adjusted when working with HDR content and display.
2024-02-06 07:20:43 +00:00
/**
* Get the color scale used for render operations.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
Reverted 3d2e5a0b66eca4ade34f2a4fa81c8f4d8d33dac3 Applying these changes to external code doesn't actually improve anything, and within the context of the other Get* functions for renderers and surfaces, these stand out as outliers, so I'm going to back this change out.
2024-07-17 16:40:25 +00:00
* \param scale a pointer filled in with the current color scale value.
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Generalize SDR white level handling into a color scale This gives applications better control over how and when light levels are adjusted when working with HDR content and display.
2024-02-06 07:20:43 +00:00
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_SetRenderColorScale
*/
Reverted 3d2e5a0b66eca4ade34f2a4fa81c8f4d8d33dac3 Applying these changes to external code doesn't actually improve anything, and within the context of the other Get* functions for renderers and surfaces, these stand out as outliers, so I'm going to back this change out.
2024-07-17 16:40:25 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetRenderColorScale(SDL_Renderer *renderer, float *scale);
Generalize SDR white level handling into a color scale This gives applications better control over how and when light levels are adjusted when working with HDR content and display.
2024-02-06 07:20:43 +00:00
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Set the blend mode used for drawing operations (Fill and Line).
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* If the blend mode is not supported, the closest supported mode is chosen.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
* \param blendMode the SDL_BlendMode to use for blending.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_GetRenderDrawBlendMode
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_SetRenderDrawBlendMode(SDL_Renderer *renderer, SDL_BlendMode blendMode);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Get the blend mode used for drawing operations.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
Reverted 3d2e5a0b66eca4ade34f2a4fa81c8f4d8d33dac3 Applying these changes to external code doesn't actually improve anything, and within the context of the other Get* functions for renderers and surfaces, these stand out as outliers, so I'm going to back this change out.
2024-07-17 16:40:25 +00:00
* \param blendMode a pointer filled in with the current SDL_BlendMode.
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_SetRenderDrawBlendMode
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Reverted 3d2e5a0b66eca4ade34f2a4fa81c8f4d8d33dac3 Applying these changes to external code doesn't actually improve anything, and within the context of the other Get* functions for renderers and surfaces, these stand out as outliers, so I'm going to back this change out.
2024-07-17 16:40:25 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetRenderDrawBlendMode(SDL_Renderer *renderer, SDL_BlendMode *blendMode);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Clear the current rendering target with the drawing color.
*
* This function clears the entire rendering target, ignoring the viewport and
Sync SDL3 wiki -> header
2024-05-22 19:47:56 +00:00
* the clip rectangle. Note, that clearing will also set/fill all pixels of
* the rendering target to current renderer draw color, so make sure to invoke
* SDL_SetRenderDrawColor() when needed.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_SetRenderDrawColor
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_RenderClear(SDL_Renderer *renderer);
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Draw a point on the current rendering target at subpixel precision.
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the renderer which should draw a point.
* \param x the x coordinate of the point.
* \param y the y coordinate of the point.
Made return value descriptions more consistent across the API
2024-07-18 07:30:33 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
*
* \sa SDL_RenderPoints
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_RenderPoint(SDL_Renderer *renderer, float x, float y);
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Draw multiple points on the current rendering target at subpixel precision.
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the renderer which should draw multiple points.
* \param points the points to draw.
* \param count the number of points to draw.
Update `\returns` to the generic form
2023-02-12 09:09:42 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
*
* \sa SDL_RenderPoint
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_RenderPoints(SDL_Renderer *renderer, const SDL_FPoint *points, int count);
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Draw a line on the current rendering target at subpixel precision.
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the renderer which should draw a line.
* \param x1 the x coordinate of the start point.
* \param y1 the y coordinate of the start point.
* \param x2 the x coordinate of the end point.
* \param y2 the y coordinate of the end point.
Made return value descriptions more consistent across the API
2024-07-18 07:30:33 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
*
* \sa SDL_RenderLines
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_RenderLine(SDL_Renderer *renderer, float x1, float y1, float x2, float y2);
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Draw a series of connected lines on the current rendering target at
* subpixel precision.
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the renderer which should draw multiple lines.
* \param points the points along the lines.
* \param count the number of points, drawing count-1 lines.
Update `\returns` to the generic form
2023-02-12 09:09:42 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
*
* \sa SDL_RenderLine
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_RenderLines(SDL_Renderer *renderer, const SDL_FPoint *points, int count);
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Draw a rectangle on the current rendering target at subpixel precision.
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the renderer which should draw a rectangle.
* \param rect a pointer to the destination rectangle, or NULL to outline the
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* entire rendering target.
Made return value descriptions more consistent across the API
2024-07-18 07:30:33 +00:00
* \returns 0 on success or a negative error code on failure; call
Sync SDL3 wiki -> header
2024-07-19 19:23:24 +00:00
* SDL_GetError() for more information.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
*
* \sa SDL_RenderRects
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_RenderRect(SDL_Renderer *renderer, const SDL_FRect *rect);
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Draw some number of rectangles on the current rendering target at subpixel
* precision.
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the renderer which should draw multiple rectangles.
* \param rects a pointer to an array of destination rectangles.
* \param count the number of rectangles.
Update `\returns` to the generic form
2023-02-12 09:09:42 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
*
* \sa SDL_RenderRect
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_RenderRects(SDL_Renderer *renderer, const SDL_FRect *rects, int count);
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
/**
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* Fill a rectangle on the current rendering target with the drawing color at
* subpixel precision.
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the renderer which should fill a rectangle.
* \param rect a pointer to the destination rectangle, or NULL for the entire
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* rendering target.
Made return value descriptions more consistent across the API
2024-07-18 07:30:33 +00:00
* \returns 0 on success or a negative error code on failure; call
Sync SDL3 wiki -> header
2024-07-19 19:23:24 +00:00
* SDL_GetError() for more information.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
*
* \sa SDL_RenderFillRects
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_RenderFillRect(SDL_Renderer *renderer, const SDL_FRect *rect);
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Fill some number of rectangles on the current rendering target with the
* drawing color at subpixel precision.
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the renderer which should fill multiple rectangles.
* \param rects a pointer to an array of destination rectangles.
* \param count the number of rectangles.
Update `\returns` to the generic form
2023-02-12 09:09:42 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
*
* \sa SDL_RenderFillRect
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_RenderFillRects(SDL_Renderer *renderer, const SDL_FRect *rects, int count);
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Copy a portion of the texture to the current rendering target at subpixel
* precision.
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the renderer which should copy parts of a texture.
* \param texture the source texture.
* \param srcrect a pointer to the source rectangle, or NULL for the entire
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* texture.
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param dstrect a pointer to the destination rectangle, or NULL for the
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* entire rendering target.
Made return value descriptions more consistent across the API
2024-07-18 07:30:33 +00:00
* \returns 0 on success or a negative error code on failure; call
Sync SDL3 wiki -> header
2024-07-19 19:23:24 +00:00
* SDL_GetError() for more information.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
*
* \sa SDL_RenderTextureRotated
Added SDL_RenderTextureTiled()
2024-07-20 20:47:01 +00:00
* \sa SDL_RenderTextureTiled
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_RenderTexture(SDL_Renderer *renderer, SDL_Texture *texture, const SDL_FRect *srcrect, const SDL_FRect *dstrect);
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
/**
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* Copy a portion of the source texture to the current rendering target, with
* rotation and flipping, at subpixel precision.
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the renderer which should copy parts of a texture.
* \param texture the source texture.
* \param srcrect a pointer to the source rectangle, or NULL for the entire
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* texture.
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param dstrect a pointer to the destination rectangle, or NULL for the
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* entire rendering target.
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param angle an angle in degrees that indicates the rotation that will be
* applied to dstrect, rotating it in a clockwise direction.
* \param center a pointer to a point indicating the point around which
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* dstrect will be rotated (if NULL, rotation will be done
* around dstrect.w/2, dstrect.h/2).
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param flip an SDL_FlipMode value stating which flipping actions should be
* performed on the texture.
Update `\returns` to the generic form
2023-02-12 09:09:42 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
*
* \sa SDL_RenderTexture
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_RenderTextureRotated(SDL_Renderer *renderer, SDL_Texture *texture,
SDL_RenderTexture() and SDL_RenderTextureRotated() take floating point source coordinates See the discussion at https://discourse.libsdl.org/t/sdl-rendercopyf-uses-ints/36732/8
2023-03-02 16:56:54 +00:00
const SDL_FRect *srcrect, const SDL_FRect *dstrect,
Removed non-float versions of SDL render API drawing functions This simplifies the API and removes a level of API translation between the int variants of the functions and the float implementation Fixes https://github.com/libsdl-org/SDL/issues/6656
2022-12-31 19:19:32 +00:00
const double angle, const SDL_FPoint *center,
Added SDL_FlipSurface() to flip a surface vertically or horizontally Fixes https://github.com/libsdl-org/SDL/issues/8857
2024-01-20 14:31:37 +00:00
const SDL_FlipMode flip);
render: Add floating point versions of various draw APIs.
2018-10-23 05:34:03 +00:00
Added SDL_RenderTextureTiled()
2024-07-20 20:47:01 +00:00
/**
* Tile a portion of the texture to the current rendering target at subpixel
* precision.
*
Sync SDL3 wiki -> header
2024-07-21 01:22:39 +00:00
* The pixels in `srcrect` will be repeated as many times as needed to
* completely fill `dstrect`.
Added SDL_RenderTextureTiled()
2024-07-20 20:47:01 +00:00
*
* \param renderer the renderer which should copy parts of a texture.
* \param texture the source texture.
* \param srcrect a pointer to the source rectangle, or NULL for the entire
* texture.
Sync SDL3 wiki -> header
2024-07-21 01:22:39 +00:00
* \param scale the scale used to transform srcrect into the destination
* rectangle, e.g. a 32x32 texture with a scale of 2 would fill
* 64x64 tiles.
Added SDL_RenderTextureTiled()
2024-07-20 20:47:01 +00:00
* \param dstrect a pointer to the destination rectangle, or NULL for the
* entire rendering target.
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_RenderTexture
*/
extern SDL_DECLSPEC int SDLCALL SDL_RenderTextureTiled(SDL_Renderer *renderer, SDL_Texture *texture, const SDL_FRect *srcrect, float scale, const SDL_FRect *dstrect);
Added SDL_BlitSurface9Grid() and SDL_RenderTexture9Grid()
2024-07-20 23:39:09 +00:00
/**
Sync SDL3 wiki -> header
2024-07-21 01:22:39 +00:00
* Perform a scaled copy using the 9-grid algorithm to the current rendering
* target at subpixel precision.
Added SDL_BlitSurface9Grid() and SDL_RenderTexture9Grid()
2024-07-20 23:39:09 +00:00
*
Sync SDL3 wiki -> header
2024-07-21 01:22:39 +00:00
* The pixels in the texture are split into a 3x3 grid, using the corner size
* for each corner, and the sides and center making up the remaining pixels.
* The corners are then scaled using `scale` and fit into the corners of the
* destination rectangle. The sides and center are then stretched into place
* to cover the remaining destination rectangle.
Added SDL_BlitSurface9Grid() and SDL_RenderTexture9Grid()
2024-07-20 23:39:09 +00:00
*
* \param renderer the renderer which should copy parts of a texture.
* \param texture the source texture.
Sync SDL3 wiki -> header
2024-07-21 01:22:39 +00:00
* \param srcrect the SDL_Rect structure representing the rectangle to be used
* for the 9-grid, or NULL to use the entire texture.
Added SDL_BlitSurface9Grid() and SDL_RenderTexture9Grid()
2024-07-20 23:39:09 +00:00
* \param corner_size the size, in pixels, of the corner in `srcrect`.
Sync SDL3 wiki -> header
2024-07-21 01:22:39 +00:00
* \param scale the scale used to transform the corner of `srcrect` into the
* corner of `dstrect`, or 0.0f for an unscaled copy.
Added SDL_BlitSurface9Grid() and SDL_RenderTexture9Grid()
2024-07-20 23:39:09 +00:00
* \param dstrect a pointer to the destination rectangle, or NULL for the
* entire rendering target.
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_RenderTexture
*/
extern SDL_DECLSPEC int SDLCALL SDL_RenderTexture9Grid(SDL_Renderer *renderer, SDL_Texture *texture, const SDL_FRect *srcrect, float corner_size, float scale, const SDL_FRect *dstrect);
Add SDL_RenderGeometry based on SDL_RenderGeometryRaw
2021-04-01 07:55:00 +00:00
/**
Sync wiki -> header
2021-08-18 22:13:05 +00:00
* Render a list of triangles, optionally using a texture and indices into the
* vertex array Color and alpha modulation is done per vertex
* (SDL_SetTextureColorMod and SDL_SetTextureAlphaMod are ignored).
Add SDL_RenderGeometry based on SDL_RenderGeometryRaw
2021-04-01 07:55:00 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
Sync wiki -> header
2021-08-18 22:13:05 +00:00
* \param texture (optional) The SDL texture to use.
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param vertices vertices.
* \param num_vertices number of vertices.
Sync wiki -> header
2021-08-18 22:13:05 +00:00
* \param indices (optional) An array of integer indices into the 'vertices'
* array, if NULL all vertices will be rendered in sequential
* order.
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param num_indices number of indices.
Made return value descriptions more consistent across the API
2024-07-18 07:30:33 +00:00
* \returns 0 on success or a negative error code on failure; call
Sync SDL3 wiki -> header
2024-07-19 19:23:24 +00:00
* SDL_GetError() for more information.
Add SDL_RenderGeometry based on SDL_RenderGeometryRaw
2021-04-01 07:55:00 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync wiki -> header
2022-01-10 20:40:05 +00:00
* \sa SDL_RenderGeometryRaw
Add SDL_RenderGeometry based on SDL_RenderGeometryRaw
2021-04-01 07:55:00 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_RenderGeometry(SDL_Renderer *renderer,
Add SDL_RenderGeometry based on SDL_RenderGeometryRaw
2021-04-01 07:55:00 +00:00
SDL_Texture *texture,
const SDL_Vertex *vertices, int num_vertices,
const int *indices, int num_indices);
Use SDL_Color for SDL_RenderGeometryRaw() and add SDL_RenderGeometryRawFloat() Eventually we can re-add a fast path for that data down to the individual renderers. Setting color scale would still require converting to float, and most hardware accelerated renderers prefer to consume colors as float, so this requires some thought and performance testing. Fixes https://github.com/libsdl-org/SDL/issues/9009
2024-02-07 01:23:07 +00:00
/**
* Render a list of triangles, optionally using a texture and indices into the
* vertex arrays Color and alpha modulation is done per vertex
* (SDL_SetTextureColorMod and SDL_SetTextureAlphaMod are ignored).
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
Use SDL_Color for SDL_RenderGeometryRaw() and add SDL_RenderGeometryRawFloat() Eventually we can re-add a fast path for that data down to the individual renderers. Setting color scale would still require converting to float, and most hardware accelerated renderers prefer to consume colors as float, so this requires some thought and performance testing. Fixes https://github.com/libsdl-org/SDL/issues/9009
2024-02-07 01:23:07 +00:00
* \param texture (optional) The SDL texture to use.
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param xy vertex positions.
* \param xy_stride byte size to move from one element to the next element.
* \param color vertex colors (as SDL_FColor).
* \param color_stride byte size to move from one element to the next element.
* \param uv vertex normalized texture coordinates.
* \param uv_stride byte size to move from one element to the next element.
* \param num_vertices number of vertices.
Use SDL_Color for SDL_RenderGeometryRaw() and add SDL_RenderGeometryRawFloat() Eventually we can re-add a fast path for that data down to the individual renderers. Setting color scale would still require converting to float, and most hardware accelerated renderers prefer to consume colors as float, so this requires some thought and performance testing. Fixes https://github.com/libsdl-org/SDL/issues/9009
2024-02-07 01:23:07 +00:00
* \param indices (optional) An array of indices into the 'vertices' arrays,
* if NULL all vertices will be rendered in sequential order.
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param num_indices number of indices.
* \param size_indices index size: 1 (byte), 2 (short), 4 (int).
Use SDL_Color for SDL_RenderGeometryRaw() and add SDL_RenderGeometryRawFloat() Eventually we can re-add a fast path for that data down to the individual renderers. Setting color scale would still require converting to float, and most hardware accelerated renderers prefer to consume colors as float, so this requires some thought and performance testing. Fixes https://github.com/libsdl-org/SDL/issues/9009
2024-02-07 01:23:07 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_RenderGeometry
*/
Removed SDL_RenderGeometryRawFloat() After discussion with @ocornut, SDL_RenderGeometryRaw() will take floating point colors and conversion from 8-bit color can happen on the application side. We can always add an 8-bit color fast path in the future if we need it on handheld platforms. If you need code to do this in your application, you can use the following: int SDL_RenderGeometryRaw8BitColor(SDL_Renderer *renderer, SDL_Texture *texture, const float *xy, int xy_stride, const SDL_Color *color, int color_stride, const float *uv, int uv_stride, int num_vertices, const void *indices, int num_indices, int size_indices) { int i, retval, isstack; const Uint8 *color2 = (const Uint8 *)color; SDL_FColor *color3; if (num_vertices <= 0) { return SDL_InvalidParamError("num_vertices"); } if (!color) { return SDL_InvalidParamError("color"); } color3 = (SDL_FColor *)SDL_small_alloc(SDL_FColor, num_vertices, &isstack); if (!color3) { return -1; } for (i = 0; i < num_vertices; ++i) { color3[i].r = color->r / 255.0f; color3[i].g = color->g / 255.0f; color3[i].b = color->b / 255.0f; color3[i].a = color->a / 255.0f; color2 += color_stride; color = (const SDL_Color *)color2; } retval = SDL_RenderGeometryRaw(renderer, texture, xy, xy_stride, color3, sizeof(*color3), uv, uv_stride, num_vertices, indices, num_indices, size_indices); SDL_small_free(color3, isstack); return retval; } Fixes https://github.com/libsdl-org/SDL/issues/9009
2024-06-29 06:55:23 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_RenderGeometryRaw(SDL_Renderer *renderer,
Add API: SDL_Vertex type and SDL_RenderGeometry
2021-03-16 14:07:44 +00:00
SDL_Texture *texture,
Move to SDL_RenderGeometryRaw prototype with separate xy/uv/color pointer parameters
2021-04-01 07:49:16 +00:00
const float *xy, int xy_stride,
Renderer colors now have floating point precision
2024-01-29 21:28:33 +00:00
const SDL_FColor *color, int color_stride,
Move to SDL_RenderGeometryRaw prototype with separate xy/uv/color pointer parameters
2021-04-01 07:49:16 +00:00
const float *uv, int uv_stride,
int num_vertices,
Change 'size_indice' to 'size_indices'
2021-04-23 10:00:14 +00:00
const void *indices, int num_indices, int size_indices);
Add API: SDL_Vertex type and SDL_RenderGeometry
2021-03-16 14:07:44 +00:00
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
SDL_RenderReadPixels() now returns a surface Fixes https://github.com/libsdl-org/SDL/issues/8977
2024-02-03 18:18:12 +00:00
* Read pixels from the current rendering target.
*
* The returned surface should be freed with SDL_DestroySurface()
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* **WARNING**: This is a very slow operation, and should not be used
Sync wiki -> header
2022-03-18 17:30:05 +00:00
* frequently. If you're using this on the main rendering target, it should be
* called after rendering and before SDL_RenderPresent().
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
Renderer logical size is now implemented as a render target This fixes rounding errors with coordinate scaling and gives more flexibility in the presentation, as well as making it easy to maintain device independent resolution as windows move between different pixel density displays. By default when a renderer is created, it will match the window size so window coordinates and render coordinates are 1-1. Mouse and touch events are no longer filtered to change their coordinates, instead you can call SDL_ConvertEventToRenderCoordinates() to explicitly map event coordinates into the rendering viewport. SDL_RenderWindowToLogical() and SDL_RenderLogicalToWindow() have been renamed SDL_RenderCoordinatesFromWindow() and SDL_RenderCoordinatesToWindow() and take floating point coordinates in both directions. The viewport, clipping state, and scale for render targets are now persistent and will remain set whenever they are active.
2023-02-03 20:25:46 +00:00
* \param rect an SDL_Rect structure representing the area in pixels relative
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* to the to current viewport, or NULL for the entire viewport.
SDL_RenderReadPixels() now returns a surface Fixes https://github.com/libsdl-org/SDL/issues/8977
2024-02-03 18:18:12 +00:00
* \returns a new SDL_Surface on success or NULL on failure; call
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* SDL_GetError() for more information.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_RenderReadPixels(SDL_Renderer *renderer, const SDL_Rect *rect);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* Update the screen with any rendering performed since the previous call.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
* SDL's rendering functions operate on a backbuffer; that is, calling a
Sync wiki -> headers.
2023-01-25 17:58:29 +00:00
* rendering function such as SDL_RenderLine() does not directly put a line on
* the screen, but rather updates the backbuffer. As such, you compose your
* entire scene and *present* the composed backbuffer to the screen as a
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* complete picture.
*
* Therefore, when using SDL's rendering API, one does all drawing intended
* for the frame, and then calls this function once per frame to present the
* final drawing to the user.
*
* The backbuffer should be considered invalidated after each present; do not
* assume that previous contents will exist between frames. You are strongly
* encouraged to call SDL_RenderClear() to initialize the backbuffer before
* starting each new frame's drawing, even if you plan to overwrite every
* pixel.
*
Sync SDL3 wiki -> header
2024-07-14 23:42:33 +00:00
* Please note, that in case of rendering to a texture - there is **no need**
* to call `SDL_RenderPresent` after drawing needed objects to a texture, you
* are only required to change back the rendering target to default via
* `SDL_SetRenderTarget(renderer, NULL)` afterwards, as textures by themselves
* do not have a concept of backbuffers.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
Change return type from void to int, for functions that set an error (SDL_SetError(), SDL_OutOfMemory(), SDL_Unsupported(), SDL_InvalidParam()) Update prototype to forward errors to generic layer, for the functions: MoveCursor, WarpMouse, GL_DeleteContext, GetDisplayModes. Check invalid parameter in SDL_SetTextInputRect() generic layer.
2023-02-06 19:24:12 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
include: make SDL_RenderPresent thread safety notes less verbose. Reference Issue #7140.
2023-01-25 18:15:34 +00:00
* \threadsafety You may only call this function on the main thread.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync wiki -> headers.
2023-01-25 17:58:29 +00:00
* \since This function is available since SDL 3.0.0.
wikiheaders: Add a `\threadsafety` tag to document threading details. Reference Issue #7140.
2023-01-25 03:13:25 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_RenderClear
SDL API renaming: SDL_render.h Fixes https://github.com/libsdl-org/SDL/issues/6883
2022-12-27 14:21:13 +00:00
* \sa SDL_RenderLine
* \sa SDL_RenderLines
* \sa SDL_RenderPoint
* \sa SDL_RenderPoints
* \sa SDL_RenderRect
* \sa SDL_RenderRects
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_RenderFillRect
* \sa SDL_RenderFillRects
* \sa SDL_SetRenderDrawBlendMode
* \sa SDL_SetRenderDrawColor
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_RenderPresent(SDL_Renderer *renderer);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Destroy the specified texture.
*
* Passing NULL or an otherwise invalid texture will set the SDL error message
* to "Invalid texture".
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param texture the texture to destroy.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_CreateTexture
* \sa SDL_CreateTextureFromSurface
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_Texture *texture);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/**
Sync SDL3 wiki -> header
2024-07-05 15:59:26 +00:00
* Destroy the rendering context for a window and free all associated
* textures.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*
Clarified that the renderer should be destroyed before the window I didn't add a note to SDL_DestroyWindow() because we actually protect against this case now, but it's useful information to know conceptually when working with the renderer.
2024-07-05 15:57:30 +00:00
* This should be called before destroying the associated window.
Sync SDL wiki -> header
2022-08-20 17:50:04 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \sa SDL_CreateRenderer
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_Renderer *renderer);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
render: Added SDL_RenderFlush().
2018-10-04 20:34:44 +00:00
/**
render: Replaced SDL_RenderFlush with SDL_FlushRenderer. This uses the same `SDL_VerbNoun` format as the rest of SDL3, and also adds stronger effort to invalidate cached state in the backend, so cooperation improves with apps that are using lowlevel rendering APIs directly. Fixes #367.
2023-11-26 03:41:23 +00:00
* Force the rendering context to flush any pending commands and state.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* You do not need to (and in fact, shouldn't) call this function unless you
render: Replaced SDL_RenderFlush with SDL_FlushRenderer. This uses the same `SDL_VerbNoun` format as the rest of SDL3, and also adds stronger effort to invalidate cached state in the backend, so cooperation improves with apps that are using lowlevel rendering APIs directly. Fixes #367.
2023-11-26 03:41:23 +00:00
* are planning to call into OpenGL/Direct3D/Metal/whatever directly, in
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* addition to using an SDL_Renderer.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
*
render: Batching is always enabled now! Make sure your app uses SDL_RenderFlush() before it talks to D3D/OpenGL/etc! Fixes #8584.
2023-11-21 01:26:12 +00:00
* This is for a very-specific case: if you are using SDL's render API, and
* you plan to make OpenGL/D3D/whatever calls in addition to SDL render API
render: Replaced SDL_RenderFlush with SDL_FlushRenderer. This uses the same `SDL_VerbNoun` format as the rest of SDL3, and also adds stronger effort to invalidate cached state in the backend, so cooperation improves with apps that are using lowlevel rendering APIs directly. Fixes #367.
2023-11-26 03:41:23 +00:00
* calls. If this applies, you should call this function between calls to
render: Batching is always enabled now! Make sure your app uses SDL_RenderFlush() before it talks to D3D/OpenGL/etc! Fixes #8584.
2023-11-21 01:26:12 +00:00
* SDL's render API and the low-level API you're using in cooperation.
*
* In all other cases, you can ignore this function.
render: Added SDL_RenderFlush().
2018-10-04 20:34:44 +00:00
*
Sync SDL3 wiki -> header
2023-11-30 15:22:19 +00:00
* This call makes SDL flush any pending rendering work it was queueing up to
* do later in a single batch, and marks any internal cached state as invalid,
* so it'll prepare all its state again later, from scratch.
render: Replaced SDL_RenderFlush with SDL_FlushRenderer. This uses the same `SDL_VerbNoun` format as the rest of SDL3, and also adds stronger effort to invalidate cached state in the backend, so cooperation improves with apps that are using lowlevel rendering APIs directly. Fixes #367.
2023-11-26 03:41:23 +00:00
*
* This means you do not need to save state in your rendering code to protect
Sync SDL3 wiki -> header
2023-11-30 15:22:19 +00:00
* the SDL renderer. However, there lots of arbitrary pieces of Direct3D and
Sync SDL3 wiki -> header
2024-06-19 14:15:46 +00:00
* OpenGL state that can confuse things; you should use your best judgment and
* be prepared to make changes if specific state needs to be protected.
render: Replaced SDL_RenderFlush with SDL_FlushRenderer. This uses the same `SDL_VerbNoun` format as the rest of SDL3, and also adds stronger effort to invalidate cached state in the backend, so cooperation improves with apps that are using lowlevel rendering APIs directly. Fixes #367.
2023-11-26 03:41:23 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
render: Added SDL_RenderFlush().
2018-10-04 20:34:44 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
render: Added SDL_RenderFlush().
2018-10-04 20:34:44 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_FlushRenderer(SDL_Renderer *renderer);
render: Added SDL_RenderFlush().
2018-10-04 20:34:44 +00:00
Added SDL_RenderGetMetalLayer() and SDL_RenderGetMetalCommandEncoder()
2017-12-08 22:30:10 +00:00
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* Get the CAMetalLayer associated with the given Metal renderer.
Added SDL_RenderGetMetalLayer() and SDL_RenderGetMetalCommandEncoder()
2017-12-08 22:30:10 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* This function returns `void *`, so SDL doesn't have to include Metal's
* headers, but it can be safely cast to a `CAMetalLayer *`.
Added SDL_RenderGetMetalLayer() and SDL_RenderGetMetalCommandEncoder()
2017-12-08 22:30:10 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the renderer to query.
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* \returns a `CAMetalLayer *` on success, or NULL if the renderer isn't a
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* Metal renderer.
Added SDL_RenderGetMetalLayer() and SDL_RenderGetMetalCommandEncoder()
2017-12-08 22:30:10 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
SDL API renaming: SDL_render.h Fixes https://github.com/libsdl-org/SDL/issues/6883
2022-12-27 14:21:13 +00:00
* \sa SDL_GetRenderMetalCommandEncoder
Added SDL_RenderGetMetalLayer() and SDL_RenderGetMetalCommandEncoder()
2017-12-08 22:30:10 +00:00
*/
Standardize placement of '*' in function declarations Implemented using these sed commands on the headers: sed -E -i'' '/SDLCALL|;/ s,([a-z])\* ,\1 *,g' * sed -E -i'' 's,(\(.*[^\*])\* ([a-z])(.*\)),\1*\2\3,g' * sed -E -i'' 's,\*const,* const,g' * sed -E -i'' 's,\*SDLCALL,* SDLCALL,g' * sed -E -i'' 's,void\(,void (,g' * git checkout *gl*
2024-07-18 15:54:50 +00:00
extern SDL_DECLSPEC void * SDLCALL SDL_GetRenderMetalLayer(SDL_Renderer *renderer);
Added SDL_RenderGetMetalLayer() and SDL_RenderGetMetalCommandEncoder()
2017-12-08 22:30:10 +00:00
/**
include: A ton of little documentation tweaks, fixes, and improvements. This is just stuff I noticed while working on the wikiheaders updates. A thorough pass over all the docs would not be terrible, and maybe a simple script to check for consistency (does everything have a `\since` on it? etc) might be nice, too.
2024-04-09 02:36:57 +00:00
* Get the Metal command encoder for the current frame.
Added SDL_RenderGetMetalLayer() and SDL_RenderGetMetalCommandEncoder()
2017-12-08 22:30:10 +00:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 18:18:39 +00:00
* This function returns `void *`, so SDL doesn't have to include Metal's
* headers, but it can be safely cast to an `id<MTLRenderCommandEncoder>`.
Added SDL_RenderGetMetalLayer() and SDL_RenderGetMetalCommandEncoder()
2017-12-08 22:30:10 +00:00
*
Sync SDL3 wiki -> header
2024-04-13 13:24:25 +00:00
* This will return NULL if Metal refuses to give SDL a drawable to render to,
* which might happen if the window is hidden/minimized/offscreen. This
include: Removed some SDL2 references in the documentation.
2024-04-13 13:23:22 +00:00
* doesn't apply to command encoders for render targets, just the window's
* backbuffer. Check your return values!
metal: Deal better with -[CAMetalLayer nextDrawable] returning nil. Fixes #4863.
2021-11-09 16:50:49 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the renderer to query.
Sync wiki -> header.
2021-07-14 21:07:04 +00:00
* \returns an `id<MTLRenderCommandEncoder>` on success, or NULL if the
metal: Deal better with -[CAMetalLayer nextDrawable] returning nil. Fixes #4863.
2021-11-09 16:50:49 +00:00
* renderer isn't a Metal renderer or there was an error.
Added SDL_RenderGetMetalLayer() and SDL_RenderGetMetalCommandEncoder()
2017-12-08 22:30:10 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
SDL API renaming: SDL_render.h Fixes https://github.com/libsdl-org/SDL/issues/6883
2022-12-27 14:21:13 +00:00
* \sa SDL_GetRenderMetalLayer
Added SDL_RenderGetMetalLayer() and SDL_RenderGetMetalCommandEncoder()
2017-12-08 22:30:10 +00:00
*/
Standardize placement of '*' in function declarations Implemented using these sed commands on the headers: sed -E -i'' '/SDLCALL|;/ s,([a-z])\* ,\1 *,g' * sed -E -i'' 's,(\(.*[^\*])\* ([a-z])(.*\)),\1*\2\3,g' * sed -E -i'' 's,\*const,* const,g' * sed -E -i'' 's,\*SDLCALL,* SDLCALL,g' * sed -E -i'' 's,void\(,void (,g' * git checkout *gl*
2024-07-18 15:54:50 +00:00
extern SDL_DECLSPEC void * SDLCALL SDL_GetRenderMetalCommandEncoder(SDL_Renderer *renderer);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
Added SDL_AddVulkanRenderSemaphores() for external synchronization with SDL rendering
2024-03-02 18:03:37 +00:00
/**
* Add a set of synchronization semaphores for the current frame.
*
Sync SDL3 wiki -> header
2024-03-04 17:30:25 +00:00
* The Vulkan renderer will wait for `wait_semaphore` before submitting
* rendering commands and signal `signal_semaphore` after rendering commands
* are complete for this frame.
Added SDL_AddVulkanRenderSemaphores() for external synchronization with SDL rendering
2024-03-02 18:03:37 +00:00
*
Sync SDL3 wiki -> header
2024-03-04 17:30:25 +00:00
* This should be called each frame that you want semaphore synchronization.
* The Vulkan renderer may have multiple frames in flight on the GPU, so you
* should have multiple semaphores that are used for synchronization. Querying
* SDL_PROP_RENDERER_VULKAN_SWAPCHAIN_IMAGE_COUNT_NUMBER will give you the
* maximum number of semaphores you'll need.
Added SDL_AddVulkanRenderSemaphores() for external synchronization with SDL rendering
2024-03-02 18:03:37 +00:00
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the rendering context.
* \param wait_stage_mask the VkPipelineStageFlags for the wait.
Sync SDL3 wiki -> header
2024-03-04 17:30:25 +00:00
* \param wait_semaphore a VkSempahore to wait on before rendering the current
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* frame, or 0 if not needed.
Sync SDL3 wiki -> header
2024-03-04 17:30:25 +00:00
* \param signal_semaphore a VkSempahore that SDL will signal when rendering
* for the current frame is complete, or 0 if not
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* needed.
Added SDL_AddVulkanRenderSemaphores() for external synchronization with SDL rendering
2024-03-02 18:03:37 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
Sync SDL3 wiki -> header
2024-05-22 00:41:09 +00:00
* \threadsafety It is **NOT** safe to call this function from two threads at
* once.
*
Added SDL_AddVulkanRenderSemaphores() for external synchronization with SDL rendering
2024-03-02 18:03:37 +00:00
* \since This function is available since SDL 3.0.0.
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_AddVulkanRenderSemaphores(SDL_Renderer *renderer, Uint32 wait_stage_mask, Sint64 wait_semaphore, Sint64 signal_semaphore);
Added SDL_AddVulkanRenderSemaphores() for external synchronization with SDL rendering
2024-03-02 18:03:37 +00:00
Add `SDL_RenderSetVSync()` Currently, if an application wants to toggle VSync, they'd have to tear down the renderer and recreate it. This patch fixes that by letting applications call SDL_RenderSetVSync(). This is the same as the patch in #3673, except it applies to all renderers (including PSP, even thought it seems that the VSync flag is disabled for that renderer). Furthermore, the renderer flags also change as well, which #3673 didn't do. It is also an API instead of using hint callbacks (which could be potentially dangerous). Closes #3673.
2021-03-07 23:20:45 +00:00
/**
* Toggle VSync of the given renderer.
*
Added SDL_SetWindowSurfaceVSync() and SDL_GetWindowSurfaceVSync() Fixes https://github.com/libsdl-org/SDL/issues/9347
2024-05-27 17:27:17 +00:00
* When a renderer is created, vsync defaults to SDL_RENDERER_VSYNC_DISABLED.
*
include: Tweaked some vsync-related documentation. Reference PR #9903.
2024-05-27 20:57:21 +00:00
* The `vsync` parameter can be 1 to synchronize present with every vertical
* refresh, 2 to synchronize present with every second vertical refresh, etc.,
* SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE for late swap tearing (adaptive vsync),
* or SDL_WINDOW_SURFACE_VSYNC_DISABLED to disable. Not every value is
* supported by every driver, so you should check the return value to see
* whether the requested setting is supported.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the renderer to toggle.
include: Tweaked some vsync-related documentation. Reference PR #9903.
2024-05-27 20:57:21 +00:00
* \param vsync the vertical refresh sync interval.
Update `\returns` to the generic form
2023-02-12 09:09:42 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Sync wiki -> header
2021-10-27 01:36:05 +00:00
*
Sync SDL wiki -> header
2022-11-22 22:40:14 +00:00
* \since This function is available since SDL 3.0.0.
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
*
* \sa SDL_GetRenderVSync
Add `SDL_RenderSetVSync()` Currently, if an application wants to toggle VSync, they'd have to tear down the renderer and recreate it. This patch fixes that by letting applications call SDL_RenderSetVSync(). This is the same as the patch in #3673, except it applies to all renderers (including PSP, even thought it seems that the VSync flag is disabled for that renderer). Furthermore, the renderer flags also change as well, which #3673 didn't do. It is also an API instead of using hint callbacks (which could be potentially dangerous). Closes #3673.
2021-03-07 23:20:45 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_SetRenderVSync(SDL_Renderer *renderer, int vsync);
Add `SDL_RenderSetVSync()` Currently, if an application wants to toggle VSync, they'd have to tear down the renderer and recreate it. This patch fixes that by letting applications call SDL_RenderSetVSync(). This is the same as the patch in #3673, except it applies to all renderers (including PSP, even thought it seems that the VSync flag is disabled for that renderer). Furthermore, the renderer flags also change as well, which #3673 didn't do. It is also an API instead of using hint callbacks (which could be potentially dangerous). Closes #3673.
2021-03-07 23:20:45 +00:00
Prefix names with `SDL_RENDERER_`
2024-05-15 19:43:05 +00:00
#define SDL_RENDERER_VSYNC_DISABLED 0
#define SDL_RENDERER_VSYNC_ADAPTIVE (-1)
Add defined constants for renderer vsync values
2024-05-15 18:43:03 +00:00
Add SDL_GetRenderVSync (see #6495) (#6965)
2023-01-02 19:21:02 +00:00
/**
* Get VSync of the given renderer.
*
Updated headers with latest wikiheaders tweaks.
2024-06-14 06:09:55 +00:00
* \param renderer the renderer to toggle.
Sync SDL3 wiki -> header
2024-05-15 21:33:30 +00:00
* \param vsync an int filled with the current vertical refresh sync interval.
Added SDL_SetWindowSurfaceVSync() and SDL_GetWindowSurfaceVSync() Fixes https://github.com/libsdl-org/SDL/issues/9347
2024-05-27 17:27:17 +00:00
* See SDL_SetRenderVSync() for the meaning of the value.
Update `\returns` to the generic form
2023-02-12 09:09:42 +00:00
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
Add SDL_GetRenderVSync (see #6495) (#6965)
2023-01-02 19:21:02 +00:00
*
* \since This function is available since SDL 3.0.0.
Updated "see also" references to be more consistent Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 18:00:15 +00:00
*
* \sa SDL_SetRenderVSync
Add SDL_GetRenderVSync (see #6495) (#6965)
2023-01-02 19:21:02 +00:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 23:52:36 +00:00
extern SDL_DECLSPEC int SDLCALL SDL_GetRenderVSync(SDL_Renderer *renderer, int *vsync);
Add SDL_GetRenderVSync (see #6495) (#6965)
2023-01-02 19:21:02 +00:00
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
}
#endif
include: Renamed begin_code.h and close_code.h to have SDL_ prefixes. Fixes #6864.
2022-12-22 16:38:59 +00:00
#include <SDL3/SDL_close_code.h>
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 15:33:46 +00:00
Renaming of guard header names to quiet -Wreserved-id-macro Patch contributed by Sylvain
2016-11-21 05:34:54 +00:00
#endif /* SDL_render_h_ */
Reference in New Issue Copy Permalink