top
all js glsl

TextureAtlas

TextureAtlas

new

A TextureAtlas stores multiple images in one square texture and keeps track of the texture coordinates for each image. TextureAtlas is dynamic, meaning new images can be added at any point in time. Calling addImages is more space-efficient than calling addImage multiple times. Texture coordinates are subject to change if the texture atlas resizes, so it is important to check TextureAtlas#getGUID before using old values.

Parameters:
Name Type Argument Default Description
description.context Context The context in which the texture gets created.
description.pixelFormat PixelFormat <optional>
 PixelFormat.RGBA The pixel format of the texture.
description.borderWidthInPixels Number <optional>
 1 The amount of spacing between adjacent images in pixels.
description.initialSize Cartesian2 <optional>
 new Cartesian2(16.0, 16.0) The initial side lengths of the texture.
description.images Array Optional array of Image to be added to the atlas. Same as calling addImages(images).
description.image Image Optional single image to be added to the atlas. Same as calling addImage(image).
Throws:
Source:

Methods

Adds an image to the texture atlas. Calling addImages is more space-efficient than calling addImage multiple times. Texture coordinates are subject to change if the texture atlas resizes, so it is important to check TextureAtlas#getGUID before using old values.

Parameters:
Name Type Description
image Image An image to be added to the texture atlas.
Throws:
DeveloperError : image is required.
Returns:
Number The index of the newly added image.
See:

Adds an array of images to the texture atlas. Calling addImages is more space-efficient than calling addImage multiple times. Texture coordinates are subject to change if the texture atlas resizes, so it is important to check TextureAtlas#getGUID before using old values.

Parameters:
Name Type Description
images Array An array of Image to be added to the texture atlas.
Throws:
DeveloperError : images is required and must have length greater than zero.
Returns:
Number The first index of the newly added images.
See:

Add a set of sub-regions to one atlas image as additional image indices.

Parameters:
Name Type Description
image Image An image to be added to the texture atlas.
subRegions Array An array of BoundingRectangle sub-regions measured in pixels from the bottom-left.
Throws:
DeveloperError : image is required.
Returns:
Number The index of the first newly-added region.

Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.

Throws:
DeveloperError : This object was destroyed, i.e., destroy() was called.
Returns:
Example
atlas = atlas && atlas.destroy();
See:

Returns the amount of spacing between adjacent images in pixels.

Returns:
Number The border width in pixels.

Returns the atlas' globally unique identifier (GUID). The GUID changes whenever the texture atlas is modified. Classes that use a texture atlas should check if the GUID has changed before processing the atlas data.

Returns:
String The globally unique identifier (GUID).

Returns the number of images in the texture atlas. This value increases every time addImage or addImages is called. Texture coordinates are subject to change if the texture atlas resizes, so it is important to check TextureAtlas#getGUID before using old values.

Returns:
Number The number of images in the texture atlas.

Returns the texture that all of the images are being written to.

Returns:
@link Texture The texture used by the texture atlas.

Returns an array of BoundingRectangle texture coordinate regions for all the images in the texture atlas. The x and y values of the rectangle correspond to the bottom-left corner of the texture coordinate. The coordinates are in the order that the corresponding images were added to the atlas.

Returns:
Array The texture coordinates.
See:

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

Returns:
Boolean True if this object was destroyed; otherwise, false.
See: