LED Studio API Reference

This reference is generated from the shipped LED Studio assemblies and their XML documentation.

LEDStudio

BoardDefinition: Immutable runtime snapshot of a LEDStudio.LedBoardProfile. Created once from the authored asset and shared across board instances that reference the…
ILedBoardConfiguration: Focused board-definition and physical-sizing contract.
ILedBoardContent: Focused content contract for assigning and updating board sources.
ILedBoardDiagnostics: Focused lifecycle and output diagnostics contract.
ILedBoardFaults: Focused defect-simulation contract.
ILedBoardPlayback: Focused playlist and synchronization contract.
ILedBoardRuntime: Public runtime interface for controlling an LED board. Game code should interact with boards exclusively through this interface so implementation…
ILedSource: Unified interface for all content sources that can feed into the logical board composition pipeline. Sources provide content at board-space…
ILedTextRenderBackend: Optional render backend for LEDStudio.TextSource. Implementations can render rich text into a texture while LED Studio keeps source identity, board…
ILedTextRenderBackendEditorProvider: Editor extension contract for optional text-rendering packages that provide isolated previews and configure their required scene backend.
ILedTextRenderBackendIdentity: Identifies the render mode served by an optional text backend. Implement this alongside LEDStudio.ILedTextRenderBackend when more than one external…
ITextBlinkSource: Exposes shared flash or fade timing for a text-capable LED source.
ITextScrollOffsetSource: Exposes a manually controllable normalized scroll offset in addition to automatic text scrolling.
ITextStyledSource: Extended source interface for text-based sources that share common appearance properties (colours, text style, scrolling). Implemented by…
LedBoardBodyRegion: API type
LedBoardController: Main Unity scene component for LED board instances. Binds a board profile, source/composition content, and optional playlist to object lifetime…
LedBoardElement: UI Toolkit element that presents a live LED board output or standalone source texture, with optional scheduled refresh and hardware-style…
LedBoardElementBinder: Binds an authoritative scene LEDStudio.LedBoardController to one named LEDStudio.LedBoardElement in a UI Toolkit document.
LedBoardElementTextureMode: API type
LedBoardExtrusionMaterialSettings: Assigns optional materials to the generated side, top, bottom, and back body regions.
LedBoardExtrusionSettings: Configures generated board depth, depth scaling, and which body regions are rendered.
LedBoardFaultController: Convenience MonoBehaviour for applying a defect profile to a board at startup. Provides simple severity and toggle controls for designers and…
LedBoardGroup: Supervisor component for multi-panel LED configurations. Composes content into a single master RenderTexture at the combined resolution of all child…
LedBoardProfile: Reusable board definition that combines logical resolution, physical LED pitch and emitters, topology, cabinet layout, extrusion, and distance-based…
LedBoardSizing: Converts between physical display dimensions, emitter counts, pixel pitch, and generated topology bounds.
LedBoardState: API type
LedBrightnessResponse: API type
LedCabinetGrid: Describes the cabinet grid used for physical seams, cabinet dimensions, and installation layout.
LedCanvasDataSource: Feeds uGUI Canvas content into the LED board via a Camera that renders the Canvas to a managed RenderTexture. Assign a Camera that sees the Canvas…
LedCompositionAsset: Reusable layered program that positions, orders, blends, and scales LED sources or named live inputs within normalized board space.
LedCompositionLayer: Describes one composition layer’s source or live-input binding, normalized placement, fit mode, opacity, priority, and visibility.
LedDataSourceBase: Base class for data source components that sit alongside a LEDStudio.LedBoardController and automatically feed content into the board. Add one of…
LedDefectBlendRequest: Requests a defect profile to be added, replaced, multiplied, or removed under a stable layer key.
LedDefectEntry: Describes one simulated dead, stuck, dim, or intermittent LED defect.
LedDefectMode: API type
LedDefectProfile: Reusable authored collection of LED defects that can be layered onto a board at runtime.
LedDefectTarget: API type
LedEmitterParams: Configures an emitter’s shape, size, brightness, response, subpixel order, and close-up appearance.
LedEmitterShape: API type
LedFitMode: API type
LedGroupLayout: API type
LedImageDataSource: Displays a static image/logo on the LED board. Place on the same GameObject as LEDStudio.LedBoardController or a child — it will be auto-discovered.
LedLayoutAsset: Reusable normalized layer layout that can position live source textures on an LED canvas.
LedLayoutLayer: Defines one source layer’s normalized rectangle and blend properties in a reusable layout.
LedLiveInputBinding: Maps a named composition input to a live scene source component or texture.
LedPitchPreset: Defines the physical pixel pitch of an LED display in millimetres.
LedPlaylistAsset: Time-ordered sequence of LED sources or compositions, including entry duration, transitions, looping, and an optional synchronization group shared…
LedPlaylistEntry: Defines one playlist item, its source or composition, duration, transition, and placement overrides.
LedPlaylistEntryContentType: API type
LedPlaylistFrame: Identifies the current and previous playlist entries plus normalized transition progress at a sampled playback time.
LedPlaylistSourcePlacement: Overrides playlist source placement and reduction without changing the authored source asset.
LedQualityLevel: API type
LedQualityProfile: Reusable performance and fidelity profile controlling logical resolution, reduction, anti-moire treatment, defects, and shader quality.
LedReductionMode: API type
LedReductionSettings: Resolved texture-reduction settings used when converting source content to board resolution.
LedRenderPipelineGuard: Coordinates safe manual camera rendering for edit-mode GPU source and optional backend previews, including Scriptable Render Pipeline initialization…
LedRenderTextureDataSource: Feeds an external RenderTexture into the LED board (e.g. from a camera, a UI canvas, or another render pipeline). Place on the same GameObject as…
LedScoreDataSource: Displays a scoreboard on the LED board. Place on the same GameObject as LEDStudio.LedBoardController or a child — it will be auto-discovered.
LedSeamlessWrapDistribution: API type
LedSourceAsset: Reusable content definition for image, video, render-texture, text, timer, score, and UI Toolkit sources, including their rendering and refresh…
LedSourceIdUtility: Creates deterministic, normalized board-local IDs for runtime content sources and ports.
LedSourceType: API type
LedSubpixelOrder: API type
LedSyncDriver: Drives the shared clocks of every LEDStudio.LedSyncManager group exactly once per frame. Individual boards read the group clock via…
LedSyncManager: Manages sync groups across multiple LEDStudio.LedBoardController instances. Boards that belong to the same group share a single monotonic clock and…
LedTextBasedDataSource: Common base for text-based data source components that share appearance, font and scrolling settings. Derive from this instead of…
LedTextBlinkMode: API type
LedTextBlinkSettings: Configures text flashing or fading with on, off, and transition durations in seconds.
LedTextDataSource: Displays text content on the LED board using a built-in bitmap font. Place on the same GameObject as LEDStudio.LedBoardController or a child — it…
LedTextRasterizationMode: API type
LedTextRenderBackendAsset: Reusable configuration and factory for an optional text renderer. Each call must return an unshared backend instance. The receiving LED source owns…
LedTextRenderMode: API type
LedTextScrollAxis: API type
LedTextSettings: Shared bitmap and font-texture text layout settings, including pixel sizing, fit, alignment, wrapping, line spacing, character spacing, and…
LedTextSizingMode: API type
LedTimerDataSource: Displays a countdown timer on the LED board. Place on the same GameObject as LEDStudio.LedBoardController or a child — it will be auto-discovered.
LedTopologyAsset: Reusable asset containing validated flat, curved, or corner board topology settings.
LedTopologyMeshBuilder: Generates a board face and optional six-region extruded body mesh from topology settings and logical aspect ratio.
LedTopologySettings: Defines flat, curved, or corner board geometry, including sweep angle, radius, surface side, tessellation, physical segments, and UV behavior.
LedTopologyShape: API type
LedTopologySurfaceSide: API type
LedTransitionType: API type
LedUIToolkitDataSource: Feeds UI Toolkit content from the assigned UnityEngine.UIElements.UIDocument into the LED board through a managed RenderTexture. Place on the same…
LedVideoDataSource: Feeds video content from a sibling UnityEngine.Video.VideoPlayer to the LED board. Add a VideoPlayer component, assign a clip, and this source will…