processing / processing/processing-website
Fix Inaccuracies in `noise()` Documentation Regarding Perlin Noise vs Value Noise
Personne n'a encore pris cette issue.
- Langage dominant
- MDX
- Étoiles
- 90
- Forks
- 122
- Merge moyen
- 1 h 43 min
- PR mergées (30 j)
- 3
Description
Select the type of content error.
Factual Mistake
Section
Reference
Location of the error
https://processing.org/reference/noise_.html
Describe the error
This issue is a follow-up to this comment in the p5.js repository.
The current noise() documentation states in multiple places that the function implements Perlin noise. However, this is inaccurate. Processing actually uses a form of value noise, originally ported by Karsten Schmidt from the demo "Art" by the German demoscene group Farbrausch.
This issue was discussed back in 2014, and as a result, the following line was added to the documentation:
There have been debates over the accuracy of the implementation of noise in Processing. For clarification, it's an implementation of "classic Perlin noise" from 1983, and not the newer "simplex noise" method from 2001.
However, this addition did not address the actual inaccuracy, which is that Processing's implementation uses value noise, not Perlin noise. In fact, it reinforces the prior misleading statements.
Suggested correction
I suggest editing the inline JavaDoc in PApplet.java here to add something like the following.
The noise() function is similar to "Perlin noise," a popular technique for for generating smooth, random-like patterns, invented by Ken Perlin while animating the original Tron film in the 1980s. Note that noise() is not an exact implementation of Perlin noise, but belongs to a category called "value noise." which has slightly different properties.
The rest of the documentation page could be similarly edited to focus more on practical use, possibly taking inspiration from the p5.js version.
Related discussions
In processing/processing: Real Perlin noise would be nice #2549
In processing/processing-docs: Perlin noise documentation #51
In processing/processing-web-archive: Perlin noise documentation #423
In processing/p5.js: Code improvements of the Perlin noise generator. #875
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par le JavaDoc intégré de noise() dans core/src/processing/core/PApplet.java à l’emplacement indiqué par le lien, puis examinez la page de référence de noise() sur processing.org/reference/noise_.html ainsi que la référence p5.js liée. Mettez à jour les descriptions inexactes du bruit de Perlin afin de le distinguer du value noise, et assurez-vous que le texte de la page associée reflète l’explication corrigée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- java
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100