Skip to main content

Function: createUiAspectRatioFitterEcsSystem()

createUiAspectRatioFitterEcsSystem(): EcsSystem<[AspectRatioFitterDefaultedOptions, RectTransformDefaultedOptions]>

Defined in: ui/systems/ui-aspect-ratio-fitter-system.ts:26

Creates a system that keeps every AspectRatioFitterEcsComponent's RectTransformEcsComponent's own size at its configured aspectRatio - widthControlsHeight/heightControlsWidth derive one axis from the other; fitInParent/envelopeParent derive both axes from the parent's own resolved rect (one frame stale, like every other cross-entity read in this module - see createUiLayoutEcsSystem's own doc comment), and are a no-op for an entity with no ParentEcsComponent.

Must be registered before createUiLayoutEcsSystem.

Returns​

EcsSystem<[AspectRatioFitterDefaultedOptions, RectTransformDefaultedOptions]>

The UI aspect ratio fitter ECS system.