Texture.API

Class: Texture

Texture

new Texture(data, width, height, format)

Texture

Parameters:

Name	Type	Argument	Description
data	Uint8Array | Float32Array | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement		The data
width	Number		Data width
height	Number		Data height
format	Texture.Format	<optional>	The format

Source:

• gl/Texture.js , lineno 16

Classes

Format

Methods

<static> createBlank() → {Texture}

Returns a new white texture.

Source:

• gl/Texture.js , lineno 199

Returns:

Type

Texture

<static> createFromImage(image, format) → {Texture}

Returns a new texture form an image

Parameters:

Name	Type	Description
image	HTMLImageElement
format

Source:

• gl/Texture.js , lineno 212

Returns:

Type

Texture

<static> createRandom(width, height, format, valueR, valueG, valueB, valueA) → {Texture}

Returns a randomly pixelated texture.

Parameters:

Name	Type	Argument	Description
width	Number		The width
height	Number		The height
format	Texture.Format	<optional>	The format
valueR	Number	<optional>	Optional fixed red value, random if null
valueG	Number	<optional>	Optional fixed green value, random if null
valueB	Number	<optional>	Optional fixed blue value, random if null
valueA	Number	<optional>	Optional fixed alpha value, random if null

Source:

• gl/Texture.js , lineno 228

Returns:

Type

Texture

bind(unit)

Activates & binds the texture.

Parameters:

Name	Type	Argument	Description
unit	Number	<optional>	The texture unit

Source:

• gl/Texture.js , lineno 131

delete()

Delete the texture.

Source:

• gl/Texture.js , lineno 188

getFormat() → {Number}

Returns the textures format.

Source:

• gl/Texture.js , lineno 94

Returns:

Type

Number

getGLTexture() → {WebGLTexture}

Returns the webgl texture.

Source:

• gl/Texture.js , lineno 70

Returns:

Type

WebGLTexture

getHeight() → {Number}

Returns the height of the texture

Source:

• gl/Texture.js , lineno 112

Returns:

Type

Number

getSize(v) → {Vec2}

Returns the size of the texture.

Parameters:

Name	Type	Argument	Description
v	Vec2	<optional>	Out size

Source:

• gl/Texture.js , lineno 122

Returns:

Type

Vec2

getWidth() → {Number}

Returns the width of the texture.

Source:

• gl/Texture.js , lineno 103

Returns:

Type

Number

unbind(unit)

Unbind the texture

Parameters:

Name	Type	Description
unit

Source:

• gl/Texture.js , lineno 146

writeData(data, offsetX, offsetY, width, height)

Writes new data to the texture.

Parameters:

Name	Type	Argument	Description
data	Uint8Array | Float32Array		The data
offsetX	Number	<optional>
offsetY	Number	<optional>
width	Number	<optional>
height	Number	<optional>

Source:

• gl/Texture.js , lineno 165

Generated with wicked.