---

title: TextureHelper category: Addons layout: docs

TextureHelper

A helper that can be used to display any type of texture for debugging purposes. Depending on the type of texture (2D, 3D, Array), the helper becomes a plane or box mesh.

This helper can only be used with WebGLRenderer. When using WebGPURenderer, import from TextureHelperGPU.js.

Import

TextureHelper is an addon, and must be imported explicitly, see Installation#Addons.

import { TextureHelper } from 'three/addons/helpers/TextureHelper.js';

Constructor

new TextureHelper( texture : Texture, width : number, height : number, depth : number )

Constructs a new texture helper.

texture | The texture to visualize.
---|---
width | The helper's width. Default is 1.
height | The helper's height. Default is 1.
depth | The helper's depth. Default is 1.

Properties

.texture : Texture

The texture to visualize.

Methods

.dispose()

Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

Source

examples/jsm/helpers/TextureHelper.js