Skip to content
Apexify.jsDocs
Apexify.js version v5.4.5

interface export

SceneRenderOptions

Published interface export SceneRenderOptions.

apexify.jsCURRENTnode22node24node26
Source: lib-next/types/scene.ts (opens in a new tab)

Signature

TypeScript
export interface SceneRenderOptions {
    /**
     * @deprecated Safety validation is mandatory and this option is ignored. It remains only for source compatibility.
     */
    validate?: boolean;
    /** Optional stricter surface depth cap. It may not exceed the configured runtime `maxSceneDepth`. */
    maxSurfaceDepth?: number;
    /** Resolve `$name`/`$value.path` asset tokens before painting. */
    resolveAssetRefs?: boolean;
}

Related APIs

No explicit related API metadata.

Next steps

AdsrEnvelopeAPI · node · CURRENT

ADSR envelope (seconds + sustain level 0–1). Stages are proportionally fitted when A+D+R exceeds the layer duration.

ApexifyPluginAPI · node · CURRENT

Install hook for optional features without growing the core {@link ApexPainter } class. Installation may be synchronous or asynchronous. `ApexPainter.use(plugin)` always returns a Promise and must be awaited before plugin APIs are considered installed. Plugin names are unique per painter. Registrations made through `painter.plugins` during a failed installation are rolled back.

AssetRegistrationInfoAPI · node · CURRENT

Published interface export AssetRegistrationInfo.

AvatarToLayersOptionsAPI · node · CURRENT

Published interface export AvatarToLayersOptions.