Skip to content

Commit

Permalink
Small JSDoc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
kungfooman committed Sep 29, 2024
1 parent 48c3c30 commit 4caa970
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 6 deletions.
2 changes: 1 addition & 1 deletion src/platform/graphics/texture.js
Original file line number Diff line number Diff line change
Expand Up @@ -875,7 +875,7 @@ class Texture {
* Set the pixel data of the texture from a canvas, image, video DOM element. If the texture is
* a cubemap, the supplied source must be an array of 6 canvases, images or videos.
*
* @param {HTMLCanvasElement|HTMLImageElement|HTMLVideoElement|HTMLCanvasElement[]|HTMLImageElement[]|HTMLVideoElement[]} source - A
* @param {HTMLCanvasElement|HTMLImageElement|HTMLVideoElement|HTMLCanvasElement[]|HTMLImageElement[]|HTMLVideoElement[]|ImageBitmap} source - A
* canvas, image or video element, or an array of 6 canvas, image or video elements.
* @param {number} [mipLevel] - A non-negative integer specifying the image level of detail.
* Defaults to 0, which represents the base image source. A level value of N, that is greater
Expand Down
2 changes: 1 addition & 1 deletion src/platform/graphics/vertex-buffer.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class VertexBuffer {
* @param {object} [options] - Object for passing optional arguments.
* @param {number} [options.usage] - The usage type of the vertex buffer (see BUFFER_*).
* Defaults to BUFFER_STATIC.
* @param {ArrayBuffer} [options.data] - Initial data.
* @param {ArrayBuffer|Float32Array} [options.data] - Initial data.
* @param {boolean} [options.storage] - Defines if the vertex buffer can be used as a storage
* buffer by a compute shader. Defaults to false. Only supported on WebGPU.
*/
Expand Down
2 changes: 0 additions & 2 deletions src/platform/graphics/vertex-iterator.js
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,6 @@ class VertexIteratorAccessor {
* that are not relevant to this attribute.
* @param {number} vertexElement.stride - The number of total bytes that are between the start
* of one vertex, and the start of the next.
* @param {ScopeId} vertexElement.scopeId - The shader input variable corresponding to the
* attribute.
* @param {number} vertexElement.size - The size of the attribute in bytes.
* @param {VertexFormat} vertexFormat - A vertex format that defines the layout of vertex data
* inside the buffer.
Expand Down
4 changes: 2 additions & 2 deletions src/platform/input/keyboard-event.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ class KeyboardEvent {
/**
* Create a new KeyboardEvent.
*
* @param {Keyboard} keyboard - The keyboard object which is firing the event.
* @param {globalThis.KeyboardEvent} event - The original browser event that was fired.
* @param {Keyboard} [keyboard] - The keyboard object which is firing the event.
* @param {globalThis.KeyboardEvent} [event] - The original browser event that was fired.
* @example
* const onKeyDown = function (e) {
* if (e.key === pc.KEY_SPACE) {
Expand Down

0 comments on commit 4caa970

Please sign in to comment.