Class DataTexture

Creates a texture directly from raw data, width and height.

Example

// create a buffer with color data
const width = 512;
const height = 512;
const size = width * height;
const data = new Uint8Array(4 * size);
const color = new THREE.Color(0xffffff);
const r = Math.floor(color.r * 255);
const g = Math.floor(color.g * 255);
const b = Math.floor(color.b * 255);
for (let i = 0; i & lt; size; i++) {
    const stride = i * 4;
    data[stride] = r;
    data[stride + 1] = g;
    data[stride + 2] = b;
    data[stride + 3] = 255;
}
// used the buffer to create a [name]
const texture = new THREE.DataTexture(data, width, height);
texture.needsUpdate = true;

See

Hierarchy (view full)

Texture
- DataTexture

Constructors

constructor

new DataTexture(data?, width?, height?, format?, type?, mapping?, wrapS?, wrapT?, magFilter?, minFilter?, anisotropy?, colorSpace?): DataTexture
Parameters
- Optional data: null | BufferSource
  ArrayBufferView of the texture. Default null.
- Optional width: number
  Width of the texture. Default 1.
- Optional height: number
  Height of the texture. Default 1.
- Optional format: PixelFormat
  See .format. Default THREE.RGBAFormat
- Optional type: TextureDataType
  See .type. Default THREE.UnsignedByteType
- Optional mapping: Mapping
  See .mapping. Default THREE.Texture.DEFAULT_MAPPING
- Optional wrapS: Wrapping
  See .wrapS. Default THREE.ClampToEdgeWrapping
- Optional wrapT: Wrapping
  See .wrapT. Default THREE.ClampToEdgeWrapping
- Optional magFilter: MagnificationTextureFilter
  See .magFilter. Default THREE.NearestFilter
- Optional minFilter: MinificationTextureFilter
  See .minFilter. Default THREE.NearestFilter
- Optional anisotropy: number
  See .anisotropy. Default THREE.Texture.DEFAULT_ANISOTROPY
- Optional colorSpace: ColorSpace
  See .colorSpace. Default NoColorSpace
Returns DataTexture
Overrides Texture.constructor
- Defined in ../node_modules/@types/three/src/textures/DataTexture.d.ts:55

Properties

anisotropy

anisotropy: number

The number of samples taken along the axis through the pixel that has the highest density of texels.

Remarks

A higher value gives a less blurry result than a basic mipmap, at the cost of more Texture samples being used.

Default

value of THREE.Texture.DEFAULT_ANISOTROPY. That is normally 1.

center

center: Vector2

The point around which rotation occurs.

Remarks

A value of (0.5, 0.5) corresponds to the center of the texture.

Default Value

new THREE.Vector2( 0, 0 ), lower left.

channel

channel: number

Lets you select the uv attribute to map the texture to. 0 for uv, 1 for uv1, 2 for uv2 and 3 for uv3.

colorSpace

colorSpace: ColorSpace

The Textures | {@link Texture constants} page for details of other color spaces.

Remarks

Textures containing color data should be annotated with THREE.SRGBColorSpace or THREE.LinearSRGBColorSpace.

See

Default Value

{@link THREE.NoColorSpace}

encoding

encoding: TextureEncoding

The Textures | {@link Texture constants} page for details of other formats.

Remarks

Values of encoding !== THREE.LinearEncoding are only supported on map, envMap and emissiveMap.

See

Default Value

{@link THREE.LinearEncoding}

Deprecated

Use .colorSpace in three.js r152+.

flipY

flipY: boolean

Default Value

false

format

format: AnyPixelFormat

These define how elements of a 2D texture, or texels, are read by shaders.

Remarks

All Texture types except THREE.DepthTexture and THREE.CompressedPixelFormat expect the values be THREE.PixelFormat

See

Default Value

{@link THREE.RGBAFormat}.

generateMipmaps

generateMipmaps: boolean

Default Value

false

`Readonly` id

id: number

Unique number for this Texture instance.

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

internalFormat

internalFormat: null | PixelFormatGPU

The GPU Pixel Format allows the developer to specify how the data is going to be stored on the GPU.

Remarks

Compatible only with WebGL2RenderingContext | WebGL 2 Rendering Context.

See

Texture Constants

Default Value

The default value is obtained using a combination of {@link Texture.format | .format} and {@link Texture.type | .type}.

`Readonly` isDataTexture

isDataTexture: true

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

Remarks

This is a constant value

Default Value

true

isRenderTargetTexture

isRenderTargetTexture: boolean

