Atlas Engine
API Referenceatlas

WindowConfiguration

Window geometry, presentation flags, and rendering configuration for windowed mode.

Module: atlas

Window geometry, presentation flags, and rendering configuration for windowed mode.

Declaration

export type WindowConfiguration = {
        /**
         * The title.
         */
        title: string;
        /**
         * The width.
         */
        width: number;
        /**
         * The height.
         */
        height: number;
        /**
         * The render scale.
         */
        renderScale: number;
        /**
         * Whether the mouse starts captured by the window.
         */
        mouseCaptured: boolean;
        /**
         * The position X.
         */
        posX: number;
        /**
         * The position Y.
         */
        posY: number;
        /**
         * Whether multisample antialiasing is enabled.
         */
        multisampling: boolean;
        /**
         * Whether built-in editor camera controls are enabled.
         */
        editorControls: boolean;
        /**
         * Whether the operating-system window decorations are shown.
         */
        decorations: boolean;
        /**
         * Whether the user can resize the window.
         */
        resizable: boolean;
        /**
         * Whether the window framebuffer supports transparency.
         */
        transparent: boolean;
        /**
         * Whether the window remains above other windows.
         */
        alwaysOnTop: boolean;
        /**
         * The opacity.
         */
        opacity: number;
        /**
         * The aspect ratio X.
         */
        aspectRatioX: number;
        /**
         * The aspect ratio Y.
         */
        aspectRatioY: number;
        /**
         * The screen-space ambient occlusion scale.
         */
        ssaoScale: number;
    };

Properties

title

The title.

title: string;

width

The width.

width: number;

height

The height.

height: number;

renderScale

The render scale.

renderScale: number;

mouseCaptured

Whether the mouse starts captured by the window.

mouseCaptured: boolean;

posX

The position X.

posX: number;

posY

The position Y.

posY: number;

multisampling

Whether multisample antialiasing is enabled.

multisampling: boolean;

editorControls

Whether built-in editor camera controls are enabled.

editorControls: boolean;

decorations

Whether the operating-system window decorations are shown.

decorations: boolean;

resizable

Whether the user can resize the window.

resizable: boolean;

transparent

Whether the window framebuffer supports transparency.

transparent: boolean;

alwaysOnTop

Whether the window remains above other windows.

alwaysOnTop: boolean;

opacity

The opacity.

opacity: number;

aspectRatioX

The aspect ratio X.

aspectRatioX: number;

aspectRatioY

The aspect ratio Y.

aspectRatioY: number;

ssaoScale

The screen-space ambient occlusion scale.

ssaoScale: number;

On this page