Class Mip`Abstract`

A version of a texture used for rendering at different sizes.

Hierarchy

Index

Constructors

Constructors

constructor

new Mip(source?, internalFormat?, dims?): Mip
Creates a mip.
Parameters
- Optional source: MipSource
  
  The pixel source of the mip.
- internalFormat: TextureInternalFormat = TextureInternalFormat.RGBA
  
  The format of the color components in the mip.
- dims: (undefined | number)[] = []
  
  The dimensions of the mip.
Returns Mip
- Defined in src/textures/Mip.ts:18

Properties

`Private` dimsPrivate

dimsPrivate: readonly (undefined | number)[]

The dimensions of this mip.

`Private` formatPrivate

formatPrivate: undefined | TextureBaseFormat

The format of the texel data in this mip.

`Private` internalFormatPrivate

internalFormatPrivate: TextureInternalFormat

The format of the color components in this mip.

`Private` `Optional` lodPrivate

lodPrivate?: number

The level of detail of this mip.

`Private` needsUpdate

needsUpdate: boolean

Whether this mip requires an update.

`Private` sourcePrivate

sourcePrivate: MipSource

The source data of this mip.

`Private` `Optional` targetPrivate

targetPrivate?: MipmapTarget

The target of this mip.

`Private` `Optional` texturePrivate

texturePrivate?: Texture<Mip>

The texture of this mip.

`Private` typePrivate

typePrivate: undefined | TextureDataType

The data type of the components in this mip.

`Optional` unpackAlignment

unpackAlignment?: 2 | 1 | 4 | 8

The unpack alignment of this mip.

Accessors

dims

get dims(): readonly (undefined | number)[]
The dimensions of this mip.

Returns readonly (undefined | number)[]
- Defined in src/textures/Mip.ts:89
set dims(value): void
The dimensions of this mip.
Parameters
- value: readonly (undefined | number)[]
Returns void
- Defined in src/textures/Mip.ts:94

format

get format(): TextureBaseFormat
The format of the texel data in this mip.

Returns TextureBaseFormat
- Defined in src/textures/Mip.ts:103
set format(value): void
The format of the texel data in this mip.
Parameters
- value: undefined | TextureBaseFormat
Returns void
- Defined in src/textures/Mip.ts:164

internalFormat

get internalFormat(): TextureInternalFormat
The format of the color components in this mip.

Returns TextureInternalFormat
- Defined in src/textures/Mip.ts:75
set internalFormat(value): void
The format of the color components in this mip.
Parameters
- value: TextureInternalFormat
Returns void
- Defined in src/textures/Mip.ts:80

lod

get lod(): undefined | number
The level of detail of this mip.

Returns undefined | number
- Defined in src/textures/Mip.ts:50

source

get source(): MipSource
The source data of this mip.

Returns MipSource
- Defined in src/textures/Mip.ts:58
set source(value): void
The source data of this mip.
Parameters
- value: MipSource
Returns void
- Defined in src/textures/Mip.ts:63

target

get target(): undefined | MipmapTarget
The target of this mip.

Returns undefined | MipmapTarget
- Defined in src/textures/Mip.ts:42

texture

get texture(): undefined | Texture<Mip>
The texture of this mip.

Returns undefined | Texture<Mip>
- Defined in src/textures/Mip.ts:34

type

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

Returns TextureDataType
- Defined in src/textures/Mip.ts:173
set type(value): void
The data type of the components in this mip.
Parameters
- value: undefined | TextureDataType
Returns void
- Defined in src/textures/Mip.ts:227

Methods

setNeedsUpdate

setNeedsUpdate(): void
Sets this mip as outdated.

Returns void
- Defined in src/textures/Mip.ts:282

update

update(texture, target, lod): boolean
Updates this mip.
Parameters
- texture: Texture<Mip>
  
  The texture of this mip.
- target: MipmapTarget
  
  The target of this mip.
- lod: number
  
  The level of detail of this mip.
Returns boolean
Whether an update was performed.
- Defined in src/textures/Mip.ts:242

`Protected` `Abstract` updateInternal

updateInternal(texture, target, lod): void
Updates this mip.
Parameters
- texture: Texture<Mip>
  
  The texture of this mip.
- target: MipmapTarget
  
  The target of this mip.
- lod: number
  
  The level of detail of this mip.
Returns void
- Defined in src/textures/Mip.ts:275

Class MipAbstract

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional source: MipSource

internalFormat: TextureInternalFormat = TextureInternalFormat.RGBA

dims: (undefined | number)[] = []

Returns Mip

Properties

Private dimsPrivate

Private formatPrivate

Private internalFormatPrivate

Private Optional lodPrivate

Private needsUpdate

Private sourcePrivate

Private Optional targetPrivate

Private Optional texturePrivate

Private typePrivate

Optional unpackAlignment

Accessors

dims

Returns readonly (undefined | number)[]

Parameters

value: readonly (undefined | number)[]

Returns void

format

Returns TextureBaseFormat

Parameters

value: undefined | TextureBaseFormat

Returns void

internalFormat

Returns TextureInternalFormat

Parameters

value: TextureInternalFormat

Returns void

lod

Returns undefined | number

source

Returns MipSource

Parameters

value: MipSource

Returns void

target

Returns undefined | MipmapTarget

texture

Returns undefined | Texture<Mip>

type

Returns TextureDataType

Parameters

value: undefined | TextureDataType

Returns void

Methods

setNeedsUpdate

Returns void

update

Parameters

texture: Texture<Mip>

target: MipmapTarget

lod: number

Returns boolean

Protected Abstract updateInternal

Parameters

texture: Texture<Mip>

target: MipmapTarget

lod: number

Returns void

Settings

Member Visibility

Theme

On This Page

Class Mip`Abstract`

`Optional` source: MipSource

`Private` dimsPrivate

`Private` formatPrivate

`Private` internalFormatPrivate

`Private` `Optional` lodPrivate

`Private` needsUpdate

`Private` sourcePrivate

`Private` `Optional` targetPrivate

`Private` `Optional` texturePrivate

`Private` typePrivate

`Optional` unpackAlignment

`Protected` `Abstract` updateInternal