Skip to content

Commit 897fe66

Browse files
committed
update readme and remove useless point typedef
1 parent eed6846 commit 897fe66

File tree

2 files changed

+19
-16
lines changed

2 files changed

+19
-16
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
11
# parallax
2-
This can be used in a constrained parallax background. This could be used for 2d side-scrolling parallax but I haven't tested it yet.
3-
Openfl for now. Could be agnostic later.
4-
5-
# TODO
6-
✅ simple bg scrolling
7-
✅ make it configurable
8-
✅ use xml config
9-
✅ add parallax layer
10-
✅ sample (openfl)
11-
- [ ] zoom
12-
- [ ] agnostic
2+
3+
This can be used in a constrained parallax background. This could be used for 2d infinite side-scrolling parallax but I haven't tested it yet.
4+
There is a sample with openfl that can help use this library in any engine.
5+
6+
# Features
7+
8+
- parallax scrolling constrained by a defined world dimension
9+
- configurable by xml (or code)
10+
- zoom
11+
- sample (openfl)
12+
- agnostic
13+
14+
# Demo
15+
16+
The sample can be tested here (better fullscreen): http://loudoweb.fr/app/parallax/
17+
18+
# known issue
19+
20+
The app is constrained by the world dimension. But it lacks screen dimension constrain. So now the app works better fullscreen. (A fix is coming).

parallax/Parallax.hx

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,6 @@ import haxe.ds.WeakMap;
33
import haxe.xml.Access;
44
using parallax.ParallaxHelper;
55

6-
#if openfl
7-
typedef Point = openfl.geom.Point;
8-
#else
9-
typedef Point = { x:Float, y:Float};
10-
#end
116
/**
127
* ...
138
* @author Ludovic Bas - www.lugludum.com

0 commit comments

Comments
 (0)