TextMesh Pro *** Preview 3 Release of Version 2.2.0 and 3.2.0 Now Available! ***

Yay, thanks for getting it out the door! I look forward to updating and integrating this into our project and finalizing our text/font features for our game. Some questions:

What specific features need a new TextCore (new Unity version)? Could you mark them in the changelog or in the post above? Also when you know which version, the version they'll be in?

Do you have ligatures exposed on a per label or runtime accessible settings so can use to enable/disable ligatures in our GameOptions? Some of our ligatures can be a little "extreme" and we want to provide our users with that option.

Is this the targeted feature set for 3.2 final or are you planning on squeezing in a few others?

This may be a problem custom to my project or I might need to wait on a Unity upgrade, but we're still not seeing either the ligatures or glyph pair kerning implemented (one of the big reasons we're trying to upgrade). I tried creating the font from the .ttf and .otf version of the font and they're still not being included? Neither the ligatures or the glyph adjustment pairs are being exported. Let me know if you want me to DM you one of our fonts so you can see if this is an authoring problem.

 

With the upcoming editor update for emoji support will there be an update to the TMP Input field to have an option to block emoji input? We currently only support emojis in chat and don't want players to be able to enter them in their names. This would be helpful option.

 

This is great! Thanks Stephan!

Just to clarify, with this preview release on its own, can I get Arabic fonts working in Unity out-of-the-box, or is this dependent on the completion of the changes in the TextCore FontEngine you spoke about above?

Also, will these changes allow Arabic fonts/text to render correctly within the Unity editor interface (and editor plugin UI), or is this only relevant to in-game UI elements that use TextMeshPro?

 

Are there any more plans for 'native integration', for lack of a better term? It seems that newer Unity versions moved Text to the Legacy menu. I teach Unity and every single new user is completely confused what this TextMeshPro in the menu is supposed to be and how UI works now.

I've noticed that they just want to add text or a button, so basically something that should be extremely simple and quick. But then they get a popup asking them to import TMP essentials. Some close the window, because they don't want to break anything. Or they want to import a font and have no idea why they can't just add it to the component, and are confused when I tell them to open this kind of hidden menu to create font assets. And then they want to script with it and I have to explain that UI.Text isn't actually what they want, but they need this TextMeshProUGUI thing and import TMPro instead of the UI package, which you would never know without googling explicitily for TextMeshPro.

With the de facto 'removal' of the old Text component, I feel like you really need to streamline the entire Text functionality. People shouldn't have to import these essentials manually if TMP is to be used as the default text. Adding and changing text through code should just work out of the box without much explanation.

 

Hi, not sure if this is the best place to post my problem, but I can't get access the download for the pre release TMP in package manager no matter what I try.



I am on Unity 2021.2.1 & am not shown any preview packages for TMP.

Is there a specific git URL I can use for version 3.2?

Thanks,

EDIT:

Ok found a solution. If anyone else is having this issue enter this into the "add package by name" option:



com.unity.textmeshpro
3.2.0-pre.3

 

This is great! Does Dynamic OS Font Assets work on WebGL? I have not been able to get it to work.

EDIT: I noticed that you can load a font binary into FontEngine.LoadFontFace, however I don't know how to get the Font from there into a TMP_FontAsset. I could not find any documentation on how it works.

Does anybody know how to do this?

Alternatively, could the font asset keep a reference to byte[] and just use that?

This would allow us to load font files from streamingAssets at runtime.

EDIT 2: Did a few changes myself and got it working, now i just need to see if this is stable.

If you want to do this yourself, google how to modify a package, and here is the code i modified.

Code (CSharp):

