summaryrefslogtreecommitdiffhomepage
path: root/src/easings.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/easings.h')
-rw-r--r--src/easings.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/easings.h b/src/easings.h
index a198be4d..a8178f4a 100644
--- a/src/easings.h
+++ b/src/easings.h
@@ -7,6 +7,23 @@
* This header uses:
* #define EASINGS_STATIC_INLINE // Inlines all functions code, so it runs faster.
* // This requires lots of memory on system.
+* How to use:
+* The four inputs t,b,c,d are defined as follows:
+* t = current time in milliseconds
+* b = starting position in only one dimension [X || Y || Z] your choice
+* c = the total change in value of b that needs to occur
+* d = total time it should take to complete
+*
+* Example:
+* float speed = 1.f;
+* float currentTime = 0.f;
+* float currentPos[2] = {0,0};
+* float finalPos[2] = {1,1};
+* float startPosition[2] = currentPos;//x,y positions
+* while(currentPos[0] < finalPos[0])
+* currentPos[0] = EaseSineIn(currentTime, startPosition[0], startPosition[0]-finalPos[0], speed);
+* currentPos[1] = EaseSineIn(currentTime, startPosition[1], startPosition[1]-finalPos[0], speed);
+* currentTime += diffTime();
*
* A port of Robert Penner's easing equations to C (http://robertpenner.com/easing/)
*