Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Texture2D

The 2D texture asset. It supports mipmap, each level of mipmap use an ImageAsset.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _anisotropy

_anisotropy: number = 8

Protected _format

_format: number = PixelFormat.RGBA8888

Protected _gfxTexture

_gfxTexture: GFXTexture | 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: ImageAsset[] = []

Protected _name

_name: string

_native

_native: string = ""

Serializable url for native asset. For internal usage.

default

""

_objFlags

_objFlags: number

_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

Whether the asset is loaded or not

Static Filter

Filter: Filter = Filter

The texture filter mode enum

Static PixelFormat

PixelFormat: PixelFormat = PixelFormat

The pixel format enum.

Static WrapMode

WrapMode: WrapMode = WrapMode

The wrap mode enum.

Static preventDeferredLoadDependents

preventDeferredLoadDependents: boolean = false

Indicates whether its dependent raw assets can support deferred load if the owner scene (or prefab) is marked as asyncLoadAssets.

default

false

Static preventPreloadNativeObject

preventPreloadNativeObject: boolean = false

Indicates whether its native object should be preloaded from native url.

default

false

Accessors

Private nativeAsset

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

  • The underlying native asset of this asset if one is available.
    This property can be used to access additional details or functionality releated to the asset.
    This property will be initialized by the loader if _native is available.

    default

    null

    Returns any

  • The underlying native asset of this asset if one is available.
    This property can be used to access additional details or functionality releated to the asset.
    This property will be initialized by the loader if _native is available.

    default

    null

    Parameters

    • obj: any

    Returns void

height

  • get height(): number

image

isCompressed

  • get isCompressed(): boolean

isValid

  • get isValid(): boolean

  • Indicates whether the object is not yet destroyed. (It will not be available after being destroyed)
    When an object's destroy is called, it is actually destroyed after the end of this frame. So isValid will return false from the next frame, while isValid in the current frame will still be true. If you want to determine whether the current frame has called destroy, use isValid(obj, true), but this is often caused by a particular logical requirements, which is not normally required.

    default

    true

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

    Returns boolean

mipmapLevel

  • get mipmapLevel(): number

mipmaps

  • All levels of mipmap images, be noted, automatically generated mipmaps are not included. When setup mipmap, the size of the texture and pixel format could be modified.

    Returns ImageAsset[]

  • All levels of mipmap images, be noted, automatically generated mipmaps are not included. When setup mipmap, the size of the texture and pixel format could be modified.

    Parameters

    Returns void

name

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

nativeUrl

  • get nativeUrl(): string

width

  • get width(): number

Methods

Protected assignImage

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

Protected checkTextureLoaded

  • _checkTextureLoaded(): void

Protected createTexture

deserialize

  • deserialize(serializedData: any, handle: any): void

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(): any

Protected getGFXPixelFormat

  • getGFXPixelFormat(format: any): any

Protected getGfxTextureCreateInfo

