@types/three 0.172.0 → 0.174.0

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

@@ -1,6 +1,6 @@
 import { Camera } from "../../cameras/Camera.js";
-import { Object3D } from "../../core/Object3D.js";
 import { RenderTarget } from "../../core/RenderTarget.js";
+import { Scene } from "../../scenes/Scene.js";
 import ChainMap from "./ChainMap.js";
 import RenderContext from "./RenderContext.js";
 /**
@@ -10,15 +10,7 @@ import RenderContext from "./RenderContext.js";
  */
 declare class RenderContexts {
     chainMaps: {
-        [attachmentState: string]:
-            | ChainMap<
-                | readonly [Object3D, Camera]
-                | readonly [Object3D, Camera, {
-                    id: "default";
-                }],
-                RenderContext
-            >
-            | undefined;
+        [attachmentState: string]: ChainMap<readonly [Scene, Camera], RenderContext> | undefined;
     };
     /**
      * Constructs a new render context management component.
@@ -27,27 +19,27 @@ declare class RenderContexts {
     /**
      * Returns a render context for the given scene, camera and render target.
      *
-     * @param {Scene?} [scene=null] - The scene. The parameter can become `null` e.g. when the renderer clears a render target.
-     * @param {Camera?} [camera=null] - The camera that is used to render the scene. The parameter can become `null` e.g. when the renderer clears a render target.
-     * @param {RenderTarget?} [renderTarget=null] - The active render target.
+     * @param {Scene} scene - The scene.
+     * @param {Camera} camera - The camera that is used to render the scene.
+     * @param {?RenderTarget} [renderTarget=null] - The active render target.
      * @return {RenderContext} The render context.
      */
-    get(scene?: Object3D | null, camera?: Camera | null, renderTarget?: RenderTarget | null): RenderContext;
+    get(scene: Scene, camera: Camera, renderTarget?: RenderTarget | null): RenderContext;
+    /**
+     * Returns a render context intended for clear operations.
+     *
+     * @param {?RenderTarget} [renderTarget=null] - The active render target.
+     * @return {RenderContext} The render context.
+     */
+    getForClear(renderTarget?: RenderTarget | null): RenderContext;
     /**
      * Returns a chain map for the given attachment state.
      *
-     * @param {String} attachmentState - The attachment state.
+     * @private
+     * @param {string} attachmentState - The attachment state.
      * @return {ChainMap} The chain map.
      */
-    getChainMap(
-        attachmentState: string,
-    ): ChainMap<
-        | readonly [Object3D<import("../../core/Object3D.js").Object3DEventMap>, Camera]
-        | readonly [Object3D<import("../../core/Object3D.js").Object3DEventMap>, Camera, {
-            id: "default";
-        }],
-        RenderContext
-    >;
+    _getChainMap(attachmentState: string): ChainMap<readonly [Scene, Camera], RenderContext>;
     /**
      * Frees internal resources.
      */

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

@@ -72,9 +72,9 @@ declare class RenderList {
      * @param {Object3D} object - The 3D object.
      * @param {BufferGeometry} geometry - The 3D object's geometry.
      * @param {Material} material - The 3D object's material.
-     * @param {Number} groupOrder - The current group order.
-     * @param {Number} z - Th 3D object's depth value (z value in clip space).
-     * @param {Number?} group - {Object?} group - Only relevant for objects using multiple materials. This represents a group entry from the respective `BufferGeometry`.
+     * @param {number} groupOrder - The current group order.
+     * @param {number} z - Th 3D object's depth value (z value in clip space).
+     * @param {?number} group - {?Object} group - Only relevant for objects using multiple materials. This represents a group entry from the respective `BufferGeometry`.
      * @param {ClippingContext} clippingContext - The current clipping context.
      * @return {Object} The render item.
      */
@@ -94,9 +94,9 @@ declare class RenderList {
      * @param {Object3D} object - The 3D object.
      * @param {BufferGeometry} geometry - The 3D object's geometry.
      * @param {Material} material - The 3D object's material.
-     * @param {Number} groupOrder - The current group order.
-     * @param {Number} z - Th 3D object's depth value (z value in clip space).
-     * @param {Number?} group - {Object?} group - Only relevant for objects using multiple materials. This represents a group entry from the respective `BufferGeometry`.
+     * @param {number} groupOrder - The current group order.
+     * @param {number} z - Th 3D object's depth value (z value in clip space).
+     * @param {?number} group - {?Object} group - Only relevant for objects using multiple materials. This represents a group entry from the respective `BufferGeometry`.
      * @param {ClippingContext} clippingContext - The current clipping context.
      */
     push(
@@ -115,9 +115,9 @@ declare class RenderList {
      * @param {Object3D} object - The 3D object.
      * @param {BufferGeometry} geometry - The 3D object's geometry.
      * @param {Material} material - The 3D object's material.
-     * @param {Number} groupOrder - The current group order.
-     * @param {Number} z - Th 3D object's depth value (z value in clip space).
-     * @param {Number?} group - {Object?} group - Only relevant for objects using multiple materials. This represents a group entry from the respective `BufferGeometry`.
+     * @param {number} groupOrder - The current group order.
+     * @param {number} z - Th 3D object's depth value (z value in clip space).
+     * @param {?number} group - {?Object} group - Only relevant for objects using multiple materials. This represents a group entry from the respective `BufferGeometry`.
      * @param {ClippingContext} clippingContext - The current clipping context.
      */
     unshift(
@@ -144,8 +144,8 @@ declare class RenderList {
     /**
      * Sorts the internal render lists.
      *
-     * @param {Function} customOpaqueSort - A custom sort function for opaque objects.
-     * @param {Function} customTransparentSort -  A custom sort function for transparent objects.
+     * @param {function(any, any): number} customOpaqueSort - A custom sort function for opaque objects.
+     * @param {function(any, any): number} customTransparentSort -  A custom sort function for transparent objects.
      */
     sort(
         customOpaqueSort: ((a: RenderItem, b: RenderItem) => number) | null,

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

@@ -35,7 +35,7 @@ import RenderPipeline from "./RenderPipeline.js";
  *
  * @private
  */
-export default class RenderObject {
+declare class RenderObject {
     _nodes: Nodes;
     _geometries: Geometries;
     id: number;
@@ -107,21 +107,21 @@ export default class RenderObject {
     /**
      * Whether the clipping requires an update or not.
      *
-     * @type {Boolean}
+     * @type {boolean}
      * @readonly
      */
     get clippingNeedsUpdate(): boolean;
     /**
      * The number of clipping planes defined in context of hardware clipping.
      *
-     * @type {Number}
+     * @type {number}
      * @readonly
      */
     get hardwareClippingPlanes(): number;
     /**
      * Returns the node builder state of this render object.
      *
-     * @return {NodeBuilderState} The node buider state.
+     * @return {NodeBuilderState} The node builder state.
      */
     getNodeBuilderState(): NodeBuilderState;
     /**
@@ -136,16 +136,23 @@ export default class RenderObject {
      * @return {Array<BindGroup>} The bindings.
      */
     getBindings(): BindGroup[];
+    /**
+     * Returns a binding group by group name of this render object.
+     *
+     * @param {string} name - The name of the binding group.
+     * @return {?BindGroup} The bindings.
+     */
+    getBindingGroup(name: string): BindGroup | undefined;
     /**
      * Returns the index of the render object's geometry.
      *
-     * @return {BufferAttribute?} The index. Returns `null` for non-indexed geometries.
+     * @return {?BufferAttribute} The index. Returns `null` for non-indexed geometries.
      */
     getIndex(): BufferAttribute | null;
     /**
      * Returns the indirect buffer attribute.
      *
-     * @return {BufferAttribute?} The indirect attribute. `null` if no indirect drawing is used.
+     * @return {?BufferAttribute} The indirect attribute. `null` if no indirect drawing is used.
      */
     getIndirect(): import("./IndirectStorageBufferAttribute.js").default | null;
     /**
@@ -182,7 +189,7 @@ export default class RenderObject {
     /**
      * Returns the draw parameters for the render object.
      *
-     * @return {{vertexCount: Number, firstVertex: Number, instanceCount: Number, firstInstance: Number}} The draw parameters.
+     * @return {{vertexCount: number, firstVertex: number, instanceCount: number, firstInstance: number}} The draw parameters.
      */
     getDrawParameters(): {
         vertexCount: number;
@@ -195,7 +202,7 @@ export default class RenderObject {
      *
      * The geometry cache key is part of the material cache key.
      *
-     * @return {String} The geometry cache key.
+     * @return {string} The geometry cache key.
      */
     getGeometryCacheKey(): string;
     /**
@@ -203,13 +210,13 @@ export default class RenderObject {
      *
      * The material cache key is part of the render object cache key.
      *
-     * @return {String} The material cache key.
+     * @return {number} The material cache key.
      */
     getMaterialCacheKey(): number;
     /**
      * Whether the geometry requires an update or not.
      *
-     * @type {Boolean}
+     * @type {boolean}
      * @readonly
      */
     get needsGeometryUpdate(): boolean;
@@ -224,27 +231,28 @@ export default class RenderObject {
      * `RenderObjects.get()`. The render object's NodeMaterialObserver is then used to detect
      * a need for a refresh due to material, geometry or object related value changes.
      *
-     * TODO: Investigate if it's possible to merge boths steps so there is only a single place
+     * TODO: Investigate if it's possible to merge both steps so there is only a single place
      * that performs the 'needsUpdate' check.
      *
-     * @type {Boolean}
+     * @type {boolean}
      * @readonly
      */
     get needsUpdate(): boolean;
     /**
      * Returns the dynamic cache key which represents a key that is computed per draw command.
      *
-     * @return {String} The cache key.
+     * @return {number} The cache key.
      */
-    getDynamicCacheKey(): string;
+    getDynamicCacheKey(): number;
     /**
      * Returns the render object's cache key.
      *
-     * @return {String} The cache key.
+     * @return {number} The cache key.
      */
-    getCacheKey(): string;
+    getCacheKey(): number;
     /**
      * Frees internal resources.
      */
     dispose(): void;
 }
+export default RenderObject;

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

@@ -56,7 +56,7 @@ declare class RenderObjects {
      * @param {LightsNode} lightsNode - The lights node.
      * @param {RenderContext} renderContext - The render context.
      * @param {ClippingContext} clippingContext - The clipping context.
-     * @param {String?} passId - An optional ID for identifying the pass.
+     * @param {?string} passId - An optional ID for identifying the pass.
      * @return {RenderObject} The render object.
      */
     get(
@@ -72,7 +72,7 @@ declare class RenderObjects {
     /**
      * Returns a chain map for the given pass ID.
      *
-     * @param {String} [passId='default'] - The pass ID.
+     * @param {string} [passId='default'] - The pass ID.
      * @return {ChainMap} The chain map.
      */
     getChainMap(
@@ -98,7 +98,7 @@ declare class RenderObjects {
      * @param {LightsNode} lightsNode - The lights node.
      * @param {RenderContext} renderContext - The render context.
      * @param {ClippingContext} clippingContext - The clipping context.
-     * @param {String?} passId - An optional ID for identifying the pass.
+     * @param {?string} passId - An optional ID for identifying the pass.
      * @return {RenderObject} The render object.
      */
     createRenderObject(

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

@@ -12,7 +12,7 @@ declare class RenderPipeline extends Pipeline {
     /**
      * Constructs a new render pipeline.
      *
-     * @param {String} cacheKey - The pipeline's cache key.
+     * @param {string} cacheKey - The pipeline's cache key.
      * @param {ProgrammableStage} vertexProgram - The pipeline's vertex shader.
      * @param {ProgrammableStage} fragmentProgram - The pipeline's fragment shader.
      */