Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextureCube

立方体贴图资源。 立方体贴图资源的每个 Mipmap 层级都为 6 张 ImageAsset,分别代表了立方体贴图的 6 个面。

Hierarchy

Index

Constructors

constructor

Properties

__asyncLoadAssets__

__asyncLoadAssets__: boolean = false

__depends__

__depends__: any = null

__nativeDepend__

__nativeDepend__: any = null

__onLoadedInvoked__

__onLoadedInvoked__: boolean = false

Protected _anisotropy

_anisotropy: number = 8

Protected _format

_format: number = PixelFormat.RGBA8888

Protected _gfxTexture

_gfxTexture: Texture | null = null

Protected _height

_height: number = 1

Protected _magFilter

_magFilter: number = Filter.LINEAR

Protected _minFilter

_minFilter: number = Filter.LINEAR

Protected _mipFilter

_mipFilter: number = Filter.NONE

_mipmaps

_mipmaps: ITextureCubeMipmap[] = []

_native

_native: string = ""

用于本机资产的可序列化URL。供内部使用。

default

""

_nativeUrl

_nativeUrl: string = ""

_uuid

_uuid: string

Protected _width

_width: number = 1

Protected _wrapR

_wrapR: number = WrapMode.REPEAT

Protected _wrapS

_wrapS: number = WrapMode.REPEAT

Protected _wrapT

_wrapT: number = WrapMode.REPEAT

loaded

loaded: boolean = true

该资源是否已经成功加载。

Static FaceIndex

FaceIndex: FaceIndex = FaceIndex

Static Filter

Filter: Filter = Filter

纹理过滤模式枚举类型

Static PixelFormat

PixelFormat: PixelFormat = PixelFormat

像素格式枚举类型

Static WrapMode

WrapMode: WrapMode = WrapMode

环绕模式枚举类型

Static preventDeferredLoadDependents

preventDeferredLoadDependents: boolean = false

当场景或 Prefab 被标记为 asyncLoadAssets,禁止延迟加载该资源所依赖的其它原始资源。

default

false

Static preventPreloadNativeObject

preventPreloadNativeObject: boolean = false

禁止预加载原生对象。

default

false

Accessors

Private nativeAsset

  • get nativeAsset(): any
  • set nativeAsset(obj: any): void
  • 此资源的基础资源(如果有)。 此属性可用于访问与资源相关的其他详细信息或功能。
    如果_native可用,则此属性将由加载器初始化。

    default

    null

    Returns any

  • 此资源的基础资源(如果有)。 此属性可用于访问与资源相关的其他详细信息或功能。
    如果_native可用,则此属性将由加载器初始化。

    default

    null

    Parameters

    • obj: any

    Returns void

nativeDep

  • get nativeDep(): undefined | { __isNative__: boolean; ext: string; uuid: string }

height

  • get height(): number

image

isCompressed

  • get isCompressed(): boolean

mipmapLevel

  • get mipmapLevel(): number

mipmaps

nativeUrl

  • get nativeUrl(): string

refCount

  • get refCount(): number

width

  • get width(): number

Methods

Protected assignImage

  • assignImage(image: ImageAsset, level: number, arrayIndex?: undefined | number): void

Protected checkTextureLoaded

  • _checkTextureLoaded(): void

Protected createTexture

  • createTexture(device: Device): void

deserialize

Protected getGFXDevice

  • _getGFXDevice(): Device | null

Protected getGFXFormat

Protected getGFXPixelFormat

  • getGFXPixelFormat(format: any): Format

Protected getGfxTextureCreateInfo

serialize

  • serialize(ctxForExporting: any): any

Protected setGFXFormat

Protected setMipmapLevel

  • setMipmapLevel(value: number): void

Private setRawAsset

  • setRawAsset(filename: string, inLibrary?: boolean): void

Protected textureReady

  • _textureReady(): void

Protected tryDestroyTexture

  • _tryDestroyTexture(): void

Protected tryReset

  • _tryReset(): void

addRef

Optional createNode

decRef

  • decRef(autoRelease?: boolean): Asset

destroy

  • destroy(): any

getAnisotropy

  • getAnisotropy(): number

getGFXSampler

getGFXTexture

getHash

  • getHash(): number

getId

  • getId(): string

getPixelFormat

  • getPixelFormat(): number

Private getSamplerHash

  • getSamplerHash(): number

onLoaded

  • onLoaded(): void

releaseTexture

  • releaseTexture(): void

reset

  • 将当前贴图重置为指定尺寸、像素格式以及指定 mipmap 层级。重置后,贴图的像素数据将变为未定义。 mipmap 图像的数据不会自动更新到贴图中,你必须显式调用 uploadData 来上传贴图数据。

    Parameters

    Returns void

Private serialize

  • serialize(): void

setAnisotropy

  • setAnisotropy(anisotropy: number): void

setFilters

setMipFilter

  • setMipFilter(mipFilter: Filter): void

setWrapMode

toString

  • toString(): string
  • 返回对象的字符串表示形式。
    Asset 对象将会重写 Object 对象的 toString() 方法。
    当资源要表示为文本值时或在字符串连接时引用时,
    JavaScript 会自动调用 toString() 方法。

    对于原始类型的资源,它将返回this.nativeUrl
    否则,返回空字符串。
    子类可能会覆盖此方法。

    method

    toString

    Returns string

updateImage

  • updateImage(): void

updateMipmaps

  • updateMipmaps(firstLevel?: number, count?: undefined | number): void

uploadData

  • uploadData(source: HTMLCanvasElement | HTMLImageElement | ArrayBufferView | ImageBitmap, level?: number, arrayIndex?: number): void
  • 上传图像数据到指定层级的 Mipmap 中。 图像的尺寸影响 Mipmap 的更新范围:

    • 当图像是 ArrayBuffer 时,图像的尺寸必须和 Mipmap 的尺寸一致;否则,
    • 若图像的尺寸与 Mipmap 的尺寸相同,上传后整个 Mipmap 的数据将与图像数据一致;
    • 若图像的尺寸小于指定层级 Mipmap 的尺寸(不管是长或宽),则从贴图左上角开始,图像尺寸范围内的 Mipmap 会被更新;
    • 若图像的尺寸超出了指定层级 Mipmap 的尺寸(不管是长或宽),都将引起错误。

    Parameters

    • source: HTMLCanvasElement | HTMLImageElement | ArrayBufferView | ImageBitmap

      The source image or image data

    • Default value level: number = 0

      Mipmap level to upload the image to

    • Default value arrayIndex: number = 0

      The array index

    Returns void

Static deserialize

  • deserialize(data: any): any

Static fromTexture2DArray

  • 通过二维贴图数组指定每个 Mipmap 的每个面创建立方体贴图。

    example
    const textures = new Array<Texture2D>(6);
    textures[TextureCube.FaceIndex.front] = frontImage;
    textures[TextureCube.FaceIndex.back] = backImage;
    textures[TextureCube.FaceIndex.left] = leftImage;
    textures[TextureCube.FaceIndex.right] = rightImage;
    textures[TextureCube.FaceIndex.top] = topImage;
    textures[TextureCube.FaceIndex.bottom] = bottomImage;
    const textureCube = TextureCube.fromTexture2DArray(textures);

    Parameters

    • textures: Texture2D[]

      Texture array, the texture count must be multiple of 6. Every 6 textures are 6 faces of a mipmap level. The order should obey FaceIndex order.

    • Optional out: TextureCube

      Output texture cube, if not given, will create a new texture cube.

    Returns TextureCube

    The created texture cube.

Generated using TypeDoc