Skip to content

Docs: Text#setResolution() description #7266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
samme wants to merge 1 commit into
base: v4.0.0
Choose a base branch
from
+5 −5
Open

Docs: Text#setResolution() description #7266

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/gameobjects/text/Text.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1055,17 +1055,17 @@ var Text = new Class({
},

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