CalmUI
API Reference

C++ API

Generated inventory of public CalmUI Core and Unreal plugin declarations.

The inventory below is generated from public headers in core/*/include/calmui and the Unreal modules' Public directories. Expand a header to see its public classes, structures, and enumerations.

CalmUiCompilercore/CalmUiCompiler/include/calmui/compiler/ComponentCompiler.h
  • enum class PackageConfiguration
  • struct ComponentImport
  • struct ComponentSection
  • struct ParsedComponent
  • struct ComponentParseResult
  • struct ComponentBuildOptions
  • struct Screen
  • struct ComponentBuildResult
  • struct PackageManifest
  • struct PackageInspection
CalmUiCorecore/CalmUiCore/include/calmui/Actions.h
  • struct ActionPayloadField
  • struct ActionDefinition
  • struct CalmUiActionSchema
  • struct ActionContext
  • enum class ActionDispatchResult
  • struct ActionLogEntry
  • class CalmUiActionDispatcher
  • struct Registration
CalmUiCorecore/CalmUiCore/include/calmui/Animation.h
  • enum class EasingKind
  • struct Easing
  • enum class VisualProperty
  • struct VisualStyle
  • struct TransitionSpec
  • class TransitionRuntime
  • struct Track
  • enum class AnimationDirection
  • enum class AnimationFillMode
  • struct Keyframe
  • struct TransformOperation
  • enum class Kind
  • struct KeyframeAnimation
  • class KeyframeRuntime
  • struct StyleStateSet
  • class FUIStyleStateResolver
CalmUiCorecore/CalmUiCore/include/calmui/Components.h
  • enum class ScreenLayer
  • enum class ScreenInputPolicy
  • enum class ScreenRetentionPolicy
  • struct ScreenDescriptor
  • struct Transition
  • struct SourceLocation
  • enum class ExpressionOpcode
  • struct ExpressionInstruction
  • struct ExpressionProgram
  • enum class TemplateOpcode
  • struct TemplateInstruction
  • struct TemplateProgram
  • struct SlotDefinition
  • struct ComponentDescriptor
  • struct ComponentScriptHandler
  • struct ComponentScriptModule
  • enum class PackageFeature
  • struct ComponentPackage
  • struct PackageLoadResult
  • struct PackageLoadOptions
  • struct ComponentInstance
  • struct ComponentRuntimeCounters
  • struct ComponentEvent
  • struct UiInputEvent
  • struct ComponentViewResult
  • enum class LocalizationStatus
  • struct LocalizationResult
  • class ComponentView
  • enum class HotReloadMode
  • struct HotReloadResult
  • struct Impl
CalmUiCorecore/CalmUiCore/include/calmui/CoreFingerprint.h
  • struct CoreFingerprint
CalmUiCorecore/CalmUiCore/include/calmui/Deprecation.h
  • struct DeprecationNotice
CalmUiCorecore/CalmUiCore/include/calmui/Diagnostics.h
  • enum class DiagnosticSeverity
  • enum class DiagnosticCategory
  • struct Diagnostic
CalmUiCorecore/CalmUiCore/include/calmui/Document.h
  • class CalmUiDocument
CalmUiCorecore/CalmUiCore/include/calmui/Input.h
  • enum class InputAction
  • enum class InputDevice
  • struct InputBinding
  • struct InputProfile
  • enum class InputProfileIssueCode
  • struct InputProfileIssue
  • struct InputProfileValidation
  • enum class InputRebindResult
  • struct InputRebindOutcome
  • class ActiveInputDevice
CalmUiCorecore/CalmUiCore/include/calmui/Interaction.h
  • enum class NavigationDirection
  • enum class InputEventType
  • struct UiInputEvent
  • struct ControlMetadata
  • struct ClipRegion
  • struct HitTestEntry
  • class FUIHitTestTree
  • struct FUIFocusState
  • class FUIFocusManager
  • enum class UiPseudoState
  • struct NodePseudoState
  • struct DispatchedEvent
  • class InteractionRuntime
  • struct PointerDragView
  • class PointerDragCoordinator
  • enum class DirtyFlags
CalmUiCorecore/CalmUiCore/include/calmui/Layout.h
  • struct SafeAreaInsets
  • struct ViewportMetrics
  • struct DocumentSource
  • struct LayoutClip
  • enum class TextDecorationPaint
  • struct LayoutEdges
  • struct LayoutElement
  • struct LayoutResult
  • class IUILayoutBackend
CalmUiCorecore/CalmUiCore/include/calmui/LucideIcons.h
  • struct LucideSegment
  • struct LucideFillCircle
  • struct LucideIconView
CalmUiCorecore/CalmUiCore/include/calmui/Math2D.h
  • struct Vec2
CalmUiCorecore/CalmUiCore/include/calmui/Notifications.h
  • enum class NotificationPhase
  • enum class NotificationEnqueueStatus
  • struct NotificationQueueOptions
  • struct NotificationRequest
  • class NotificationEntry
  • struct NotificationEnqueueResult
  • class NotificationQueue
  • enum class NotificationPublishStatus
  • class NotificationStoreProjection
CalmUiCorecore/CalmUiCore/include/calmui/PaintRecorder.h
  • class IUIPaintRecorder
  • class PaintRecorder
CalmUiCorecore/CalmUiCore/include/calmui/PointerFollow.h
  • struct PointerFollowSettings
CalmUiCorecore/CalmUiCore/include/calmui/Resources.h
  • struct ImageMetadata
  • class FUIResourceManager
CalmUiCorecore/CalmUiCore/include/calmui/Runtime.h
  • class Runtime
CalmUiCorecore/CalmUiCore/include/calmui/Screens.h
  • enum class ScreenLifecycle
  • struct ScreenReference
  • struct ScreenShowOptions
  • struct ScreenEntry
  • struct ScreenLifecycleEvent
  • struct ScreenInputState
  • class ScreenManager
CalmUiCorecore/CalmUiCore/include/calmui/Script.h
  • enum class ScriptClockDomain
  • struct ScriptLimits
  • struct ScriptHandlerDescriptor
  • struct ScriptModule
  • struct ScriptReloadResult
  • struct ScriptError
  • struct ScriptCounters
  • struct ScriptEmission
  • struct ScriptHost
  • struct ScriptEventControl
  • class ICalmUiScriptContext
  • class ICalmUiScriptRuntime
CalmUiCorecore/CalmUiCore/include/calmui/Store.h
  • class CalmUiStoreSubscription
  • enum class StoreValueType
  • enum class StoreScope
  • struct StoreFieldDefinition
  • struct CalmUiStoreSchema
  • enum class StorePatchKind
  • struct CalmUiStorePatch
  • struct StoreCounters
  • struct StoreDiagnostic
  • struct CalmUiStoreSnapshot
  • enum class StoreSchemaChange
  • class CalmUiStore
  • struct Subscription
  • struct PendingPatch
  • struct MemberRef
  • struct MemberRange
  • struct PathPart
  • class CalmUiStoreTransaction
CalmUiCorecore/CalmUiCore/include/calmui/TextEdit.h
  • class TextEdit
  • enum class LineBreaks
  • struct Snapshot
CalmUiCorecore/CalmUiCore/include/calmui/UiScaling.h
  • enum class UiScalingMode
  • struct UiScaling
CalmUiCorecore/CalmUiCore/include/calmui/Value.h
  • struct AssetRef
  • class Value
CalmUiCorecore/CalmUiCore/include/calmui/VirtualList.h
  • struct FixedVirtualListConfig
  • struct VirtualListWindow
  • enum class VirtualListAlignment
CalmUiCorecore/CalmUiCore/include/calmui/WorldAnchors.h
  • enum class WorldAnchorOrigin
  • enum class WorldAnchorClamp
  • struct WorldAnchorSettings
  • struct WorldAnchor
  • class WorldAnchorTable
  • enum class WorldAnchorState
  • struct WorldAnchorResolution
CalmUiCorecore/CalmUiCore/include/calmui/WorldSurface.h
  • enum class WorldSurfaceColorSpace
  • enum class WorldSurfaceOcclusionPolicy
  • enum class WorldPointerPhase
  • struct WorldSurfaceDescriptor
  • struct WorldSurfacePointerSample
  • struct RoutedWorldPointer
  • class WorldSurfaceInputRouter
CalmUiDevcore/CalmUiDev/include/calmui/dev/CompilerDaemon.h
  • struct DevProject
  • struct ChangedFile
  • class FileWatcher
  • struct DevTelemetry
  • struct DaemonEvent
  • enum class Kind
  • struct AssetSyncReport
  • struct Rejection
  • struct DaemonStatus
  • struct DevDiscoverySession
  • class CompilerDaemon
CalmUiDevcore/CalmUiDev/include/calmui/dev/DevProtocol.h
  • enum class MessageType
  • enum class ChangeKind
  • enum class PatchRejectReason
  • enum Feature
  • enum class ClientRole
  • struct FrameHeader
  • struct Frame
  • struct LocalizationQuery
  • class FrameDecoder
  • struct Hello
  • enum class HandshakeRejectReason
  • struct HandshakeRejection
  • enum class WorkspaceStatus
  • enum class PackageBuildStatus
  • struct ProjectPackageInfo
  • struct ProjectInfo
  • struct Patch
  • struct Asset
  • enum class Type
  • struct PatchResponse
  • struct AssetResult
  • struct RuntimeIdentity
  • struct InspectorNode
  • struct RuntimeSnapshot
  • struct ProfilerTelemetry
  • class TcpServer
  • struct DroppedClient
  • class TcpClient
CalmUiLayoutcore/CalmUiLayout/include/calmui/layout/LiteHtmlLayoutBackend.h
  • class FUIResourceManager
  • class TextSystem
  • class LiteHtmlLayoutBackend
  • struct Impl
CalmUiLayoutcore/CalmUiLayout/include/calmui/layout/NineSlice.h
  • struct NineSliceMargins
  • enum class NineSliceMode
  • struct NineSliceOptions
  • struct NineSliceLoweringResult
CalmUiRendererApicore/CalmUiRendererApi/include/calmui/renderer/BorderPattern.h
  • struct BorderPatternSide
  • struct BorderPatternParams
CalmUiRendererApicore/CalmUiRendererApi/include/calmui/renderer/PaintFrame.h
  • struct PaintFrameVersion
  • struct PaintViewport
  • struct Rect
  • struct Color
  • struct CornerRadii
  • struct EdgeWidths
  • struct UvRect
  • struct Transform2D
  • struct ResourceHandle
  • enum class TextureFilter
  • enum class PaintResourceFormat
  • class PaintPixelBuffer
  • enum class PaintResourceKind
  • struct PaintResource
  • struct SolidRectCommand
  • struct RoundedRectCommand
  • enum class BorderStyle
  • struct BorderCommand
  • struct ImageCommand
  • struct GlyphQuad
  • enum class TextRasterMode
  • struct TextRunCommand
  • struct PushClipCommand
  • struct PopClipCommand
  • struct PushTransformCommand
  • struct PopTransformCommand
  • struct PushOpacityCommand
  • struct PopOpacityCommand
  • struct FilterParameters
  • struct PushFilterCommand
  • struct PopFilterCommand
  • struct BackdropBlurCommand
  • struct BoxShadowCommand
  • struct GradientStop
  • struct LinearGradientCommand
  • struct RadialGradientCommand
  • struct ConicGradientCommand
  • enum class PaintCommandType
  • class PaintCommand
  • class PaintFrame
  • enum class PaintFrameValidationError
  • struct PaintFrameValidationResult
CalmUiRendererApicore/CalmUiRendererApi/include/calmui/renderer/PaintFrameDebugCodec.h
  • enum class PaintFrameDebugCodecError
  • struct PaintFrameDebugEncodeResult
  • struct PaintFrameDebugDecodeResult
  • class ByteReader
CalmUiRendererApicore/CalmUiRendererApi/include/calmui/renderer/TextShadowTaps.h
  • struct TextShadowTap
CalmUiStylecore/CalmUiStyle/include/calmui/style/CssProfile.h
  • struct CssValidationResult
  • struct CssOriginBreakpoint
  • struct CssSourceRange
CalmUiStylecore/CalmUiStyle/include/calmui/style/Effects.h
  • enum class OriginUnit
  • struct TransformOriginValue
  • struct CompiledTransform
  • struct CompiledShadow
  • struct CompiledOutline
  • struct CompiledGradient
  • enum class Kind
  • struct Stop
  • struct CompiledFilter
  • struct EffectsCompileResult
CalmUiStylecore/CalmUiStyle/include/calmui/style/InteractiveStyles.h
  • struct InteractiveAncestorMetadata
  • struct InteractiveElementMetadata
  • struct ResolvedInteractiveStyle
  • enum class InteractivePseudoMask
  • struct InteractiveStylePatch
  • struct CompiledInteractiveRule
  • struct Attribute
  • struct Ancestor
  • struct PreparedInteractiveStyles
  • struct Rule
  • class InteractiveStyleSheet
  • struct PreparedCache
  • struct InteractiveStyleSheetCompileResult
CalmUiTextcore/CalmUiText/include/calmui/text/BuiltinFonts.h
  • struct BuiltinFontInfo
CalmUiTextcore/CalmUiText/include/calmui/text/InputPaint.h
  • struct EditableTextLine
  • struct EditableTextMetrics
CalmUiTextcore/CalmUiText/include/calmui/text/TextSystem.h
  • enum class TextRasterizationMode
  • struct TextStyle
  • struct ShapedGlyph
  • struct ShapedText
  • struct TextSystemConfig
  • class TextSystem
  • struct Impl
CalmUiVectorcore/CalmUiVector/include/calmui/vector/Vector.h
  • enum class PaintKind
  • enum class FitMode
  • struct Paint
  • struct Path
  • struct Shape
  • struct VectorDocument
  • struct Limits
  • struct Result
  • struct RasterResult
CalmUiEditorintegrations/unreal/Source/CalmUiEditor/Public/CalmUiPackageFactory.h
  • class UCalmUiPackageFactory
  • class UCalmUiPackageAsset
CalmUiEditorintegrations/unreal/Source/CalmUiEditor/Public/CalmUiPackageImportCommandlet.h
  • class UCalmUiPackageImportCommandlet
CalmUiRendererintegrations/unreal/Source/CalmUiRenderer/Public/CalmUiExternalTextureProvider.h
  • class UTexture
  • enum class ECalmUiExternalResourceKind
  • struct FCalmUiExternalResourceEntry
  • enum class ECalmUiExternalResourceState
  • struct FCalmUiExternalResourceStatus
  • class ICalmUiExternalTextureProvider
  • class FCalmUiExternalTextureRegistry
CalmUiRendererintegrations/unreal/Source/CalmUiRenderer/Public/CalmUiHostImageAdapter.h
  • class FUIResourceManager
  • struct FCalmUiHostImageSource
  • class FCalmUiHostImageCache
  • struct FImpl
CalmUiRendererintegrations/unreal/Source/CalmUiRenderer/Public/CalmUiHotReloadBridge.h
  • class ICalmUiPlayerRuntimeBridge
  • struct FCalmUiDevelopmentPatch
  • struct FAsset
  • struct FCalmUiDevelopmentApplyResult
  • struct FAssetResult
  • struct FCalmUiInspectorNodeData
  • struct FCalmUiRuntimeSnapshotData
  • struct FProfilerTelemetry
  • class ICalmUiDevelopmentTarget
  • class FCalmUiDevelopmentTargetRegistry
CalmUiRendererintegrations/unreal/Source/CalmUiRenderer/Public/CalmUiInputBridge.h
  • enum class ECalmUiHostInputType
  • struct FCalmUiHostInputEvent
  • class FCalmUiInputBridge
CalmUiRendererintegrations/unreal/Source/CalmUiRenderer/Public/CalmUiLocalization.h
  • struct FPolyglotTextData
  • class FCalmUiLocalization
CalmUiRendererintegrations/unreal/Source/CalmUiRenderer/Public/CalmUiPlayerRuntimeBridge.h
  • class CalmUiStore
  • struct ComponentPackage
  • class ICalmUiScriptContext
  • class ICalmUiScriptRuntime
  • class WorldAnchorTable
  • struct FCalmUiScreenRenderEntry
  • struct FCalmUiHostAssetRenderEntry
  • struct FCalmUiRuntimeHostAssetRequest
  • class ICalmUiPlayerRuntimeBridge
  • class FCalmUiPlayerRuntimeRegistry
CalmUiRendererintegrations/unreal/Source/CalmUiRenderer/Public/CalmUiStyleResolveCache.h
  • struct FCache
CalmUiRendererintegrations/unreal/Source/CalmUiRenderer/Public/CalmUiTestBridge.h
  • enum class ECalmUiTestCommandType
  • struct FCalmUiTestCommand
  • struct FCalmUiTestElementSnapshot
  • struct FCalmUiTestExternalResourceSnapshot
  • struct FCalmUiTestAssetPatchResult
  • struct FCalmUiTestSnapshot
  • class FCalmUiTestBridge
CalmUiRendererintegrations/unreal/Source/CalmUiRenderer/Public/CalmUiViewSpace.h
  • struct FCalmUiViewSpaceMetrics
  • class FCalmUiViewSpace
CalmUiRendererintegrations/unreal/Source/CalmUiRenderer/Public/CalmUiWorldSurfaceBridge.h
  • class UTextureRenderTarget2D
  • class UWorld
  • struct FCalmUiWorldSurfaceRenderSubmission
  • class FCalmUiWorldSurfaceRenderRegistry
CalmUiRuntimeintegrations/unreal/Source/CalmUiRuntime/Public/CalmUiActionListener.h
  • class APlayerController
  • class UCalmUiActionListener
CalmUiRuntimeintegrations/unreal/Source/CalmUiRuntime/Public/CalmUiActionPrompt.h
  • struct FCalmUiActionPrompt
CalmUiRuntimeintegrations/unreal/Source/CalmUiRuntime/Public/CalmUiBlueprintLibrary.h
  • class APlayerController
  • class UCalmUiLocalPlayerSubsystem
  • enum class ECalmUiOpenScreenError
  • class UCalmUiBlueprintLibrary
  • class ULoadCalmUiPackageAsync
  • class UOpenCalmUiScreenAsync
  • enum class EOpenMode
CalmUiRuntimeintegrations/unreal/Source/CalmUiRuntime/Public/CalmUiEngineSubsystem.h
  • class UCalmUiEngineSubsystem
  • struct FState
CalmUiRuntimeintegrations/unreal/Source/CalmUiRuntime/Public/CalmUiInputProfile.h
  • enum class ECalmUiInputAction
  • enum class ECalmUiInputDevice
  • enum class ECalmUiInputMethod
  • enum class ECalmUiInputRebindResult
  • struct FCalmUiInputBinding
  • class UCalmUiInputProfile
CalmUiRuntimeintegrations/unreal/Source/CalmUiRuntime/Public/CalmUiLocalPlayerSubsystem.h
  • struct FCalmUiRuntimeHostAssetRequest
  • enum class ECalmUiStoreScalarType
  • struct FCalmUiStoreScalarValue
  • struct FCalmUiStoreObjectMemberValue
  • struct FCalmUiWorldAnchor
  • struct FCalmUiWorldAnchorLocation
  • struct FCalmUiExternalSurfaceStatus
  • enum class ECalmUiStoreKeyType
  • struct FCalmUiStoreKey
  • class UInputAction
  • class UTexture
  • class UCalmUiActionListener
  • class UInputMappingContext
  • struct FInputKeyEventArgs
  • class FViewport
  • class UGameViewportClient
  • enum class ECalmUiStorePatchKind
  • struct FCalmUiStorePatchEvent
  • struct FCalmUiActionEvent
  • enum class ECalmUiActionDispatchResult
  • struct FCalmUiNotificationState
  • class UCalmUiLocalPlayerSubsystem
  • struct FState
CalmUiRuntimeintegrations/unreal/Source/CalmUiRuntime/Public/CalmUiNotifications.h
  • enum class ECalmUiNotificationTone
  • enum class ECalmUiNotificationResult
  • struct FCalmUiNotificationContent
  • struct FCalmUiNotificationOptions
CalmUiRuntimeintegrations/unreal/Source/CalmUiRuntime/Public/CalmUiPackageAsset.h
  • enum class ECalmUiScreenLayer
  • enum class ECalmUiInputPolicy
  • enum class ECalmUiRetentionPolicy
  • enum class ECalmUiPackageBuildStatus
  • enum class ECalmUiHostAssetKind
  • enum class ECalmUiStoreValueType
  • enum class ECalmUiStoreScope
  • struct FCalmUiStoreFieldDescriptor
  • struct FCalmUiActionPayloadDescriptor
  • struct FCalmUiActionDescriptor
  • struct FCalmUiHostAssetReference
  • struct FCalmUiScreenId
  • struct FCalmUiScreenDescriptor
  • class UCalmUiPackageAsset
  • struct FCalmUiStoreFieldReference
  • struct FCalmUiActionReference
  • struct FCalmUiScreenReference
CalmUiRuntimeintegrations/unreal/Source/CalmUiRuntime/Public/CalmUiProjectSettings.h
  • class UCalmUiInputProfile
  • class UCalmUiProjectSettings
CalmUiRuntimeintegrations/unreal/Source/CalmUiRuntime/Public/CalmUiProjectTests.h
  • class FJsonObject
  • struct FCalmUiProjectTestHooks
  • class FCalmUiProjectTests
CalmUiRuntimeintegrations/unreal/Source/CalmUiRuntime/Public/CalmUiWorldSubsystem.h
  • class APlayerController
  • class UPrimitiveComponent
  • class UTextureRenderTarget2D
  • enum class ECalmUiWorldSurfaceColorSpace
  • enum class ECalmUiWorldSurfaceOcclusionPolicy
  • enum class ECalmUiWorldPointerPhase
  • enum class ECalmUiWorldNavigation
  • struct FCalmUiWorldSurfaceHandle
  • struct FCalmUiWorldSurfaceOptions
  • class UCalmUiWorldSubsystem
  • struct FSurfaceState

This is an API inventory, not a replacement for the workflow guides. Begin with C++ Store integration, C++ actions, or Unreal Engine integration for usage and ownership rules.

Notification scheduling (C++)

Schedule bounded notifications in a host-owned Core queue.

Blueprint API

Look up the current Blueprint node names and their categories.