Class Texture2D

A two-dimensional texture.

Hierarchy

Texture
- Texture2D

Index

Constructors

Constructors

constructor

new Texture2D(parameters: Texture2DParameters): Texture2D
Creates a two-dimensional texture.
Parameters
- parameters: Texture2DParameters
  
  The parameters of the texture.
Returns Texture2D
Overrides Texture.constructor
- Defined in src/webgl/Texture.ts:126

Properties

`Private` formatPrivate

formatPrivate: undefined | TextureFormat

The format of the texel data.

`Readonly` gl

gl: WebGL2RenderingContext

The rendering context of this texture.

`Private` heightPrivate

heightPrivate: undefined | number

The height of this texture.

`Private` internalFormatPrivate

internalFormatPrivate: TextureFormat

The format of the color components in this texture.

`Private` lodPrivate

lodPrivate: number

The level of detail of this texture.

`Protected` needsUpdate

needsUpdate: boolean

Whether this texture needs to be updated.

`Private` pixelsPrivate

pixelsPrivate: Texture2DPixelSource

The pixel source for this texture.

`Readonly` target

target: TextureTarget

The target binding point of this texture.

`Readonly` texture

texture: WebGLTexture

The WebGL API interface of this texture.

`Private` typePrivate

typePrivate: undefined | TextureDataType

The data type of the components in this texture.

`Private` widthPrivate

widthPrivate: undefined | number

The width of this texture.

Accessors

format

get format(): TextureFormat
The format of the texel data.

Returns TextureFormat
- Defined in src/webgl/Texture.ts:212
set format(value: undefined | TextureFormat): void
Parameters
- value: undefined | TextureFormat
Returns void
- Defined in src/webgl/Texture.ts:261

height

get height(): undefined | number
The height of this texture.

Returns undefined | number
- Defined in src/webgl/Texture.ts:199
set height(value: undefined | number): void
Parameters
- value: undefined | number
Returns void
- Defined in src/webgl/Texture.ts:203

internalFormat

get internalFormat(): TextureFormat
The format of the color components in this texture.

Returns TextureFormat
- Defined in src/webgl/Texture.ts:173
set internalFormat(value: TextureFormat): void
Parameters
- value: TextureFormat
Returns void
- Defined in src/webgl/Texture.ts:177

lod

get lod(): number
The level of detail of this texture.

Returns number
- Defined in src/webgl/Texture.ts:160
set lod(value: number): void
Parameters
- value: number
Returns void
- Defined in src/webgl/Texture.ts:164

magFilter

get magFilter(): TextureFilter
The magnification filter for this texture.

Returns TextureFilter
- Defined in src/webgl/Texture.ts:330
set magFilter(value: TextureFilter): void
Parameters
- value: TextureFilter
Returns void
- Defined in src/webgl/Texture.ts:335

minFilter

get minFilter(): TextureFilter
The minification filter for this texture.

Returns TextureFilter
- Defined in src/webgl/Texture.ts:342
set minFilter(value: TextureFilter): void
Parameters
- value: TextureFilter
Returns void
- Defined in src/webgl/Texture.ts:347

pixels

get pixels(): Texture2DPixelSource
The pixel source for this texture.

Returns Texture2DPixelSource
- Defined in src/webgl/Texture.ts:320
set pixels(value: Texture2DPixelSource): void
Parameters
- value: Texture2DPixelSource
Returns void
- Defined in src/webgl/Texture.ts:324

type

get type(): TextureDataType
The data type of the components in this texture.

Returns TextureDataType
- Defined in src/webgl/Texture.ts:270
set type(value: undefined | TextureDataType): void
Parameters
- value: undefined | TextureDataType
Returns void
- Defined in src/webgl/Texture.ts:311

width

get width(): undefined | number
The width of this texture.

Returns undefined | number
- Defined in src/webgl/Texture.ts:186
set width(value: undefined | number): void
Parameters
- value: undefined | number
Returns void
- Defined in src/webgl/Texture.ts:190

wrapSFunction

get wrapSFunction(): TextureWrapFunction
The wrapping function of this texture in the S direction.

Returns TextureWrapFunction
- Defined in src/webgl/Texture.ts:354
set wrapSFunction(value: TextureWrapFunction): void
Parameters
- value: TextureWrapFunction
Returns void
- Defined in src/webgl/Texture.ts:359

wrapTFunction

get wrapTFunction(): TextureWrapFunction
The wrapping function of this texture in the T direction.

Returns TextureWrapFunction
- Defined in src/webgl/Texture.ts:366
set wrapTFunction(value: TextureWrapFunction): void
Parameters
- value: TextureWrapFunction
Returns void
- Defined in src/webgl/Texture.ts:371

Methods

assign

assign(textureUnit: number): void
Assigns this texture to a texture unit.
Parameters
- textureUnit: number
  
  The texture unit.
Returns void
Inherited from Texture.assign
- Defined in src/webgl/Texture.ts:40

bind

bind(): void
Binds this texture to its target.

Returns void
Inherited from Texture.bind
- Defined in src/webgl/Texture.ts:32

generateMipmap

generateMipmap(): void
Generates a mipmap for this texture.

Returns void
Inherited from Texture.generateMipmap
- Defined in src/webgl/Texture.ts:55

update

update(): void
Updates the texels of this texture.

Returns void
Inherited from Texture.update
- Defined in src/webgl/Texture.ts:46

updateIfNeeded

updateIfNeeded(): void
Updates this texture if necessary.

Returns void
Inherited from Texture.updateIfNeeded
- Defined in src/webgl/Texture.ts:64

`Protected` updateInternal

updateInternal(): void
Updates the texels of this texture.

Returns void
Overrides Texture.updateInternal
- Defined in src/webgl/Texture.ts:378

Class Texture2D

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

parameters: Texture2DParameters

Returns Texture2D

Properties

Private formatPrivate

Readonly gl

Private heightPrivate

Private internalFormatPrivate

Private lodPrivate

Protected needsUpdate

Private pixelsPrivate

Readonly target

Readonly texture

Private typePrivate

Private widthPrivate

Accessors

format

Returns TextureFormat

Parameters

value: undefined | TextureFormat

Returns void

height

Returns undefined | number

Parameters

value: undefined | number

Returns void

internalFormat

Returns TextureFormat

Parameters

value: TextureFormat

Returns void

lod

Returns number

Parameters

value: number

Returns void

magFilter

Returns TextureFilter

Parameters

value: TextureFilter

Returns void

minFilter

Returns TextureFilter

Parameters

value: TextureFilter

Returns void

pixels

Returns Texture2DPixelSource

Parameters

value: Texture2DPixelSource

Returns void

type

Returns TextureDataType

Parameters

value: undefined | TextureDataType

Returns void

width

Returns undefined | number

Parameters

value: undefined | number

Returns void

wrapSFunction

Returns TextureWrapFunction

Parameters

value: TextureWrapFunction

Returns void

wrapTFunction

Returns TextureWrapFunction

Parameters

value: TextureWrapFunction

Returns void

`Private` formatPrivate

`Readonly` gl

`Private` heightPrivate

`Private` internalFormatPrivate

`Private` lodPrivate

`Protected` needsUpdate

`Private` pixelsPrivate

`Readonly` target

`Readonly` texture

`Private` typePrivate

`Private` widthPrivate

`Protected` updateInternal