Class TextureCubemap

A cube mapped texture.

See

WebGLTexture

Hierarchy (view full)

Texture
- TextureCubemap

Constructors

constructor

new TextureCubemap(context): TextureCubemap
Create a cube mapped texture.
Parameters
- context: Context
  The rendering context of the texture.
Returns TextureCubemap
Throws
UnsupportedOperationError if a texture cannot be created.

See
createTexture
Overrides Texture.constructor
- Defined in src/core/textures/TextureCubemap.ts:150
new TextureCubemap(context, levels, format, dim): TextureCubemap
Create a cube mapped 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.
- dim: number
  The width and height of the texture.
Returns TextureCubemap
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/TextureCubemap.ts:162

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:1057
set baseLevel(value): void
Parameters
- value: number
Returns void
Inherited from Texture.baseLevel
- Defined in src/core/textures/Texture.ts:1065

comparisonFunction

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

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

comparisonMode

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

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

depth

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

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

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:430
set format(value): void
Parameters
- value: TextureFormat
Returns void
Inherited from Texture.format
- Defined in src/core/textures/Texture.ts:439

height

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

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

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:536

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:1232

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:913
set magFilter(value): void
Parameters
- value: NEAREST | LINEAR
Returns void
Inherited from Texture.magFilter
- Defined in src/core/textures/Texture.ts:921

maxAnisotropy

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

Returns number
Throws
UnsupportedOperationError if the anisotropic filtering extension is not available.
Inherited from Texture.maxAnisotropy
- Defined in src/core/textures/Texture.ts:1016
set maxAnisotropy(value): void
Parameters
- value: number
Returns void
Inherited from Texture.maxAnisotropy
- Defined in src/core/textures/Texture.ts:1032

maxLevel

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

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

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:1157
set maxLod(value): void
Parameters
- value: number
Returns void
Inherited from Texture.maxLod
- Defined in src/core/textures/Texture.ts:1165

minFilter

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

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

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:1182
set minLod(value): void
Parameters
- value: number
Returns void
Inherited from Texture.minLod
- Defined in src/core/textures/Texture.ts:1190

width

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

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

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:1207
set wrapRFunction(value): void
Parameters
- value: WrapMode
Returns void
Inherited from Texture.wrapRFunction
- Defined in src/core/textures/Texture.ts:1215

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:963
set wrapSFunction(value): void
Parameters
- value: WrapMode
Returns void
Inherited from Texture.wrapSFunction
- Defined in src/core/textures/Texture.ts:971

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:988
set wrapTFunction(value): void
Parameters
- value: WrapMode
Returns void
Inherited from Texture.wrapTFunction
- Defined in src/core/textures/Texture.ts:996

Methods

delete

delete(): void
Delete this texture.

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

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:1291

getSizeOfMip

getSizeOfMip(level): 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:1277

makeImmutableFormat

makeImmutableFormat(levels?, format?, dims?): 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.
Inherited from Texture.makeImmutableFormat
- Defined in src/core/textures/Texture.ts:547

setMip

setMip(framebuffer, level?, face?, bounds?, type?, unpackAlignment?, area?): 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:599
setMip(buffer, level, face, bounds, type, unpackAlignment, size, offset): void
Copy the data in a buffer into one of this texture's mips.
Parameters
- buffer: Vbo
  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:621
setMip(data?, level?, face?, bounds?, type?, unpackAlignment?): 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:642
setMip(array, level?, face?, bounds?, type?, unpackAlignment?, offset?, length?): 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:663

`Static`fromImageUrls

fromImageUrls(context, px, nx, py, ny, pz, nz): TextureCubemap
Create a cube mapped texture from the data in the images at the given URLs. The texture is initially filled with magenta and is later filled with the images once they load.
Parameters
- context: Context
  The rendering context of the texture.
- px: string
  The URL of the image for the face on the X-axis in the positive direction.
- nx: string
  The URL of the image for the face on the X-axis in the negative direction.
- py: string
  The URL of the image for the face on the Y-axis in the positive direction.
- ny: string
  The URL of the image for the face on the Y-axis in the negative direction.
- pz: string
  The URL of the image for the face on the Z-axis in the positive direction.
- nz: string
  The URL of the image for the face on the Z-axis in the negative direction.
Returns TextureCubemap
The texture.
- Defined in src/core/textures/TextureCubemap.ts:34

`Static`fromImageUrlsPromise

fromImageUrlsPromise(context, px, nx, py, ny, pz, nz): Promise<TextureCubemap>
Create a cube mapped texture from the data in the images at the given URLs.
Parameters
- context: Context
  The rendering context of the texture.
- px: string
  The URL of the image for the face on the X-axis in the positive direction.
- nx: string
  The URL of the image for the face on the X-axis in the negative direction.
- py: string
  The URL of the image for the face on the Y-axis in the positive direction.
- ny: string
  The URL of the image for the face on the Y-axis in the negative direction.
- pz: string
  The URL of the image for the face on the Z-axis in the positive direction.
- nz: string
  The URL of the image for the face on the Z-axis in the negative direction.
Returns Promise<TextureCubemap>
The texture.
- Defined in src/core/textures/TextureCubemap.ts:94

Class TextureCubemap

See

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns TextureCubemap

Throws

See

Parameters

Returns TextureCubemap

Throws

Throws

See

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

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

Returns WrapMode

Parameters

Returns void

wrapTFunction

`Static`fromImageUrls

`Static`fromImageUrlsPromise