TextureProps | Gadget

Hierarchy

Texture2DProps
- TextureProps

Index

Properties

width

width: number

The textures width in pixels.

height

height: number

The textures height in pixels.

Optional context

context?: Context

Context override

defaultvalue: defaultContext

Optional levels

levels?: number

The amount of mipmap levels. Level 0 represents the original texture.

defaultvalue: 1

Optional storageFormat

storageFormat?: TextureStorageFormat | CompressedTextureStorageFormat

How the data is stored in GPU memory.

defaultvalue: TextureStorageFormat.rgba8

Optional clampLodToUploadedLevels

clampLodToUploadedLevels?: boolean

Whether to clamp mipmap LOD to levels that have been uploaded, i.e. whether to show lower/higher res levels in place of empty ones.

defaultvalue

false

remarks

For this to have a visible effect, the texture needs to be sampled with TextureProps.minFilter set to any filter that takes mipmaps into account.

Also, the texture cannot be used with a Sampler.

Optional minFilter

minFilter?: TextureMinFilter

The texture minification filter.

defaultvalue: TextureMinFilter.linear

Optional magFilter

magFilter?: TextureMagFilter

The texture magnification filter.

defaultvalue: TextureMagFilter.linear

Optional wrapS

wrapS?: TextureWrap

Texture wrapping mode for the s/x coordinate.

defaultvalue: TextureWrap.clampToEdge

Optional wrapT

wrapT?: TextureWrap

Texture wrapping mode for the t/y coordinate.

defaultvalue: TextureWrap.clampToEdge

Optional wrapR

wrapR?: TextureWrap

Texture wrapping mode for the r/z coordinate.

defaultvalue: TextureWrap.clampToEdge

Optional minLod

minLod?: number

The minimum level-of-detail.

defaultvalue: -1000

Optional maxLod

maxLod?: number

The maximum level-of-detail.

defaultvalue: 1000

Optional compareMode

compareMode?: TextureCompareMode

The texture comparison mode.

defaultvalue: TextureCompareMode.none

Optional compareFunc

compareFunc?: TextureCompareFunc

The texture comparison function.

defaultvalue: TextureCompareFunc.lessOrEqual