A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.
TypeScript 2d-game-engine3d3d-game-engineandroidcppecsgame-editorgame-enginegamedeviostypescriptwebassemblywebglwebgpuwechat-minigame
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
/**
* @file ui/core/dimension.ts
* @brief Dimension — a CSS-style length (value + unit) for the runtime UI box
* model.
*
* One field can be pixels, a percentage of the parent, or content-driven (auto),
* replacing the old size/offset/`-1`-sentinel scheme. The on-wire shape matches
* the C++ `Dimension` struct serialized by the EHT codegen (`{ value, unit }`,
* `unit` an integer); these helpers give it a typed, ergonomic authoring API.
*/
/** How a {@link Dimension}'s `value` is interpreted. Mirrors the C++ u8 unit.
* @public */
export const DimensionUnit = {
/** Absolute pixels. */
Px: 0,
/** Percentage of the parent's corresponding axis (0..100). */
Percent: 1,
/** Content-/layout-driven; `value` is ignored. */
Auto: 2,
} as const;
/** @public */
export type DimensionUnit = (typeof DimensionUnit)[keyof typeof DimensionUnit];
/**
* A CSS-style length. Plain data matching the generated `Dimension` struct, so it
* crosses to the engine as memory rather than being converted.
*
* @public
*/
export interface Dimension {
value: number;
unit: number;
}
/** `n` pixels — a design pixel, which at the project's design resolution is one
* screen pixel and scales with it thereafter.
* @public */
export const px = (n: number): Dimension => ({ value: n, unit: DimensionUnit.Px });
/** `n` percent of the parent axis (0..100), not a 0..1 fraction.
* @public */
export const percent = (n: number): Dimension => ({ value: n, unit: DimensionUnit.Percent });
/** Content-/layout-driven length (Yoga `auto`); `value` is ignored. Not frozen
* with its two siblings: no certified game asks for one. */
export const auto = (): Dimension => ({ value: 0, unit: DimensionUnit.Auto });
/** True when the dimension is the content-/layout-driven `auto` length. */
export const isAuto = (d: Dimension): boolean => d.unit === DimensionUnit.Auto;