@nativescript/canvas-three 2.0.0-webgpu.27 → 2.0.0-webgpu.28

package/three/src/audio/Audio.d.ts

@@ -1,6 +1,6 @@
-import { Object3D } from "../core/Object3D.js";
-import { AudioContext } from "./AudioContext.js";
-import { AudioListener } from "./AudioListener.js";
+import { Object3D } from '../core/Object3D.js';
+import { AudioContext } from './AudioContext.js';
+import { AudioListener } from './AudioListener.js';
 
 // Extras / Audio /////////////////////////////////////////////////////////////////////
 
@@ -29,242 +29,242 @@ import { AudioListener } from "./AudioListener.js";
  * @see {@link https://github.com/mrdoob/three.js/blob/master/src/audio/Audio.js | Source}
  */
 export class Audio<NodeType extends AudioNode = GainNode> extends Object3D {
-    /**
-     * Create a new instance of {@link Audio}
-     * @param listener (required) {@link AudioListener | AudioListener} instance.
-     */
-    constructor(listener: AudioListener);
-
-    /**
-     * A Read-only _string_ to check if `this` object type.
-     * @remarks Sub-classes will update this value.
-     * @defaultValue `Audio`
-     */
-    readonly type: string | "Audio";
-
-    /**
-     * A reference to the listener object of this audio.
-     */
-    listener: AudioListener;
-
-    /**
-     * The {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioContext | AudioContext} of the {@link AudioListener | listener} given in the constructor.
-     */
-    context: AudioContext;
-
-    /**
-     * A {@link https://developer.mozilla.org/en-US/docs/Web/API/GainNode | GainNode} created using
-     * {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createGain | AudioContext.createGain}().
-     */
-    gain: GainNode;
-
-    /**
-     * Whether to start playback automatically.
-     * @defaultValue `false`
-     */
-    autoplay: boolean;
-
-    buffer: AudioBuffer | null;
-
-    /**
-     * Modify pitch, measured in cents. +/- 100 is a semitone. +/- 1200 is an octave.
-     * @defaultValue `0`
-     */
-    detune: number;
-
-    /**
-     * @default false
-     */
-    loop: boolean;
-
-    /**
-     * @default 0
-     */
-    loopStart: number;
-
-    /**
-     * @default 0
-     */
-    loopEnd: number;
-
-    /**
-     * An offset to the time within the {@link Audio} buffer that playback should begin.
-     * Same as the {@link Audio.offset | offset} parameter of {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/start | AudioBufferSourceNode.start()}.
-     * @defaultValue `0`
-     */
-    offset: number;
-
-    /**
-     * Overrides the duration of the audio. Same as the {@link Audio.duration | duration} parameter of
-     * {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/start | AudioBufferSourceNode.start()}.
-     * @defaultValue `undefined` _to play the whole buffer_.
-     */
-    duration: number | undefined;
-
-    /**
-     * Speed of playback.
-     * @defaultValue `1`
-     */
-    playbackRate: number;
-
-    /**
-     * Whether the {@link Audio} is currently playing.
-     * @defaultValue `false`
-     */
-    isPlaying: boolean;
-
-    /**
-     * Whether playback can be controlled using the {@link Audio.play | play}(), {@link Audio.pause | pause}() etc. methods.
-     * @defaultValue `true`
-     */
-    hasPlaybackControl: boolean;
-
-    /**
-     * Type of the {@link Audio} source.
-     * @defaultValue 'empty'.
-     */
-    sourceType: string;
-
-    /**
-     * An {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode | AudioBufferSourceNode} created using
-     * {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createBufferSource | AudioContext.createBufferSource()}.
-     */
-    source: AudioScheduledSourceNode | null;
-
-    /**
-     * Represents an array of {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioNode | AudioNodes}.
-     * Can be used to apply a variety of low-order filters to create more complex sound effects.
-     * In most cases, the array contains instances of {@link https://developer.mozilla.org/en-US/docs/Web/API/BiquadFilterNode | BiquadFilterNodes}.
-     * Filters are set via {@link THREE.Audio.setFilter | Audio.setFilter} or {@link THREE.Audio.setFilters | Audio.setFilters}.
-     * @defaultValue `[]`
-     */
-    filters: AudioNode[];
-
-    /**
-     * Return the {@link Audio.gain | gainNode}.
-     */
-    getOutput(): NodeType;
-
-    /**
-     * Setup the {@link Audio.source | source} to the audioBuffer, and sets {@link Audio.sourceType | sourceType} to 'audioNode'.
-     * @remarks Also sets {@link Audio.hasPlaybackControl | hasPlaybackControl} to false.
-     */
-    setNodeSource(audioNode: AudioScheduledSourceNode): this;
-
-    /**
-     * Applies the given object of type {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement | HTMLMediaElement} as the source of this audio.
-     * @remarks Also sets {@link Audio.hasPlaybackControl | hasPlaybackControl} to false.
-     */
-    setMediaElementSource(mediaElement: HTMLMediaElement): this;
-
-    /**
-     * Applies the given object of type {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaStream | MediaStream} as the source of this audio.
-     * @remarks Also sets {@link Audio.hasPlaybackControl | hasPlaybackControl} to false.
-     */
-    setMediaStreamSource(mediaStream: MediaStream): this;
-
-    /**
-     * Setup the {@link Audio.source | source} to the audioBuffer, and sets {@link Audio.sourceType | sourceType} to 'buffer'.
-     * @remarks If {@link Audio.autoplay | autoplay}, also starts playback.
-     */
-    setBuffer(audioBuffer: AudioBuffer): this;
-
-    /**
-     * If {@link Audio.hasPlaybackControl | hasPlaybackControl} is true, starts playback.
-     */
-    play(delay?: number): this;
-    /**
-     * If {@link Audio.hasPlaybackControl | hasPlaybackControl} is true, pauses playback.
-     */
-    pause(): this;
-    /**
-     * If {@link Audio.hasPlaybackControl | hasPlaybackControl} is enabled, stops playback.
-     */
-    stop(): this;
-
-    /**
-     * Called automatically when playback finished.
-     */
-    onEnded(): void;
-
-    /**
-     * Connect to the {@link THREE.Audio.source | Audio.source}
-     * @remarks This is used internally on initialisation and when setting / removing filters.
-     */
-    connect(): this;
-    /**
-     * Disconnect from the {@link THREE.Audio.source | Audio.source}
-     * @remarks This is used internally when setting / removing filters.
-     */
-    disconnect(): this;
-
-    /**
-     * Returns the detuning of oscillation in cents.
-     */
-    getDetune(): number;
-    /**
-     * Defines the detuning of oscillation in cents.
-     * @param value Expects a `Float`
-     */
-    setDetune(value: number): this;
-
-    /**
-     * Returns the first element of the {@link Audio.filters | filters} array.
-     */
-    getFilter(): AudioNode;
-    /**
-     * Applies a single filter node to the audio.
-     */
-    setFilter(filter: AudioNode): this;
-
-    /**
-     * Returns the {@link Audio.filters | filters} array.
-     */
-    getFilters(): AudioNode[];
-    /**
-     * Applies an array of filter nodes to the audio.
-     * @param value Arrays of filters.
-     */
-    setFilters(value: AudioNode[]): this;
-
-    /**
-     * Return the value of {@link Audio.playbackRate | playbackRate}.
-     */
-    getPlaybackRate(): number;
-    /**
-     * If {@link Audio.hasPlaybackControl | hasPlaybackControl} is enabled, set the {@link Audio.playbackRate | playbackRate} to `value`.
-     * @param value Expects a `Float`
-     */
-    setPlaybackRate(value: number): this;
-
-    /**
-     * Return the value of {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop | source.loop} (whether playback should loop).
-     */
-    getLoop(): boolean;
-    /**
-     * Set {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop | source.loop} to `value` (whether playback should loop).
-     * @param value
-     */
-    setLoop(value: boolean): this;
-
-    /**
-     * Set {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopStart | source.loopStart} to `value`.
-     * @param value Expects a `Float`
-     */
-    setLoopStart(value: number): this;
-    /**
-     * Set {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopEnd | source.loopEnd} to `value`.
-     * @param value Expects a `Float`
-     */
-    setLoopEnd(value: number): this;
-
-    /**
-     * Return the current volume.
-     */
-    getVolume(): number;
-    /**
-     * Set the volume.
-     * @param value Expects a `Float`
-     */
-    setVolume(value: number): this;
+	/**
+	 * Create a new instance of {@link Audio}
+	 * @param listener (required) {@link AudioListener | AudioListener} instance.
+	 */
+	constructor(listener: AudioListener);
+
+	/**
+	 * A Read-only _string_ to check if `this` object type.
+	 * @remarks Sub-classes will update this value.
+	 * @defaultValue `Audio`
+	 */
+	readonly type: string | 'Audio';
+
+	/**
+	 * A reference to the listener object of this audio.
+	 */
+	listener: AudioListener;
+
+	/**
+	 * The {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioContext | AudioContext} of the {@link AudioListener | listener} given in the constructor.
+	 */
+	context: AudioContext;
+
+	/**
+	 * A {@link https://developer.mozilla.org/en-US/docs/Web/API/GainNode | GainNode} created using
+	 * {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createGain | AudioContext.createGain}().
+	 */
+	gain: GainNode;
+
+	/**
+	 * Whether to start playback automatically.
+	 * @defaultValue `false`
+	 */
+	autoplay: boolean;
+
+	buffer: AudioBuffer | null;
+
+	/**
+	 * Modify pitch, measured in cents. +/- 100 is a semitone. +/- 1200 is an octave.
+	 * @defaultValue `0`
+	 */
+	detune: number;
+
+	/**
+	 * @default false
+	 */
+	loop: boolean;
+
+	/**
+	 * @default 0
+	 */
+	loopStart: number;
+
+	/**
+	 * @default 0
+	 */
+	loopEnd: number;
+
+	/**
+	 * An offset to the time within the {@link Audio} buffer that playback should begin.
+	 * Same as the {@link Audio.offset | offset} parameter of {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/start | AudioBufferSourceNode.start()}.
+	 * @defaultValue `0`
+	 */
+	offset: number;
+
+	/**
+	 * Overrides the duration of the audio. Same as the {@link Audio.duration | duration} parameter of
+	 * {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/start | AudioBufferSourceNode.start()}.
+	 * @defaultValue `undefined` _to play the whole buffer_.
+	 */
+	duration: number | undefined;
+
+	/**
+	 * Speed of playback.
+	 * @defaultValue `1`
+	 */
+	playbackRate: number;
+
+	/**
+	 * Whether the {@link Audio} is currently playing.
+	 * @defaultValue `false`
+	 */
+	isPlaying: boolean;
+
+	/**
+	 * Whether playback can be controlled using the {@link Audio.play | play}(), {@link Audio.pause | pause}() etc. methods.
+	 * @defaultValue `true`
+	 */
+	hasPlaybackControl: boolean;
+
+	/**
+	 * Type of the {@link Audio} source.
+	 * @defaultValue 'empty'.
+	 */
+	sourceType: string;
+
+	/**
+	 * An {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode | AudioBufferSourceNode} created using
+	 * {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createBufferSource | AudioContext.createBufferSource()}.
+	 */
+	source: AudioScheduledSourceNode | null;
+
+	/**
+	 * Represents an array of {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioNode | AudioNodes}.
+	 * Can be used to apply a variety of low-order filters to create more complex sound effects.
+	 * In most cases, the array contains instances of {@link https://developer.mozilla.org/en-US/docs/Web/API/BiquadFilterNode | BiquadFilterNodes}.
+	 * Filters are set via {@link THREE.Audio.setFilter | Audio.setFilter} or {@link THREE.Audio.setFilters | Audio.setFilters}.
+	 * @defaultValue `[]`
+	 */
+	filters: AudioNode[];
+
+	/**
+	 * Return the {@link Audio.gain | gainNode}.
+	 */
+	getOutput(): NodeType;
+
+	/**
+	 * Setup the {@link Audio.source | source} to the audioBuffer, and sets {@link Audio.sourceType | sourceType} to 'audioNode'.
+	 * @remarks Also sets {@link Audio.hasPlaybackControl | hasPlaybackControl} to false.
+	 */
+	setNodeSource(audioNode: AudioScheduledSourceNode): this;
+
+	/**
+	 * Applies the given object of type {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement | HTMLMediaElement} as the source of this audio.
+	 * @remarks Also sets {@link Audio.hasPlaybackControl | hasPlaybackControl} to false.
+	 */
+	setMediaElementSource(mediaElement: HTMLMediaElement): this;
+
+	/**
+	 * Applies the given object of type {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaStream | MediaStream} as the source of this audio.
+	 * @remarks Also sets {@link Audio.hasPlaybackControl | hasPlaybackControl} to false.
+	 */
+	setMediaStreamSource(mediaStream: MediaStream): this;
+
+	/**
+	 * Setup the {@link Audio.source | source} to the audioBuffer, and sets {@link Audio.sourceType | sourceType} to 'buffer'.
+	 * @remarks If {@link Audio.autoplay | autoplay}, also starts playback.
+	 */
+	setBuffer(audioBuffer: AudioBuffer): this;
+
+	/**
+	 * If {@link Audio.hasPlaybackControl | hasPlaybackControl} is true, starts playback.
+	 */
+	play(delay?: number): this;
+	/**
+	 * If {@link Audio.hasPlaybackControl | hasPlaybackControl} is true, pauses playback.
+	 */
+	pause(): this;
+	/**
+	 * If {@link Audio.hasPlaybackControl | hasPlaybackControl} is enabled, stops playback.
+	 */
+	stop(): this;
+
+	/**
+	 * Called automatically when playback finished.
+	 */
+	onEnded(): void;
+
+	/**
+	 * Connect to the {@link THREE.Audio.source | Audio.source}
+	 * @remarks This is used internally on initialisation and when setting / removing filters.
+	 */
+	connect(): this;
+	/**
+	 * Disconnect from the {@link THREE.Audio.source | Audio.source}
+	 * @remarks This is used internally when setting / removing filters.
+	 */
+	disconnect(): this;
+
+	/**
+	 * Returns the detuning of oscillation in cents.
+	 */
+	getDetune(): number;
+	/**
+	 * Defines the detuning of oscillation in cents.
+	 * @param value Expects a `Float`
+	 */
+	setDetune(value: number): this;
+
+	/**
+	 * Returns the first element of the {@link Audio.filters | filters} array.
+	 */
+	getFilter(): AudioNode;
+	/**
+	 * Applies a single filter node to the audio.
+	 */
+	setFilter(filter: AudioNode): this;
+
+	/**
+	 * Returns the {@link Audio.filters | filters} array.
+	 */
+	getFilters(): AudioNode[];
+	/**
+	 * Applies an array of filter nodes to the audio.
+	 * @param value Arrays of filters.
+	 */
+	setFilters(value: AudioNode[]): this;
+
+	/**
+	 * Return the value of {@link Audio.playbackRate | playbackRate}.
+	 */
+	getPlaybackRate(): number;
+	/**
+	 * If {@link Audio.hasPlaybackControl | hasPlaybackControl} is enabled, set the {@link Audio.playbackRate | playbackRate} to `value`.
+	 * @param value Expects a `Float`
+	 */
+	setPlaybackRate(value: number): this;
+
+	/**
+	 * Return the value of {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop | source.loop} (whether playback should loop).
+	 */
+	getLoop(): boolean;
+	/**
+	 * Set {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop | source.loop} to `value` (whether playback should loop).
+	 * @param value
+	 */
+	setLoop(value: boolean): this;
+
+	/**
+	 * Set {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopStart | source.loopStart} to `value`.
+	 * @param value Expects a `Float`
+	 */
+	setLoopStart(value: number): this;
+	/**
+	 * Set {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopEnd | source.loopEnd} to `value`.
+	 * @param value Expects a `Float`
+	 */
+	setLoopEnd(value: number): this;
+
+	/**
+	 * Return the current volume.
+	 */
+	getVolume(): number;
+	/**
+	 * Set the volume.
+	 * @param value Expects a `Float`
+	 */
+	setVolume(value: number): this;
 }

package/three/src/audio/AudioAnalyser.d.ts

@@ -1,4 +1,4 @@
-import { Audio } from "./Audio.js";
+import { Audio } from './Audio.js';
 
 /**
  * Create a {@link AudioAnalyser} object, which uses an {@link https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode | AnalyserNode} to analyse audio data.
@@ -29,30 +29,30 @@ import { Audio } from "./Audio.js";
  * @see {@link https://github.com/mrdoob/three.js/blob/master/src/audio/AudioAnalyser.js | Source}
  */
 export class AudioAnalyser {
-    /**
-     * Create a new {@link {@link AudioAnalyser} | AudioAnalyser}.
-     * @param audio
-     * @param fftSize See {@link https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/fftSize | AnalyserNode.fftSize }. Expects a `unsigned integer`. Default `2048`.
-     */
-    constructor(audio: Audio<AudioNode>, fftSize?: number);
+	/**
+	 * Create a new {@link {@link AudioAnalyser} | AudioAnalyser}.
+	 * @param audio
+	 * @param fftSize See {@link https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/fftSize | AnalyserNode.fftSize }. Expects a `unsigned integer`. Default `2048`.
+	 */
+	constructor(audio: Audio<AudioNode>, fftSize?: number);
 
-    /**
-     * An {@link https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode | AnalyserNode} used to analyze audio.
-     */
-    analyser: AnalyserNode;
+	/**
+	 * An {@link https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode | AnalyserNode} used to analyze audio.
+	 */
+	analyser: AnalyserNode;
 
-    /**
-     * A Uint8Array with size determined by {@link https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount | analyser.frequencyBinCount} used to hold analysis data.
-     */
-    data: Uint8Array;
+	/**
+	 * A Uint8Array with size determined by {@link https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount | analyser.frequencyBinCount} used to hold analysis data.
+	 */
+	data: Uint8Array;
 
-    /**
-     * Uses the Web Audio's {@link https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData | getByteFrequencyData} method
-     */
-    getFrequencyData(): Uint8Array;
+	/**
+	 * Uses the Web Audio's {@link https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData | getByteFrequencyData} method
+	 */
+	getFrequencyData(): Uint8Array;
 
-    /**
-     * Get the average of the frequencies returned by the {@link AudioAnalyser.getFrequencyData | getFrequencyData} method.
-     */
-    getAverageFrequency(): number;
+	/**
+	 * Get the average of the frequencies returned by the {@link AudioAnalyser.getFrequencyData | getFrequencyData} method.
+	 */
+	getAverageFrequency(): number;
 }

package/three/src/audio/AudioContext.d.ts

@@ -6,14 +6,14 @@
  * @see {@link https://github.com/mrdoob/three.js/blob/master/src/audio/AudioContext.js | Source}
  */
 export namespace AudioContext {
-    /**
-     * Return the value of the variable `context` in the outer scope, if defined, otherwise set it to a new {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioContext | AudioContext}.
-     */
-    function getContext(): AudioContext;
+	/**
+	 * Return the value of the variable `context` in the outer scope, if defined, otherwise set it to a new {@link https://developer.mozilla.org/en-US/docs/Web/API/AudioContext | AudioContext}.
+	 */
+	function getContext(): AudioContext;
 
-    /**
-     * Set the variable `context` in the outer scope to `value`.
-     * @param value
-     */
-    function setContext(context: AudioContext): void;
+	/**
+	 * Set the variable `context` in the outer scope to `value`.
+	 * @param value
+	 */
+	function setContext(context: AudioContext): void;
 }