CompressedTexture - Verge3D User Manual - Soft8Soft
Description: Learn how to use CompressedTexture in your interactive 3D apps made with Verge3D

Texture →

# CompressedTexture

Creates a texture based on data in compressed form, for example from a KTX file.

For use with the CompressedTextureLoader.

## Constructor

### CompressedTexture(mipmaps : Array, width : Integer, height : Integer, format : Constant, type : Constant, mapping : Constant, wrapS : Constant, wrapT : Constant, magFilter : Constant, minFilter : Constant, anisotropy : Integer, encoding : Constant)

- mipmaps — the mipmaps array should contain objects with data, width and height. The mipmaps should be of the correct format and type.
- width — the width of the biggest mipmap.
- height — the height of the biggest mipmap.
- format — the format used in the mipmaps. See ST3C Compressed Texture Formats, PVRTC Compressed Texture Formats and ETC Compressed Texture Format for possible choices.
- type — default is v3d.UnsignedByteType. See type constants for other choices.
- mapping — how the image is applied to the object. An object type of v3d.UVMapping. See mapping constants for other choices.
- wrapS — the default is v3d.ClampToEdgeWrapping. See wrap mode constants for other choices.
- wrapT — the default is v3d.ClampToEdgeWrapping. See wrap mode constants for other choices.
- magFilter — how the texture is sampled when a texel covers more than one pixel. The default is v3d.LinearFilter. See magnification filter constants for other choices.
- minFilter — how the texture is sampled when a texel covers less than one pixel. The default is v3d.LinearMipmapLinearFilter. See minification filter constants for other choices.
- anisotropy — the number of samples taken along the axis through the pixel that has the highest density of texels. By default, this value is 1. A higher value gives a less blurry result than a basic mipmap, at the cost of more texture samples being used. Use renderer.getMaxAnisotropy() to find the maximum valid anisotropy value for the GPU; this value is usually a power of 2.

## Properties

See the base Texture class for inherited properties.

### # .flipY : Boolean

False by default. Flipping textures does not work for compressed textures.

### # .generateMipmaps : Boolean

False by default. Mipmaps can't be generated for compressed textures

### # .isCompressedTexture : Boolean

Read-only flag to check if a given object is of type CompressedTexture.

## Methods

See the base Texture class for inherited methods.

## Source

For more info on how to obtain the source code of this module see this page.