Skip to content

[sdl] Add window_options documentation #4976

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 18, 2025
Merged

[sdl] Add window_options documentation #4976

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3f95e43
Update sdl.rst
Hannah-GBS Jun 3, 2025
8940ad2
Merge branch 'next' into sdl-options
nagyrobi Jun 3, 2025
9fcfb61
Add resizable
Hannah-GBS Jun 4, 2025
5194de0
Merge branch 'next' into sdl-options
Hannah-GBS Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion components/display/sdl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,16 @@ Configuration variables:
- **sdl_options** (*Optional*, string): Build arguments if required to specify include or library paths. Should not be required if SDL2 is properly installed.
- **pages** (*Optional*, list): Show pages instead of a single lambda. See :ref:`display-pages`.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.

- **window_options** (*Optional*): Options that affect how the display renders on the host system. All default to false, except position, which defaults to SDL's undefined position

- **position** (*Optional*):
- **x** (**Required**, int): X position of the display window in pixels
- **y** (**Required**, int): Y position of the display window in pixels
- **borderless** (*Optional*, boolean): Whether to draw the display window with or without borders
- **always_on_top** (*Optional*, boolean): Whether to always draw the display window above other windows or not
- **fullscreen** (*Optional*, boolean): Whether to draw the display window in fullscreen or not. This may resize the resolution of the host display to match the SDL display dimensions
- **skip_taskbar** (*Optional*, boolean): Whether to skip adding a taskbar icon for the display window or not
- **resizable** (*Optional*, boolean): Whether the display window can be manually resized

.. note::

Expand Down