Add documentation

This commit is contained in:
litter 2019-11-10 12:09:03 -05:00
parent f0569d8ef1
commit ef2352f667
3 changed files with 16 additions and 2 deletions

View File

@ -6,7 +6,7 @@ url = https://github.com/sixteenmillimeter/SoundtrackOptical
categories = "Animation,Sound,Video & Vision"
sentence = Framework for generating 16mm optical soundtracks from a digital audio file.
paragraph = Create optical soundtracks in different styles to be used in super16 film-out
version = 2
prettyVersion = 0.02a
version = 3
prettyVersion = 0.03a
minRevision = 2
#maxRevision = 2

Binary file not shown.

View File

@ -89,10 +89,24 @@ public class SoundtrackOptical {
}
}
/**
* Calls frame() every frame of parent PApplet draw()
*
* @param X {Integer} Left position of soundtrack to draw on parent renderer
* @param Y {Integer} Top position
*/
public void draw (int X, int Y) {
frame(X, Y, parent.frameCount);
}
/**
* Draws a frame on parent PApplet window at position
*
* @param X {Integer} Left position of soundtrack to draw on parent renderer
* @param Y {Integer} Top position
* @param frameNumber {Integer} Frame of soundtrack to draw
*/
@SuppressWarnings("static-access")
public void frame(int X, int Y, int frameNumber) {
if (frameNumber != -1) {