Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextureCube

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

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected _anisotropy

_anisotropy: number = 8

_callbackTable

_callbackTable: any = createMap(true)

IEventTarget 实现,它们将被 applyMixins 在 EventTarget 中用相同的实现覆盖

Protected _flipY

_flipY: boolean = false

Protected _format

_format: number = PixelFormat.RGBA8888

Protected _gfxTexture

_gfxTexture: GFXTexture | null = null

Protected _gfxTextureView

_gfxTextureView: GFXTextureView | null = null

Protected _height

_height: number = 0

Protected _magFilter

_magFilter: number = Filter.LINEAR

Protected _minFilter

_minFilter: number = Filter.LINEAR

Protected _mipFilter

_mipFilter: number = Filter.NONE

_mipmaps

_mipmaps: ITextureCubeMipmap[] = []

Protected _name

_name: string

_native

_native: string = ""

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

default

""

_objFlags

_objFlags: number

Protected _premultiplyAlpha

_premultiplyAlpha: boolean = false

_uuid

_uuid: string

内部使用。

Protected _width

_width: number = 0

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,禁止延迟加载该资源所依赖的其它 RawAsset。

property

{Boolean} preventDeferredLoadDependents

default

false

static

Static preventPreloadNativeObject

preventPreloadNativeObject: boolean = false

禁止预加载原生对象。

property

{Boolean} preventPreloadNativeObject

default

false

static

Accessors

Private nativeAsset

  • get nativeAsset(): any
  • set nativeAsset(obj: any): void

height

  • get height(): number

image

isCompressed

  • get isCompressed(): boolean

isValid

  • get isValid(): boolean
  • 表示该对象是否可用(被 destroy 后将不可用)。
    当一个对象的 destroy 调用以后,会在这一帧结束后才真正销毁。
    因此从下一帧开始 isValid 就会返回 false,而当前帧内 isValid 仍然会是 true。
    如果希望判断当前帧是否调用过 destroy,请使用 cc.isValid(obj, true),不过这往往是特殊的业务需求引起的,通常情况下不需要这样。

    property

    {Boolean} isValid

    default

    true

    readonly
    example
    import * as cc from 'cc';
    var node = new cc.Node();
    cc.log(node.isValid);    // true
    node.destroy();
    cc.log(node.isValid);    // true, still valid in this frame
    // after a frame...
    cc.log(node.isValid);    // false, destroyed in the end of last frame

    Returns boolean

mipmapLevel

  • get mipmapLevel(): number

mipmaps

name

  • get name(): string
  • set name(value: string): void

nativeUrl

  • get nativeUrl(): string
  • 返回该资源对应的目标平台资源的 URL,如果没有将返回一个空字符串。

    property

    nativeUrl

    type

    {String}

    readonly

    Returns string

width

  • get width(): number

Methods

Protected assignImage

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

Protected checkTextureLoaded

  • _checkTextureLoaded(): void

Protected createTexture

deserialize

destroyImmediate

  • _destroyImmediate(): void

destruct

  • _destruct(): void
  • Clear all references in the instance.

    NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }

    Returns void

Protected getGFXDevice

Protected getGFXFormat

  • _getGFXFormat(): number

Protected getGfxTextureCreateInfo

Protected getGfxTextureViewCreateInfo

serialize

  • serialize(exporting?: any): object

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

Optional createNode

destroy

  • destroy(): boolean

dispatchEvent

  • dispatchEvent(event: Event): void

emit

  • emit(key: string, ...args: any[]): void

getAnisotropy

  • getAnisotropy(): number

getGFXSampler

getGFXTexture

getGFXTextureView

getId

  • getId(): string

getPixelFormat

  • getPixelFormat(): number

Private getSamplerHash

  • getSamplerHash(): number

hasEventListener

  • hasEventListener(key: string, callback?: Function | undefined, target?: Object | undefined): boolean

hasPremultipliedAlpha

  • hasPremultipliedAlpha(): boolean

off

  • off(type: string, callback?: Function | undefined, target?: Object | undefined): void

on

  • on(type: string, callback: Function, target?: Object | undefined): Function | undefined

onLoaded

  • onLoaded(): void

once

  • once(type: string, callback: Function, target?: Object | undefined): Function | undefined

releaseTexture

  • releaseTexture(): void

removeAll

  • removeAll(keyOrTarget?: string | Object | undefined): void

reset

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

    Parameters

    Returns void

Private serialize

  • serialize(): void

setAnisotropy

  • setAnisotropy(anisotropy: number): void

setFilters

setFlipY

  • setFlipY(flipY: boolean): void

setMipFilter

  • setMipFilter(mipFilter: Filter): void

setPremultiplyAlpha

  • setPremultiplyAlpha(premultiply: boolean): void

setWrapMode

targetOff

  • targetOff(keyOrTarget?: string | Object | undefined): void

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, level?: number, arrayIndex?: number): void
  • 上传图像数据到指定层级的 Mipmap 中。 图像的尺寸影响 Mipmap 的更新范围:

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

    Parameters

    • source: HTMLCanvasElement | HTMLImageElement | ArrayBufferView

      图像数据源。

    • Default value level: number = 0

      Mipmap 层级。

    • Default value arrayIndex: number = 0

      数组索引。

    Returns void

Static deferredDestroy

  • _deferredDestroy(): 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[]

      数组长度必须是6的倍数。 每 6 个二维贴图依次构成立方体贴图的 Mipmap。6 个面应该按 FaceIndex 规定顺序排列。

    • Optional out: TextureCube

      出口立方体贴图,若未定义则将创建为新的立方体贴图。

    Returns TextureCube

    out

Static isRawAssetType

  • isRawAssetType(ctor: Function): boolean

Generated using TypeDoc