Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Texture2D

2D贴图资源。

Hierarchy

  • Texture
    • Texture2D

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Texture2D(desc?: ITexture2DDesc): Texture2D

  • 创建Texture2D。

    Parameters

    • Optional desc: ITexture2DDesc

    Returns Texture2D

Properties

Optional groupID

groupID: string

Optional resourceID

resourceID: string

编辑器中使用的资源id。

memberof

BaseResource

Accessors

anisoLevel

  • get anisoLevel(): number

  • 各向异性参数，有效值为1-16。

    Returns number

filterMode

  • get filterMode(): TextureFilterMode

  • 贴图的填充模式。

    Returns TextureFilterMode

height

  • get height(): number

  • 贴图高。

    readonly
    memberof

    Texture2D

    Returns number

imageSrc

  • get imageSrc(): string
  • set imageSrc(imgSrc: string): void

  • 仅在图片为非压缩纹理时，获取原始图片的url。

    Returns string

  • 仅在图片为非压缩纹理时，获取原始图片的url。

    Parameters

    • imgSrc: string

    Returns void

mipmapLevel

  • get mipmapLevel(): number

  • Returns number

pixelFormat

  • 像素格式。

    Returns ETextureFormat

useMipmap

  • get useMipmap(): boolean

  • 是否使用mipmap。

    Returns boolean

width

  • get width(): number

  • 贴图宽。

    Returns number

wrapU

  • 横向采样包围模式。

    Returns EWrapMode

wrapV

  • 纵向采样包围模式。

    Returns EWrapMode

writeable

  • get writeable(): boolean

  • 是否可动态写入。

    Returns boolean

Methods

initDynamicTexture

  • initDynamicTexture(width: number, height: number): void

  • 创建动态纹理，可用于后续updateSubTexture更新。

    Parameters

    • width: number
    • height: number

    Returns void

initWithCanvas

  • initWithCanvas(canvas: HTMLCanvasElement): boolean

  • 使用wxCanvas来初始化。

    Parameters

    • canvas: HTMLCanvasElement

      HTMLCanvas或wxCanvas。

    Returns boolean

    是否初始化成功

initWithCompressTexture

  • initWithCompressTexture(pixelFormat: ETextureFormat, bufferSrc: ArrayBuffer, width: number, height: number, mipmapLevel?: number): boolean

  • 使用压缩纹理初始化。
    目前支持 PVR/ASTC (IOS) , ETC1/ETC2 (Android)。

    Parameters

    • pixelFormat: ETextureFormat

      纹理格式。

    • bufferSrc: ArrayBuffer

      原始buffer,如有mipmap，则逐级连接。

    • width: number
    • height: number
    • mipmapLevel: number = 1

    Returns boolean

initWithImage

  • initWithImage(image: IImage, generateMipmap?: boolean, needUnpackPremultiplyAlpha?: boolean): boolean

  • 使用Image来初始化。

    Parameters

    • image: IImage

      Image对象。

    • generateMipmap: boolean = false

      是否生成mipmap。

    • needUnpackPremultiplyAlpha: boolean = false

      上传贴图时是否进行反预乘。

    Returns boolean

    是否初始化成功。

initWithRGBABuffer

  • initWithRGBABuffer(arraybuffer: ArrayBufferView, width: number, height: number, generateMipmap?: boolean, needUnpackPremultiplyAlpha?: boolean): boolean

  • 使用原始RGBA buffer进行初始化

    Parameters

    • arraybuffer: ArrayBufferView
    • width: number
    • height: number
    • generateMipmap: boolean = false

      是否生成mipmap

    • needUnpackPremultiplyAlpha: boolean = false

      上传贴图时是否进行反预乘

    Returns boolean

    是否初始化成功

updateSubTexture

  • updateSubTexture(source: TextureSource, x: number, y: number, width: number, height: number, needUnpackPremultiplyAlpha?: boolean): void

  • 上传局部纹理。
    仅在动态贴图的模式下有效。

    Parameters

    • source: TextureSource
    • x: number
    • y: number
    • width: number
    • height: number
    • needUnpackPremultiplyAlpha: boolean = false

    Returns void

Generated using TypeDoc