Game Python Reference Manual.
[blender.git] / source / gameengine / PyDoc / Rasterizer.py
1 """
2 Documentation for the Rasterizer module.
3
4 Usage:
5 import Rasterizer
6 """
7
8 def getWindowWidth():
9         """
10         Gets the width of the window (in pixels)
11         
12         @rtype: integer
13         """
14 def getWindowHeight():
15         """
16         Gets the height of the window (in pixels)
17         
18         @rtype: integer
19         """
20 def makeScreenshot(filename):
21         """
22         Writes a screenshot to the given filename.
23         
24         @type filename: string
25         """
26
27 def enableVisibility(visible):
28         """
29         Doesn't really do anything...
30         """
31
32 def showMouse(visible):
33         """
34         Enables or disables the operating system mouse cursor.
35         
36         @type visible: boolean
37         """
38
39 def setMousePosition(x, y):
40         """
41         Sets the mouse cursor position.
42         
43         @type x, y: integer
44         """
45
46 def setBackgroundColor(rgba):
47         """
48         Sets the window background colour.
49         
50         @type rgba: list [r, g, b, a]
51         """
52
53 def setMistColor(rgb):
54         """
55         Sets the mist colour.
56         
57         @type rgb: list [r, g, b]
58         """
59
60 def setMistStart(start):
61         """
62         Sets the mist start value.  Objects further away than start will have mist applied to them.
63         
64         @type start: float
65         """
66
67 def setMistEnd(end):
68         """
69         Sets the mist end value.  Objects further away from this will be coloured solid with
70         the colour set by setMistColor().
71         
72         @type end: float
73         """
74