Indicates whether a texture belongs to a render target or not

Default Value

false

`Readonly` isTexture

isTexture: true

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

Remarks

This is a constant value

Default Value

true

magFilter

magFilter: MagnificationTextureFilter

Default Value

{@link THREE.NearestFilter}

mapping

mapping: AnyMapping

How the image is applied to the object.

Remarks

All Texture types except THREE.CubeTexture expect the values be THREE.Mapping

See

Texture Constants

Default Value

_value of_ {@link THREE.Texture.DEFAULT_MAPPING}

matrix

matrix: Matrix3

The uv-transform matrix for the texture.

Remarks

When .matrixAutoUpdate property is true. Will be updated by the renderer from the properties:

See

.matrixAutoUpdate

Default Value

new THREE.Matrix3()

matrixAutoUpdate

matrixAutoUpdate: boolean

Whether is to update the texture's uv-transform .matrix.

Remarks

Set this to false if you are specifying the uv-transform matrix directly.

See

.matrix

Default Value

true

minFilter

minFilter: MinificationTextureFilter

Default Value

{@link THREE.NearestFilter}

mipmaps

mipmaps: any[]

Array of user-specified mipmaps

Default Value

[]

name

name: string

Optional name of the object

Remarks

(doesn't need to be unique).

Default Value

""

needsPMREMUpdate

needsPMREMUpdate: boolean

Indicates whether this texture should be processed by THREE.PMREMGenerator or not.

Remarks

Only relevant for render target textures.

Default Value

false

offset

offset: Vector2

How much a single repetition of the texture is offset from the beginning, in each direction U and V.

Remarks

Typical range is 0.0 to 1.0.

Default Value

new THREE.Vector2(0, 0)

onUpdate

onUpdate: (() => void)

A callback function, called when the texture is updated (e.g., when needsUpdate has been set to true and then the texture is used).

Type declaration

- (): void
- Returns void

premultiplyAlpha

premultiplyAlpha: boolean

If set to true, the alpha channel, if present, is multiplied into the color channels when the texture is uploaded to the GPU.

Remarks

Note that this property has no effect for ImageBitmap. You need to configure on bitmap creation instead. See ImageBitmapLoader.

See

ImageBitmapLoader.

Default Value

false

repeat

repeat: Vector2

How many times the texture is repeated across the surface, in each direction U and V.

Remarks

If repeat is set greater than 1 in either direction, the corresponding Wrap parameter should also be set to THREE.RepeatWrapping or THREE.MirroredRepeatWrapping to achieve the desired tiling effect.

See

wrapS
wrapT

Default Value

new THREE.Vector2( 1, 1 )

rotation

rotation: number

How much the texture is rotated around the center point, in radians.

Remarks

Positive values are counter-clockwise.

Default Value

0

source

source: external.three.Source

The data definition of a texture. A reference to the data source can be shared across textures. This is often useful in context of spritesheets where multiple textures render the same data but with different Texture transformations.

type

type: TextureDataType

This must correspond to the .format.

Remarks

THREE.UnsignedByteType, is the type most used by Texture formats.

See

Default Value

{@link THREE.UnsignedByteType}

unpackAlignment

unpackAlignment: number

Default Value

1

userData

userData: Record<string, any>

An object that can be used to store custom data about the texture.

Remarks

It should not hold references to functions as these will not be cloned.

Default Value

{}

uuid

uuid: string

UUID of this object instance.

Remarks

This gets automatically assigned and shouldn't be edited.

version

version: number

This starts at 0 and counts how many times .needsUpdate is set to true.

Remarks

Expects a Integer

Default Value

0

wrapS

wrapS: Wrapping

This defines how the Texture is wrapped horizontally and corresponds to U in UV mapping.

Remarks

for WEBGL1 - tiling of images in textures only functions if image dimensions are powers of two (2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, ...) in terms of pixels. Individual dimensions need not be equal, but each must be a power of two. This is a limitation of WebGL1, not three.js. WEBGL2 does not have this limitation.

See

Default Value

{@link THREE.ClampToEdgeWrapping}

wrapT

wrapT: Wrapping

This defines how the Texture is wrapped vertically and corresponds to V in UV mapping.

Remarks

See

Default Value

{@link THREE.ClampToEdgeWrapping}

`Static` DEFAULT_ANISOTROPY

DEFAULT_ANISOTROPY: number

The Global default value for .anisotropy.

Default Value

1.

`Static` DEFAULT_IMAGE

DEFAULT_IMAGE: any

The Global default value for .image.

Default Value

null.

`Static` DEFAULT_MAPPING

DEFAULT_MAPPING: Mapping

The Global default value for .mapping.

Default Value

{@link THREE.UVMapping}

Accessors

image

get image(): TextureImageData
Overridden with a record type holding data, width and height and depth.

Returns TextureImageData
Overrides Texture.image
- Defined in ../node_modules/@types/three/src/textures/DataTexture.d.ts:81
set image(value): void
Parameters
- value: TextureImageData
Returns void
Overrides Texture.image
- Defined in ../node_modules/@types/three/src/textures/DataTexture.d.ts:82

needsUpdate

set needsUpdate(value): void
Set this to true to trigger an update next time the texture is used. Particularly important for setting the wrap mode.
Parameters
- value: boolean
Returns void
Inherited from Texture.needsUpdate
- Defined in ../node_modules/@types/three/src/textures/Texture.d.ts:381

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{
  dispose: {};
  }[T], T, DataTexture>
  The function that gets called when the event is fired.
Returns void
Inherited from Texture.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:52
addEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, DataTexture>
Returns void
Inherited from Texture.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:56

clone

clone(): this
Make copy of the texture

Returns this
Remarks
Note this is not a "deep copy", the image is shared
Inherited from Texture.clone
- Defined in ../node_modules/@types/three/src/textures/Texture.d.ts:433

copy

copy(source): this
Parameters
- source: Texture
Returns this
Inherited from Texture.copy
- Defined in ../node_modules/@types/three/src/textures/Texture.d.ts:435

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends "dispose"
Parameters
- event: BaseEvent<T> & {
  dispose: {};
  }[T]
  The event that gets fired.
Returns void
Inherited from Texture.dispatchEvent
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:84

dispose

dispose(): void
Frees the GPU-related resources allocated by this instance

Returns void
Remarks
Call this method whenever this instance is no longer used in your app.
Inherited from Texture.dispose
- Defined in ../node_modules/@types/three/src/textures/Texture.d.ts:447

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{
  dispose: {};
  }[T], T, DataTexture>
  The function that gets called when the event is fired.
Returns boolean
Inherited from Texture.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:63
hasEventListener<T>(type, listener): boolean
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, DataTexture>
Returns boolean
Inherited from Texture.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:67

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<{
  dispose: {};
  }[T], T, DataTexture>
  The listener function that gets removed.
Returns void
Inherited from Texture.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:74
removeEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, DataTexture>
Returns void
Inherited from Texture.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:78

toJSON

toJSON(meta?): {}
Convert the texture to three.js JSON Object/Scene format.
Parameters
- Optional meta: string | {}
  Optional object containing metadata.
Returns {}
Inherited from Texture.toJSON
- Defined in ../node_modules/@types/three/src/textures/Texture.d.ts:441

transformUv

transformUv(uv): Vector2
Transform the UV based on the value of this texture's .offset, .repeat, .wrapS, .wrapT and .flipY properties.
Parameters
- uv: Vector2
Returns Vector2
Inherited from Texture.transformUv
- Defined in ../node_modules/@types/three/src/textures/Texture.d.ts:415

updateMatrix

updateMatrix(): void
Update the texture's UV-transform .matrix from the texture properties .offset, .repeat, .rotation and .center.

Returns void
Inherited from Texture.updateMatrix
- Defined in ../node_modules/@types/three/src/textures/Texture.d.ts:424

Class DataTexture

Example

See

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DataTexture

Properties

anisotropy

Remarks

Default

center

Remarks

Default Value

channel

colorSpace

Remarks

See

Default Value

encoding

Remarks

See

Default Value

Deprecated

flipY

Default Value

format

Remarks

See

Default Value

generateMipmaps

Default Value

Readonly id

Remarks

internalFormat

Remarks

See

Default Value

Readonly isDataTexture

Remarks

Default Value

isRenderTargetTexture

Default Value

Readonly isTexture

Remarks

Default Value

magFilter

Default Value

mapping

Remarks

See

Default Value

matrix

Remarks

See

Default Value

matrixAutoUpdate

Remarks

See

Default Value

minFilter

Default Value

mipmaps

Default Value

name

Remarks

Default Value

needsPMREMUpdate

Remarks

Default Value

offset

Remarks

Default Value

onUpdate

`Readonly` id

`Readonly` isDataTexture

`Readonly` isTexture

`Static` DEFAULT_ANISOTROPY

`Static` DEFAULT_IMAGE

`Static` DEFAULT_MAPPING