1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
Getting started
===============
These bindings are easy to apprehend and learn if you come from the C++
library; class, methods and functions names are the same. We'll see here
step by step everything you need to know to get started with pySFML!
Of course, you need first to have pySFML downloaded and installed on
your computer. To do that, read the :doc:`download </download>` section, it
provides all explanations you'll need to install on your favourite platform.
At worst, you'll need to compile.
After reading this you can jump to the single :ref:`tutorials-reference` that
summarizes all the large, potentially surprising, changes that you
should be aware of. You'll be able to start coding serious project with
the documentation at hand.
Diving In
---------
.. note::
On Windows, typing these commands directly in a console might cause the
console to freeze, in which case it is better to save the lines of code
(without the '>>>' prompt) to a file to run later.
Open a terminal and run the Python interpreter. Now we can experiment::
>>> import sfml as sf
>>> w = sf.RenderWindow(sf.VideoMode(640, 480), "My first pySFML Window - or not ?")
>>> w.clear(sf.Color.BLUE)
>>> w.display()
>>> w.size = (800, 600)
>>> w.clear(sf.Color.GREEN)
>>> w.display()
>>> w.title = "Yes, it's my first PySFML Window"
>>> w.display()
>>> w.capture().show()
>>> w.close()
>>> exit()
Short Example
-------------
As a start, let's compare the python short example with the C++ one.
Here it is:
.. code-block:: python
:linenos:
import sfml as sf
# create the main window
window = sf.RenderWindow(sf.VideoMode(640, 480), "pySFML Window")
try:
# load a sprite to display
texture = sf.Texture.from_file("cute_image.png")
sprite = sf.Sprite(texture)
# create some graphical text to display
font = sf.Font.from_file("arial.ttf")
text = sf.Text("Hello SFML", font, 50)
# load music to play
music = sf.Music.from_file("nice_music.ogg")
except IOError: exit(1)
# play the music
music.play()
# start the game loop
while window.is_open:
# process events
for event in window.events:
# close window: exit
if type(event) is sf.CloseEvent:
window.close()
window.clear() # clear screen
window.draw(sprite) # draw the sprite
window.draw(text) # draw the string
window.display() # update the window
First, you can notice the interface is not far different from the
original and remains quite the same; the interface has been pythonized.
Importing
^^^^^^^^^
In practise, you import the whole library a single namespace **sf**.
Doing so imports the five sub-module in one shot (sfml.system, sfml.window,
sfml.graphics, sfml.audio and sfml.network).
.. code-block:: python
import sfml as sf
sf.sleep(sf.seconds(5))
Function and classes can be plainly specified.
.. code-block:: python
import sfml
sfml.system.sleep(sfml.system.seconds(5))
Window Creation
^^^^^^^^^^^^^^^
There's no difference here. if you want to give a style:
.. code-block:: python
window = sf.RenderWindow(sf.VideoMode(640, 480), "pySFML Window", sf.Style.TITLEBAR | sf.Style.RESIZE)
Loading Resources
^^^^^^^^^^^^^^^^^
Instead of checking everytime if the resource has effectivly been loaded,
pySFML takes advantages of the Python mechanisms. Just enclose
your resource loading processes in a try-except bloc and Python will tell
you when something goes wrong.
As you can see in the code, it will trigger an exception :exc:`IOError` in
accordance with the Python's exception rules.
To follow the same convention as the standard Python library and so,
offer a better integration, `openFromFile` and `loadFromFile` have been
renamed into `from_file`.
Event Handling
^^^^^^^^^^^^^^
To iterate over the pending events, use the generator that Window.events
return. It's similar to the polling event process.
.. code-block:: python
for event in window.events:
print(event)
.. note::
:meth:`sfml.window.Window.poll_event` and :meth:`sfml.window.Window.wait_event` do exist.
Once you get an event you need to process it. To do that, you need to
check its type as you would do in C++. pysfml2 doesn't provides
the attribute **type** that tells you what event it is (keyboard event,
mouse event, mouse move event, etc). Therefore you need to use the
built-in function :func:`type` to determine its type.
.. code-block:: python
if type(event) is sf.CloseEvent:
window.close()
You can get a list of the event class in the documentation, section
window, as event handling is located in the window module ;).
Updating the Screen
^^^^^^^^^^^^^^^^^^^
Don't forget to clear, draw and update the screen.
.. code-block:: python
window.clear() # clear screen
window.draw(sprite) # draw the sprite
window.draw(text) # draw the string
window.display() # update the window
Vectors
-------
As Python is not a typed language, you don't have to care about the
type when you use sf::Vector<T>. Python just needs to know if it's a
two or three dimensional vector, after, you can store any numeric type
inside.
.. code-block:: python
vector2 = sf.Vector2()
vector2.x = 5
vector2.y = 1.16
vector3 = sf.Vector3()
vector3.x = Decimal(0.333333333)
x, y, z = vector3 # you can unpack the vector
|
