roavatar-renderer 1.9.8 → 1.9.10

package/dist/index.d.ts

@@ -1013,6 +1013,9 @@ export declare interface BundleDetails_Result {
 /** @category Outfit */
 export declare const BundleTypes: string[];
 
+/**
+ * @category API
+ */
 export declare const CACHE: {
     AssetBuffer: Cache_2<string, Promise<ArrayBuffer | Response>>;
     RBX: Cache_2<string, RBX>;
@@ -1026,16 +1029,22 @@ export declare const CACHE: {
     UserInfo: undefined;
 };
 
+/**
+ * @category API
+ */
 declare class Cache_2<K, V> {
     map: Map<K, V>;
     lastAccess: Map<K, number>;
     maxEntries: number;
+    minDeleteLifetime: number;
     onDelete?: (key: K) => void;
     constructor(maxEntries?: number);
     get(key: K): V | undefined;
     set(key: K, value: V): Cache_2<K, V>;
     has(key: K): boolean;
     delete(key: K): boolean;
+    deleteUntil(): void;
+    deleteOne(): boolean;
 }
 export { Cache_2 as Cache }
 
@@ -1295,11 +1304,36 @@ export declare function createContentMap(): void;
 
 export declare function createThumbnailCamera(): Instance;
 
+/**
+ * @returns A RBXRenderScene ready to be used for thumbnail generation
+ */
+export declare function createThumbnailScene(): RBXRendererScene;
+
 /**
  * @category Mesh
  */
 export declare function createWeightsForMeshChunked(mesh: FileMesh, ref_mesh: FileMesh): WeightChunk[];
 
+/**
+ * Used internally by cropForModel
+ *
+ * @category ThumbnailGenerator
+ */
+export declare function cropCameraToViewExtents(camera: THREE.PerspectiveCamera, viewExtents: [Vector2, Vector2], width: number, height: number, keepAspectRatio?: boolean): number;
+
+/**
+ * Crops the camera projection matrix to only contain model, allows for image to be cropped without lowering resolution
+ * @param model Model that should be in focus
+ * @param renderScene RenderScene containing model and camera
+ * @param width Width of thumbnail in pixels
+ * @param height Height of thumbnail in pixels
+ * @param resizeToRemoveUnusedSpace If the aspect ratio can be changed to crop out unused space. Default false
+ * @returns [newWidth, newHeight] (Only differs from provided width/height if resizeToRemoveUnusedSpace = true)
+ *
+ * @category ThumbnailGenerator
+ */
+export declare function cropForModel(model: Instance, renderScene: RBXRendererScene, width: number, height: number, resizeToRemoveUnusedSpace?: boolean): number[];
+
 /**
  * @category Mesh
  */
@@ -1386,10 +1420,14 @@ export declare function deformReferenceToBaseBodyParts(reference: FileMesh, targ
 export declare function deg(radians: number): number;
 
 declare class DisposableDesc {
+    toDispose: THREEDisposable[];
+    managedTextures: ManagedTexture[];
     disposeMesh(scene: THREE.Scene, mesh: THREE.Mesh): void;
     disposeMeshes(scene: THREE.Scene, meshes: THREE.Mesh[]): void;
     disposeRenderLists(renderer: THREE.WebGLRenderer): void;
     dispose(_renderer: THREE.WebGLRenderer, _scene: THREE.Scene): void;
+    clearToDispose(): void;
+    removeFromToDispose(disposable: THREEDisposable): void;
 }
 
 export declare function disposeMesh(scene: THREE.Scene, mesh: THREE.Mesh): void;
@@ -1912,6 +1950,13 @@ export declare interface GetInfoForId_Result {
     "displayName": string;
 }
 
+/**
+ * Returns 2D bounds for model in screen space
+ *
+ * @category ThumbnailGenerator
+ */
+export declare function getModelViewExtents(model: Instance, camera: THREE.Camera, width: number, height: number): [Vector2, Vector2];
+
 /**
  * @category Mesh
  */
@@ -1947,6 +1992,14 @@ export declare interface GetSubscription_Result {
     };
 }
 
+/**
+ * Calculates the CFrame the camera should be at when generating a thumbnail
+ * @param model The model-like instance to get thumbnail camera for
+ * @returns Thumbnail camera cframe
+ * @category ThumbnailGenerator
+ */
+export declare function getThumbnailCamera(model: Instance): Instance;
+
 /**
  * Calculates the CFrame the camera should be at when generating a thumbnail
  * @param model The model-like instance to get thumbnail camera for
@@ -1991,6 +2044,13 @@ export declare function getUVtoIndexMap(mesh: FileMesh): Map<number, number>;
  */
 export declare function getUVtoIndicesMap(mesh: FileMesh): Map<number, number[]>;
 
+/**
+ * Returns 2D bounds for array of positions in screen spade
+ *
+ * @category ThumbnailGenerator
+ */
+export declare function getViewExtents(camera: THREE.Camera, positions: Vector3[], width: number, height: number): [Vector2, Vector2];
+
 export declare function getWorkerOnMessage(): (event: MessageEvent) => void;
 
 /**
@@ -2151,7 +2211,7 @@ export declare const HumanoidRigType: {
  *
  * @category ThumbnailGenerator
  */
-export declare function imageThumbnailClick(renderScene: RBXRendererScene, width: number, height: number, format: ImageThumbnailFormat, options?: Partial<ImageThumbnailOptions>): Promise<string | undefined>;
+export declare function imageThumbnailClick(renderScene: RBXRendererScene, width: number, height: number, format: ImageThumbnailFormat, options?: Partial<ImageThumbnailOptions>): Promise<ImageThumbnailResult>;
 
 /**
  * @category ThumbnailGenerator
@@ -2163,8 +2223,14 @@ export declare type ImageThumbnailFormat = "png" | "webp" | "jpeg";
  */
 export declare interface ImageThumbnailOptions {
     quality: number;
+    size: Vec2;
 }
 
+/**
+ * @category
+ */
+export declare type ImageThumbnailResult = string | undefined;
+
 export declare function imageUrlToDataUrl(imageUrl: string): Promise<string>;
 
 /**
@@ -2264,6 +2330,11 @@ export declare class Instance {
     Child(name: string): Instance | undefined;
     FindFirstChildOfClass(className: string): Instance | undefined;
     FindLastChildOfClass(className: string): Instance | undefined;
+    /**
+     * IMPORTANT: Only works properly for instances with an InstanceWrapper
+     * @param className
+     * @returns
+     */
     IsA(className: string): boolean;
     IsDescendantOf(instance: Instance): boolean;
     preRender(): void;
@@ -2615,6 +2686,11 @@ export declare const MakeupType: {
     Eye: number;
 };
 
+declare interface ManagedTexture {
+    url: string;
+    params?: TextureParams;
+}
+
 /**
  * @category InstanceWrapper
  */
@@ -2735,9 +2811,7 @@ export declare function minus(v0: Vec3, v1: Vec3): Vec3;
  *
  * @category ThumbnailGenerator
  */
-export declare function modelThumbnailClick(renderScene: RBXRendererScene, format: ModelThumbnailFormat, options?: Partial<ModelThumbnailOptions>): Promise<ArrayBuffer | {
-    [key: string]: unknown;
-}>;
+export declare function modelThumbnailClick(renderScene: RBXRendererScene, format: ModelThumbnailFormat, options?: Partial<ModelThumbnailOptions>): Promise<ModelThumbnailResult>;
 
 /**
  * @category ThumbnailGenerator
@@ -2751,6 +2825,13 @@ export declare interface ModelThumbnailOptions {
     includeAnimations: boolean;
 }
 
+/**
+ * @category ThumbnailGenerator
+ */
+export declare type ModelThumbnailResult = ArrayBuffer | {
+    [key: string]: unknown;
+};
+
 /**
  * @category InstanceWrapper
  */
@@ -3631,9 +3712,18 @@ export declare class RBXRenderer {
     static removeInstance(instance: Instance, renderScene?: RBXRendererScene): void;
     static getRenderDescs(instance: Instance): RenderDesc[];
     private static _addSkeletonToResult;
+    private static _updateCompiledRenderDesc;
     private static _addRenderDesc;
-    /**Adds an instance to the renderer or updates it */
-    static addInstance(instance: Instance, auth: Authentication, renderScene?: RBXRendererScene): void;
+    /** */
+    /**
+     * Adds an instance to the renderer or updates it, add it again to update it after changes have been made
+     * @param instance The instance that will be updated (the descendants will also update)
+     * @param auth This is here just in case something requires it in the future
+     * @param renderScene The scene the instances will be rendered in. Default RBXRenderer.firstScene
+     * @param includeDescendants If descendants should also have addInstance called on them. Default true
+     * @returns
+     */
+    static addInstance(instance: Instance, auth: Authentication, renderScene?: RBXRendererScene, includeDescendants?: boolean): void;
     static setRendererSize(width: number, height: number): void;
     /**
      * @deprecated Use getRendererElement instead which includes the loading icon
@@ -3728,6 +3818,12 @@ export declare class RBXRendererScene {
      * @return true if all have been compiled
      */
     isFullyCompiled(): boolean;
+    /**
+     * @param instances Array of instances you want to wait to be finished compiling
+     * @param timeoutSeconds Default is 30 seconds
+     * @returns true if successful, false if a RenderDesc failed to compile or timed out
+     */
+    waitUntilFullyCompiled(instances: Instance[], timeoutSeconds?: number): Promise<boolean>;
     /**
      * Exports scene as a GLTF or GLB
      * @param name Name of the resulting file if autoDownload is true
@@ -3996,6 +4092,15 @@ export declare interface Search_Result {
     }[];
 }
 
+/**
+ * Sets the APICACHE to a preset value
+ *
+ * @param preset
+ *
+ * @category API
+ */
+export declare function setCacheFootprintPreset(preset: "none" | "low" | "normal" | "high"): void;
+
 export declare function setupAccessoryCamera(accessoryModel: Instance, camera: Instance): void;
 
 export declare function setupBodyPartCamera(mannequin: Instance, faceRight: boolean, focusPartNames: string[], camera: Instance): void;
@@ -4005,7 +4110,7 @@ export declare function setupCamera(camera: Instance, cameraOptions: CameraOptio
 export declare function setupHeadCamera(headModel: Instance, camera: Instance): void;
 
 /**
- * Gives a scene the default appearance for thumbnails
+ * Gives a scene the default appearance and properties for thumbnails
  * @param renderScene RBXRenderScene to setup
  *
  * @category ThumbnailGenerator
@@ -4119,6 +4224,17 @@ export declare const TextureMode: {
     Static: number;
 };
 
+declare interface TextureParams {
+    colorSpace?: THREE.ColorSpace;
+    wrapS?: THREE.Wrapping;
+    wrapT?: THREE.Wrapping;
+    magFilter?: THREE.MagnificationTextureFilter;
+    minFilter?: THREE.MinificationTextureFilter;
+    generateMipmaps?: boolean;
+}
+
+declare type THREEDisposable = THREE.Texture | THREE.BufferGeometry | THREE.Material | THREE.InstancedMesh | THREE.WebGLRenderTarget;
+
 declare type ThreePoseCorrective = Vec3;
 
 /**