roavatar-renderer 1.9.5 → 1.9.6

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { EffectComposer } from 'postprocessing';
+import { EffectPass } from 'postprocessing';
 import { N8AOPostPass } from 'n8ao';
 import { OrbitControls } from 'three/examples/jsm/Addons.js';
 import * as THREE from 'three';
@@ -1029,6 +1030,7 @@ declare class Cache_2<K, V> {
     map: Map<K, V>;
     lastAccess: Map<K, number>;
     maxEntries: number;
+    onDelete?: (key: K) => void;
     constructor(maxEntries?: number);
     get(key: K): V | undefined;
     set(key: K, value: V): Cache_2<K, V>;
@@ -1431,6 +1433,11 @@ export declare function exposeAPI(): void;
  */
 export declare function exposeFLAGS(): void;
 
+/**
+ * @category Exposer
+ */
+export declare function exposeManagedTextures(): void;
+
 /**
  * @category Exposer
  */
@@ -1640,7 +1647,7 @@ export declare const FLAGS: {
     RBF_PATCH_SHAPE_SAMPLES: number;
     /**forces vertex color to be white when false */
     USE_VERTEX_COLOR: boolean;
-    /**this enables bloom and ssao */
+    /**despite its name it is not needed for post processing, all it does is automatically add post processing to RBXRenderer.firstScene*/
     USE_POST_PROCESSING: boolean;
     /**doubles render resolution when using post processing, makes anti-aliasing artifacts less visible but can be performance heavy on high resolutions */
     POST_PROCESSING_IS_DOUBLE_SIZE: boolean;
@@ -3541,7 +3548,9 @@ export declare class RBXRenderer {
     /**@deprecated This can only get the first renderScene's controls */
     static get controls(): OrbitControls<THREE.Camera> | undefined;
     static renderer?: THREE.WebGLRenderer;
-    /**Can be used to disable post processing even when FLAGS.USE_POST_PROCESSING = true */
+    /**
+     * @deprecated Renders wihout the effectComposer, which is no longer intended behavior as it leads to incorrect color management, instead create a new effect composer
+     */
     static usePostProcessing: boolean;
     static resolution: [number, number];
     static backgroundColor: THREE.ColorRepresentation;
@@ -3573,7 +3582,12 @@ export declare class RBXRenderer {
     static boilerplateSetup(): Promise<void>;
     static showErrorHTML(): Promise<void>;
     static createLoadingIconHTML(): void;
-    static addScene(): RBXRendererScene;
+    /**
+     *
+     * @param includeEffectComposer Only ever set this to false if you know you will be rendering to a RenderTarget (for example thumbnail generation), otherwise color handling is incorrect
+     * @returns
+     */
+    static addScene(includeEffectComposer?: boolean): RBXRendererScene;
     /**Fully sets up renderer with scene, camera and frame rendering
      * @returns success
      */
@@ -3607,10 +3621,16 @@ export declare class RBXRenderer {
      * @deprecated use createEffectComposer()
      */
     static _createEffectComposer(renderScene?: RBXRendererScene): void;
-    static createEffectComposer(renderScene?: RBXRendererScene): void;
+    /**
+     * Scenes now always have an effectComposer, to add post processing use the dedicated function RBXRendererScene.addPostProcessing()
+     *
+     * This function disposes the original effectComposer and creates a new one, which adds a little overhead (probably) though it still adds post processing for backwards compatibility
+     */
+    static createEffectComposer(renderScene?: RBXRendererScene, includePostProcessing?: boolean): void;
     /**Removes an instance from the renderer */
     static removeInstance(instance: Instance, renderScene?: RBXRendererScene): void;
     static getRenderDescs(instance: Instance): RenderDesc[];
+    private static _addSkeletonToResult;
     private static _addRenderDesc;
     /**Adds an instance to the renderer or updates it */
     static addInstance(instance: Instance, auth: Authentication, renderScene?: RBXRendererScene): void;
@@ -3654,8 +3674,15 @@ export declare class RBXRendererScene {
     controls: OrbitControls | undefined;
     shouldAnimate: boolean;
     destroyed: boolean;
+    /**Used internally to determine color space output */
+    isForRenderTarget: boolean;
+    get colorSpace(): THREE.ColorSpace;
     n8aoPass: N8AOPostPass | undefined;
+    effectPass: EffectPass | undefined;
     effectComposer: EffectComposer | undefined;
+    hasPostProcessing: boolean;
+    /**Used so MSAA will stay the same even when effectComposer is recreated */
+    _msaa: number;
     scissor?: [number, number, number, number];
     viewport?: [number, number, number, number];
     addedInstances: Instance[];
@@ -3679,6 +3706,11 @@ export declare class RBXRendererScene {
     ambientLight?: THREE.AmbientLight;
     directionalLight?: THREE.DirectionalLight;
     directionalLight2?: THREE.DirectionalLight;
+    /**Adds a SSAO pass to the effectComposer and replaces the current EffectPass with one that contains SSAO and Bloom */
+    addPostProcessing(): void;
+    /**Sets/gets MSAA level of the effectComposer, which is 4 by default */
+    set msaa(value: number);
+    get msaa(): number;
     /** Forces viewport to be within bounds */
     setRect(bounds: DOMRect): void;
     /** Makes viewport size 0x0, invisible */