table of contents
- experimental 3.1.0+ds-1
SDL_SetWindowPosition(3) | SDL3 FUNCTIONS | SDL_SetWindowPosition(3) |
NAME¶
SDL_SetWindowPosition - Request that the window's position be set.
SYNOPSIS¶
#include "SDL3/SDL.h"
int SDL_SetWindowPosition(SDL_Window *window, int x, int y);
DESCRIPTION¶
If, at the time of this request, the window is in a fixed-size state such as maximized, this request may be deferred until the window returns to a resizable state.
This can be used to reposition fullscreen-desktop windows onto a different display, however, exclusive fullscreen windows are locked to a specific display and can only be repositioned programmatically via
SDL_SetWindowFullscreenMode ().
On some windowing systems this request is asynchronous and the new coordinates may not have have been applied immediately upon the return of this function. If an immediate change is required, call
SDL_SyncWindow () to block until the changes have taken effect.
When the window position changes, an
SDL_EVENT_WINDOW_MOVED
event will be emitted with the window's new coordinates. Note that the new
coordinates may not match the exact coordinates requested, as some windowing
systems can restrict the position of the window in certain scenarios (e.g.
constraining the position so the window is always within desktop bounds).
Additionally, as this is just a request, it can be denied by the windowing
system.
FUNCTION PARAMETERS¶
RETURN VALUE¶
Returns 0 on success or a negative error code on failure; call
SDL_GetError () for more information.
AVAILABILITY¶
This function is available since SDL 3.0.0.
SEE ALSO¶
SDL 3.1.0 | SDL |