SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_GetDisplayBounds

Get the desktop area represented by a display.

Header File

Defined in <SDL3/SDL_video.h>

Syntax

int SDL_GetDisplayBounds(SDL_DisplayID displayID, SDL_Rect *rect);

Function Parameters

displayID the instance ID of the display to query
rect the SDL_Rect structure filled in with the display bounds

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

The primary display is always located at (0,0).

Version

This function is available since SDL 3.0.0.

Code Examples

SDL_Rect r;
if (SDL_GetDisplayBounds(0, &r) != 0) {
    SDL_Log("SDL_GetDisplayBounds failed: %s", SDL_GetError());
    return 1;
}

See Also


CategoryAPI, CategoryAPIFunction, CategoryVideo


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.