Class Texture2d

A two-dimensional texture.

See

WebGLTexture

Hierarchy (View Summary)

Texture
- Texture2d

Index

Constructors

constructor

new Texture2d(context: Context): Texture2d
Create a two-dimensional texture.
Parameters
- context: Context
  The rendering context of the texture.
Returns Texture2d
Throws
UnsupportedOperationError if a texture cannot be created.

See
createTexture
Overrides Texture.constructor
- Defined in src/core/textures/Texture2d.ts:90
new Texture2d(
    context: Context,
    levels: number,
    format: TextureFormat,
    width: number,
    height: number,
): Texture2d
Create a two-dimensional texture with a fixed size. This has better performance than a variable-sized texture.
Parameters
- context: Context
  The rendering context of the texture.
- levels: number
  The number of levels in the texture.
- format: TextureFormat
  The internal format of the texture.
- width: number
  The width of the texture.
- height: number
  The height of the texture.
Returns Texture2d
Throws
UnsupportedOperationError if a texture cannot be created.

Throws
TextureFormatError if the given format is unsized.

See
createTexture
Overrides Texture.constructor
- Defined in src/core/textures/Texture2d.ts:103

Properties

`Readonly`context

context: Context

The rendering context.

Accessors

baseLevel

get baseLevel(): number
The base mipmap level of this texture.

Returns number
Inherited from Texture.baseLevel
- Defined in src/core/textures/Texture.ts:1076
set baseLevel(value: number): void
Parameters
- value: number
Returns void
Inherited from Texture.baseLevel
- Defined in src/core/textures/Texture.ts:1092

comparisonFunction

get comparisonFunction(): TestFunction
The comparison function of this texture.

Returns TestFunction
Inherited from Texture.comparisonFunction
- Defined in src/core/textures/Texture.ts:1109
set comparisonFunction(value: TestFunction): void
Parameters
- value: TestFunction
Returns void
Inherited from Texture.comparisonFunction
- Defined in src/core/textures/Texture.ts:1125

comparisonMode

get comparisonMode(): TextureCompareMode
The comparison mode of this texture.

Returns TextureCompareMode
Inherited from Texture.comparisonMode
- Defined in src/core/textures/Texture.ts:1142
set comparisonMode(value: TextureCompareMode): void
Parameters
- value: TextureCompareMode
Returns void
Inherited from Texture.comparisonMode
- Defined in src/core/textures/Texture.ts:1158

depth

get depth(): number
The depth of this texture.

Returns number
Inherited from Texture.depth
- Defined in src/core/textures/Texture.ts:481

format

get format(): TextureFormat
The format of this texture.

Returns TextureFormat
Throws
ImmutableError if the format of an immutable-format texture is changed.
Inherited from Texture.format
- Defined in src/core/textures/Texture.ts:404
set format(value: TextureFormat): void
Parameters
- value: TextureFormat
Returns void
Inherited from Texture.format
- Defined in src/core/textures/Texture.ts:411

height

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

Returns number
Inherited from Texture.height
- Defined in src/core/textures/Texture.ts:460

isImmutableFormat

get isImmutableFormat(): boolean
Whether or not this is an immutable-format texture.

Returns boolean
Inherited from Texture.isImmutableFormat
- Defined in src/core/textures/Texture.ts:508

isTextureComplete

get isTextureComplete(): boolean
Whether or not this texture is texture complete.

Returns boolean
Inherited from Texture.isTextureComplete
- Defined in src/core/textures/Texture.ts:1307

magFilter

get magFilter(): NEAREST | LINEAR
The magnification filter of this texture.

Returns NEAREST | LINEAR
Inherited from Texture.magFilter
- Defined in src/core/textures/Texture.ts:894
set magFilter(value: NEAREST | LINEAR): void
Parameters
- value: NEAREST | LINEAR
Returns void
Inherited from Texture.magFilter
- Defined in src/core/textures/Texture.ts:910

maxAnisotropy

get maxAnisotropy(): number
The desired maximum anisotropy of this texture.

Returns number
Throws
UnsupportedOperationError if the anisotropic filtering extension is not available.

Throws
BadValueError if set to a higher value than the current system supports.
Inherited from Texture.maxAnisotropy
- Defined in src/core/textures/Texture.ts:1030
set maxAnisotropy(value: number): void
Parameters
- value: number
Returns void
Inherited from Texture.maxAnisotropy
- Defined in src/core/textures/Texture.ts:1052

maxLevel

get maxLevel(): number
The maximum mipmap level of this texture.

Returns number
Inherited from Texture.maxLevel
- Defined in src/core/textures/Texture.ts:1175
set maxLevel(value: number): void
Parameters
- value: number
Returns void
Inherited from Texture.maxLevel
- Defined in src/core/textures/Texture.ts:1191

maxLod

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

Returns number
Inherited from Texture.maxLod
- Defined in src/core/textures/Texture.ts:1208
set maxLod(value: number): void
Parameters
- value: number
Returns void
Inherited from Texture.maxLod
- Defined in src/core/textures/Texture.ts:1224

minFilter

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

