MBMGlyphsRasterizationOptions.h 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. // This file is generated and will be overwritten automatically.
  2. #import <Foundation/Foundation.h>
  3. #import <MapboxCoreMaps/MBMGlyphsRasterizationMode.h>
  4. /** Describes the glyphs rasterization option values. */
  5. NS_SWIFT_NAME(GlyphsRasterizationOptions)
  6. __attribute__((visibility ("default")))
  7. @interface MBMGlyphsRasterizationOptions : NSObject
  8. // This class provides custom init which should be called
  9. - (nonnull instancetype)init NS_UNAVAILABLE;
  10. // This class provides custom init which should be called
  11. + (nonnull instancetype)new NS_UNAVAILABLE;
  12. - (nonnull instancetype)initWithRasterizationMode:(MBMGlyphsRasterizationMode)rasterizationMode
  13. fontFamily:(nullable NSString *)fontFamily;
  14. /** Glyphs rasterization mode for client-side text rendering. */
  15. @property (nonatomic, readonly) MBMGlyphsRasterizationMode rasterizationMode;
  16. /**
  17. * Font family to use as font fallback for client-side text renderings.
  18. *
  19. * Note: `GlyphsRasterizationMode` has precedence over font family. If `AllGlyphsRasterizedLocally`
  20. * or `IdeographsRasterizedLocally` is set, local glyphs will be generated based on the provided font family. If no
  21. * font family is provided, the map will fall back to use the system default font. The mechanisms of choosing the
  22. * default font are varied in platforms:
  23. * - For darwin(iOS/macOS) platform, the default font family is created from the <a href="https://developer.apple.com/documentation/uikit/uifont/1619027-systemfontofsize?language=objc">systemFont</a>.
  24. * If provided fonts are not supported on darwin platform, the map will fall back to use the first available font from the global fallback list.
  25. * - For Android platform: the default font <a href="https://developer.android.com/reference/android/graphics/Typeface#DEFAULT">Typeface.DEFAULT</a> will be used.
  26. *
  27. * Besides, the font family will be discarded if it is provided along with `NoGlyphsRasterizedLocally` mode.
  28. *
  29. */
  30. @property (nonatomic, readonly, nullable, copy) NSString *fontFamily;
  31. @end