Scylla Framework
  • API Reference
Search Results for

    Show / Hide Table of Contents
    • Scylla.Core
      • Char
      • FileLog
      • ILogReceiver
      • IScyllaDependencyProvider
      • Log
      • LogCategory
      • LogEntry
      • LogFileFormat
      • LogLevel
      • Num
      • ScyllaAAMode
      • ScyllaAAQuality
      • ScyllaBootstrap
      • ScyllaCore
      • ScyllaCore.Meta
      • ScyllaCreateAssetAttribute
      • ScyllaDependencyInfoData
      • ScyllaMaterialSurface
      • ScyllaRenderPipeline
      • ScyllaShadowResolution
      • Str
      • TextAlignment
      • UnityConsoleLog
    • Scylla.Core.Attributes
      • AttributeValidator
      • CompareOperator
      • ConditionalAttributeBase
      • DisableIfAttribute
      • DisplayNameAttribute
      • EnableIfAttribute
      • FoldoutAttribute
      • FormerlySerializedAsAttribute
      • GroupAttribute
      • HideIfAttribute
      • HideInFilterWindowAttribute
      • HorizontalLineAttribute
      • InfoBoxAttribute
      • InfoType
      • LayerFieldAttribute
      • MinMaxRangeAttribute
      • MonoTextAreaAttribute
      • NotEmptyAttribute
      • NotNullAttribute
      • ReadOnlyAttribute
      • ReflectedTypeAttribute
      • RequiredAttribute
      • SceneFieldAttribute
      • ShowIfAttribute
      • SortingLayerFieldAttribute
      • TagFieldAttribute
      • TitleAttribute
      • ValidateInputAttribute
      • ValidationException
    • Scylla.Core.Config
      • ConfigFileManager
      • ConfigurationRegistry
      • ConfigurationSlotAttribute
      • ConfigurationValidationResult
      • ConsoleLoggingSettings
      • FileLogFormattingSettings
      • FileLoggingSettings
      • IConfigurationRegistry
      • ScyllaConfiguration
      • ScyllaCoreConfiguration
      • ScyllaEventConfiguration
      • ScyllaLoggerConfiguration
      • ValidationSeverity
    • Scylla.Core.Editor
      • CalendarDefinitionEditor
      • ClockDefinitionEditor
      • ColorGradientAssetEditor
      • ColorGradientReducer
      • ColorPaletteAssetEditor
      • DebugCameraEditor
      • DebugEventMonitor
      • DependencySourceType
      • DependencyStatus
      • EventFilterCategory
      • EventLogEntry
      • GameViewCapture
      • IScyllaShaderProvider
      • ScyllaAboutWindow
      • ScyllaBootstrapEditor
      • ScyllaCard
      • ScyllaChoiceCardGroup
      • ScyllaConfigurationEditorBase
      • ScyllaCopyMenu
      • ScyllaCoreConfigurationEditor
      • ScyllaCoreDependencyProvider
      • ScyllaCoreShaderProvider
      • ScyllaDebugWindow
      • ScyllaDependencyDetector
      • ScyllaDependencyGraphElement
      • ScyllaDependencyInfo
      • ScyllaDescriptionBox
      • ScyllaEditorAssetUtil
      • ScyllaEditorAssets
      • ScyllaEditorBase
      • ScyllaEditorClipboard
      • ScyllaEditorColors
      • ScyllaEditorConstants
      • ScyllaEditorIconNames
      • ScyllaEditorLogScope
      • ScyllaEditorPrefs
      • ScyllaEditorSceneUtil
      • ScyllaEditorStyles
      • ScyllaEditorTheme
      • ScyllaEditorUSSClasses
      • ScyllaEventConfigurationEditor
      • ScyllaFontCharacterExtractorWindow
      • ScyllaGettingStartedWindow
      • ScyllaIconPreview
      • ScyllaLoggerConfigurationEditor
      • ScyllaLogoElement
      • ScyllaMenuGroup
      • ScyllaMenuItemAttribute
      • ScyllaMenuItems
      • ScyllaModuleEditor
      • ScyllaModuleStatusIndicator
      • ScyllaModuleWindow
      • ScyllaNameField
      • ScyllaPanel
      • ScyllaPlayModeReloadGuard
      • ScyllaPresetSelector
      • ScyllaSceneConfigurationEditor
      • ScyllaScheduler
      • ScyllaSearchField
      • ScyllaSearchablePopup
      • ScyllaSearchablePopup.Item
      • ScyllaSettingsProvider
      • ScyllaSetupWizard
      • ScyllaShaderInclusionBuildProcessor
      • ScyllaSplitView
      • ScyllaStatusBar
      • ScyllaTabBar
      • ScyllaTimeConfigurationEditor
      • ScyllaToolWindowBase
      • ScyllaToolbar
      • ScyllaValidatedTextField
      • ScyllaWizardWindowBase
      • ScyllaWizardWindowBase.WizardLayout
      • ScyllaWizardWindowBase.WizardStepDef
    • Scylla.Core.Editor.Attributes
      • AttributeReflectionCache
      • ConditionalDrawerBase
      • DisableIfDrawer
      • EnableIfDrawer
      • FoldoutDrawer
      • HideIfDrawer
      • HorizontalLineDrawer
      • InfoBoxDrawer
      • LayerFieldDrawer
      • MinMaxRangeDrawer
      • MonoTextAreaDrawer
      • ReadOnlyDrawer
      • RequiredDrawer
      • SceneFieldDrawer
      • SerializedPropertyExtensions
      • ShowIfDrawer
      • SortingLayerFieldDrawer
      • TagFieldDrawer
      • TitleDrawer
    • Scylla.Core.Editor.Drawers
      • DoubleRangeDrawer
      • FloatRangeDrawer
      • IntRangeDrawer
    • Scylla.Core.Editor.Util.UI.Layout
      • ScyllaUIEdgeInsetsDrawer
      • ScyllaUILayoutMenuItems
      • ScyllaUILengthDrawer
    • Scylla.Core.Events
      • IScyllaEventBus
      • ScyllaEvent
      • ScyllaEventBus
      • ScyllaEventPriority
      • ScyllaEventSubscription
      • ScyllaEvents
      • ScyllaFrameworkInitializedEvent
      • ScyllaFrameworkShutdownEvent
      • ScyllaModuleShutdownEvent
      • ScyllaModuleStartedEvent
    • Scylla.Core.Modules
      • IScyllaModule
      • IScyllaModuleManager
      • ScyllaModule
      • ScyllaModuleDependency
      • ScyllaModuleDependencyIssue
      • ScyllaModuleDependencyIssueType
      • ScyllaModuleDependencyType
      • ScyllaModuleException
      • ScyllaModuleID
      • ScyllaModuleInfo
      • ScyllaModuleManager
      • ScyllaModulePlacement
      • ScyllaModuleState
      • ScyllaModuleTier
    • Scylla.Core.Persistence
      • IScyllaPersistable
      • IScyllaPersistable<TState>
      • ScyllaPartitionID
      • ScyllaPersistenceRegistry
    • Scylla.Core.Scenes
      • HygieneOverride
      • SceneLoadOperation
      • SceneLoadRunner
      • SceneLoadState
      • ScyllaActiveSceneChangedEvent
      • ScyllaSceneConfiguration
      • ScyllaSceneLoadOptions
      • ScyllaSceneLoadProgressEvent
      • ScyllaSceneLoadedEvent
      • ScyllaSceneManager
      • ScyllaSceneUnloadedEvent
      • ScyllaSceneWillLoadEvent
      • ScyllaSceneWillUnloadEvent
    • Scylla.Core.Settings
      • ScyllaProjectSettings
    • Scylla.Core.Structures
      • FractionalHexCoord
      • GridUtil
      • HexCoord
      • HexCornerCoord
      • HexCornerMap<TData>
      • HexCornerMap<TData>.Enumerator
      • HexCornerPosition
      • HexEdgeCoord
      • HexEdgeDirection
      • HexEdgeMap<TData>
      • HexEdgeMap<TData>.Enumerator
      • HexGridLayout
      • HexLayoutMode
      • HexOrientation
      • IScyllaCollection
      • IScyllaCollection<T>
      • IScyllaGraph
      • IScyllaGrid<TCoord, TCell>
      • IScyllaMap<TKey, TValue>
      • IScyllaMutableGraph
      • IScyllaMutableGraph<TNodeData>
      • IScyllaMutableGraph<TNodeData, TEdgeData>
      • IScyllaPausableState<TContext>
      • IScyllaPriorityQueueItem
      • IScyllaReadOnlyGraph
      • IScyllaReadOnlyGraph<TNodeData>
      • IScyllaReadOnlyGraph<TNodeData, TEdgeData>
      • IScyllaState<TContext>
      • IScyllaTransition<TContext>
      • IScyllaTrie
      • IScyllaTrie<TValue>
      • NeighborWriter<TCoord>
      • ScyllaAABB2
      • ScyllaAABB3
      • ScyllaAdjacencyListGraph
      • ScyllaAdjacencyListGraph.Builder
      • ScyllaAdjacencyListGraph.NodeEnumerator
      • ScyllaAdjacencyListGraph.SynchronizedScyllaAdjacencyListGraph
      • ScyllaAdjacencyListGraph<TNodeData>
      • ScyllaAdjacencyListGraph<TNodeData, TEdgeData>
      • ScyllaBVH
      • ScyllaBVH.Builder
      • ScyllaBVHCore
      • ScyllaBitArray
      • ScyllaBitArray.Builder
      • ScyllaBitArray.Enumerator
      • ScyllaBitArray.SynchronizedScyllaBitArray
      • ScyllaBitArrayDOTS
      • ScyllaBitArrayDOTS.Builder
      • ScyllaBitArrayDOTS.Enumerator
      • ScyllaCSRGraph
      • ScyllaCSRGraph.Builder
      • ScyllaCSRGraph<TNodeData>
      • ScyllaCSRGraph<TNodeData, TEdgeData>
      • ScyllaCollectionCapabilities
      • ScyllaCollectionThreadSafety
      • ScyllaCompositeState<TContext>
      • ScyllaDequeDOTS<T>
      • ScyllaDequeDOTS<T>.Builder
      • ScyllaDeque<T>
      • ScyllaDeque<T>.Builder
      • ScyllaDeque<T>.Enumerator
      • ScyllaDeque<T>.SynchronizedScyllaDeque
      • ScyllaDisjointSet
      • ScyllaDisjointSet.Builder
      • ScyllaDisjointSet.SynchronizedScyllaDisjointSet
      • ScyllaDisjointSetDOTS
      • ScyllaDisjointSetDOTS.Builder
      • ScyllaGenericObjectPool<T>
      • ScyllaGenericObjectPool<T>.Builder
      • ScyllaGenericObjectPool<T>.Enumerator
      • ScyllaGenericObjectPool<T>.SynchronizedScyllaGenericObjectPool
      • ScyllaGraphAlgorithms
      • ScyllaGraphDOTS
      • ScyllaGraphDOTS.Builder
      • ScyllaGraphEdge
      • ScyllaGraphEdge<TEdgeData>
      • ScyllaGraphNode
      • ScyllaGraphNodeFlags
      • ScyllaGraphPath
      • ScyllaGraphProperties
      • ScyllaGraphSearchState
      • ScyllaGridGraphAdapter<TCoord, TCell>
      • ScyllaHexGrid<TCell>
      • ScyllaHexGrid<TCell>.Builder
      • ScyllaHexGrid<TCell>.Enumerator
      • ScyllaHexGrid<TCell>.SynchronizedScyllaHexGrid
      • ScyllaHierarchicalStateMachine<TContext>
      • ScyllaKDTree3
      • ScyllaKDTree3.Builder
      • ScyllaKDTree3Core
      • ScyllaKDTree3Core.Node
      • ScyllaLayeredStateMachine<TContext>
      • ScyllaLooseOctree
      • ScyllaLooseOctree.Builder
      • ScyllaLooseOctreeCore
      • ScyllaLooseOctreeUtil
      • ScyllaLooseOctree<T>
      • ScyllaLooseQuadtree
      • ScyllaLooseQuadtree.Builder
      • ScyllaLooseQuadtreeCore
      • ScyllaLooseQuadtreeUtil
      • ScyllaLooseQuadtree<T>
      • ScyllaMapDOTS<TKey, TValue>
      • ScyllaMapDOTS<TKey, TValue>.Builder
      • ScyllaMapEntry<TKey, TValue>
      • ScyllaMap<TKey, TValue>
      • ScyllaMap<TKey, TValue>.Builder
      • ScyllaMap<TKey, TValue>.Enumerator
      • ScyllaMap<TKey, TValue>.SynchronizedScyllaMap
      • ScyllaObjectPool<T>
      • ScyllaObjectPool<T>.Builder
      • ScyllaObjectPool<T>.Enumerator
      • ScyllaObjectPool<T>.SynchronizedScyllaObjectPool
      • ScyllaPausableStateBase<TContext>
      • ScyllaPriorityQueueDOTS<TValue>
      • ScyllaPriorityQueueDOTS<TValue>.Builder
      • ScyllaPriorityQueueItemComparer<T>
      • ScyllaPriorityQueueNode<TValue>
      • ScyllaPriorityQueueOrder
      • ScyllaPriorityQueue<T>
      • ScyllaPriorityQueue<T>.Builder
      • ScyllaPriorityQueue<T>.Enumerator
      • ScyllaPriorityQueue<T>.SynchronizedScyllaPriorityQueue
      • ScyllaPushdownStateMachine<TContext>
      • ScyllaQuadtreePlane
      • ScyllaQueueDOTS<T>
      • ScyllaQueueDOTS<T>.Builder
      • ScyllaQueue<T>
      • ScyllaQueue<T>.Builder
      • ScyllaQueue<T>.Enumerator
      • ScyllaQueue<T>.SynchronizedScyllaQueue
      • ScyllaRay3
      • ScyllaRingBufferDOTS<T>
      • ScyllaRingBufferDOTS<T>.Builder
      • ScyllaRingBufferDOTS<T>.Enumerator
      • ScyllaRingBufferDOTS<T>.ReverseEnumerable
      • ScyllaRingBufferDOTS<T>.ReverseEnumerator
      • ScyllaRingBuffer<T>
      • ScyllaRingBuffer<T>.Builder
      • ScyllaRingBuffer<T>.Enumerator
      • ScyllaRingBuffer<T>.ReverseEnumerable
      • ScyllaRingBuffer<T>.ReverseEnumerator
      • ScyllaRingBuffer<T>.SynchronizedScyllaRingBuffer
      • ScyllaSparseHexGrid<TCell>
      • ScyllaSparseHexGrid<TCell>.Builder
      • ScyllaSparseHexGrid<TCell>.Enumerator
      • ScyllaSparseHexGrid<TCell>.SynchronizedScyllaSparseHexGrid
      • ScyllaSparseSquareGrid<TCell>
      • ScyllaSparseSquareGrid<TCell>.Builder
      • ScyllaSparseSquareGrid<TCell>.Enumerator
      • ScyllaSparseSquareGrid<TCell>.SynchronizedScyllaSparseSquareGrid
      • ScyllaSparseTriGrid<TCell>
      • ScyllaSparseTriGrid<TCell>.Builder
      • ScyllaSparseTriGrid<TCell>.Enumerator
      • ScyllaSparseTriGrid<TCell>.SynchronizedScyllaSparseTriGrid
      • ScyllaSquareGrid<TCell>
      • ScyllaSquareGrid<TCell>.Builder
      • ScyllaSquareGrid<TCell>.Enumerator
      • ScyllaSquareGrid<TCell>.SynchronizedScyllaSquareGrid
      • ScyllaStackDOTS<T>
      • ScyllaStackDOTS<T>.Builder
      • ScyllaStack<T>
      • ScyllaStack<T>.Builder
      • ScyllaStack<T>.Enumerator
      • ScyllaStack<T>.SynchronizedScyllaStack
      • ScyllaStateBase<TContext>
      • ScyllaStateMachine<TContext>
      • ScyllaTransition<TContext>
      • ScyllaTriGrid<TCell>
      • ScyllaTriGrid<TCell>.Builder
      • ScyllaTriGrid<TCell>.Enumerator
      • ScyllaTriGrid<TCell>.SynchronizedScyllaTriGrid
      • ScyllaTrie
      • ScyllaTrie.Builder
      • ScyllaTrie.SynchronizedScyllaTrie
      • ScyllaTrie<TValue>
      • ScyllaTrie<TValue>.Builder
      • ScyllaTrie<TValue>.SynchronizedScyllaTrie
      • ScyllaTypeMap
      • ScyllaTypeMap.Builder
      • ScyllaTypeMap.DiagnosticEntry
      • ScyllaTypeMap.SynchronizedScyllaTypeMap
      • SerializableDictionary<TKey, TValue>
      • SquareAdjacency
      • SquareCoord
      • SquareCornerCoord
      • SquareCornerMap<TData>
      • SquareCornerMap<TData>.Enumerator
      • SquareDistanceMetric
      • SquareEdgeCoord
      • SquareEdgeDirection
      • SquareEdgeMap<TData>
      • SquareEdgeMap<TData>.Enumerator
      • SquareGridLayout
      • TriCoord
      • TriCornerCoord
      • TriCornerMap<TData>
      • TriCornerMap<TData>.Enumerator
      • TriEdgeCoord
      • TriEdgeDirection
      • TriEdgeMap<TData>
      • TriEdgeMap<TData>.Enumerator
      • TriGridLayout
    • Scylla.Core.Time
      • CalendarDefinition
      • CalendarMath
      • ClockDayChangedEvent
      • ClockDebugInfo
      • ClockDefinition
      • ClockEraChangedEvent
      • ClockEvent
      • ClockEventKind
      • ClockHourChangedEvent
      • ClockMinuteChangedEvent
      • ClockMonthChangedEvent
      • ClockPausedEvent
      • ClockRegisteredEvent
      • ClockResumedEvent
      • ClockSeasonChangedEvent
      • ClockSecondChangedEvent
      • ClockState
      • ClockTickEvent
      • ClockTimeScaleChangedEvent
      • ClockUnregisteredEvent
      • ClockWeekdayChangedEvent
      • ClockYearChangedEvent
      • EraDefinition
      • GameDate
      • IClockListener
      • IClockSource
      • IEraConditionProvider
      • ILocationProfile
      • INetworkTimeSyncStrategy
      • ITimeListener
      • LeapYearRule
      • MasterTimeState
      • MonthDefinition
      • PauseMode
      • ScheduleExtensions
      • ScheduleMode
      • ScheduledTickHandle
      • ScyllaClock
      • ScyllaTime
      • ScyllaTimeConfiguration
      • ScyllaTimeDebugInfo
      • SeasonDefinition
      • SmoothTimeScaleTransition
      • TimeDebugOverlay
      • TimeEffectHandle
      • TimeEffects
      • TimeEvent
      • TimeScaleBlendMode
      • TimeScaleModifier
      • TimeScaleModifierHandle
      • TimeScaleModifierStack
      • TimeScaleModifierState
      • TimeTickRunner
      • WeekdayDefinition
    • Scylla.Core.Util
      • ArrayUtil
      • AssemblyUtil
      • CameraUtil
      • CollectionUtil
      • ColorAnalysis
      • ColorBlindnessSimulator
      • ColorBlindnessType
      • ColorHarmony
      • ColorHarmonyHueMode
      • ColorHarmonyType
      • ColorRamps
      • ColorUtil
      • ComponentUtil
      • DateUtil
      • DebugCamera
      • FontUtil
      • FontVariant
      • GameObjectExtensions
      • GameObjectUtil
      • IScyllaInspectorChangeHandler
      • InterfaceUtil
      • Interpolation
      • LightUtil
      • LitMaterialDescriptor
      • ManualResetEventEx
      • MaterialUtil
      • NumberExtensions
      • NumberUtil
      • OptionalPackages
      • PlatformUtil
      • ResourceUtil
      • ScyllaEditorHooks
      • ScyllaPlayModeStateChange
      • SpriteUtil
      • StringUtil
      • TabularText
      • TabularText.Builder
      • TestTextGenerator
      • ThreadUtil
      • TimeUtil
      • Timer
      • TransformExtensions
      • TypeUtil
      • UnicodeRange
      • VirtualTransform
      • WCAGLevel
      • WaitForSettledFrames
    • Scylla.Core.Util.Addressables
      • AddressableErrorCode
      • AddressableException
      • AddressableExtensions
      • AddressableProgress
      • AddressableResult
      • AddressableResult<T>
      • AddressableSettings
      • ManagedAddressableList<T>
      • ManagedAddressable<T>
      • ScyllaAddressables
    • Scylla.Core.Util.Checksum
      • ChecksumAdler32
      • ChecksumCRC16
      • ChecksumCRC32
      • ChecksumFletcher32
      • ChecksumXXHash32
      • ChecksumXXHash64
      • IChecksum
    • Scylla.Core.Util.Compression
      • ArchiveEntryInfo
      • CompressionAlgorithm
      • CompressionErrorCode
      • CompressionException
      • CompressionExtensions
      • CompressionLevel
      • CompressionProgress
      • CompressionResult
      • CompressionResult<T>
      • CompressionSettings
      • IArchiveProvider
      • ICompressionProvider
      • ScyllaCompression
    • Scylla.Core.Util.Crypto
      • CryptoAlgorithm
      • CryptoErrorCode
      • CryptoException
      • CryptoExtensions
      • CryptoSettings
      • ICryptoProvider
      • KeyDerivationHash
      • KeyDerivationSettings
      • ScyllaCrypto
    • Scylla.Core.Util.DebugDraw
      • DebugDraw
      • DebugDrawSpace
      • DebugDrawTextAlign
    • Scylla.Core.Util.Effects
      • ColorAnimationText
      • ColorAnimationTextDirection
      • ColorAnimationTextGradient
    • Scylla.Core.Util.File
      • ConfigFile
      • ConfigFileGroup
      • ConfigFileProperty
      • ConfigFilePropertyType
      • ConfigFileUtil
      • FileErrorCode
      • FileException
      • FileExtensions
      • FilePathExtensions
      • FilePathUtil
      • FileProgress
      • FileSettings
      • ImageFileFormat
      • ImageFileSettings
      • ScyllaFileUtil
    • Scylla.Core.Util.Geom
      • AABB3D
      • BarrelColoringMode
      • BollardColoringMode
      • CappedWallColoringMode
      • Capsule3D
      • ColliderMode
      • CrateColoringMode
      • Ellipse
      • FaceColoringMode
      • IFaceColorResolver
      • OBB3D
      • PaletteFaceColorResolver
      • PaneledWall1ColoringMode
      • PaneledWall2ColoringMode
      • PipeSegmentColoringMode
      • RoundedBoxColoringMode
      • ScyllaArchwayShape
      • ScyllaBarrelShape
      • ScyllaBollardShape
      • ScyllaBoxShape
      • ScyllaCappedWallShape
      • ScyllaCapsuleShape
      • ScyllaColumnShape
      • ScyllaConeShape
      • ScyllaCrateShape
      • ScyllaCurvedStairsShape
      • ScyllaCylinderShape
      • ScyllaDomeShape
      • ScyllaFloorTileShape
      • ScyllaIcoSphereShape
      • ScyllaLadderShape
      • ScyllaLinearStairsShape
      • ScyllaOctahedronShape
      • ScyllaPaneledWall1Shape
      • ScyllaPaneledWall2Shape
      • ScyllaPipeSegmentShape
      • ScyllaPipeShape
      • ScyllaPlaneShape
      • ScyllaPyramidShape
      • ScyllaQuadShape
      • ScyllaRampShape
      • ScyllaRingShape
      • ScyllaRoundedBoxShape
      • ScyllaShapeBase3D
      • ScyllaShapes
      • ScyllaShelvedWallShape
      • ScyllaSignShape
      • ScyllaSkirtedWallShape
      • ScyllaSkyDomeShape
      • ScyllaSphereShape
      • ScyllaSpiralStairsShape
      • ScyllaTorusShape
      • ScyllaTriangularPrismShape
      • ScyllaWallShape
      • ScyllaWallWithDoorShape
      • ScyllaWallWithWindowShape
      • ShapeMaterialCache
      • ShelvedWallColoringMode
      • SignColoringMode
      • Size2D
      • Size3D
      • SkirtedWallColoringMode
      • Sphere3D
      • StairsColoringMode
      • UniformColorResolver
    • Scylla.Core.Util.Math
      • Complex
      • MathUtil
      • Monomial
      • Polynomial
    • Scylla.Core.Util.Noise
      • CellularDistanceType
      • CellularReturnType
      • CellularSettings
      • FractalType
      • NoiseAlgorithm
      • NoiseCurlSampler
      • NoiseDomainWarper
      • NoiseGenerator
      • NoiseSettings
      • PixelNoise
      • PixelNoiseDistribution
      • PixelNoiseSettings
      • WarpSettings
    • Scylla.Core.Util.Palette
      • ColorAssetRegistry
      • ColorGradient
      • ColorGradientAlphaStop
      • ColorGradientAlphaStopData
      • ColorGradientAsset
      • ColorGradientColorSpace
      • ColorGradientData
      • ColorGradientMode
      • ColorGradientStop
      • ColorGradientStopData
      • ColorGradientStopInterpolation
      • ColorPalette
      • ColorPaletteAsset
      • ColorPaletteData
      • ColorPaletteEntry
      • ColorPaletteEntryData
      • ColorPaletteMapping
      • ColorRole
      • ColorStopBlendMode
      • ColorSwatchCollection
      • ColorSwatchCollectionAsset
      • ColorSwatchCollectionData
      • ColorSwatchEntryData
      • MutableColorGradient
      • MutableColorPalette
    • Scylla.Core.Util.ProceduralMapGen
      • BSPSettings
      • CellularAutomataSettings
      • CorridorStyle
      • DoorAxis
      • DoorPlacement
      • DoorPlacementSettings
      • DoorShapeConfig
      • DrunkardWalkSettings
      • FloorplanSettings
      • InstantiationResult
      • MapCellType
      • MapCorridor<TCoord>
      • MapGenResult<TCoord>
      • MapGenSettings
      • MapOverlaySettings
      • MapPatternType
      • MapRoom<TCoord>
      • MazeRoomSettings
      • MazeSettings
      • NoiseThresholdSettings
      • ProceduralMapGenerator
      • ProceduralMapOverlay
      • ProceduralMapPostProcessor
      • RoomCorridorSettings
      • RoomGroup
      • ScyllaProceduralMapInstantiator
      • VoronoiRegionSettings
      • WindingCorridorSettings
    • Scylla.Core.Util.Random
      • AliasTable
      • CryptoRandomSource
      • DiceRoll
      • IProbabilityInfluence
      • IRandomSource
      • MersenneTwister
      • MersenneTwisterState
      • PCG32
      • PCG32State
      • PickHistory
      • PickRecord
      • PoissonDiskSampler
      • PoissonDiskSampler.BoundChecker
      • ProbabilityEntry<T>
      • ProbabilityList<T>
      • ProbabilityNormalizer
      • RandomAlgorithm
      • RandomExtensions
      • RandomID
      • RandomSeeder
      • RandomText
      • RandomUtil
      • RandomUtil.DeterministicRNG
      • RandomUtil.DeterministicRNGState
      • RepeatPreventionMode
      • SelectionStrategy
      • SplitMix64RNG
      • SplitMix64State
      • SystemRandomSource
      • UnityRandomSource
      • Xoroshiro128Plus
      • Xoroshiro128State
      • Xoshiro256StarStar
      • Xoshiro256State
    • Scylla.Core.Util.Ranges
      • DoubleRange
      • FloatRange
      • IntRange
    • Scylla.Core.Util.Serialization
      • ArraySerializer<T>
      • BinaryTypeTag
      • BoolSerializer
      • BoundsSerializer
      • ByteArraySerializer
      • ByteSerializer
      • CharSerializer
      • Color32Serializer
      • ColorSerializer
      • DateTimeOffsetSerializer
      • DateTimeSerializer
      • DecimalSerializer
      • DefaultValueHandling
      • DictionarySerializer<TKey, TValue>
      • DoubleSerializer
      • EnumSerializer<T>
      • FloatSerializer
      • GuidSerializer
      • HashSetSerializer<T>
      • IScyllaReader
      • IScyllaWriter
      • ISerializationContext
      • ITypeSerializer
      • ITypeSerializer<T>
      • IntSerializer
      • LayerMaskSerializer
      • ListSerializer<T>
      • LongSerializer
      • NullHandling
      • PropertyMetadata
      • QuaternionSerializer
      • QueueSerializer<T>
      • RectIntSerializer
      • RectSerializer
      • ReferenceHandling
      • ReferenceTracker
      • ReflectionSerializer
      • SByteSerializer
      • ScyllaBinaryReader
      • ScyllaBinaryWriter
      • ScyllaIgnoreAttribute
      • ScyllaIncludeAttribute
      • ScyllaJSONReader
      • ScyllaJSONWriter
      • ScyllaMigrationAttribute
      • ScyllaPropertyAttribute
      • ScyllaSerializableAttribute
      • ScyllaSerialization
      • SerializationContext
      • SerializationEngine
      • SerializationException
      • SerializationFormat
      • SerializationResult
      • SerializationResult<T>
      • SerializationSettings
      • SerializationSettings.Builder
      • SerializationToken
      • ShortSerializer
      • StackSerializer<T>
      • StringSerializer
      • TimeSpanSerializer
      • TypeMetadata
      • TypeMetadataCache
      • TypeSerializerAdapter<T>
      • TypeSerializerBase<T>
      • UIntSerializer
      • ULongSerializer
      • UShortSerializer
      • Vector2IntSerializer
      • Vector2Serializer
      • Vector3IntSerializer
      • Vector3Serializer
      • Vector4Serializer
    • Scylla.Core.Util.Tween
      • Ease
      • EaseType
      • ITween
      • LoopType
      • ScyllaShapeTweenExtensions
      • ScyllaTween
      • SequenceItem
      • SequenceItemType
      • TweenAudioSourceExtensions
      • TweenBase
      • TweenCanvasGroupExtensions
      • TweenColor
      • TweenErrorCode
      • TweenException
      • TweenExtensions
      • TweenFloat
      • TweenID
      • TweenLerp
      • TweenManager
      • TweenMaterialExtensions
      • TweenPool
      • TweenQuaternion
      • TweenRectTransformExtensions
      • TweenSequence
      • TweenSettings
      • TweenSpriteRendererExtensions
      • TweenState
      • TweenTransformExtensions
      • TweenVector2
      • TweenVector3
      • TweenVector4
      • TweenVisualElementExtensions
      • Tween<T>
    • Scylla.Core.Util.UI
      • DebugCanvasUtil
      • GradientBackground
      • IUIText
      • IUITextField
      • LineScrollTextArea
      • LineScrollTextAreaBuilder
      • LineScrollTextBuffer
      • LineScrollTextBuffer.Builder
      • LineScrollTextBuffer.LogicalLine
      • LineScrollTextBufferLineAddedEvent
      • LineScrollTextBufferScrolledEvent
      • LineScrollWindow
      • LineScrollWindow.Enumerator
      • ScrollDirection
      • ScrollPhysics
      • ScrollTextArea
      • ScrollTextAreaBuilder
      • ScrollTextAreaDragEndedEvent
      • ScrollTextAreaDragStartedEvent
      • ScrollTextAreaScrolledEvent
      • ScrollTextBuffer
      • ScrollTextBuffer.Builder
      • ScrollTextBuffer.ScrollTextLine
      • ScrollTextBufferLineAddedEvent
      • ScrollTextLineView
      • ScyllaScrollRect
      • ScyllaUIAdaptiveStack
      • ScyllaUIAlignment
      • ScyllaUIAspectBreakpoint
      • ScyllaUICrossAlignment
      • ScyllaUIEdgeInsets
      • ScyllaUIFitMode
      • ScyllaUIFlexElement
      • ScyllaUIGrid
      • ScyllaUIGridItem
      • ScyllaUIHStack
      • ScyllaUILayoutAnimator
      • ScyllaUILayoutDebugDraw
      • ScyllaUILayoutDebugDrawConfig
      • ScyllaUILayoutGizmos
      • ScyllaUILayoutRoot
      • ScyllaUILayoutStyle
      • ScyllaUILength
      • ScyllaUILengthUnit
      • ScyllaUIPositioned
      • ScyllaUISafeArea
      • ScyllaUIScreenMargin
      • ScyllaUISizeMode
      • ScyllaUISpacer
      • ScyllaUIStackBase
      • ScyllaUIText
      • ScyllaUITextGroup
      • ScyllaUITrack
      • ScyllaUITrackSizingMode
      • ScyllaUIVStack
      • ScyllaUIZStack
      • TMPSettings
      • TMPUtil
      • TextSelectionPosition
      • TextSelectionRange
      • UIAlignment
      • UIAnchor
      • UIAnchors
      • UIFontReference
      • UIFontStyle
      • UIMargin
      • UIPadding
      • UITextBuilder
      • UITextComponent
      • UITextFactory
      • UITextFieldBuilder
      • UITextFieldComponent
      • UIUtil
      • VisualLine
    • Scylla.Core.Util.UIToolkit
      • ScyllaSafeScheduler
    • Scylla.Core.Util.Units
      • AreaUnit
      • DataUnit
      • LengthUnit
      • MassUnit
      • PressureUnit
      • SpeedUnit
      • TemperatureUnit
      • TimeFormat
      • TimeUnit

    Class FontUtil

    Centralized font loading and management utility for the Scylla framework. Provides a single source of truth for font access, supporting both Unity's built-in UnityEngine.Font (TTF) and TextMesh Pro's TMPro.TMP_FontAsset (SDF) formats. Uses lazy per-name dictionaries to cache loaded assets so that repeated calls to any Load* method never trigger a redundant Load<T>(string) call.

    Inheritance
    object
    FontUtil
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Scylla.Core.Util
    Assembly: ScyllaCore.dll
    Syntax
    public static class FontUtil
    Remarks

    The Scylla monospace font ships in two families: ScyllaMono (standard width) and ScyllaMono-Cond (condensed). The standard-width family is the framework default. Both are stored under Resources/Fonts/TTF/ for TTF assets and Resources/Fonts/SDF/ for TMP SDF assets, in three weights mapped via FontVariant. The LoadDefaultMono methods select the family via a condensed flag and, when a requested weight is not found on disk, can walk a fallback chain toward Regular.

    Character extraction methods (GetSupportedCharacters(Font, UnicodeRange[]) and GetSupportedCharacters(TMP_FontAsset)) also use their own caches keyed by font instance ID and Unicode range hash, so expensive glyph-table scans are never repeated for the same font and range combination.

    DPI-based text scaling (GetDPITextScale()) is computed once and cached for the session. It uses a fifth-root curve relative to a 24" 1080p reference monitor to boost readability on physically small high-DPI screens.

    Editor-only methods (LoadFromAssetPath, LoadSDFFromAssetPath, GetDefaultMonoAssetPath, GetDefaultMonoSDFAssetPath) load assets outside the Resources folder through LoadAssetAtPath<T>(string), and the loaders return null in a player build.

    Fields

    DPI_TEXT_SCALE_MAX

    Maximum value returned by GetDPITextScale().

    Declaration
    public const float DPI_TEXT_SCALE_MAX = 2
    Field Value
    Type Description
    float

    DPI_TEXT_SCALE_MIN

    Minimum value returned by GetDPITextScale().

    Declaration
    public const float DPI_TEXT_SCALE_MIN = 1
    Field Value
    Type Description
    float

    FALLBACK_SCREEN_DPI

    Default screen DPI assumed when UnityEngine.Screen.dpi returns 0 (unknown).

    Declaration
    public const float FALLBACK_SCREEN_DPI = 96
    Field Value
    Type Description
    float

    FONT_FOLDER

    Base fonts folder name under Resources.

    Declaration
    public const string FONT_FOLDER = "Fonts"
    Field Value
    Type Description
    string

    FONT_SCYLLA_DEFAULT_MONO_NAME

    Scylla default monospace TTF font name (standard-width Regular).

    Declaration
    public const string FONT_SCYLLA_DEFAULT_MONO_NAME = "ScyllaMono-Regular"
    Field Value
    Type Description
    string

    FONT_SCYLLA_DEFAULT_MONO_SDF_NAME

    Scylla default monospace TMP SDF font asset name (standard-width Regular SDF).

    Declaration
    public const string FONT_SCYLLA_DEFAULT_MONO_SDF_NAME = "ScyllaMono-Regular SDF"
    Field Value
    Type Description
    string

    FONT_SCYLLA_MONO_BASE

    Base name for the condensed Scylla monospace font family (ScyllaMono-Cond).

    Declaration
    public const string FONT_SCYLLA_MONO_BASE = "ScyllaMono-Cond"
    Field Value
    Type Description
    string

    FONT_SCYLLA_MONO_BOLD

    Condensed monospace Bold (ExtraBold) TTF font name.

    Declaration
    public const string FONT_SCYLLA_MONO_BOLD = "ScyllaMono-Cond-ExtraBold"
    Field Value
    Type Description
    string

    FONT_SCYLLA_MONO_BOLD_SDF

    Condensed monospace Bold (ExtraBold) SDF font asset name.

    Declaration
    public const string FONT_SCYLLA_MONO_BOLD_SDF = "ScyllaMono-Cond-ExtraBold SDF"
    Field Value
    Type Description
    string

    FONT_SCYLLA_MONO_LIGHT

    Condensed monospace Light (Thin) TTF font name.

    Declaration
    public const string FONT_SCYLLA_MONO_LIGHT = "ScyllaMono-Cond-Thin"
    Field Value
    Type Description
    string

    FONT_SCYLLA_MONO_LIGHT_SDF

    Condensed monospace Light (Thin) SDF font asset name.

    Declaration
    public const string FONT_SCYLLA_MONO_LIGHT_SDF = "ScyllaMono-Cond-Thin SDF"
    Field Value
    Type Description
    string

    FONT_SCYLLA_MONO_REGULAR

    Condensed monospace Regular TTF font name.

    Declaration
    public const string FONT_SCYLLA_MONO_REGULAR = "ScyllaMono-Cond-Regular"
    Field Value
    Type Description
    string

    FONT_SCYLLA_MONO_REGULAR_SDF

    Condensed monospace Regular SDF font asset name.

    Declaration
    public const string FONT_SCYLLA_MONO_REGULAR_SDF = "ScyllaMono-Cond-Regular SDF"
    Field Value
    Type Description
    string

    FONT_SCYLLA_MONO_STD_BASE

    Base name for the standard-width Scylla monospace font family (ScyllaMono), the framework default.

    Declaration
    public const string FONT_SCYLLA_MONO_STD_BASE = "ScyllaMono"
    Field Value
    Type Description
    string

    FONT_SCYLLA_MONO_STD_BOLD

    Standard-width monospace Bold (ExtraBold) TTF font name.

    Declaration
    public const string FONT_SCYLLA_MONO_STD_BOLD = "ScyllaMono-ExtraBold"
    Field Value
    Type Description
    string

    FONT_SCYLLA_MONO_STD_BOLD_SDF

    Standard-width monospace Bold (ExtraBold) SDF font asset name.

    Declaration
    public const string FONT_SCYLLA_MONO_STD_BOLD_SDF = "ScyllaMono-ExtraBold SDF"
    Field Value
    Type Description
    string

    FONT_SCYLLA_MONO_STD_LIGHT

    Standard-width monospace Light (Thin) TTF font name.

    Declaration
    public const string FONT_SCYLLA_MONO_STD_LIGHT = "ScyllaMono-Thin"
    Field Value
    Type Description
    string

    FONT_SCYLLA_MONO_STD_LIGHT_SDF

    Standard-width monospace Light (Thin) SDF font asset name.

    Declaration
    public const string FONT_SCYLLA_MONO_STD_LIGHT_SDF = "ScyllaMono-Thin SDF"
    Field Value
    Type Description
    string

    FONT_SCYLLA_MONO_STD_REGULAR

    Standard-width monospace Regular TTF font name.

    Declaration
    public const string FONT_SCYLLA_MONO_STD_REGULAR = "ScyllaMono-Regular"
    Field Value
    Type Description
    string

    FONT_SCYLLA_MONO_STD_REGULAR_SDF

    Standard-width monospace Regular SDF font asset name.

    Declaration
    public const string FONT_SCYLLA_MONO_STD_REGULAR_SDF = "ScyllaMono-Regular SDF"
    Field Value
    Type Description
    string

    FONT_SCYLLA_STATS_NAME

    Scylla performance-monitor stats TTF font name (ScyllaStats).

    Declaration
    public const string FONT_SCYLLA_STATS_NAME = "ScyllaStats"
    Field Value
    Type Description
    string

    FONT_SCYLLA_STATS_SDF_NAME

    Scylla performance-monitor stats SDF font asset name (ScyllaStats SDF).

    Declaration
    public const string FONT_SCYLLA_STATS_SDF_NAME = "ScyllaStats SDF"
    Field Value
    Type Description
    string

    FONT_SDF_ASSET_PATH

    Default asset path for Scylla SDF fonts folder.

    Declaration
    public const string FONT_SDF_ASSET_PATH = "Assets/Scylla/Framework/Core/Resources/Fonts/SDF"
    Field Value
    Type Description
    string

    FONT_SDF_PATH

    Full Resources path to SDF fonts folder.

    Declaration
    public const string FONT_SDF_PATH = "Fonts/SDF"
    Field Value
    Type Description
    string

    FONT_SDF_SUBFOLDER

    SDF fonts subfolder name.

    Declaration
    public const string FONT_SDF_SUBFOLDER = "SDF"
    Field Value
    Type Description
    string

    FONT_SDF_SUFFIX

    SDF font asset name suffix.

    Declaration
    public const string FONT_SDF_SUFFIX = " SDF"
    Field Value
    Type Description
    string

    FONT_TMPRO_DEFAULT_NAME

    TMPro default SDF font asset name (LiberationSans SDF).

    Declaration
    public const string FONT_TMPRO_DEFAULT_NAME = "LiberationSans SDF"
    Field Value
    Type Description
    string

    FONT_TMPRO_DEFAULT_PATH_FALLBACK

    Fallback path for TMPro default font (TMP default location).

    Declaration
    public const string FONT_TMPRO_DEFAULT_PATH_FALLBACK = "Fonts & Materials/LiberationSans SDF"
    Field Value
    Type Description
    string

    FONT_TMPRO_DEFAULT_PATH_PRIMARY

    Primary path for TMPro default font (Scylla custom location).

    Declaration
    public const string FONT_TMPRO_DEFAULT_PATH_PRIMARY = "Fonts/SDF/LiberationSans SDF"
    Field Value
    Type Description
    string

    FONT_TTF_ASSET_PATH

    Default asset path for Scylla TTF fonts folder.

    Declaration
    public const string FONT_TTF_ASSET_PATH = "Assets/Scylla/Framework/Core/Resources/Fonts/TTF"
    Field Value
    Type Description
    string

    FONT_TTF_PATH

    Full Resources path to TTF fonts folder.

    Declaration
    public const string FONT_TTF_PATH = "Fonts/TTF"
    Field Value
    Type Description
    string

    FONT_TTF_SUBFOLDER

    TTF fonts subfolder name.

    Declaration
    public const string FONT_TTF_SUBFOLDER = "TTF"
    Field Value
    Type Description
    string

    FONT_VARIANT_BOLD

    Font variant suffix for the Bold weight. Maps to the ExtraBold font asset.

    Declaration
    public const string FONT_VARIANT_BOLD = "-ExtraBold"
    Field Value
    Type Description
    string

    FONT_VARIANT_LIGHT

    Font variant suffix for the Light weight. Maps to the Thin font asset.

    Declaration
    public const string FONT_VARIANT_LIGHT = "-Thin"
    Field Value
    Type Description
    string

    FONT_VARIANT_REGULAR

    Font variant suffix for Regular weight.

    Declaration
    public const string FONT_VARIANT_REGULAR = "-Regular"
    Field Value
    Type Description
    string

    REFERENCE_PHYSICAL_WIDTH_INCHES

    Reference physical screen width in inches, based on a typical 24" 1080p monitor. Used as the baseline for DPI text scale calculations.

    Declaration
    public const float REFERENCE_PHYSICAL_WIDTH_INCHES = 20.9
    Field Value
    Type Description
    float

    Properties

    IsDefaultMonoCached

    Gets whether the Scylla default monospace TTF font is currently cached.

    Declaration
    public static bool IsDefaultMonoCached { get; }
    Property Value
    Type Description
    bool

    IsDefaultMonoSDFCached

    Gets whether the Scylla default monospace TMP SDF font is currently cached.

    Declaration
    public static bool IsDefaultMonoSDFCached { get; }
    Property Value
    Type Description
    bool

    Methods

    ClearCache()

    Clears all cached fonts and character data from memory. Note: This does not unload the fonts from Unity's memory.

    Declaration
    public static void ClearCache()

    ClearCharacterCache(TMP_FontAsset)

    Clears the character cache for a specific TMP SDF font asset.

    Declaration
    public static void ClearCharacterCache(TMP_FontAsset font)
    Parameters
    Type Name Description
    TMP_FontAsset font

    The TMP SDF font asset to clear from cache.

    ClearCharacterCache(Font)

    Clears the character cache for a specific TTF font.

    Declaration
    public static void ClearCharacterCache(Font font)
    Parameters
    Type Name Description
    Font font

    The TTF font to clear from cache.

    Exists(string)

    Checks if a TTF font exists in the default Fonts folder.

    Declaration
    public static bool Exists(string fontName)
    Parameters
    Type Name Description
    string fontName

    The font name without extension.

    Returns
    Type Description
    bool

    True if the font exists, false otherwise.

    ExistsSDF(string)

    Checks if an SDF font asset exists in the default Fonts folder.

    Declaration
    public static bool ExistsSDF(string fontName)
    Parameters
    Type Name Description
    string fontName

    The font asset name without extension.

    Returns
    Type Description
    bool

    True if the SDF font asset exists, false otherwise.

    GetAllFonts()

    Gets all TTF fonts from the default Fonts/TTF folder.

    Declaration
    public static Font[] GetAllFonts()
    Returns
    Type Description
    Font[]

    Array of all available TTF fonts.

    GetAllSDFFonts()

    Gets all SDF font assets from the default Fonts/SDF folder.

    Declaration
    public static TMP_FontAsset[] GetAllSDFFonts()
    Returns
    Type Description
    TMP_FontAsset[]

    Array of all available SDF font assets.

    GetDPITextScale()

    Computes a text size multiplier to compensate for physically small high-DPI screens. On a typical desktop monitor (~24") the multiplier is 1.0 (no change). On smaller screens (e.g., 13" Retina MacBook) it returns a value greater than 1.0 to boost text readability. Uses a fourth-root curve for gentle scaling. The result is cached after the first call.

    Declaration
    public static float GetDPITextScale()
    Returns
    Type Description
    float

    A scale multiplier in the range [DPI_TEXT_SCALE_MIN, DPI_TEXT_SCALE_MAX].

    GetDefaultMonoAssetPath()

    Gets the full asset path for the Scylla default monospace TTF font. Editor-only method.

    Declaration
    public static string GetDefaultMonoAssetPath()
    Returns
    Type Description
    string

    The full asset path to the default monospace TTF font.

    GetDefaultMonoSDFAssetPath()

    Gets the full asset path for the Scylla default monospace TMP SDF font asset. Editor-only method.

    Declaration
    public static string GetDefaultMonoSDFAssetPath()
    Returns
    Type Description
    string

    The full asset path to the default monospace TMP SDF font.

    GetSupportedCharacterCount(TMP_FontAsset)

    Gets the number of supported characters in a TMP SDF font asset.

    Declaration
    public static int GetSupportedCharacterCount(TMP_FontAsset font)
    Parameters
    Type Name Description
    TMP_FontAsset font

    The TMP SDF font asset to check.

    Returns
    Type Description
    int

    The number of supported characters, or 0 if font is null.

    GetSupportedCharacterCount(Font, UnicodeRange[])

    Gets the number of supported characters in a TTF font within the specified Unicode ranges.

    Declaration
    public static int GetSupportedCharacterCount(Font font, UnicodeRange[] ranges = null)
    Parameters
    Type Name Description
    Font font

    The TTF font to check.

    UnicodeRange[] ranges

    Optional array of Unicode ranges to scan. If null or empty, uses Common.

    Returns
    Type Description
    int

    The number of supported characters, or 0 if font is null.

    GetSupportedCharacters(TMP_FontAsset)

    Gets all supported characters from a TMP SDF font asset. Results are cached for subsequent calls.

    Declaration
    public static string GetSupportedCharacters(TMP_FontAsset font)
    Parameters
    Type Name Description
    TMP_FontAsset font

    The TMP SDF font asset to extract characters from.

    Returns
    Type Description
    string

    A string containing all supported characters, sorted by codepoint. Returns empty string if font is null.

    GetSupportedCharacters(Font, UnicodeRange[])

    Gets all supported characters from a TTF font within the specified Unicode ranges. Results are cached for subsequent calls with the same font and ranges.

    Declaration
    public static string GetSupportedCharacters(Font font, UnicodeRange[] ranges = null)
    Parameters
    Type Name Description
    Font font

    The TTF font to extract characters from.

    UnicodeRange[] ranges

    Optional array of Unicode ranges to scan. If null or empty, uses Common.

    Returns
    Type Description
    string

    A string containing all supported characters, sorted by codepoint. Returns empty string if font is null.

    GetSupportedCharactersFull(Font)

    Gets all supported characters from a TTF font by scanning the full Basic Multilingual Plane (BMP). This scans approximately 65,000 codepoints and may be slow on first call. Results are cached for subsequent calls.

    Declaration
    public static string GetSupportedCharactersFull(Font font)
    Parameters
    Type Name Description
    Font font

    The TTF font to extract characters from.

    Returns
    Type Description
    string

    A string containing all supported characters in the BMP, sorted by codepoint. Returns empty string if font is null.

    HasCharacter(TMP_FontAsset, char)

    Checks if a TMP SDF font asset contains a specific character.

    Declaration
    public static bool HasCharacter(TMP_FontAsset font, char character)
    Parameters
    Type Name Description
    TMP_FontAsset font

    The TMP SDF font asset to check.

    char character

    The character to check for.

    Returns
    Type Description
    bool

    True if the font supports the character, false otherwise.

    HasCharacter(Font, char)

    Checks if a TTF font contains a specific character.

    Declaration
    public static bool HasCharacter(Font font, char character)
    Parameters
    Type Name Description
    Font font

    The TTF font to check.

    char character

    The character to check for.

    Returns
    Type Description
    bool

    True if the font supports the character, false otherwise.

    Load(string)

    Loads a TTF font by name from the default Fonts folder. The font is cached on first load for subsequent calls.

    Declaration
    public static Font Load(string fontName)
    Parameters
    Type Name Description
    string fontName

    The font name without extension.

    Returns
    Type Description
    Font

    The loaded font, or null if not found.

    LoadDefaultMono()

    Loads the Scylla default monospace TTF font (standard-width Regular). The font is cached on first load for subsequent calls.

    Declaration
    public static Font LoadDefaultMono()
    Returns
    Type Description
    Font

    The default monospace font, or null if not found.

    LoadDefaultMono(FontVariant, bool, bool)

    Loads a Scylla monospace TTF font weight with automatic fallback. If the requested weight is not found, attempts to load fallback weights. Fallback chain: Bold -> Regular, Light -> Regular. The family (condensed or standard) is preserved across the fallback chain.

    Declaration
    public static Font LoadDefaultMono(FontVariant variant, bool condensed = false, bool useFallback = true)
    Parameters
    Type Name Description
    FontVariant variant

    The font weight to load.

    bool condensed

    If true, loads from the condensed family (ScyllaMono-Cond); if false (default), loads from the standard-width family (ScyllaMono).

    bool useFallback

    If true, attempts fallback weights when the requested weight is not found. If false, returns null if the exact weight is not available.

    Returns
    Type Description
    Font

    The loaded font weight, a fallback font, or null if none found.

    LoadDefaultMonoSDF()

    Loads the Scylla default monospace SDF font asset (standard-width Regular SDF). The font is cached on first load for subsequent calls.

    Declaration
    public static TMP_FontAsset LoadDefaultMonoSDF()
    Returns
    Type Description
    TMP_FontAsset

    The default monospace SDF font asset, or null if not found.

    LoadDefaultMonoSDF(FontVariant, bool, bool)

    Loads a Scylla monospace SDF font weight with automatic fallback. If the requested weight is not found, attempts to load fallback weights. Fallback chain: Bold -> Regular, Light -> Regular. The family (condensed or standard) is preserved across the fallback chain.

    Declaration
    public static TMP_FontAsset LoadDefaultMonoSDF(FontVariant variant, bool condensed = false, bool useFallback = true)
    Parameters
    Type Name Description
    FontVariant variant

    The font weight to load.

    bool condensed

    If true, loads from the condensed family (ScyllaMono-Cond); if false (default), loads from the standard-width family (ScyllaMono).

    bool useFallback

    If true, attempts fallback weights when the requested weight is not found. If false, returns null if the exact weight is not available.

    Returns
    Type Description
    TMP_FontAsset

    The loaded SDF font weight, a fallback font, or null if none found.

    LoadFromAssetPath(string)

    Loads a TTF font from a full asset path using AssetDatabase. Editor-only method for loading fonts outside of Resources; returns null in a player build.

    Declaration
    public static Font LoadFromAssetPath(string assetPath)
    Parameters
    Type Name Description
    string assetPath

    The full asset path (e.g., "Assets/Fonts/MyFont.ttf").

    Returns
    Type Description
    Font

    The loaded font, or null if not found.

    LoadFromPath(string)

    Loads a TTF font from a custom Resources path.

    Declaration
    public static Font LoadFromPath(string resourcePath)
    Parameters
    Type Name Description
    string resourcePath

    The full Resources path to the font (without extension).

    Returns
    Type Description
    Font

    The loaded font, or null if not found.

    LoadSDF(string)

    Loads an SDF font asset by name from the default Fonts folder. The font is cached on first load for subsequent calls.

    Declaration
    public static TMP_FontAsset LoadSDF(string fontName)
    Parameters
    Type Name Description
    string fontName

    The font asset name without extension.

    Returns
    Type Description
    TMP_FontAsset

    The loaded SDF font asset, or null if not found.

    LoadSDFFromAssetPath(string)

    Loads an SDF font asset from a full asset path using AssetDatabase. Editor-only method for loading fonts outside of Resources; returns null in a player build.

    Declaration
    public static TMP_FontAsset LoadSDFFromAssetPath(string assetPath)
    Parameters
    Type Name Description
    string assetPath

    The full asset path (e.g., "Assets/Fonts/MyFont SDF.asset").

    Returns
    Type Description
    TMP_FontAsset

    The loaded SDF font asset, or null if not found.

    LoadSDFFromPath(string)

    Loads an SDF font asset from a custom Resources path.

    Declaration
    public static TMP_FontAsset LoadSDFFromPath(string resourcePath)
    Parameters
    Type Name Description
    string resourcePath

    The full Resources path to the SDF font asset (without extension).

    Returns
    Type Description
    TMP_FontAsset

    The loaded SDF font asset, or null if not found.

    LoadTMProDefaultSDF()

    Loads the TMPro default SDF font asset (LiberationSans SDF). First attempts to load from the Scylla custom location, then falls back to the TMP default location. The font is cached on first load for subsequent calls.

    Declaration
    public static TMP_FontAsset LoadTMProDefaultSDF()
    Returns
    Type Description
    TMP_FontAsset

    The TMPro default SDF font asset, or null if not found in either location.

    PreloadDefaultMono()

    Preloads the Scylla default monospace TTF and TMP SDF fonts into the cache. Call this during initialization to ensure fonts are ready when needed.

    Declaration
    public static void PreloadDefaultMono()

    ScaledFontSizeFor(float)

    Applies the DPI text scale to a font size. Convenience method equivalent to fontSize * GetDPITextScale().

    Declaration
    public static float ScaledFontSizeFor(float fontSize)
    Parameters
    Type Name Description
    float fontSize

    The base font size to scale.

    Returns
    Type Description
    float

    The DPI-adjusted font size.

    TryGetSupportedCharacters(TMP_FontAsset, out string)

    Attempts to get supported characters from a TMP SDF font asset.

    Declaration
    public static bool TryGetSupportedCharacters(TMP_FontAsset font, out string characters)
    Parameters
    Type Name Description
    TMP_FontAsset font

    The TMP SDF font asset to extract characters from.

    string characters

    The resulting character string if successful.

    Returns
    Type Description
    bool

    True if the font is valid and characters were extracted, false otherwise.

    TryGetSupportedCharacters(Font, out string, UnicodeRange[])

    Attempts to get supported characters from a TTF font.

    Declaration
    public static bool TryGetSupportedCharacters(Font font, out string characters, UnicodeRange[] ranges = null)
    Parameters
    Type Name Description
    Font font

    The TTF font to extract characters from.

    string characters

    The resulting character string if successful.

    UnicodeRange[] ranges

    Optional array of Unicode ranges to scan. If null or empty, uses Common.

    Returns
    Type Description
    bool

    True if the font is valid and characters were extracted, false otherwise.

    TryLoad(string, out Font)

    Attempts to load a TTF font by name.

    Declaration
    public static bool TryLoad(string fontName, out Font font)
    Parameters
    Type Name Description
    string fontName

    The font name without extension.

    Font font

    The loaded font if successful.

    Returns
    Type Description
    bool

    True if the font was loaded successfully, false otherwise.

    TryLoadDefaultMono(FontVariant, out Font, bool, bool)

    Attempts to load a Scylla monospace TTF font weight with automatic fallback.

    Declaration
    public static bool TryLoadDefaultMono(FontVariant variant, out Font font, bool condensed = false, bool useFallback = true)
    Parameters
    Type Name Description
    FontVariant variant

    The font weight to load.

    Font font

    The loaded font if successful.

    bool condensed

    If true, loads from the condensed family (ScyllaMono-Cond); if false (default), loads from the standard-width family (ScyllaMono).

    bool useFallback

    If true, attempts fallback weights when the requested weight is not found.

    Returns
    Type Description
    bool

    True if a font was loaded (possibly a fallback), false otherwise.

    TryLoadDefaultMonoSDF(FontVariant, out TMP_FontAsset, bool, bool)

    Attempts to load a Scylla monospace SDF font weight with automatic fallback.

    Declaration
    public static bool TryLoadDefaultMonoSDF(FontVariant variant, out TMP_FontAsset font, bool condensed = false, bool useFallback = true)
    Parameters
    Type Name Description
    FontVariant variant

    The font weight to load.

    TMP_FontAsset font

    The loaded SDF font if successful.

    bool condensed

    If true, loads from the condensed family (ScyllaMono-Cond); if false (default), loads from the standard-width family (ScyllaMono).

    bool useFallback

    If true, attempts fallback weights when the requested weight is not found.

    Returns
    Type Description
    bool

    True if a font was loaded (possibly a fallback), false otherwise.

    TryLoadSDF(string, out TMP_FontAsset)

    Attempts to load an SDF font asset by name.

    Declaration
    public static bool TryLoadSDF(string fontName, out TMP_FontAsset font)
    Parameters
    Type Name Description
    string fontName

    The font asset name without extension.

    TMP_FontAsset font

    The loaded SDF font asset if successful.

    Returns
    Type Description
    bool

    True if the font was loaded successfully, false otherwise.

    TryLoadTMProDefaultSDF(out TMP_FontAsset)

    Attempts to load the TMPro default SDF font asset.

    Declaration
    public static bool TryLoadTMProDefaultSDF(out TMP_FontAsset font)
    Parameters
    Type Name Description
    TMP_FontAsset font

    The loaded SDF font asset if successful.

    Returns
    Type Description
    bool

    True if the font was loaded successfully, false otherwise.

    In this article
    Back to top Scylla Framework - Core Module API Documentation