Returns TextureFilter
Inherited from Texture.minFilter
- Defined in src/core/textures/Texture.ts:927
set minFilter(value: TextureFilter): void
Parameters
- value: TextureFilter
Returns void
Inherited from Texture.minFilter
- Defined in src/core/textures/Texture.ts:943

minLod

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

Returns number
Inherited from Texture.minLod
- Defined in src/core/textures/Texture.ts:1241
set minLod(value: number): void
Parameters
- value: number
Returns void
Inherited from Texture.minLod
- Defined in src/core/textures/Texture.ts:1257

width

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

Returns number
Inherited from Texture.width
- Defined in src/core/textures/Texture.ts:439

wrapRFunction

get wrapRFunction(): WrapMode
The wrapping function on the R-axis of this texture.

Returns WrapMode
Inherited from Texture.wrapRFunction
- Defined in src/core/textures/Texture.ts:1274
set wrapRFunction(value: WrapMode): void
Parameters
- value: WrapMode
Returns void
Inherited from Texture.wrapRFunction
- Defined in src/core/textures/Texture.ts:1290

wrapSFunction

get wrapSFunction(): WrapMode
The wrapping function on the S-axis of this texture.

Returns WrapMode
Inherited from Texture.wrapSFunction
- Defined in src/core/textures/Texture.ts:960
set wrapSFunction(value: WrapMode): void
Parameters
- value: WrapMode
Returns void
Inherited from Texture.wrapSFunction
- Defined in src/core/textures/Texture.ts:976

wrapTFunction

get wrapTFunction(): WrapMode
The wrapping function on the T-axis of this texture.

Returns WrapMode
Inherited from Texture.wrapTFunction
- Defined in src/core/textures/Texture.ts:993
set wrapTFunction(value: WrapMode): void
Parameters
- value: WrapMode
Returns void
Inherited from Texture.wrapTFunction
- Defined in src/core/textures/Texture.ts:1009

Methods

delete

delete(): void
Delete this texture.

Returns void
See
deleteTexture
Inherited from Texture.delete
- Defined in src/core/textures/Texture.ts:1392

generateMipmap

generateMipmap(): void
Generate a mipmap for this texture. Overwrites all mips except those at the top level. Does nothing for immutable-format textures.

Returns void
See
generateMipmap
Inherited from Texture.generateMipmap
- Defined in src/core/textures/Texture.ts:1368

getSizeOfMip

getSizeOfMip(level: number): number[]
Get the dimensions of the mip at the given level.
Parameters
- level: number
  The level of the mip.
Returns number[]
The width, height (if applicable), and depth (if applicable) of the mip, in that order.
Inherited from Texture.getSizeOfMip
- Defined in src/core/textures/Texture.ts:1353

makeImmutableFormat

makeImmutableFormat(
    levels?: number,
    format?: TextureFormat,
    dims?: number[],
): void
Make this texture into an immutable-format texture.
Parameters
- Optionallevels: number
  The number of levels in the texture, or undefined for one level.
- Optionalformat: TextureFormat
  The internal format of the texture, or undefined to keep the current format (defaults to RGBA).
- Optionaldims: number[]
  The dimensions of the texture, or undefined to keep the current dimensions.
Returns void
Throws
TextureFormatError if the given format is unsized.

Throws
BadValueError if the given dimensions are too small for the given number of levels.
Inherited from Texture.makeImmutableFormat
- Defined in src/core/textures/Texture.ts:520

setMip

setMip(
    framebuffer: null | Framebuffer,
    level?: number,
    face?: CubeFace,
    bounds?: Rectangle | Prism,
    type?: TextureDataType,
    unpackAlignment?: 1 | 2 | 4 | 8,
    area?: Rectangle | Prism,
): void
Copy the data in a framebuffer into one of this texture's mips.
Parameters
- framebuffer: null | Framebuffer
  The framebuffer to copy into the mip, or null for the default framebuffer.
- Optionallevel: number
  The level of the mip within its mipmap. Defaults to the top mip.
- Optionalface: CubeFace
  The mipmap that the mip belongs to. Ignored by non-cubemap textures.
- Optionalbounds: Rectangle | Prism
  The bounds of the mip to be updated. Defaults to the entire mip if not set.
- Optionaltype: TextureDataType
  The type of the given data. Must be compatible with the format of the given data.
- OptionalunpackAlignment: 1 | 2 | 4 | 8
  The alignment to use when unpacking the data, or undefined to let this be automatically determined.
- Optionalarea: Rectangle | Prism
  The area of the framebuffer to copy into the mip.
Returns void
Throws
TextureFormatError if the given data type is incompatible with this texture's format.
Inherited from Texture.setMip
- Defined in src/core/textures/Texture.ts:591
setMip(
    buffer: VertexBuffer,
    level: undefined | number,
    face: undefined | CubeFace,
    bounds: undefined | Rectangle | Prism,
    type: undefined | TextureDataType,
    unpackAlignment: undefined | 1 | 2 | 4 | 8,
    size: number,
    offset: number,
): void
Copy the data in a buffer into one of this texture's mips.
Parameters
- buffer: VertexBuffer
  The buffer to copy into the mip.
