Skip to content

Commit

Permalink
Sync SDL3 header -> wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
SDLWikiBot committed Jun 23, 2024
1 parent e941cac commit c3205eb
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions SDL3/SDL_HINT_MOUSE_RELATIVE_CLIP_INTERVAL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
###### (This is the documentation for SDL3, which is under heavy development and the API is changing! [SDL2](https://wiki.libsdl.org/SDL2/) is the current stable version!)
# SDL_HINT_MOUSE_RELATIVE_CLIP_INTERVAL

Controls how often SDL issues cursor confinement commands to the operating system while relative mode is active, in case the desired confinement state became out-of-sync due to interference from other running programs.

## Header File

Defined in [<SDL3/SDL_hints.h>](https://github.com/libsdl-org/SDL/blob/main/include/SDL3/SDL_hints.h)

## Syntax

```c
#define SDL_HINT_MOUSE_RELATIVE_CLIP_INTERVAL "SDL_MOUSE_RELATIVE_CLIP_INTERVAL"
```
## Remarks
The variable can be integers representing miliseconds between each refresh.
A value of zero means SDL will not automatically refresh the confinement.
The default value varies depending on the operating system, this variable
might not have any effects on inapplicable platforms such as those without
a cursor.
----
[CategoryAPI](CategoryAPI), [CategoryAPIMacro](CategoryAPIMacro), [CategoryHints](CategoryHints)

0 comments on commit c3205eb

Please sign in to comment.