serialize

  • serialize(exporting?: 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

create

  • create(width: number, height: number, format?: PixelFormat, mipmapLevel?: number): void

  • Reset the current texture with given size, pixel format and mipmap images. After reset, the gfx resource will become invalid, you must use uploadData explicitly to upload the new mipmaps to GPU resources.

    deprecated

    since v1.0 please use reset instead

    Parameters

    • width: number

      Pixel width

    • height: number

      Pixel height

    • Default value format: PixelFormat = PixelFormat.RGBA8888

      Pixel format

    • Default value mipmapLevel: number = 1

      Mipmap level count

    Returns void

Optional createNode

description

  • description(): string

destroy

  • destroy(): boolean

emit

  • emit(type: EventType, arg0?: any, arg1?: any, arg2?: any, arg3?: any, arg4?: any): void

  • Trigger an event directly with the event name and necessary arguments.

    Parameters

    • type: EventType

      event type

    • Optional arg0: any
    • Optional arg1: any
    • Optional arg2: any
    • Optional arg3: any
    • Optional arg4: any

    Returns void

getAnisotropy

  • getAnisotropy(): number

getGFXSampler

getGFXTexture

getHtmlElementObj

  • getHtmlElementObj(): null | HTMLCanvasElement | HTMLImageElement

  • If the level 0 mipmap image is a HTML element, then return it, otherwise return null.

    deprecated

    Please use [[image.data]] instead

    Returns null | HTMLCanvasElement | HTMLImageElement

    HTML element or null

getId

  • getId(): string

getPixelFormat

  • getPixelFormat(): number

Private getSamplerHash

  • getSamplerHash(): number

hasEventListener

  • hasEventListener(type: string, callback?: Function, target?: undefined | object): boolean

  • Checks whether there is correspond event listener registered on the given event.

    Parameters

    • type: string

      Event type.

    • Optional callback: Function

      Callback function when event triggered.

    • Optional target: undefined | object

      Callback callee.

    Returns boolean

initialize

  • initialize(): void

off

  • Removes the listeners previously registered with the same type, callback, target and or useCapture, if only type is passed as parameter, all listeners registered with that type will be removed.

    example

    import { log } from 'cc'; // register fire eventListener var callback = eventTarget.on('fire', function () { log("fire in the hole"); }, target); // remove fire event listener eventTarget.off('fire', callback, target); // remove all fire event listeners eventTarget.off('fire');

    Type parameters

    • TFunction: Function

    Parameters

    • type: EventType

      A string representing the event type being removed.

    • Optional callback: TFunction

      The callback to remove.

    • Optional thisArg: any

    Returns void

on

  • on<TFunction>(type: EventType, callback: TFunction, thisArg?: any, once?: undefined | false | true): typeof callback

  • Register an callback of a specific event type on the EventTarget. This type of event should be triggered via emit.

    example

    import { log } from 'cc'; eventTarget.on('fire', function () { log("fire in the hole"); }, node);

    Type parameters

    • TFunction: Function

    Parameters

    • type: EventType

      A string representing the event type to listen for.

    • callback: TFunction

      The callback that will be invoked when the event is dispatched. The callback is ignored if it is a duplicate (the callbacks are unique).

    • Optional thisArg: any

      The target (this object) to invoke the callback, can be null

    • Optional once: undefined | false | true

    Returns typeof callback

    • Just returns the incoming callback so you can save the anonymous function easier.

onLoaded

  • onLoaded(): void

once

  • once<TFunction>(type: EventType, callback: TFunction, thisArg?: any): typeof callback

  • Register an callback of a specific event type on the EventTarget, the callback will remove itself after the first time it is triggered.

    example

    import { log } from 'cc'; eventTarget.once('fire', function () { log("this is the callback and will be invoked only once"); }, node);

    Type parameters

    • TFunction: Function

    Parameters

    • type: EventType

      A string representing the event type to listen for.

    • callback: TFunction

      The callback that will be invoked when the event is dispatched. The callback is ignored if it is a duplicate (the callbacks are unique).

    • Optional thisArg: any

    Returns typeof callback

releaseTexture

  • releaseTexture(): void

removeAll

  • removeAll(typeOrTarget: string | object): void

  • Removes all callbacks registered in a certain event type or all callbacks registered with a certain target

    Parameters

    • typeOrTarget: string | object

      The event type or target with which the listeners will be removed

    Returns void

reset

  • Reset the current texture with given size, pixel format and mipmap images. After reset, the gfx resource will become invalid, you must use uploadData explicitly to upload the new mipmaps to GPU resources.

    Parameters

    Returns void

Private serialize

  • serialize(): void

setAnisotropy

  • setAnisotropy(anisotropy: number): void

setFilters

setMipFilter

  • setMipFilter(mipFilter: Filter): void

setWrapMode

targetOff

  • targetOff(typeOrTarget: string | object): void

  • Removes all callbacks previously registered with the same target (passed as parameter). This is not for removing all listeners in the current event target, and this is not for removing all listeners the target parameter have registered. It's only for removing all listeners (callback and target couple) registered on the current event target by the target parameter.

    Parameters

    • typeOrTarget: string | object

      The target to be searched for all related listeners

    Returns void

toString

  • toString(): string

updateImage

  • updateImage(): void

updateMipmaps

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

uploadData

  • uploadData(source: HTMLCanvasElement | HTMLImageElement | ArrayBufferView, level?: number, arrayIndex?: number): void

  • Upload data to the given mipmap level. The size of the image will affect how the mipmap is updated.

    • When the image is an ArrayBuffer, the size of the image must match the mipmap size.
    • If the image size matches the mipmap size, the mipmap data will be updated entirely.
    • If the image size is smaller than the mipmap size, the mipmap will be updated from top left corner.
    • If the image size is larger, an error will be raised

    Parameters

    • source: HTMLCanvasElement | HTMLImageElement | ArrayBufferView

      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 deferredDestroy

  • _deferredDestroy(): void

Static deserialize

  • deserialize(data: any): any

Static isRawAssetType

  • isRawAssetType(ctor: Function): boolean

Generated using TypeDoc