mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-10-26 12:27:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: A few minor improvements to the GL context creation docs.

Browse Source
This commit is contained in:
Ryan C. Gordon
2025-10-13 01:39:03 -04:00
parent 57789dc9ad
commit f767809e25
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
include/SDL3/SDL_video.h
View File

@@ -3195,8 +3195,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void);
* SDL_GL_GetAttribute() to check the values after creating the OpenGL * SDL_GL_GetAttribute() to check the values after creating the OpenGL
* context, since the values obtained can differ from the requested ones. * context, since the values obtained can differ from the requested ones.
* *
* \param attr an SDL_GLAttr enum value specifying the OpenGL attribute to * \param attr an enum value specifying the OpenGL attribute to set.
* set.
* \param value the desired value for the attribute. * \param value the desired value for the attribute.
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
@@ -3205,6 +3204,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void);
* *
* \since This function is available since SDL 3.2.0. * \since This function is available since SDL 3.2.0.
* *
* \sa SDL_GL_CreateContext
* \sa SDL_GL_GetAttribute * \sa SDL_GL_GetAttribute
* \sa SDL_GL_ResetAttributes * \sa SDL_GL_ResetAttributes
*/ */
@@ -3231,6 +3231,9 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GL_GetAttribute(SDL_GLAttr attr, int *value
/** /**
* Create an OpenGL context for an OpenGL window, and make it current. * Create an OpenGL context for an OpenGL window, and make it current.
* *
* The OpenGL context will be created with the current states set through
* SDL_GL_SetAttribute().
*
* Windows users new to OpenGL should note that, for historical reasons, GL * Windows users new to OpenGL should note that, for historical reasons, GL
* functions added after OpenGL version 1.1 are not available by default. * functions added after OpenGL version 1.1 are not available by default.
* Those functions must be loaded at run-time, either with an OpenGL * Those functions must be loaded at run-time, either with an OpenGL