brepjs API Reference
    Preparing search index...

    Interface SurfaceFromImageOptions

    interface SurfaceFromImageOptions {
        channel?: "r" | "g" | "b" | "luminance";
        depth?: number;
        downsample?: number;
        scaleZ?: number;
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    channel? depth? downsample? scaleZ? width?

    Properties

    channel?: "r" | "g" | "b" | "luminance"

    Which channel to use for height. Default: 'luminance'.

    depth?: number

    Physical depth in Y direction. Default: number of rows - 1.

    downsample?: number

    Downsample factor — use every Nth pixel. Default: 1 (no downsampling).

    scaleZ?: number

    Scale factor for Z values. Default: 1.

    width?: number

    Physical width in X direction. Default: number of columns - 1.

    Settings

    Member Visibility

    On This Page

    Properties