@itwin/core-frontend/lib/cjs/internal/render/RenderSystemDebugControl.d.ts

iTwin.js frontend components

/** @packageDocumentation
 * @module Rendering
 */
/** @internal */
export declare enum RenderDiagnostics {
    /** No diagnostics enabled. */
    None = 0,
    /** Debugging output to browser console enabled. */
    DebugOutput = 2,
    /** Potentially expensive checks of WebGL state enabled. */
    WebGL = 4,
    /** All diagnostics enabled. */
    All = 6
}
/** @internal */
export interface GLTimerResult {
    /** Label from GLTimer.beginOperation */
    label: string;
    /** Time elapsed in nanoseconds, inclusive of child result times.
     *  @note no-op queries seem to have 32ns of noise.
     */
    nanoseconds: number;
    /** Child results if GLTimer.beginOperation calls were nested */
    children?: GLTimerResult[];
}
export type GLTimerResultCallback = (result: GLTimerResult) => void;
/** @internal exported strictly for display-test-app until we remove CommonJS support. */
export declare class DebugShaderFile {
    readonly filename: string;
    readonly src: string;
    isVS: boolean;
    isGL: boolean;
    isUsed: boolean;
    constructor(filename: string, src: string, isVS: boolean, isGL: boolean, isUsed: boolean);
}
/** An interface optionally exposed by a RenderSystem that allows control of various debugging features.
 * @internal
 */
export interface RenderSystemDebugControl {
    /** Destroy this system's webgl context. Returns false if this behavior is not supported. */
    loseContext(): boolean;
    /** Overrides [[RenderSystem.dpiAwareLOD]]. */
    dpiAwareLOD: boolean;
    /** Record GPU profiling information for each frame drawn. Check isGLTimerSupported before using. */
    resultsCallback?: GLTimerResultCallback;
    /** Returns true if the browser supports GPU profiling queries. */
    readonly isGLTimerSupported: boolean;
    /** Attempts to compile all shader programs and returns true if all were successful. May throw exceptions on errors.
     * This is useful for debugging shader compilation on specific platforms - especially those which use neither ANGLE nor SwiftShader (e.g., linux, mac, iOS)
     * because our unit tests which also compile all shaders run in software mode and therefore may not catch some "errors" (especially uniforms that have no effect on
     * program output).
     */
    compileAllShaders(): boolean;
    /** Obtain accumulated debug info collected during shader compilation. See `RenderSystem.Options.debugShaders`. */
    debugShaderFiles?: DebugShaderFile[];
    /** Default: enable all diagnostics. */
    enableDiagnostics(_enable: RenderDiagnostics | undefined): void;
}
//# sourceMappingURL=RenderSystemDebugControl.d.ts.map