How To

Class: Texture

A texture is a container for texel data that can be utilized in a fragment shader. Typically, the texel data represents an image that is mapped over geometry.

Note on HDR texture format support:

As textures: - float (i.e. PIXELFORMAT_RGBA32F), half-float (i.e. PIXELFORMAT_RGBA16F) and small-float (PIXELFORMAT_111110F) formats are always supported on both WebGL2 and WebGPU with point sampling. - half-float and small-float formats are always supported on WebGL2 and WebGPU with linear sampling. - float formats are supported on WebGL2 and WebGPU with linear sampling only if GraphicsDevice#textureFloatFilterable is true.
As renderable textures that can be used as color buffers in a RenderTarget: - on WebGPU, rendering to float and half-float formats is always supported. - on WebGPU, rendering to small-float format is supported only if GraphicsDevice#textureRG11B10Renderable is true. - on WebGL2, rendering to these 3 formats formats is supported only if GraphicsDevice#textureFloatRenderable is true. - on WebGL2, if GraphicsDevice#textureFloatRenderable is false, but GraphicsDevice#textureHalfFloatRenderable is true, rendering to half-float formats only is supported. This is the case of many mobile iOS devices. - you can determine available renderable HDR format using GraphicsDevice#getRenderableHdrFormat.

Constructors

new Texture()

new Texture(graphicsDevice: GraphicsDevice, options?: {
  addressU: number;
  addressV: number;
  addressW: number;
  anisotropy: number;
  arrayLength: number;
  compareFunc: number;
  compareOnRead: boolean;
  cubemap: boolean;
  depth: number;
  flipY: boolean;
  format: number;
  height: number;
  levels:   | Uint8Array<ArrayBufferLike>[]
     | Uint16Array<ArrayBufferLike>[]
     | Uint32Array<ArrayBufferLike>[]
     | Float32Array<ArrayBufferLike>[]
     | HTMLCanvasElement[]
     | HTMLImageElement[]
     | HTMLVideoElement[]
     | Uint8Array<ArrayBufferLike>[][];
  magFilter: number;
  minFilter: number;
  mipmaps: boolean;
  name: string;
  numLevels: number;
  premultiplyAlpha: boolean;
  projection: string;
  storage: boolean;
  type: string;
  volume: boolean;
  width: number;
 }): Texture

Create a new Texture instance.

Parameters

graphicsDevice

GraphicsDevice

The graphics device used to manage this texture.

options?

Object for passing optional arguments.

addressU?

number

The repeat mode to use in the U direction. Defaults to ADDRESS_REPEAT.

addressV?

number

The repeat mode to use in the V direction. Defaults to ADDRESS_REPEAT.

addressW?

number

The repeat mode to use in the W direction. Defaults to ADDRESS_REPEAT.

anisotropy?

number

The level of anisotropic filtering to use. Defaults to 1.

arrayLength?

number

Specifies whether the texture is to be a 2D texture array. When passed in as undefined or < 1, this is not an array texture. If ≥ 1, this is an array texture. Defaults to undefined.

compareFunc?

number

Comparison function when compareOnRead is enabled. Can be:

FUNC_LESS
FUNC_LESSEQUAL
FUNC_GREATER
FUNC_GREATEREQUAL
FUNC_EQUAL
FUNC_NOTEQUAL

Defaults to FUNC_LESS.

When enabled, and if texture format is PIXELFORMAT_DEPTH or PIXELFORMAT_DEPTHSTENCIL, hardware PCF is enabled for this texture, and you can get filtered results of comparison using texture() in your shader. Defaults to false.

cubemap?

boolean

Specifies whether the texture is to be a cubemap. Defaults to false.

depth?

number

The number of depth slices in a 3D texture.

flipY?

boolean

Specifies whether the texture should be flipped in the Y-direction. Only affects textures with a source that is an image, canvas or video element. Does not affect cubemaps, compressed textures or textures set from raw pixel data. Defaults to false.

format?

number

The pixel format of the texture. Can be:

PIXELFORMAT_R8
PIXELFORMAT_RG8
PIXELFORMAT_RGB565
PIXELFORMAT_RGBA5551
PIXELFORMAT_RGBA4
PIXELFORMAT_RGB8
PIXELFORMAT_RGBA8
PIXELFORMAT_DXT1
PIXELFORMAT_DXT3
PIXELFORMAT_DXT5
PIXELFORMAT_RGB16F
PIXELFORMAT_RGBA16F
PIXELFORMAT_RGB32F
PIXELFORMAT_RGBA32F
PIXELFORMAT_ETC1
PIXELFORMAT_PVRTC_2BPP_RGB_1
PIXELFORMAT_PVRTC_2BPP_RGBA_1
PIXELFORMAT_PVRTC_4BPP_RGB_1
PIXELFORMAT_PVRTC_4BPP_RGBA_1
PIXELFORMAT_111110F
PIXELFORMAT_ASTC_4x4
PIXELFORMAT_ATC_RGB
PIXELFORMAT_ATC_RGBA

Defaults to PIXELFORMAT_RGBA8.

height?

number

The height of the texture in pixels. Defaults to 4.

levels?

Array of Uint8Array or other supported browser interface; or a two-dimensional array of Uint8Array if options.arrayLength is defined and greater than zero.

magFilter?

number

The magnification filter type to use. Defaults to FILTER_LINEAR.

minFilter?

number

The minification filter type to use. Defaults to FILTER_LINEAR_MIPMAP_LINEAR.

mipmaps?

boolean

When enabled try to generate or use mipmaps for this texture. Default is true.

name?

string

The name of the texture. Defaults to null.

numLevels?

number

Specifies the number of mip levels to generate. If not specified, the number is calculated based on the texture size. When this property is set, the mipmaps property is ignored.

premultiplyAlpha?

boolean

If true, the alpha channel of the texture (if present) is multiplied into the color channels. Defaults to false.

projection?

string

The projection type of the texture, used when the texture represents an environment. Can be:

TEXTUREPROJECTION_NONE
TEXTUREPROJECTION_CUBE
TEXTUREPROJECTION_EQUIRECT
TEXTUREPROJECTION_OCTAHEDRAL

Defaults to TEXTUREPROJECTION_CUBE if options.cubemap is true, otherwise TEXTUREPROJECTION_NONE.

storage?

boolean

Defines if texture can be used as a storage texture by a compute shader. Defaults to false.

type?

string

Specifies the texture type. Can be:

TEXTURETYPE_DEFAULT
TEXTURETYPE_RGBM
TEXTURETYPE_RGBE
TEXTURETYPE_RGBP
TEXTURETYPE_SWIZZLEGGGR

Defaults to TEXTURETYPE_DEFAULT.

volume?

boolean

Specifies whether the texture is to be a 3D volume. Defaults to false.

width?

number

The width of the texture in pixels. Defaults to 4.