eden-emu/SDL
14
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-15 09:18:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

include: A ton of little documentation tweaks, fixes, and improvements.

Browse source 
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.
This commit is contained in:
Ryan C. Gordon 2024-04-08 22:36:57 -04:00
parent 645073961d
commit ad090d2444
No known key found for this signature in database
GPG key ID: FA148B892AB48044
45 changed files with 1565 additions and 833 deletions
Download patch file Download diff file Expand all files Collapse all files

16
include/SDL3/SDL_render.h
View file

@ -62,14 +62,14 @@ extern "C" {
#endif
/**
* The name of the software renderer
* The name of the software renderer.
*/
#define SDL_SOFTWARE_RENDERER "software"
/**
* Flags used when creating a rendering context
* Flags used when creating a rendering context.
*/
typedef enum
typedef enum SDL_RendererFlags
{
SDL_RENDERER_PRESENTVSYNC = 0x00000004 /**< Present is synchronized with the refresh rate */
} SDL_RendererFlags;
@ -88,7 +88,7 @@ typedef struct SDL_RendererInfo
} SDL_RendererInfo;
/**
* Vertex structure
* Vertex structure.
*/
typedef struct SDL_Vertex
{
@ -100,7 +100,7 @@ typedef struct SDL_Vertex
/**
* The access pattern allowed for a texture.
*/
typedef enum
typedef enum SDL_TextureAccess
{
SDL_TEXTUREACCESS_STATIC, /**< Changes rarely, not lockable */
SDL_TEXTUREACCESS_STREAMING, /**< Changes frequently, lockable */
@ -108,9 +108,9 @@ typedef enum
} SDL_TextureAccess;
/**
* How the logical size is mapped to the output
* How the logical size is mapped to the output.
*/
typedef enum
typedef enum SDL_RendererLogicalPresentation
{
SDL_LOGICAL_PRESENTATION_DISABLED, /**< There is no logical size in effect */
SDL_LOGICAL_PRESENTATION_STRETCH, /**< The rendered content is stretched to the output resolution */
@ -2078,7 +2078,7 @@ extern DECLSPEC int SDLCALL SDL_FlushRenderer(SDL_Renderer *renderer);
extern DECLSPEC void *SDLCALL SDL_GetRenderMetalLayer(SDL_Renderer *renderer);
/**
* Get the Metal command encoder for the current frame
* Get the Metal command encoder for the current frame.
*
* This function returns `void *`, so SDL doesn't have to include Metal's
* headers, but it can be safely cast to an `id<MTLRenderCommandEncoder>`.