Skip to content

Commit 01c2c9f

Browse files
authored
Merge pull request #10565 from markdibarry/parallax2d-getting-started
Add Getting Started for Parallax2D
2 parents 4e0d941 + 692efa2 commit 01c2c9f

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

tutorials/2d/2d_parallax.rst

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,19 @@ up though, so this page provides in-depth descriptions of some properties and ho
1616
recommended to use over the :ref:`ParallaxLayer<class_parallaxlayer>` and
1717
:ref:`ParallaxBackground<class_parallaxbackground>` nodes.
1818

19+
Getting started
20+
---------------
21+
22+
The parallax node supports adding nodes that render things as children, so you can use one or many nodes to make up each
23+
layer. To begin, place each node or nodes you want to have scroll independently as a child of their own parallax node.
24+
Make sure that the top left of the textures used are at the ``(0, 0)`` crossing, like in the image below. See the section
25+
on :ref:`positioning <doc_2d_parallax_positioning>` for why this is important.
26+
27+
.. image:: img/2d_parallax_size_viewport.webp
28+
29+
The scene above uses one prepared texture for the higher clouds in a :ref:`Sprite2D <class_sprite2d>`, but you could
30+
just as easily use multiple nodes spaced out to compose the layer.
31+
1932
Scroll scale
2033
------------
2134

@@ -25,8 +38,6 @@ A value of 1 makes the parallax node scroll at the same speed as the camera. If
2538
when scrolling, use a value lower than 1, with 0 bringing it to a complete stop. If you want something to appear closer
2639
to the camera, use a value higher than 1, making it scroll faster.
2740

28-
.. image:: img/2d_parallax_size_viewport.webp
29-
3041
The scene above is comprised of five layers. Some good :ref:`scroll_scale <class_parallax2d_property_scroll_scale>`
3142
values might be:
3243

@@ -119,6 +130,8 @@ Below, you can see that repeating the image twice makes it large enough to cover
119130

120131
.. image:: img/2d_parallax_size_repeat.webp
121132

133+
.. _doc_2d_parallax_positioning:
134+
122135
Poor positioning
123136
~~~~~~~~~~~~~~~~
124137

45.1 KB
Loading

0 commit comments

Comments
 (0)