Skip to content

Commit 15bfe71

Browse files
authored
Merge pull request #7266 from samme/docs/v4.0.0/text-resolution
Docs: Text#setResolution() description
2 parents cca3c20 + c83a0e8 commit 15bfe71

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/gameobjects/text/Text.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1057,17 +1057,17 @@ var Text = new Class({
10571057
},
10581058

10591059
/**
1060-
* Set the resolution used by this Text object.
1060+
* Set the resolution of the Texture used by this Text object.
10611061
*
1062-
* It allows for much clearer text on High DPI devices, at the cost of memory because it uses larger
1063-
* internal Canvas textures for the Text.
1062+
* Setting resolution above 1 is useful only if you're scaling up this Text object (or an ancestor) or zooming a Camera on it.
1063+
* Otherwise, any extra detail in the Texture would just be lost during rendering.
10641064
*
1065-
* Therefore, please use with caution, as the more high res Text you have, the more memory it uses.
1065+
* Please use with caution, as the more high-resolution Text you have, the more memory it uses.
10661066
*
10671067
* @method Phaser.GameObjects.Text#setResolution
10681068
* @since 3.12.0
10691069
*
1070-
* @param {number} value - The resolution for this Text object to use.
1070+
* @param {number} value - The resolution for this Text object to use, relative to 1.
10711071
*
10721072
* @return {this} This Text object.
10731073
*/

0 commit comments

Comments
 (0)