Two.Texture

Extends: Two.Element

Fundamental to work with bitmap data, a.k.a. pregenerated imagery, in Two.js. Supported formats include jpg, png, gif, and tiff. See Two.Texture.RegularExpressions for a full list of supported formats.

Source

Constructor

Argument	Description
src	The URL path to an image file or an `<img />` element.
callback	An optional callback function once the image has been loaded.

Properties

A list of properties that are on every Two.Texture.

texture.js:188

fromObject

Returns: Two.Texture

Argument	Description
obj	Object notation of a Two.Texture to create a new instance

Create a new Two.Texture from an object notation of a Two.Texture.

texture.js:194

nota-bene

Works in conjunction with Two.Texture.toObject

RegularExpressions

A map of compatible DOM Elements categorized by media format.

texture.js:212

ImageRegistry

A canonical listing of image data used in a single session of Two.js.

texture.js:218

nota-bene

This object is used to cache image data between different textures.

getAbsoluteURL

Returns: String

The serialized absolute path.

Serializes a URL as an absolute path for canonical attribution in Two.Texture.ImageRegistry.

Argument	Description
path

texture.js:225

loadHeadlessBuffer

Loads an image as a buffer in headless environments.

Argument	Description
texture	The Two.Texture to be loaded.
onLoad	The callback function to be triggered once the image is loaded.

texture.js:240

nota-bene

This function uses node's fs.readFileSync to spoof the <img /> loading process in the browser.

getTag

Returns: String

Returns the tag name of an image, video, or canvas node.

Retrieves the tag name of an image, video, or canvas node.

Argument	Description
image	The image to infer the tag name from.

texture.js:252

getImage

Returns: HTMLImageElement

Returns either a cached version of the image or a new one that is registered in Two.Texture.ImageRegistry.

Convenience function to set Two.Texture.image properties with canonical versions set in Two.Texture.ImageRegistry.

Argument	Description
src	The URL path of the image.

texture.js:266

Register

A collection of functions to register different types of textures. Used internally by a Two.Texture.

texture.js:301

load

Argument	Description
texture	The texture to load.
callback	The function to be called once the texture is loaded.

texture.js:418

FlagOffset

Cached method to let renderers know offset has been updated on a Two.Texture.

texture.js:670

FlagScale

Cached method to let renderers know scale has been updated on a Two.Texture.

texture.js:679

loaded

Shorthand value to determine if image has been loaded into the texture.

texture.js:132

repeat

CSS style declaration to tile Two.Path. Valid values include: 'no-repeat', 'repeat', 'repeat-x', 'repeat-y'.

See: https://www.w3.org/TR/2dcontext/#dom-context-2d-createpattern

texture.js:138

offset

A two-component vector describing any pixel offset of the texture when applied to a Two.Path.

texture.js:145

src

The URL path to the image data.

texture.js:161

nota-bene

This property is ultimately serialized in a Two.Registry to cache retrieval.

image

The corresponding DOM Element of the texture. Can be a <img />, <canvas />, or <video /> element. See Two.Texture.RegularExpressions for a full list of supported elements.

texture.js:176

nota-bene

In headless environments this is a Canvas.Image object. See https://github.com/Automattic/node-canvas for more information on headless image objects.