Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Namespace: Base64
Phaser.Utils.Base64
Source: src/utils/base64/index.js (Line 7)

Methods

<static> ArrayBufferToBase64(arrayBuffer, [mediaType])
Focus
Focus

Description:

Converts an ArrayBuffer into a base64 string.

The resulting string can optionally be a data uri if the mediaType argument is provided.

See https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs for more details.

Parameters:

name type arguments description
arrayBuffer ArrayBuffer

The Array Buffer to encode.

mediaType string <optional>

An optional media type, i.e. audio/ogg or image/jpeg. If included the resulting string will be a data URI.

Returns:
Description:

The base64 encoded Array Buffer.

Type:
  • string
Examples:
Since: 3.18.0
Focus
Focus
<static> Base64ToArrayBuffer(base64)
Focus
Focus

Description:

Converts a base64 string, either with or without a data uri, into an Array Buffer.

Parameters:

name type description
base64 string

The base64 string to be decoded. Can optionally contain a data URI header, which will be stripped out prior to decoding.

Returns:
Description:

An ArrayBuffer decoded from the base64 data.

Type:
  • ArrayBuffer
Examples:
Since: 3.18.0
Focus
Focus