9.7. The Texture Object

A Texture object is a multidimensional container of pixel data.

9.7.1. Constructor

You can create a texture using the GraphicsDevice.createTexture function.

9.7.2. Methods

9.7.2.1. setData

Summary

Set the data by passing in an array of numbers.

Pixel data of the top-level of the texture, it consists of an array of numbers, one value for each component of every pixel. The number of components per pixel depends on the pixel format.

Create the texture as dynamic if you are planning to update the pixel data at runtime. If the texture has a mipmap chain all the levels would be recalculated.

Changing the pixel data can be an expensive operation.

Syntax

//set the data post-creation for a 2x2 texture of depth 1 and format 'R8G8B8A8'
texture.setData([255, 0, 0, 255,
                0, 255, 0, 255,
                0, 255, 0, 255,
                0, 0, 255, 255]);

9.7.3. Properties

9.7.3.1. name

Summary

The name of the texture object, usually the path to the image file that provided the pixel data.

Syntax

var textureName = texture.name;

Note

Read Only

9.7.3.2. width

Summary

Width of the top-level of the texture in pixels.

Syntax

var textureWidth = texture.width;

Note

Read Only

9.7.3.3. height

Summary

Height of the top-level of the texture in pixels.

Syntax

var textureHeight = texture.height;

Note

Read Only

9.7.3.4. depth

Summary

Depth of the top-level of the texture in pixels. It would be 1 for non 3D textures.

Syntax

var textureDepth = texture.depth;

Note

Read Only

9.7.3.5. format

Summary

Name of the format used to store the pixel data.

Syntax

var textureFormat = texture.format;

Note

Read Only

9.7.3.6. cubemap

Summary

True if the texture is a cubemap, false otherwise.

Syntax

var isCubemap = texture.cubemap;

Note

Read Only

9.7.3.7. mipmaps

Summary

True if the texture has a mipmap chain, false otherwise.

Syntax

var hasMipmaps = texture.mipmaps;

Note

Read Only

9.7.3.8. renderable

Summary

True if the texture can be rendered to, false otherwise.

Syntax

var isRenderable = texture.renderable;

Note

Read Only

9.7.3.9. dynamic

Summary

True if the texture was created as dynamic and hence can be modified at runtime, false otherwise.

Syntax

var isDynamic = texture.dynamic;

Note

Read Only