Project

General

Profile

« Previous | Next » 

Revision faa3ff56

Added by Leszek Koltunski almost 7 years ago

Javadoc.

View differences:

src/main/java/org/distorted/library/main/DistortedEffects.java
45 45

  
46 46
///////////////////////////////////////////////////////////////////////////////////////////////////
47 47
/**
48
 * Class containing Matrix,Vertex and Fragment effect queues. Postprocessing queue is held in a separate
49
 * class.
48
 * Class containing Matrix, Vertex, Fragment and Postprocessing effect queues.
50 49
 * <p>
51
 * The queues hold actual effects to be applied to a given (DistortedTexture,MeshObject) combo.
50
 * The queues hold actual effects to be applied to a given (InputSurface,MeshObject) combo.
52 51
 */
53 52
public class DistortedEffects implements DistortedSlave
54 53
  {
......
477 476
///////////////////////////////////////////////////////////////////////////////////////////////////
478 477
/**
479 478
 * Adds the calling class to the list of Listeners that get notified each time some event happens 
480
 * to one of the Effects in those queues. Nothing will happen if 'el' is already in the list.
479
 * to one of the Effects in our queues. Nothing will happen if 'el' is already in the list.
481 480
 * 
482 481
 * @param el A class implementing the EffectListener interface that wants to get notifications.
483 482
 */
......
492 491

  
493 492
///////////////////////////////////////////////////////////////////////////////////////////////////
494 493
/**
495
 * Removes the calling class from the list of Listeners.
494
 * Removes the calling class from the list of Listeners that get notified if something happens to Effects in our queue.
496 495
 * 
497 496
 * @param el A class implementing the EffectListener interface that no longer wants to get notifications.
498 497
 */
......
536 535

  
537 536
///////////////////////////////////////////////////////////////////////////////////////////////////
538 537
/**
539
 * Aborts all Effect by its ID.
538
 * Aborts an Effect by its ID.
540 539
 *
541 540
 * @param id the Id of the Effect to be removed, as returned by getID().
542 541
 * @return Number of effects aborted.
......
593 592

  
594 593
///////////////////////////////////////////////////////////////////////////////////////////////////
595 594
/**
596
 * Returns the maximum number of effects of a given type.
595
 * Returns the maximum number of effects of a given type that can be simultaneously applied to a
596
 * single (InputSurface,MeshObject) combo.
597 597
 *
598 598
 * @param type {@link EffectType}
599 599
 * @return The maximum number of effects of a given type.

Also available in: Unified diff