Skip to content

Commit efc00c7

Browse files
YYBartTYYBartT
committed
docs(general): "Clear Display Buffer" is not working
YoYoGames/GameMaker-Bugs#7456 Small changes to window_get_colour() & window_set_colour() manual pages
1 parent 4ddc1df commit efc00c7

File tree

2 files changed

+29
-27
lines changed

2 files changed

+29
-27
lines changed

‎Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/The_Game_Window/window_get_colour.htm

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
66
<title>window_get_colour</title>
7-
<meta name="generator" content="Adobe RoboHelp 2020" />
7+
<meta name="generator" content="Adobe RoboHelp 2022" />
88
<link rel="stylesheet" href="../../../../assets/css/default.css" type="text/css" />
99
<script src="../../../../assets/scripts/main_script.js" type="module"></script>
1010
<meta name="rh-authors" content="Mark Alexander" />
@@ -15,33 +15,33 @@
1515
</head>
1616
<body>
1717
<!--<div class="body-scroll" style="top: 150px;">-->
18-
<h1>window_get_colour</h1>
19-
<p>This function returns the background colour of the game window. This colour represents that which will be used for those areas of the game window that are not occupied by any views. The following image illustrates this:</p>
20-
<p><img alt="Windfow colour illustration" class="center" src="../../../../assets/Images/Scripting_Reference/GML/Reference/Cameras_Display/window_set_colour.png" />The above image has two views with two view ports, each one drawn at different positions. This stretches the game window to accommodate both ports and uses the window colour to colour the background where no view is shown.</p>
18+
<h1><span data-field="title" data-format="default">window_get_colour</span></h1>
19+
<p>This function returns the background colour of the game window.</p>
20+
<p>This colour represents that which will be used for those areas of the game window that are not occupied by any views. The following image illustrates this:</p>
21+
<p><img alt="Windfow colour illustration" class="center" src="../../../../assets/Images/Scripting_Reference/GML/Reference/Cameras_Display/window_set_colour.png" />The above image has two views with two view ports, each one drawn at a different position. This stretches the game window to accommodate both ports and uses the window colour to colour the background where no view is shown.</p>
2122
<p> </p>
2223
<h4>Syntax:</h4>
23-
<p class="code">window_get_colour();</p>
24+
<p class="code"><span data-field="title" data-format="default">window_get_colour</span>();</p>
2425
<p> </p>
2526
<h4>Returns:</h4>
26-
<p class="code"><span data-keyref="Type_Constant_Colour">Colour Constant</span></p>
27+
<p class="code"><span data-keyref="Type_Constant_Colour"><a href="../../Drawing/Colour_And_Alpha/Colour_And_Alpha.htm" target="_blank">Colour</a></span></p>
2728
<p> </p>
2829
<h4>Example:</h4>
29-
<p class="code">if (window_get_colour() != c_black) <br />
30+
<p class="code">if (window_get_colour() != c_black)<br />
3031
{<br />
3132
    window_set_colour(c_black);<br />
3233
}</p>
3334
<p>The above code will check the window colour to see if it is set as black or not, and if it is not it sets it to black.</p>
3435
<p> </p>
3536
<p> </p>
36-
<p> </p>
3737
<div class="footer">
3838
<div class="buttons">
3939
<div class="clear">
40-
<div style="float:left">Back: <a href="../The_Game_Window/The_Game_Window.htm">The Game Window</a></div>
41-
<div style="float:right">Next: <a href="../The_Game_Window/window_get_fullscreen.htm">window_get_fullscreen</a></div>
40+
<div style="float:left">Back: <a data-xref="{title}" href="The_Game_Window.htm">The Game Window</a></div>
41+
<div style="float:right">Next: <a data-xref="{title}" href="window_get_fullscreen.htm">window_get_fullscreen</a></div>
4242
</div>
4343
</div>
44-
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2022 All Rights Reserved</span></h5>
44+
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5>
4545
</div>
4646
<!-- KEYWORDS
4747
window_get_colour

