Legacy:GetClippingRectangle - Revision history

Apollolux: added navbox

2013-06-04T21:05:58Z

added navbox

Apollolux: /* Usage */ ClippingRectangle

2013-06-04T05:58:02Z

‎Usage: ClippingRectangle

Radnen: updated description

2013-06-04T00:09:27Z

updated description

Radnen: Created initial page

2013-06-04T00:01:11Z

Created initial page

New page

[[Category:Functions]]

Causes the back buffer to be displayed to the screen for one time frame.

==Usage==

{{Usage|returns=Rectangle|func=GetClippingRectangle}}

==Notes==

The returned clipping rectangle has the 4 properties, x, y, width, and height.

==Examples==

Get the clipping rectangle (whatever it was) and print it to screen.

<syntaxhighlight>

var clip = GetClippingRectangle();
var f = GetSystemFont();

var x = clip.x;
var y = clip.y;
var w = clip.width;
var h = clip.height;

while (!IsKeyPressed(KEY_ESCAPE)) {
f.drawText(0, 0, "x: " + x + " y: " + y + " w: " + w + " h: " + h);
FlipScreen();
}

</syntaxhighlight>

==See also==

* [[API:SetClippingRectangle|SetClippingRectangle]](x, y, w, h)
* [[API:IsKeyPressed|IsKeyPressed]]()
* [[API:font/drawText|font.drawText]](x, y, text)
* [[API:FlipScreen|FlipScreen]]()

@@ Line 1: / Line 1: @@
 Grabs the clipping rectangle as an object with 4 properties: x, y, width, and height.
@@ Line 39: / Line 37: @@
 *	[[API:font/drawText|font.drawText]](x, y, text)
 *	[[API:FlipScreen|FlipScreen]]()

@@ Line 5: / Line 5: @@
 ==Usage==
-{{Usage|returns=Rectangle|func=GetClippingRectangle}}
+{{Usage|returns=[[API:ClippingRectangle|ClippingRectangle]]|func=GetClippingRectangle}}
 ==Notes==