Hilo3d API - v2.0.0-alpha.8
    Preparing search index...

    Interface RendererContract

    Public backend-neutral renderer contract used by Stage and scene resources.

    interface RendererContract {
        backend: RendererBackend;
        cameraRelative: boolean;
        className: string;
        clearColor: Color;
        domElement: HTMLCanvasElement | null;
        forceMaterial: MaterialInstance | null;
        height: number;
        isReady: boolean;
        lightManager: LightManager;
        pixelRatio: number;
        ready: Promise<void>;
        renderInfo: RenderInfo;
        renderingProfile: "portable" | "high-end";
        renderTarget: RenderTarget | null;
        resourceManager: RendererResourceManager;
        shadowUpdateMode: "full" | "paged";
        useInstanced: boolean;
        width: number;
        createRenderTarget(parameters: RenderTargetParameters): RenderTarget;
        createStorageBuffer(
            descriptor: Readonly<StorageBufferDescriptor>,
        ): StorageBuffer;
        destroy(): void;
        getExtension(name: string): object | null;
        getViewport(): RendererViewport;
        off(type?: string, listener?: EventListener): this;
        on(type: string, listener: EventListener, once?: boolean): this;
        onInit(callback: (renderer: this) => void): void;
        present(
            target?: RenderTarget,
            options?: RenderTargetPresentationOptions,
        ): void;
        releaseGPUResources(): void;
        render(stage: RendererScene, camera: Camera, fireEvent?: boolean): void;
        renderFrame(callback: RendererFrameCallback): void;
        renderToTarget(
            target: RenderTarget,
            stage: RendererScene,
            camera: Camera,
            fireEvent?: boolean,
        ): void;
        resize(width: number, height: number, force?: boolean): void;
        setOffset(x: number, y: number): void;
        setRenderTarget(
            target: RenderTarget | null,
            options?: RenderTargetSelectionOptions,
        ): this;
        supportsTextureCompression(format: TextureCompressionFormat): boolean;
        uploadTextures(textures: readonly Texture<unknown>[]): Promise<void>;
        waitForIdle(): Promise<void>;
    }

    Implemented by

    Index
    backend cameraRelative className clearColor domElement forceMaterial height isReady lightManager pixelRatio ready renderInfo renderingProfile renderTarget resourceManager shadowUpdateMode useInstanced width
    createRenderTarget createStorageBuffer destroy getExtension getViewport off on onInit present releaseGPUResources render renderFrame renderToTarget resize setOffset setRenderTarget supportsTextureCompression uploadTextures waitForIdle
    backend: RendererBackend
    cameraRelative: boolean
    className: string
    clearColor: Color
    domElement: HTMLCanvasElement | null
    forceMaterial: MaterialInstance | null
    height: number
    isReady: boolean
    lightManager: LightManager
    pixelRatio: number
    ready: Promise<void>
    renderInfo: RenderInfo
    renderingProfile: "portable" | "high-end"
    renderTarget: RenderTarget | null
    resourceManager: RendererResourceManager
    shadowUpdateMode: "full" | "paged"

    Shadow-atlas page-budget policy selected when this renderer was created.

    useInstanced: boolean
    width: number

    • Explicit opt-in access to a backend extension; unknown names return null.

      Parameters

      • name: string

      Returns object | null

    • Parameters

      • callback: (renderer: this) => void

      Returns void

    • Release renderer caches and emit rhiResourcesReleased after fresh caches are available.

      Returns void

    • Parameters

      • width: number
      • height: number
      • Optionalforce: boolean

      Returns void

    • Upload or refresh managed textures through one Render Graph submission without drawing. Resolves after submission completion. Call outside an active render frame; failed frames leave backend revisions uncommitted. Source content must remain stable until this resolves.

      Parameters

      • textures: readonly Texture<unknown>[]

      Returns Promise<void>

    • Resolve after all work submitted before this call has completed.

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods