Clarified docs with BaseTexture.fromBuffer default options (pixijs#8413)

michaeljherrmann · Jun 20, 2022 · 57f64d8 · 57f64d8
1 parent 2ce6099
commit 57f64d8
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/packages/core/src/textures/BaseTexture.ts b/packages/core/src/textures/BaseTexture.ts
@@ -637,6 +637,10 @@ export class BaseTexture<R extends Resource = Resource, RO = IAutoDetectOptions>
      * @param width - Width of the resource
      * @param height - Height of the resource
      * @param options - See {@link PIXI.BaseTexture}'s constructor for options.
+     *        Default properties are different from the constructor's defaults.
+     * @param {PIXI.FORMATS} [options.format=PIXI.FORMATS.RGBA] - GL format type
+     * @param {PIXI.ALPHA_MODES} [options.alphaMode=PIXI.ALPHA_MODES.NPM] - Image alpha, not premultiplied by default
+     * @param {PIXI.SCALE_MODES} [options.scaleMode=PIXI.SCALE_MODES.NEAREST] - Scale mode, pixelating by default
      * @returns - The resulting new BaseTexture
      */
     static fromBuffer(buffer: Float32Array | Uint8Array,