@tresjs/core 3.2.2 → 3.3.0-next.0

package/dist/components/TresCanvas.vue.d.ts

@@ -1,4 +1,5 @@
 import type { WebGLRendererParameters, ColorSpace, ShadowMapType, ToneMapping } from 'three';
+import { type TresContext } from '../composables';
 import type { RendererPresetsType } from '../composables/useRenderer/const';
 import type { TresCamera } from '../types/';
 export interface TresCanvasProps extends Omit<WebGLRendererParameters, 'canvas'> {
@@ -92,7 +93,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: import("vue").PropType<boolean>;
         default: undefined;
     };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+}, {
+    context: import("vue").ShallowRef<TresContext | null>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     context: {
         type: import("vue").PropType<WebGLRenderingContext>;
     };

package/dist/composables/useRenderer/const.d.ts

@@ -1,5 +1,7 @@
 export declare const rendererPresets: {
     realistic: {
+        shadows: boolean;
+        physicallyCorrectLights: boolean;
         outputColorSpace: "srgb";
         toneMapping: 4;
         toneMappingExposure: number;

package/dist/composables/useRenderer/index.d.ts

@@ -71,7 +71,7 @@ export interface UseRendererOptions extends TransformToMaybeRefOrGetter<WebGLRen
     preset?: MaybeRefOrGetter<RendererPresetsType>;
 }
 /**
- * Reactive Three.js WebGLRenderer instance
+ * Reactive three.js WebGLRenderer instance
  *
  * @param canvas
  * @param {UseRendererOptions} [options]

package/dist/composables/useTexture/index.d.ts

@@ -19,7 +19,63 @@ export interface PBRTextureMaps {
     [key: string]: Texture | null;
 }
 /**
- * Composable for loading textures.
+ * Map of textures to load that can be passed to `useTexture()`.
+ */
+export interface PBRUseTextureMap {
+    map?: string;
+    displacementMap?: string;
+    normalMap?: string;
+    roughnessMap?: string;
+    metalnessMap?: string;
+    aoMap?: string;
+    alphaMap?: string;
+    matcap?: string;
+}
+/**
+ * Loads a single texture.
+ *
+ * ```ts
+ * import { useTexture } from 'tres'
+ *
+ * const matcapTexture = await useTexture(['path/to/texture.png'])
+ * ```
+ * Then you can use the texture in your material.
+ *
+ * ```vue
+ * <TresMeshMatcapMaterial :matcap="matcapTexture" />
+ * ```
+ * @see https://tresjs.org/examples/load-textures.html
+ * @export
+ * @param paths
+ * @return A promise of the resulting texture
+ */
+export declare function useTexture(paths: readonly [string]): Promise<Texture>;
+/**
+ * Loads multiple textures.
+ *
+ * ```ts
+ * import { useTexture } from 'tres'
+ *
+ * const [texture1, texture2] = await useTexture([
+ *  'path/to/texture1.png',
+ *  'path/to/texture2.png',
+ * ])
+ * ```
+ * Then you can use the texture in your material.
+ *
+ * ```vue
+ * <TresMeshStandardMaterial map="texture1" />
+ * ```
+ * @see https://tresjs.org/examples/load-textures.html
+ * @export
+ * @param paths
+ * @return A promise of the resulting textures
+ */
+export declare function useTexture<T extends string[]>(paths: [...T]): Promise<{
+    [K in keyof T]: Texture;
+}>;
+/**
+ * Loads a PBR texture map.
  *
  * ```ts
  * import { useTexture } from 'tres'
@@ -39,9 +95,9 @@ export interface PBRTextureMaps {
  * ```
  * @see https://tresjs.org/examples/load-textures.html
  * @export
- * @param {(Array<string> | { [key: string]: string })} paths
- * @return {*}  {(Promise<Texture | Array<Texture> | PBRTextureMaps>)}
+ * @param paths
+ * @return A promise of the resulting pbr texture map
  */
-export declare function useTexture(paths: Array<string> | {
-    [key: string]: string;
-}): Promise<Texture | Array<Texture> | PBRTextureMaps>;
+export declare function useTexture<TextureMap extends PBRUseTextureMap>(paths: TextureMap): Promise<{
+    [K in keyof Required<PBRUseTextureMap>]: K extends keyof TextureMap ? Texture : null;
+}>;