LED Studio API Reference
This reference is generated from the shipped LED Studio assemblies and their XML documentation.
LEDStudio
Section titled “LEDStudio”- BoardDefinition: Immutable runtime snapshot of a LedBoardProfile . Created once from the authored asset and shared across board instances that reference the same…
- 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 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 ILedTextRenderBackend when more than one external renderer…
- 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 TextSource…
- LedBoardBodyRegion: Region of the board housing used to address its front, back, side faces or front frame for geometry and surface styling.
- 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 LedBoardController to one named LedBoardElement in a runtime UI Toolkit panel.
- LedBoardElementTextureMode: Texture presented by a UI Toolkit board element, choosing the hardware-style presentation or the board’s logical content output.
- LedBoardExtrusionMaterialSettings: Assigns optional materials to generated rear-body regions and the front frame.
- LedBoardExtrusionSettings: Configures generated rear-body depth and the optional front frame around the LED surface.
- LedBoardFaultController: Convenience MonoBehaviour for applying a defect profile to a board at startup. Provides simple severity and toggle controls for designers and…
- LedBoardFrameProfile: Reusable normalized front-frame cross-section. Curve time is outward distance and curve value is forward rise, both in the range zero to one.
- LedBoardFrameStyle: Cross-section profile of the board’s front frame, including no frame, built-in molded profiles or a custom profile.
- 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: Runtime board lifecycle, distinguishing an uninitialized, active, suspended or disposed board.
- LedBrightnessResponse: Curve mapping source pixel intensity to simulated emitter brightness, using a linear, gamma-biased or venue-contrast response.
- LedCabinetEdgePanels: Whether hexagonal panels cut by the board edge are shown.
- LedCabinetGrid: Describes the cabinet grid used for physical seams, cabinet dimensions, and installation layout.
- LedCabinetLayout: Arrangement of the cabinets or panels that make up one board.
- 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 LedBoardController and automatically feed content into the board. Add one of the concrete…
- 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: Visual behavior of a simulated LED fault, including dead, dim, flickering, stuck-color, color-drift, line-failure or cabinet-outage defects.
- LedDefectProfile: Reusable authored collection of LED defects that can be layered onto a board at runtime.
- LedDefectTarget: Pattern selecting where a defect applies, such as individual emitters, cabinet groups, rows, columns, board borders or a manual mask.
- LedEmitterParams: Configures an emitter’s shape, size, brightness, response, subpixel order, and close-up appearance.
- LedEmitterShape: Shape of an individual simulated emitter, using a circle, square, hexagon or LCD-style RGB subpixel bars.
- LedFitMode: Policy for fitting source content into a destination region, using stretch, aspect-preserving fit or fill, or native-size placement constrained by…
- LedGroupLayout: Arrangement of boards sharing one content canvas, using horizontal, vertical, grid, radial or placement-based spatial layouts.
- LedImageDataSource: Displays a static image/logo on the LED board. Place on the same GameObject as 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.
- LedManagedTextRendererHost: Records which LED source owns a retained scene text-renderer host.
- LedPanelArrangement: Physical placement a board group applies to its direct child panels, or Manual to leave their positions untouched.
- 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: Content assigned to a playlist entry, choosing a single source or a layered composition.
- 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: Named quality tier used by board-rendering and defect profiles, ranging from low through medium and high to ultra.
- LedQualityProfile: Reusable performance and fidelity profile controlling logical resolution, reduction, anti-moire treatment, defects, and shader quality.
- LedRealtimeGIPublisher: Optional contribution, rate and pause policy for the board’s automatic Enlighten emission updates.
- LedReductionMode: Sampling and filtering strategy used to reduce a source texture to the board’s logical pixel grid, including nearest, averaging and content-aware…
- 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 LedBoardController or a child — it will be auto-discovered.
- LedSeamlessWrapDistribution: Distribution of repeated text during seamless scrolling, choosing a single wrapped repeat or evenly distributed repeats.
- 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: Kind of content supplied to a board, including text, images, video, timers, scores, textures, UI surfaces and optional Chart Guru content.
- LedSpatialMapping: How the panels of a Spatial board group take their part of the shared canvas.
- LedSubpixelOrder: Left-to-right color-channel order of LCD-style subpixel bars, using RGB or BGR.
- LedSyncDriver: Drives the shared clocks of every LedSyncManager group exactly once per frame. Individual boards read the group clock via…
- LedSyncManager: Manages sync groups across multiple LedBoardController instances. Boards that belong to the same group share a single monotonic clock and advance…
- LedTextBasedDataSource: Common base for text-based data source components that share appearance, font and scrolling settings. Derive from this instead of LedDataSourceBase…
- LedTextBlinkMode: Blink behavior of LED text, choosing an abrupt visibility flash or a gradual opacity fade.
- 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 LedBoardController or a child — it will be…
- LedTextRasterizationMode: Rasterization preference for LED text, using renderer-selected defaults, smooth antialiasing or crisp rendering.
- LedTextRenderBackendAsset: Reusable configuration and factory for an optional text renderer. Each call must return an unshared backend instance. The receiving LED source owns…
- LedTextRenderMode: Text-rendering backend for an LED source, using bitmap glyphs, TextMesh Pro font textures or optional Text Studio and UniText integrations.
- LedTextScrollAxis: Direction in which LED text scrolls through its output area, using the horizontal or vertical axis.
- LedTextSettings: Shared bitmap and font-texture text layout settings, including pixel sizing, fit, alignment, wrapping, line spacing, character spacing, and…
- LedTextSizingMode: Font-size constraint for LED text, retaining the configured size or fitting the output area’s height, width or both dimensions.
- LedTimerDataSource: Displays a countdown timer on the LED board. Place on the same GameObject as LedBoardController or a child — it will be auto-discovered.
- LedTopologyAsset: Reusable asset containing validated flat, curved, corner, or spherical board topology settings.
- LedTopologyBendDirection: Direction in which curved and corner topology bends the board face.
- LedTopologyMeshBuilder: Generates a board face with optional rear-body and front-frame housing from topology settings and logical aspect ratio.
- LedTopologySettings: Defines flat, hexagonal, curved, corner, or spherical board geometry, including bend direction, sweep angle, radius, sphere latitude range, surface…
- LedTopologyShape: Geometric shape of the LED board surface, including flat, curved, corner, spherical and pointy-top or flat-top hexagonal boards.
- LedTopologySurfaceSide: Orientation of the emitting surface, facing outward or toward the interior of curved board geometry.
- LedTransitionType: Effect used to switch between playlist content, including cuts, fades, wipes, splits, irises, pushes, zooms and pixel-pattern transitions.
- LedUIToolkitDataSource: Feeds UI Toolkit content from the assigned UI panel (a UnityEngine.UIElements.UIDocument or, on Unity 6.5 or newer, a PanelRenderer ) into the LED…
- LedVideoDataSource: Feeds video content from a sibling VideoPlayer to the LED board. Add a VideoPlayer component, assign a clip, and this source will route its output…