summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLRendererConfiguration.h
diff options
context:
space:
mode:
Diffstat (limited to 'platform/darwin/src/MGLRendererConfiguration.h')
-rw-r--r--platform/darwin/src/MGLRendererConfiguration.h19
1 files changed, 14 insertions, 5 deletions
diff --git a/platform/darwin/src/MGLRendererConfiguration.h b/platform/darwin/src/MGLRendererConfiguration.h
index ee5aaef174..bbcc3a8c75 100644
--- a/platform/darwin/src/MGLRendererConfiguration.h
+++ b/platform/darwin/src/MGLRendererConfiguration.h
@@ -26,11 +26,20 @@ MGL_EXPORT
/** The name of the font family to use for client-side text rendering.
Currently only used for CJK glyphs. Changing this at run time is not currently
- supported. Enable client-side rendering of CJK glyphs by setting
- `MGLIdeographicFontFamilyName` in your containing app's Info.plist to a value
- which will be available at run time. Default font for local ideograph font family
- is "PingFang". */
-@property (nonatomic, readonly) std::string localFontFamilyName;
+ supported. By default, client-side rendering is enabled for CJK glyphs using Apple
+ system default font.
+
+ Set `MGLIdeographicFontFamilyName` in your containing app's Info.plist to a string
+ value for using your specific local font which will be available at run time,
+ e.g. "PingFang TC".
+
+ Set `MGLIdeographicFontFamilyName` in your containing app's Info.plist to a array of
+ font family names. Once the front ones are unavaiable, it will fallback to others until
+ using default system font.
+
+ Set `MGLIdeographicFontFamilyName` to a Boolean value `NO` for using your custom remote font.
+ */
+@property (nonatomic, readonly) mbgl::optional<std::string> localFontFamilyName;
/**
A Boolean value indicating whether symbol layers may enable per-source symbol