Skip to content

Commit ca9d475

Browse files
authored
Merge pull request #8006 from perminder-17/mousejs-fixing
Remove incorrect mouseX/mouseY docs regarding WEBGL mode in dev-2.0 branch.
2 parents e5d4efa + 0988670 commit ca9d475

File tree

1 file changed

+10
-26
lines changed

1 file changed

+10
-26
lines changed

src/events/pointer.js

Lines changed: 10 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -109,14 +109,10 @@ function pointer(p5, fn){
109109
/**
110110
* A `Number` system variable that tracks the mouse's horizontal position.
111111
*
112-
* In 2D mode, `mouseX` keeps track of the mouse's position relative to the
112+
* `mouseX` keeps track of the mouse's position relative to the
113113
* top-left corner of the canvas. For example, if the mouse is 50 pixels from
114114
* the left edge of the canvas, then `mouseX` will be 50.
115115
*
116-
* In WebGL mode, `mouseX` keeps track of the mouse's position relative to the
117-
* center of the canvas. For example, if the mouse is 50 pixels to the right
118-
* of the canvas' center, then `mouseX` will be 50.
119-
*
120116
* If touch is used instead of the mouse, then `mouseX` will hold the
121117
* x-coordinate of the most recent touch point.
122118
*
@@ -157,7 +153,7 @@ function pointer(p5, fn){
157153
* textSize(16);
158154
*
159155
* // Display the mouse's coordinates.
160-
* text(`x: ${mouseX} y: ${mouseY}`, 50, 50);
156+
* text(`x: ${int(mouseX)} y: ${int(mouseY)}`, 50, 50);
161157
* }
162158
* </code>
163159
* </div>
@@ -208,7 +204,7 @@ function pointer(p5, fn){
208204
* fill(0);
209205
*
210206
* // Display the mouse's coordinates.
211-
* text(`x: ${mouseX} y: ${mouseY}`, 0, 0);
207+
* text(`x: ${int(mouseX)} y: ${int(mouseY)}`, 0, 0);
212208
* }
213209
* </code>
214210
* </div>
@@ -218,14 +214,10 @@ function pointer(p5, fn){
218214
/**
219215
* A `Number` system variable that tracks the mouse's vertical position.
220216
*
221-
* In 2D mode, `mouseY` keeps track of the mouse's position relative to the
217+
* `mouseY` keeps track of the mouse's position relative to the
222218
* top-left corner of the canvas. For example, if the mouse is 50 pixels from
223219
* the top edge of the canvas, then `mouseY` will be 50.
224220
*
225-
* In WebGL mode, `mouseY` keeps track of the mouse's position relative to the
226-
* center of the canvas. For example, if the mouse is 50 pixels below the
227-
* canvas' center, then `mouseY` will be 50.
228-
*
229221
* If touch is used instead of the mouse, then `mouseY` will hold the
230222
* y-coordinate of the most recent touch point.
231223
*
@@ -266,7 +258,7 @@ function pointer(p5, fn){
266258
* textSize(16);
267259
*
268260
* // Display the mouse's coordinates.
269-
* text(`x: ${mouseX} y: ${mouseY}`, 50, 50);
261+
* text(`x: ${int(mouseX)} y: ${int(mouseY)}`, 50, 50);
270262
* }
271263
* </code>
272264
* </div>
@@ -317,7 +309,7 @@ function pointer(p5, fn){
317309
* fill(0);
318310
*
319311
* // Display the mouse's coordinates.
320-
* text(`x: ${mouseX} y: ${mouseY}`, 0, 0);
312+
* text(`x: ${int(mouseX)} y: ${int(mouseY)}`, 0, 0);
321313
* }
322314
* </code>
323315
* </div>
@@ -328,16 +320,12 @@ function pointer(p5, fn){
328320
* A `Number` system variable that tracks the mouse's previous horizontal
329321
* position.
330322
*
331-
* In 2D mode, `pmouseX` keeps track of the mouse's position relative to the
323+
* `pmouseX` keeps track of the mouse's position relative to the
332324
* top-left corner of the canvas. Its value is
333325
* <a href="#/p5/mouseX">mouseX</a> from the previous frame. For example, if
334326
* the mouse was 50 pixels from the left edge of the canvas during the last
335327
* frame, then `pmouseX` will be 50.
336328
*
337-
* In WebGL mode, `pmouseX` keeps track of the mouse's position relative to the
338-
* center of the canvas. For example, if the mouse was 50 pixels to the right
339-
* of the canvas' center during the last frame, then `pmouseX` will be 50.
340-
*
341329
* If touch is used instead of the mouse, then `pmouseX` will hold the
342330
* x-coordinate of the last touch point.
343331
*
@@ -397,16 +385,12 @@ function pointer(p5, fn){
397385
* A `Number` system variable that tracks the mouse's previous vertical
398386
* position.
399387
*
400-
* In 2D mode, `pmouseY` keeps track of the mouse's position relative to the
388+
* `pmouseY` keeps track of the mouse's position relative to the
401389
* top-left corner of the canvas. Its value is
402390
* <a href="#/p5/mouseY">mouseY</a> from the previous frame. For example, if
403391
* the mouse was 50 pixels from the top edge of the canvas during the last
404392
* frame, then `pmouseY` will be 50.
405393
*
406-
* In WebGL mode, `pmouseY` keeps track of the mouse's position relative to the
407-
* center of the canvas. For example, if the mouse was 50 pixels below the
408-
* canvas' center during the last frame, then `pmouseY` will be 50.
409-
*
410394
* If touch is used instead of the mouse, then `pmouseY` will hold the
411395
* y-coordinate of the last touch point.
412396
*
@@ -496,7 +480,7 @@ function pointer(p5, fn){
496480
* textSize(16);
497481
*
498482
* // Display the mouse's coordinates within the browser window.
499-
* text(`x: ${winMouseX} y: ${winMouseY}`, 50, 50);
483+
* text(`x: ${int(winMouseX)} y: ${int(winMouseY)}`, 50, 50);
500484
* }
501485
* </code>
502486
* </div>
@@ -537,7 +521,7 @@ function pointer(p5, fn){
537521
* textSize(16);
538522
*
539523
* // Display the mouse's coordinates within the browser window.
540-
* text(`x: ${winMouseX} y: ${winMouseY}`, 50, 50);
524+
* text(`x: ${int(winMouseX)} y: ${int(winMouseY)}`, 50, 50);
541525
* }
542526
* </code>
543527
* </div>

0 commit comments

Comments
 (0)