Class TextureAbstract

A randomly-accessible array of data.

See

WebGLTexture

Hierarchy (View Summary)

Properties

context

Accessors

baseLevel comparisonFunction comparisonMode depth format height isImmutableFormat isTextureComplete magFilter maxAnisotropy maxLevel maxLod minFilter minLod width wrapRFunction wrapSFunction wrapTFunction

Methods

delete generateMipmap getSizeOfMip makeImmutableFormat setMip

Properties

Readonlycontext

context: Context

The rendering context.

Accessors

baseLevel

comparisonFunction

comparisonMode

depth

format

height

isImmutableFormat

isTextureComplete

magFilter

maxAnisotropy

maxLevel

maxLod

minFilter

minLod

width

wrapRFunction

wrapSFunction

wrapTFunction

Methods

delete

generateMipmap

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.

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.

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.

  • 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.

  • 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.

  • setMip(
        array: ArrayBufferView<ArrayBufferLike>,
        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<ArrayBufferLike>

      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.

Settings

Member Visibility

On This Page

Properties
Accessors
Methods