Skip to content

Commit 5c6f5b5

Browse files
committed
Enhance documentation for textOutput() and gridOutput() methods, detailing known limitations and alternatives for accessible canvas descriptions.
1 parent d7f7fd4 commit 5c6f5b5

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

src/accessibility/outputs.js

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,20 @@ import p5 from '../core/main';
3737
* <a href="https://p5js.org/tutorials/writing-accessible-canvas-descriptions/">Writing accessible canvas descriptions</a>
3838
* to learn more about making sketches accessible.
3939
*
40+
* `textOutput()` has several known limitations. Descriptions are only
41+
* generated in English. Text drawn with <a href="#/p5/text">text()</a> is
42+
* not described. `textOutput()` does not work with WEBGL mode or 3D shapes.
43+
* 2D primitives rendered in WEBGL may be described incorrectly because the
44+
* camera's perspective is not accounted for. Shapes with similar features may
45+
* be combined in descriptions, resulting in inaccurate counts. Shapes
46+
* positioned outside the canvas boundaries are described as though they're
47+
* visible. Custom 2D shapes created with
48+
* <a href="#/p5/beginShape">beginShape()</a> are not described.
49+
*
50+
* <a href="#/p5/describe">describe()</a> and
51+
* <a href="#/p5/describeElement">describeElement()</a> provide more accurate
52+
* and flexible alternatives for writing canvas descriptions.
53+
*
4054
* @method textOutput
4155
* @param {Constant} [display] either FALLBACK or LABEL.
4256
*
@@ -172,6 +186,20 @@ p5.prototype.textOutput = function(display) {
172186
* <a href="https://p5js.org/tutorials/writing-accessible-canvas-descriptions/">Writing accessible canvas descriptions</a>
173187
* to learn more about making sketches accessible.
174188
*
189+
* `gridOutput()` has several known limitations. Descriptions are only
190+
* generated in English. Text drawn with <a href="#/p5/text">text()</a> is
191+
* not described. `gridOutput()` does not work with WEBGL mode or 3D shapes.
192+
* 2D primitives rendered in WEBGL may be described incorrectly because the
193+
* camera's perspective is not accounted for. Shapes with similar features may
194+
* be combined in descriptions, resulting in inaccurate counts. Shapes
195+
* positioned outside the canvas boundaries are described as though they're
196+
* visible. Custom 2D shapes created with
197+
* <a href="#/p5/beginShape">beginShape()</a> are not described.
198+
*
199+
* <a href="#/p5/describe">describe()</a> and
200+
* <a href="#/p5/describeElement">describeElement()</a> provide more accurate
201+
* and flexible alternatives for writing canvas descriptions.
202+
*
175203
* @method gridOutput
176204
* @param {Constant} [display] either FALLBACK or LABEL.
177205
*

0 commit comments

Comments
 (0)