- level: undefined | number
  The level of the mip within its mipmap. Defaults to the top mip.
- face: undefined | CubeFace
  The mipmap that the mip belongs to. Ignored by non-cubemap textures.
- bounds: undefined | Rectangle | Prism
  The bounds of the mip to be updated. Defaults to the entire mip if not set.
- type: undefined | TextureDataType
  The type of the given data. Must be compatible with the format of the given data.
- unpackAlignment: undefined | 1 | 2 | 4 | 8
  The alignment to use when unpacking the data, or undefined to let this be automatically determined.
- size: number
  The number of bytes of data to copy from the buffer.
- offset: number
  The offset in bytes from the start of the buffer to start copying at.
Returns void
Throws
TextureFormatError if the given data type is incompatible with this texture's format.
Inherited from Texture.setMip
- Defined in src/core/textures/Texture.ts:613
setMip(
    data?: TexImageSource,
    level?: number,
    face?: CubeFace,
    bounds?: Rectangle | Prism,
    type?: TextureDataType,
    unpackAlignment?: 1 | 2 | 4 | 8,
): void
Copy data into one of this texture's mips.
Parameters
- Optionaldata: TexImageSource
  The data to copy into the mip.
- Optionallevel: number
  The level of the mip within its mipmap. Defaults to the top mip.
- Optionalface: CubeFace
  The mipmap that the mip belongs to. Ignored by non-cubemap textures.
- Optionalbounds: Rectangle | Prism
  The bounds of the mip to be updated. Defaults to the entire mip if not set.
- Optionaltype: TextureDataType
  The type of the given data. Must be compatible with the format of the given data.
- OptionalunpackAlignment: 1 | 2 | 4 | 8
  The alignment to use when unpacking the data, or undefined to let this be automatically determined.
Returns void
Throws
TextureFormatError if the given data type is incompatible with this texture's format.
Inherited from Texture.setMip
- Defined in src/core/textures/Texture.ts:634
setMip(
    array: ArrayBufferView,
    level?: number,
    face?: CubeFace,
    bounds?: Rectangle | Prism,
    type?: TextureDataType,
    unpackAlignment?: 1 | 2 | 4 | 8,
    offset?: number,
    length?: number,
): void
Copy the data in an array into one of this texture's mips.
Parameters
- array: ArrayBufferView
  The array to copy into the mip.
- Optionallevel: number
  The level of the mip within its mipmap. Defaults to the top mip.
- Optionalface: CubeFace
  The mipmap that the mip belongs to. Ignored by non-cubemap textures.
- Optionalbounds: Rectangle | Prism
  The bounds of the mip to be updated. Defaults to the entire mip if not set.
- Optionaltype: TextureDataType
  The type of the given data. Must be compatible with the format of the given data.
- OptionalunpackAlignment: 1 | 2 | 4 | 8
  The alignment to use when unpacking the data, or undefined to let this be automatically determined.
- Optionaloffset: number
  The offset from the start of the array to start copying at, or undefined for the start of the array.
- Optionallength: number
  The number of elements to copy from the array, or undefined for the entire array.
Returns void
Throws
TextureFormatError if the given data type is incompatible with this texture's format.
Inherited from Texture.setMip
- Defined in src/core/textures/Texture.ts:655

`Static`fromImageUrl

fromImageUrl(context: Context, url: string): Texture2d
Create a two-dimensional texture from the data in the image at the given URL. The texture is initially filled with magenta and is later filled with the image once it loads.
Parameters
- context: Context
  The rendering context of the texture.
- url: string
  The URL of the image.
Returns Texture2d
The texture.
- Defined in src/core/textures/Texture2d.ts:28

`Static`fromImageUrlPromise

fromImageUrlPromise(context: Context, url: string): Promise<Texture2d>
Create a two-dimensional texture from the data in the image at the given URL.
Parameters
- context: Context
  The rendering context of the texture.
- url: string
  The URL of the image.
Returns Promise<Texture2d>
The texture.
- Defined in src/core/textures/Texture2d.ts:57

Class Texture2d

See

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Texture2d

Throws

See

Parameters

Returns Texture2d

Throws

Throws

See

Properties

Readonlycontext

Accessors

baseLevel

Returns number

Parameters

Returns void

comparisonFunction

Returns TestFunction

Parameters

Returns void

comparisonMode

Returns TextureCompareMode

Parameters

Returns void

depth

Returns number

format

Returns TextureFormat

Throws

Parameters

Returns void

height

Returns number

isImmutableFormat

Returns boolean

isTextureComplete

Returns boolean

magFilter

Returns NEAREST | LINEAR

Parameters

Returns void

maxAnisotropy

Returns number

Throws

Throws

Parameters

Returns void

maxLevel

Returns number

Parameters

Returns void

maxLod

Returns number

Parameters

Returns void

minFilter

Returns TextureFilter

Parameters

Returns void

minLod

Returns number

Parameters

Returns void

width

Returns number

wrapRFunction

Returns WrapMode

Parameters

Returns void

wrapSFunction

`Readonly`context

`Static`fromImageUrl

`Static`fromImageUrlPromise