‎Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/The_Game_Window/window_set_colour.htm

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
66
<title>window_set_colour</title>
7-
<meta name="generator" content="Adobe RoboHelp 2020" />
7+
<meta name="generator" content="Adobe RoboHelp 2022" />
88
<link rel="stylesheet" href="../../../../assets/css/default.css" type="text/css" />
99
<script src="../../../../assets/scripts/main_script.js" type="module"></script>
1010
<meta name="rh-authors" content="Mark Alexander" />
@@ -14,45 +14,47 @@
1414
</head>
1515
<body>
1616
<!--<div class="body-scroll" style="top: 150px;">-->
17-
<h1>window_set_colour</h1>
18-
<p>This function can set the background colour of the game window. This colour represents that which will be used for those areas of the game window that are not occupied by any views. The following image illustrates this:</p>
19-
<p><img alt="Window colour example" class="center" src="../../../../assets/Images/Scripting_Reference/GML/Reference/Cameras_Display/window_set_colour.png" />The above image has two views with two view ports, each one drawn at different positions. This stretches the game window to accommodate both ports and uses the window colour to colour the background where no view is shown.</p>
17+
<h1><span data-field="title" data-format="default">window_set_colour</span></h1>
18+
<p>This function sets the background colour of the game window.</p>
19+
<p>This colour represents that which will be used for those areas of the game window that are not occupied by any views. The following image illustrates this:</p>
20+
<p><img alt="Window colour example" class="center" src="../../../../assets/Images/Scripting_Reference/GML/Reference/Cameras_Display/window_set_colour.png" />The above image has two views with two view ports, each one drawn at a different position. This stretches the game window to accommodate both ports and uses the window colour to colour the background where no view is shown.</p>
2021
<p> </p>
2122
<h4>Syntax:</h4>
22-
<p class="code">window_set_colour(colour);</p>
23+
<p class="code"><span data-field="title" data-format="default">window_set_colour</span>(colour);</p>
2324
<table>
2425
<tbody>
2526
<tr>
26-
<th>Argument</th><th>Type</th>
27+
<th>Argument</th>
28+
<th>Type</th>
2729
<th>Description</th>
28-
</tr>
30+
</tr>
2931
<tr>
30-
<td>colour</td><td><span data-keyref="Type_Constant_Colour"></span></td>
32+
<td>colour</td>
33+
<td><span data-keyref="Type_Constant_Colour"><a href="../../Drawing/Colour_And_Alpha/Colour_And_Alpha.htm" target="_blank">Colour</a></span></td>
3134
<td>The colour to set the region.</td>
32-
</tr>
35+
</tr>
3336
</tbody>
3437
</table>
3538
<p> </p>
3639
<h4>Returns:</h4>
37-
<p class="code"><span data-keyref="Type_Void"></span></p>
40+
<p class="code"><span data-keyref="Type_Void">N/A</span></p>
3841
<p> </p>
3942
<h4>Example:</h4>
40-
<p class="code">if (window_get_colour() != c_black) <br />
43+
<p class="code">if (window_get_colour() != c_black)<br />
4144
{<br />
42-
    window_set_colour(c_black);<br />
45+
    <span data-field="title" data-format="default">window_set_colour</span>(c_black);<br />
4346
}</p>
4447
<p>The above code will check the window colour to see if it is set as black or not, and if it is not it sets it to black.</p>
4548
<p> </p>
4649
<p> </p>
47-
<p> </p>
4850
<div class="footer">
4951
<div class="buttons">
5052
<div class="clear">
51-
<div style="float:left">Back: <a href="../The_Game_Window/The_Game_Window.htm">The Game Window</a></div>
52-
<div style="float:right">Next: <a href="../The_Game_Window/window_set_fullscreen.htm">window_set_fullscreen</a></div>
53+
<div style="float:left">Back: <a data-xref="{title}" href="The_Game_Window.htm">The Game Window</a></div>
54+
<div style="float:right">Next: <a data-xref="{title}" href="window_set_fullscreen.htm">window_set_fullscreen</a></div>
5355
</div>
5456
</div>
55-
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2021 All Rights Reserved</span></h5>
57+
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5>
5658
</div>
5759
<!-- KEYWORDS
5860
window_set_colour

0 commit comments

Comments
 (0)