1.         // CUSTOM : Added data field and function for data
2.         byte[] data;
3.         public static TMP_FontAsset CreateFontAsset(byte[] data)
4.         {
5.             return CreateFontAssetInstance(null, 9, GlyphRenderMode.SDFAA, 1024, 1024, AtlasPopulationMode.Dynamic, true, data);
6.         }
7.  
8.         // CUSTOM : Modified CreateFontAssetInstance to add data parameter
9.         static TMP_FontAsset CreateFontAssetInstance(Font font, int atlasPadding, GlyphRenderMode renderMode, int atlasWidth, int atlasHeight, AtlasPopulationMode atlasPopulationMode, bool enableMultiAtlasSupport, byte[] data = null)
10.         {
11.            // CUSTOM : If data, load it
12.            if (data != null) {
13.                 var result = FontEngine.LoadFontFace(data, 90);
14.                 if (result != FontEngineError.Success) throw new($"Failed to load font. {result}");
15.             }
16.  
17.             // Create new font asset
18.             TMP_FontAsset fontAsset = CreateInstance<TMP_FontAsset>();
19.          
20.            // CUSTOM : Assign data
21.             fontAsset.data = data;
22.  
23. /// Find the LoadFontFace function, and modify it with
24.         FontEngineError LoadFontFace()
25.         {
26.             if (m_AtlasPopulationMode == AtlasPopulationMode.Dynamic)
27.             {
28.                 // Font Asset should have a valid reference to a font in the Editor.
29.                 #if UNITY_EDITOR
30.                 if (m_SourceFontFile == null)
31.                     m_SourceFontFile = SourceFont_EditorRef;
32.                 #endif
33.  
34.                 // CUSTOM : If data, load it
35.                 if (data != null) return FontEngine.LoadFontFace(data, m_FaceInfo.pointSize, m_FaceInfo.faceIndex);
36.  
37.  

EDIT 3: Usage example.

Code (CSharp):

1. public class Test : MonoBehaviour {
2.     public TMP_Text tmp;
3.  
4.     IEnumerator Start() {
5.         using var request = UnityWebRequest.Get($"{Application.streamingAssetsPath}/fonts/NotoSansSC-Regular.otf");
6.         yield return request.SendWebRequest();
7.         if (request.result != UnityWebRequest.Result.Success) throw new("Failed to get font file.");
8.  
9.         TMP_Settings.fallbackFontAssets.Add(TMP_FontAsset.CreateFontAsset(request.downloadHandler.data));
10.  
11.         tmp.text = "Hello 你好 World";
12.     }
13. }

 

Is there a fix for TMPro in World Space/VR? (or can yall add something in a new update)? Posting a picture below of how it looks in VR - Basically like perspective view. (It is from another post that was "resovled" and not exactly related to my issue). When I disable "Additional Shader Channels" - (select nothing) it renders fine, but then automatically enables itself. Would it be possible to create an override when using worldspace canvas? 2nd Image shows my setup that "works" - but after a little bit, Text Mesh Pro reenabled the other shader channels and it needs to be disabled again during runtime.

 

Would these TextCore OpenType features by chance going to be backported to the 2021 LTS (our targeted release version) or has that ship sailed and will require 2022.x?

 

Hi Stephan, thank you for the great work.
I would like to report an issue with the Text Wrapping Mode.

The spacing seems not be correctly preserved once a word is pushed into a new line by leading spaces.
How to replicate:
1. Create new Text - TextMeshPro object
2. Set Text Wrapping Mode to "Preserve White spaces"
3. (optional) Stretch Rect Transform to fill the entire screen and have better visual clue of line ending.
4. In the editor set Text Input to "Sample Text".
5. Start adding leading spaces until "Text" word is pushed to new line.
6. ISSUE: Any additional leading space added at this time will cause "Sample" to advance forward, but "Text" will not move. After a certain amount of spaces (possibly depending on the word length and font used) "Sample" is pushed in the new line too. Again, multiple additional spaces will be required to make the words move forwards.

-- EDIT --

One note on my previous post, just discovered that other text editors behave in similar manner (notably Office Word and Notepad++).
If this is intended behavior please ignore this report.

 

Any chance you could add an option to never save to dynamic font assets in the first place instead of clearing them?
Kinda annoying to have them reload before/after every build due to the clear option if one doesn't care about the contents anyways (and having random version control changes even though nobody actually changed the asset)

 

the Mark to Base and Mark to Mark adjustment tables are fantastic.
we developed something similar to manage arabic diacritics, but we used the unicodes as IDs, now you ask for the glyph ID...
what happens if we reimport the font? will IDs change? could we use char unicodes as IDs?

thank you!

 

Hello everyone , any idea about this issue? Thank you.

https://forum.unity.com/threads/text-mesh-pro-curvy-edges-when-zoomed-in-issue.1280804/

 

Any updates on when the changes to the FontEngine will be available in a Unity upgrade? I haven't seen anything mentioned in the release notes.

 

I suggest you wait until it comes out on its own. Even if Stephan comes and gives you another ETA, it will be delayed from the new date again anyway.

 

Can TMP version 3.x work in Unity 2019.4? As far as I understand, only thing preventing it from working it is usage of VersionControlSettings class. If that part of code is wrapped inside "define", wouldn't that be enough to make it work in 2019.4 (LTS)? That would be a life saver for people like me who switch between versions frequently.

 

When using VR/XR - Disabling the channels (none) makes Text Mesh Pro objects look high quality when scaling which is necessary for world space canvases. However, Unity somewhere in the system reenables it at random intervals and when using it, the text goes blurry and becomes unreadable as shown in my previous post. It would be great if yall can find a fix with the text mesh pro and canvas/ui teams. I would like to permanently disable it, polling is not desirable.

 

Hi @Stephan_B, Great work! Is there any chance for TextMeshPro will react to softness in RectMask2D?

 

It should be already be with these latest releases. However, be sure to update to TMP Essential Resources as this functionality is partly contained in the updated shaders contained in those.

 

Submit following this guide? https://unity3d.com/unity/qa/bug-reporting

Ill have to just create a basic project with TextMeshPro Canvas scaled to .1/.01 in world space. Happens every time.

 

Nice update. I'm curious about the .ttc workflow, not something I've heard of before.

How to you generate a .ttc file from many .ttf files?
Does TMP import and recognize .ttc files?
How do you generate Font Assets from a .ttc?

 

All my TMPs turned into unrecognisable blobs when I updated from 3.0.6 to 3.2.0-pre3. This fixed it, just highlighting and going to slam a few keywords in here for anyone else Ctrl+F'ing: Blobs, text blobs, blocky text, blocks.

Thanks again, TMP is a great asset.

 

@Stephan_B I'm finally on 2021.3 LTS, and I've updated to TMP 3.2.0-pre.3. My whole goal with the HDRP-compatible TMP has been to be able to set the rendering of TMP text to "After post-processing" to avoid having the text affected by motion blur. Could you advise how to set the render queue for TMP under the new package? Thanks.

Nevermind. I just hadn't assigned the new HDRP shader to the material. Upon doing so, I see the material has the expected HDRP settings, like Rendering Pass. So, all set. Thanks.

 

Using the new HDRP Unlit shader, I'm seeing this in cases where the text is bold (contains <b></b> tags):

Code (CSharp):

1. Material 'Visor Diagnostics Text - Aldrich Material' with Shader 'TextMeshPro/SRP/TMP_SDF-HDRP UNLIT' doesn't have a float or range property '_ScaleRatioA'
2. UnityEngine.Material:GetFloat (int)
3. TMPro.TextMeshProUGUI:GenerateTextMesh () (at Library/PackageCache/com.unity.textmeshpro@3.2.0-pre.3/Scripts/Runtime/TMPro_UGUI_Private.cs:2364)
4. TMPro.TextMeshProUGUI:OnPreRenderCanvas () (at Library/PackageCache/com.unity.textmeshpro@3.2.0-pre.3/Scripts/Runtime/TMPro_UGUI_Private.cs:1737)
5. TMPro.TextMeshProUGUI:Rebuild (UnityEngine.UI.CanvasUpdate) (at Library/PackageCache/com.unity.textmeshpro@3.2.0-pre.3/Scripts/Runtime/TextMeshProUGUI.cs:216)
6. UnityEngine.Canvas:SendWillRenderCanvases ()

Seems the HDRP shaders don't have _ScaleRatioA, and the code's not checking for that.

 

I'm getting this as well.

 

FWIW, I just edited the shader and added a dummy _ScaleRatioA field, just to mute the error. Not a good long term solution, but a quick hack that doesn't seem to cause any issues (so far).

 

Good day! Our studio is converting all Unity text labels into TMP ones, and we stumbled upon a couple of blockers. Maybe we are missing some not very obvious solutions?

1. Kerning is distorted when text is italicized, leading to character overlap.
That happens due to an incorrect italicization pivot. Right now, each character uses its' quad middle and skews around it, leading to non-uniform offsets of symbols like "." or ",". We've tried to extend quads of affected chars in the font asset and make them the same height as letters, but it starts grabbing neighbor chars from the atlas.
Here is an example video:

2. Outline(stroke) scales with the font
Is there any way to compensate for font size and modify outline/deviation values at runtime without breaking batching? We have multiple text sizes on a screen that use the same outline material - a simple 50% opacity black stroke.
Here is an example of the issue

We thought if text size were somewhere in vertex data, we could compensate for that in a shader.

 

Unfortunately, we can not add a separate variant because of the memory issues on mobile at the moment (as many long-running service games are )
There are multiple ways to address it though. It depends on where you shear the vertices - CPU or GPU.
If it's CPU, you could just use font baseline as a vertical coordinate for transformation (shearing).
If it's GPU, the world pos of the current characters' baseline OR delta between mesh center world pos. and baseline world pos. must be recorded in vertex steam.

Yeah, that would be perfect! that's why I thought of writing font size in a vertex stream to avoid breaking batching.

 

@Stephan_B Unity 2022.2 beta is out now, will your work on updating the core engine be available in that version?

 

Any plans to release new version for TMP? We are looking for a fix to one specific issue https://forum.unity.com/threads/tmpro-submeshui-error-when-changing-scenes.1129724/

 

Hi @Stephan_B,

I’m still struggeling with getting the ligatures to work. I found the Ligature Table but have no clue, how to add the actual ligatures. As far as I understand the glyphs need to be included in the font atlas, but I simply don’t understand how. If I type them in like they are named in the file (for example: «f_i») during the creation of the font atlas, it will treat them as three sperate glyphs instead of looking for the one with that name. Am I missing something?


Thanks.

 

I found the index number of the ligatures in the font file using ‹Glyphs›. When I now try to include these by entering the numbers in the character sequence while creating the font atlas, the atlas creator simply refuses to include them, as seen in the screenshot.

Another thing with the index is that the glyph index in TMP is off by one number and in some cases the numbers don’t align at all (‹f› in TMP ID 95 in the font file ID 93).

[edit:] It seems when I set the font to dynamic and use the letter combination in some text field, that I’m then able to trial and error myself towards finding the ligature (plus minus 1–2 index numbers).

I attached screenshots and hope they illustrate my problem.

Glyph Index

Asset Creator excluding the Ligatures



Thanks again.

 

Thanks for this - it's been driving me mad!
Don't know why it doesn't just show up when you enable experimental packages in the settings. Grrrr!
<3

 

Its great to see TMPro actively being improved.

I was very excited in the ability to select a font style/weight from a TT collection, alas for my purposes it doesn't appear to work. I think its a misunderstanding on my end as I wanted to use it to extract the different weights from Googles new Material Symbols variable font files ( e.g. MaterialSymbolsOutlined[FILL,GRAD,opsz,wght].ttf) and it seems these are not collections, but a base font with embedded parameters that allow different wieghts to be generated at runtime.

Assuming I'm correct with the above, is there any chance TMPro could support this in the future?

I have a workaround currently where I download the WOFF2 web file for a specific MaterialSymbol font style and weight, convert it to ttf and import that into Unity, but its a bit of pain, especially as it generates so many different files for all the variations. Though I'm hoping to work out how to combine those conversions into a collection and leverage the new support for TT collections.

[Edit - New Suggestion]
I don't seem to find any 'default' settings for the Font Asset Creator - having to create a large number of TMPro font assets from font files is quite a bit of a pain. While you can select multiple fonts and create TMPro Font Assets, you still have to go in by hand and set up all the options, even if they are sharing the same ones.

Maybe something like Unity 'Presets' process would work here, though as the Font Asset Creator isn't technically an importer i'm not sure they could be used directly.
[Edit - end]

Finally I've recently had to start using Unity with Preferences > UI Scaling > Custom Scaling of 125% and noticed the Font Asset Creator in TMPro side bar with all the settings is always clipped horizontally, forcing you to scroll left/right constantly when changing settings. Pretty sure this occurs 100% of the time, but it definately happens every time I try to 'Update Atlas Texture' from a created TMPro font asset.

Strangely opening 'Font Asset Creator' from the menus does not exhibit the clipping issue. Its only when you use 'Update Atlas Texture' from an existing Font Asset.

 

After further investigation, it would seem that maybe the way I was creating TMPro Font Assets was not the optimum approach for my objective. I guess I was using it as you would with other Unity assets - create each TMPro asset per font file asset - then use 'Update Texture Atlas' to populate the texture within the asset.

Whilst doing this I noticed that I could simply open the 'Font Asset Creator', assign the font, set the various settings, generate Font Atlas and then use 'Save as' to create a specific TMPro Font Asset for a specific font, with bonus ability of for a specific font face ( via pre-release ). The obvious benefit being that it maintains all the settings between switching font face.

Although slightly counter intuitive it would seem far more efficient than my original process and broadly address my complaint/suggest with regard to preset/default creator settings in the post above.

The only issue with this approach that I've noticed is that 'save as' will populate the file name with the 'Source Font' name, instead of the 'Font Face' name. If that could be addressed then this makes dealing with creating many fonts, especially with the new TTC support, much more streamlined.

Suggestion:
In Font Asset Creator, have 'save as' use the selected FontFace name as the filename.

 

Edit - I might be dumb

I had reported a potential bug with TTC support, where TMPro would only report 5 FontFaces instead of the 6 that I added to the collection in FontForge. Yet FontForge would report that there were 6 fonts in the same ttc file. I carried out several different tests and originally had the same results, but later tests appeared to work.

Long story short I finally discovered that two of the fonts i'd added to the collection were duplicates, due to a naming bug. The font files were byte for byte exactly the same. Replacing the duplicate with the correct file, would appear to have address the whole TTC issue I was experiencing.

Have created half a dozen TTC files in FontForge now and all of them come in via TMPro correctly, so it would appear that accidently having a file that was a duplicate of another and instead of being a different file was the cause of my problems.

Previous post deleted.