Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation|Console: Display mode and window manipulation commands
Added documentation for commands related to display modes and window manipulation.
- Loading branch information
Showing
9 changed files
with
101 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
@summary{ | ||
Center the window on the desktop when in windowed mode. | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
@summary{ | ||
Print information about the current display mode and window state. | ||
} | ||
@description{ | ||
@seealso | ||
@list{ | ||
@item @cmd{listdisplaymodes} | ||
@item @cmd{setres} | ||
@item @cmd{setfullres} | ||
@item @cmd{setwinres} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
@summary{ | ||
List all display modes supported by the graphics hardware. | ||
} | ||
@description{ | ||
@seealso | ||
@list{ | ||
@item @cmd{displaymode} | ||
@item @cmd{setres} | ||
@item @cmd{setfullres} | ||
@item @cmd{setwinres} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
@summary{ | ||
Change to fullscreen mode using the specified resolution. | ||
} | ||
@description{ | ||
@usage | ||
@ident{setfullres} @help_arg{width} @help_arg{height} | ||
|
||
@seealso | ||
@list{ | ||
@item @cmd{listdisplaymodes} | ||
@item @cmd{setwinres} | ||
@item @cmd{setres} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,21 @@ | ||
@summary{ | ||
Change video mode resolution or window size. | ||
Change display mode resolution or window size. | ||
} | ||
@description{ | ||
Params: setres (width) (height) @cbr For example, 'setres 1024 768'. | ||
@usage | ||
@ident{setres} @help_arg{width} @help_arg{height} | ||
|
||
The window retains its current mode, adjusting the display mode if in | ||
fullscreen and the window size if in a windowed mode. | ||
|
||
@examples | ||
Change resolution to 1024 x 768: | ||
@code{setres 1024 768} | ||
|
||
@seealso | ||
@list{ | ||
@item listdisplaymodes | ||
@item setfullres | ||
@item setwinres | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
@summary{ | ||
Set window size and change to windowed mode. | ||
} | ||
@description{ | ||
@usage | ||
@ident{setwinres} @help_arg{width} @help_arg{height} | ||
|
||
@seealso | ||
@list{ | ||
@item @cmd{setfullres} | ||
@item @cmd{setres} | ||
@item @cmd{listdisplaymodes} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
@summary{ | ||
Toggle between fullscreen and windowed video modes. | ||
Toggle between fullscreen and windowed modes. | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
@summary{ | ||
Toggle between maximized and normal window modes. | ||
} |