Skip to content

BoardDefinition

ClassLEDStudioLEDStudio
public sealed class BoardDefinition

Immutable runtime snapshot of a LEDStudio.LedBoardProfile. Created once from the authored asset and shared across board instances that reference the same profile. Enables caching, diffing, and many-boards-sharing-one-definition.

public readonly Vector2Int LogicalResolution

Returns

UnityEngine.Vector2Int

public readonly float PitchMM

Returns

System.Single

public readonly LedEmitterParams Emitter

Returns

LEDStudio.LedEmitterParams

public readonly LedTopologySettings TopologySettings

Returns

LEDStudio.LedTopologySettings

public readonly LedBoardExtrusionSettings ExtrusionSettings

Returns

LEDStudio.LedBoardExtrusionSettings

public readonly LedCabinetGrid CabinetGrid

Returns

LEDStudio.LedCabinetGrid

public readonly LedReductionMode DefaultReduction

Returns

LEDStudio.LedReductionMode

public readonly float CloseUpDistance

Returns

System.Single

public readonly float FarBlendDistance

Returns

System.Single

public readonly float AspectRatio

Returns

System.Single

public BoardDefinition(LedBoardProfile profile)

Copies a profile’s resolved physical, topology, emitter, cabinet, reduction, and viewing settings.

Parameters

Name Type
profile LEDStudio.LedBoardProfile

BoardDefinition(Vector2Int, float, LedEmitterParams, LedTopologySettings, LedCabinetGrid, LedReductionMode, float, float)

Section titled “BoardDefinition(Vector2Int, float, LedEmitterParams, LedTopologySettings, LedCabinetGrid, LedReductionMode, float, float)”
public BoardDefinition(Vector2Int logicalResolution, float pitchMM, LedEmitterParams emitter, LedTopologySettings topologySettings, LedCabinetGrid cabinetGrid, LedReductionMode defaultReduction, float closeUpDistance, float farBlendDistance)

Creates a complete board definition without generated body extrusion.

Parameters

Name Type
logicalResolution UnityEngine.Vector2Int
pitchMM System.Single
emitter LEDStudio.LedEmitterParams
topologySettings LEDStudio.LedTopologySettings
cabinetGrid LEDStudio.LedCabinetGrid
defaultReduction LEDStudio.LedReductionMode
closeUpDistance System.Single
farBlendDistance System.Single

BoardDefinition(Vector2Int, float, LedEmitterParams, LedTopologySettings, LedBoardExtrusionSettings, LedCabinetGrid, LedReductionMode, float, float)

Section titled “BoardDefinition(Vector2Int, float, LedEmitterParams, LedTopologySettings, LedBoardExtrusionSettings, LedCabinetGrid, LedReductionMode, float, float)”
public BoardDefinition(Vector2Int logicalResolution, float pitchMM, LedEmitterParams emitter, LedTopologySettings topologySettings, LedBoardExtrusionSettings extrusionSettings, LedCabinetGrid cabinetGrid, LedReductionMode defaultReduction, float closeUpDistance, float farBlendDistance)

Creates a complete board definition including generated body extrusion.

Parameters

Name Type
logicalResolution UnityEngine.Vector2Int
pitchMM System.Single
emitter LEDStudio.LedEmitterParams
topologySettings LEDStudio.LedTopologySettings
extrusionSettings LEDStudio.LedBoardExtrusionSettings
cabinetGrid LEDStudio.LedCabinetGrid
defaultReduction LEDStudio.LedReductionMode
closeUpDistance System.Single
farBlendDistance System.Single