SDL_GL_SetAttribute(3)

SDL_GL_SetAttribute3

Set an opengl window attribute before window creation.

Usage

#include "SDL3/SDL.h"

bool SDL_GL_SetAttribute(SDL_GLAttr attr, int value);

Header file

Defined in SDL3/SDL_video.h

Overview

This function sets the OpenGL attribute attr to value . The requested attributes should be set before creating an OpenGL window. You should use

SDL_GL_GetAttribute () to check the values after creating the OpenGL context, since the values obtained can differ from the requested ones.

Function parameters

attr

an SDL_GLAttr
enum value specifying the OpenGL attribute to set.

value

the desired value for the attribute.

Return value

Returns true on success or false on failure; call

SDL_GetError () for more information.

Thread safety

This function should only be called on the main thread.

Releases

12 releases since Debian 3.0 (Woody); the text changed 2 times.

  1. 3.0–5.0
  2. 6.0–12
  3. 13

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.