Navigation Menu

Skip to content

Commit

Permalink
Documentation|Console: Display mode and window manipulation commands
Browse files Browse the repository at this point in the history
Added documentation for commands related to display modes and window
manipulation.
  • Loading branch information
skyjake committed Apr 7, 2013
1 parent b77c285 commit be73613
Show file tree
Hide file tree
Showing 9 changed files with 101 additions and 6 deletions.
28 changes: 25 additions & 3 deletions doomsday/client/data/cphelp.txt
Expand Up @@ -71,6 +71,9 @@ desc = Write the current lights to a DED file.
[blunlock]
desc = Unlock current/specified light.

[centerwindow]
desc = Center the window on the desktop when in windowed mode.

[chat]
desc = Broadcast a chat message.

Expand Down Expand Up @@ -120,6 +123,10 @@ inf = Params: demolump (demofile) (lumpfile)\nFor example, 'demolump demo1.dmo D
desc = Print contents of directories.
inf = Params: dir (dirs) ...\nFor example, 'dir data/'.\nVirtual files are listed, too.\nPaths are relative to the base path.

[displaymode]
desc = Print information about the current display mode and window state.
inf = SEE ALSO:\n- 'listdisplaymodes'\n- 'setres'\n- 'setfullres'\n- 'setwinres'\n

[dump]
desc = Dump a data lump currently loaded in memory.
inf = Params: dump (name)\nFor example, 'dump PLAYPAL'.
Expand Down Expand Up @@ -188,6 +195,10 @@ desc = List all console commands.
[listcontrols]
desc = List the names of all player controls.

[listdisplaymodes]
desc = List all display modes supported by the graphics hardware.
inf = SEE ALSO:\n- 'displaymode'\n- 'setres'\n- 'setfullres'\n- 'setwinres'\n

[listfiles]
desc = List all loaded resource files.

Expand Down Expand Up @@ -303,13 +314,17 @@ inf = Params: setbpp (bits)\nFor example, 'setbpp 32'.
desc = Set console and viewplayer.
inf = Params: setcon (playernum)\nFor example, 'setcon 1'.

[setfullres]
desc = Change to fullscreen mode using the specified resolution.
inf = USAGE:\nsetfullres (width) (height)\nSEE ALSO:\n- 'listdisplaymodes'\n- 'setwinres'\n- 'setres'\n

[setname]
desc = Set your name.
inf = Params: setname (name)\nFor example, 'setname "my name"'.

[setres]
desc = Change video mode resolution or window size.
inf = Params: setres (width) (height)\nFor example, 'setres 1024 768'.
desc = Change display mode resolution or window size.
inf = USAGE:\nsetres (width) (height)\nThe window retains its current mode, adjusting the display mode if in fullscreen and the window size if in a windowed mode.\nEXAMPLES:\nChange resolution to 1024 x 768: 'setres 1024 768'\nSEE ALSO:\n- listdisplaymodes\n- setfullres\n- setwinres\n

[settics]
desc = Set number of game tics per second (default: 35).
Expand All @@ -318,6 +333,10 @@ inf = Params: settics (tics)\nFor example, 'settics 15'.
[setvidramp]
desc = Update display's hardware gamma ramp.

[setwinres]
desc = Set window size and change to windowed mode.
inf = USAGE:\nsetwinres (width) (height)\nSEE ALSO:\n- 'setfullres'\n- 'setres'\n- 'listdisplaymodes'\n

[stopdemo]
desc = Stop currently playing demo.

Expand All @@ -335,7 +354,10 @@ desc = Toggle the value of a cvar between zero and nonzero.
inf = Params: toggle (cvar)\nFor example, 'toggle rend-light'.

[togglefullscreen]
desc = Toggle between fullscreen and windowed video modes.
desc = Toggle between fullscreen and windowed modes.

[togglemaximized]
desc = Toggle between maximized and normal window modes.

[uicolor]
desc = Change Doomsday user interface colors.
Expand Down
3 changes: 3 additions & 0 deletions doomsday/doc/engine/command/centerwindow.ame
@@ -0,0 +1,3 @@
@summary{
Center the window on the desktop when in windowed mode.
}
12 changes: 12 additions & 0 deletions doomsday/doc/engine/command/displaymode.ame
@@ -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}
}
}
12 changes: 12 additions & 0 deletions doomsday/doc/engine/command/listdisplaymodes.ame
@@ -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}
}
}
14 changes: 14 additions & 0 deletions doomsday/doc/engine/command/setfullres.ame
@@ -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}
}
}
19 changes: 17 additions & 2 deletions doomsday/doc/engine/command/setres.ame
@@ -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
}
}
14 changes: 14 additions & 0 deletions doomsday/doc/engine/command/setwinres.ame
@@ -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}
}
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/togglefullscreen.ame
@@ -1,3 +1,3 @@
@summary{
Toggle between fullscreen and windowed video modes.
Toggle between fullscreen and windowed modes.
}
3 changes: 3 additions & 0 deletions doomsday/doc/engine/command/togglemaximized.ame
@@ -0,0 +1,3 @@
@summary{
Toggle between maximized and normal window modes.
}

0 comments on commit be73613

Please sign in to comment.