@types/three 0.178.1 → 0.179.0

three/src/nodes/tsl/TSLCore.d.ts

@@ -210,6 +210,7 @@ export class ShaderNode<T = {}, R extends Node = Node> {
 }
 
 export function nodeObject<T extends NodeObjectOption>(obj: T): NodeObject<T>;
+export function nodeObjectIntent<T extends NodeObjectOption>(obj: T): NodeObject<T>;
 export function nodeObjects<T>(obj: T): NodeObjects<T>;
 
 export function nodeArray<T extends NodeObjectOption[]>(obj: readonly [...T]): NodeArray<T>;
@@ -234,6 +235,21 @@ export function nodeImmutable<T>(
     ...params: ProxiedTuple<GetConstructors<T>>
 ): ShaderNodeObject<ConstructedNode<T>>;
 
+export function nodeProxyIntent<T>(
+    nodeClass: T,
+): (...params: ProxiedTuple<GetConstructors<T>>) => ShaderNodeObject<ConstructedNode<T>>;
+
+export function nodeProxyIntent<T, S extends GetPossibleScopes<T>>(
+    nodeClass: T,
+    scope: S,
+): (...params: ProxiedTuple<RemoveTail<GetConstructorsByScope<T, S>>>) => ShaderNodeObject<ConstructedNode<T>>;
+
+export function nodeProxyIntent<T, S extends GetPossibleScopes<T>>(
+    nodeClass: T,
+    scope: S,
+    factor: NodeObjectOption,
+): (...params: ProxiedTuple<RemoveHeadAndTail<GetConstructorsByScope<T, S>>>) => ShaderNodeObject<ConstructedNode<T>>;
+
 interface Layout {
     name: string;
     type: string;

three/src/nodes/utils/EventNode.d.ts

@@ -0,0 +1,21 @@
+import Node from "../core/Node.js";
+import NodeFrame from "../core/NodeFrame.js";
+import { ShaderNodeObject } from "../tsl/TSLCore.js";
+
+export type EventNodeType = typeof EventNode.OBJECT | typeof EventNode.MATERIAL;
+
+declare class EventNode extends Node {
+    eventType: EventNodeType;
+    callback: (frame: NodeFrame) => void;
+
+    constructor(eventType: EventNodeType, callback: (frame: NodeFrame) => void);
+
+    static OBJECT: "object";
+    static MATERIAL: "material";
+}
+
+export default EventNode;
+
+export const OnObjectUpdate: (callback: (frame: NodeFrame) => void) => ShaderNodeObject<Node>;
+
+export const OnMaterialUpdate: (callback: (frame: NodeFrame) => void) => ShaderNodeObject<Node>;

three/src/nodes/utils/RTTNode.d.ts

@@ -9,6 +9,8 @@ export interface RTTNodeOptions {
 }
 
 declare class RTTNode extends TextureNode {
+    readonly isRTTNode: true;
+
     node: Node;
     width: number | null;
     height: number | null;

three/src/renderers/common/Color4.d.ts

@@ -27,8 +27,8 @@ declare class Color4 extends Color {
      * string argument to this method.
      *
      * @param {number|string|Color} r - The red value.
-     * @param {number} g - The green value.
-     * @param {number} b - The blue value.
+     * @param {number} [g] - The green value.
+     * @param {number} [b] - The blue value.
      * @param {number} [a=1] - The alpha value.
      * @return {Color4} A reference to this object.
      */

three/src/renderers/common/Renderer.d.ts

@@ -625,15 +625,15 @@ declare class Renderer {
      */
     clearStencilAsync(): Promise<void>;
     /**
-     * The current output tone mapping of the renderer. When a render target is set,
-     * the output tone mapping is always `NoToneMapping`.
+     * The current tone mapping of the renderer. When not producing screen output,
+     * the tone mapping is always `NoToneMapping`.
      *
      * @type {number}
      */
     get currentToneMapping(): ToneMapping;
     /**
-     * The current output color space of the renderer. When a render target is set,
-     * the output color space is always `LinearSRGBColorSpace`.
+     * The current color space of the renderer. When not producing screen output,
+     * the color space is always the working color space.
      *
      * @type {string}
      */
@@ -742,17 +742,25 @@ declare class Renderer {
      * if the renderer has been initialized.
      *
      * @param {Node|Array<Node>} computeNodes - The compute node(s).
+     * @param {Array<number>|number} [dispatchSizeOrCount=null] - Array with [ x, y, z ] values for dispatch or a single number for the count.
      * @return {Promise|undefined} A Promise that resolve when the compute has finished. Only returned when the renderer has not been initialized.
      */
-    compute(computeNodes: ComputeNode | ComputeNode[]): Promise<void> | undefined;
+    compute(
+        computeNodes: ComputeNode | ComputeNode[],
+        dispatchSizeOrCount?: number[] | number | null,
+    ): Promise<void> | undefined;
     /**
      * Execute a single or an array of compute nodes.
      *
      * @async
      * @param {Node|Array<Node>} computeNodes - The compute node(s).
+     * @param {Array<number>|number} [dispatchSizeOrCount=null] - Array with [ x, y, z ] values for dispatch or a single number for the count.
      * @return {Promise} A Promise that resolve when the compute has finished.
      */
-    computeAsync(computeNodes: ComputeNode | ComputeNode[]): Promise<void>;
+    computeAsync(
+        computeNodes: ComputeNode | ComputeNode[],
+        dispatchSizeOrCount?: number[] | number | null,
+    ): Promise<void>;
     /**
      * Checks if the given feature is supported by the selected backend.
      *
@@ -938,7 +946,7 @@ declare class Renderer {
      * @param {LightsNode} lightsNode - The current lights node.
      * @param {?{start: number, count: number}} group - Only relevant for objects using multiple materials. This represents a group entry from the respective `BufferGeometry`.
      * @param {ClippingContext} clippingContext - The clipping context.
-     * @param {?string} [passId=null] - An optional ID for identifying the pass.
+     * @param {string} [passId] - An optional ID for identifying the pass.
      */
     _renderObjectDirect(
         object: Object3D,
@@ -962,7 +970,7 @@ declare class Renderer {
      * @param {LightsNode} lightsNode - The current lights node.
      * @param {?{start: number, count: number}} group - Only relevant for objects using multiple materials. This represents a group entry from the respective `BufferGeometry`.
      * @param {ClippingContext} clippingContext - The clipping context.
-     * @param {?string} [passId=null] - An optional ID for identifying the pass.
+     * @param {string} [passId] - An optional ID for identifying the pass.
      */
     _createObjectPipeline(
         object: Object3D,

three/src/renderers/common/SampledTexture.d.ts

@@ -1,21 +1,14 @@
 import { Texture } from "../../textures/Texture.js";
-import Binding from "./Binding.js";
+import Sampler from "./Sampler.js";
 
-declare class SampledTexture extends Binding {
+declare class SampledTexture extends Sampler {
     id: number;
 
-    texture: Texture | null;
-    version: number;
     store: boolean;
-    generation: number | null;
 
     readonly isSampledTexture: true;
 
     constructor(name: string, texture: Texture | null);
-
-    needsBindingsUpdate(generation: number): boolean;
-
-    update(): boolean;
 }
 
 declare class SampledArrayTexture extends SampledTexture {

three/src/renderers/common/Sampler.d.ts

@@ -1,11 +1,17 @@
-import TextureNode from "../../nodes/accessors/TextureNode.js";
+import { Texture } from "../../textures/Texture.js";
 import Binding from "./Binding.js";
 
 declare class Sampler extends Binding {
-    texture: TextureNode | null;
     version: number;
+
+    generation: number | null;
+
     readonly isSampler: true;
-    constructor(name: string, texture: TextureNode | null);
+
+    constructor(name: string, texture: Texture | null);
+
+    set texture(value: Texture | null);
+    get texture(): Texture | null;
 }
 
 export default Sampler;

three/src/renderers/common/Storage3DTexture.d.ts

@@ -35,6 +35,8 @@ declare class Storage3DTexture extends Texture {
      * @param {number} [depth=1] - The storage texture's depth.
      */
     constructor(width?: number, height?: number, depth?: number);
+
+    setSize(width: number, height: number, depth: number): void;
 }
 
 export default Storage3DTexture;

three/src/renderers/common/StorageArrayTexture.d.ts

@@ -24,6 +24,8 @@ declare class Storage3DTexture extends Texture {
      * @param {number} [depth=1] - The storage texture's depth.
      */
     constructor(width?: number, height?: number, depth?: number);
+
+    setSize(width: number, height: number, depth: number): void;
 }
 
 export default Storage3DTexture;

three/src/renderers/common/StorageTexture.d.ts

@@ -2,4 +2,6 @@ import { Texture } from "../../textures/Texture.js";
 
 export default class StorageTexture extends Texture {
     constructor(width?: number, height?: number);
+
+    setSize(width: number, height: number, depth: number): void;
 }

three/src/renderers/common/XRManager.d.ts

@@ -79,6 +79,7 @@ declare class XRManager extends EventDispatcher<XRManagerEventMap> {
     _xrRenderTarget: XRRenderTarget | null;
     _layers: XRLayerObject[];
     _supportsLayers: boolean;
+    _supportsGlBinding: boolean;
     _frameBufferTargets:
         | WeakMap<XRRenderTarget, {
             frameBufferTarget: RenderTarget | null;

three/src/renderers/webgl/WebGLCapabilities.d.ts

@@ -14,7 +14,7 @@ export interface WebGLCapabilitiesParameters {
     /**
      * default is false.
      */
-    reverseDepthBuffer?: boolean | undefined;
+    reversedDepthBuffer?: boolean | undefined;
 }
 
 export class WebGLCapabilities {
@@ -30,7 +30,7 @@ export class WebGLCapabilities {
 
     precision: string;
     logarithmicDepthBuffer: boolean;
-    reverseDepthBuffer: boolean;
+    reversedDepthBuffer: boolean;
 
     maxTextures: number;
     maxVertexTextures: number;

three/src/renderers/webgpu/nodes/WGSLNodeBuilder.d.ts

@@ -19,7 +19,6 @@ export default class WGSLNodeBuilder extends NodeBuilder {
     builtins: { [key in BuiltinStage]: Map<string, BuiltinType> };
     uniformGroups: { [key in NodeShaderStage]: NodeUniformsGroup };
 
-    needsToWorkingColorSpace(texture: Texture): boolean;
     _generateTextureSample(
         texture: Texture,
         textureProperty: string,

three/src/renderers/webxr/WebXRDepthSensing.d.ts

@@ -1,10 +1,9 @@
 import { Mesh } from "../../objects/Mesh.js";
-import { Texture } from "../../textures/Texture.js";
-import { WebGLRenderer } from "../WebGLRenderer.js";
+import { ExternalTexture } from "../../textures/ExternalTexture.js";
 import { WebXRArrayCamera } from "./WebXRManager.js";
 
 export class WebXRDepthSensing {
-    texture: Texture | null;
+    texture: ExternalTexture | null;
     mesh: Mesh | null;
 
     depthNear: number;
@@ -12,11 +11,11 @@ export class WebXRDepthSensing {
 
     constructor();
 
-    init(renderer: WebGLRenderer, depthData: XRWebGLDepthInformation, renderState: XRRenderState): void;
+    init(depthData: XRWebGLDepthInformation, renderState: XRRenderState): void;
 
     getMesh(cameraXR: WebXRArrayCamera): Mesh | null;
 
     reset(): void;
 
-    getDepthTexture(): Texture | null;
+    getDepthTexture(): ExternalTexture | null;
 }

three/src/renderers/webxr/WebXRManager.d.ts

@@ -5,7 +5,7 @@ import { PerspectiveCamera } from "../../cameras/PerspectiveCamera.js";
 import { EventDispatcher } from "../../core/EventDispatcher.js";
 import { Vector4 } from "../../math/Vector4.js";
 import { Mesh } from "../../objects/Mesh.js";
-import { Texture } from "../../textures/Texture.js";
+import { ExternalTexture } from "../../textures/ExternalTexture.js";
 import { WebGLRenderer } from "../WebGLRenderer.js";
 import { XRGripSpace, XRHandSpace, XRTargetRaySpace } from "./WebXRController.js";
 
@@ -65,7 +65,7 @@ export class WebXRManager extends EventDispatcher<WebXRManagerEventMap> {
 
     getEnvironmentBlendMode: () => XREnvironmentBlendMode | undefined;
 
-    getDepthTexture: () => Texture | null;
+    getDepthTexture: () => ExternalTexture | null;
 
     updateCamera: (camera: PerspectiveCamera) => void;
 
@@ -79,6 +79,8 @@ export class WebXRManager extends EventDispatcher<WebXRManagerEventMap> {
 
     getDepthSensingMesh: () => Mesh | null;
 
+    getCameraTexture: (xrCamera: WebXRCamera) => ExternalTexture | undefined;
+
     setAnimationLoop: (callback: XRFrameRequestCallback | null) => void;
 
     dispose: () => void;

three/src/textures/ExternalTexture.d.ts

@@ -0,0 +1,11 @@
+import { Texture } from "./Texture.js";
+
+declare class ExternalTexture extends Texture {
+    sourceTexture: WebGLTexture | null;
+
+    readonly isExternalTexture: true;
+
+    constructor(sourceTexture?: WebGLTexture | null);
+}
+
+export { ExternalTexture };

three/examples/jsm/tsl/display/TRAAPassNode.d.ts

@@ -1,15 +0,0 @@
-import { ShaderNodeObject } from "three/tsl";
-import { Camera, ColorRepresentation, PassNode, Scene } from "three/webgpu";
-
-declare class TRAAPassNode extends PassNode {
-    readonly isTRAAPassNode: true;
-
-    clearColor: ColorRepresentation;
-    clearAlpha: number;
-
-    constructor(scene: Scene, camera: Camera);
-}
-
-export default TRAAPassNode;
-
-export const traaPass: (scene: Scene, camera: Camera) => ShaderNodeObject<TRAAPassNode>;