Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RenderTexture

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected _anisotropy

_anisotropy: number = 8

_callbackTable

_callbackTable: any = createMap(true)

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

Private _depthStencilFormat

_depthStencilFormat: DepthStencilFormat = DepthStencilFormat.NONE

Protected _flipY

_flipY: boolean = false

Protected _format

_format: number = PixelFormat.RGBA8888

Protected _height

_height: number = 0

Protected _magFilter

_magFilter: number = Filter.LINEAR

Protected _minFilter

_minFilter: number = Filter.LINEAR

Protected _mipFilter

_mipFilter: number = Filter.NONE

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

Private _window

_window: GFXWindow | null = null

Protected _wrapR

_wrapR: number = WrapMode.REPEAT

Protected _wrapS

_wrapS: number = WrapMode.REPEAT

Protected _wrapT

_wrapT: number = WrapMode.REPEAT

loaded

loaded: boolean = true

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

Static DepthStencilFormat

DepthStencilFormat: DepthStencilFormat = DepthStencilFormat

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

    property

    {Object} _nativeAsset

    default

    null

    type

    {any}

    Returns any

  • Parameters

    • obj: any

    Returns void

depthStencilFormat

height

  • get height(): number
  • set height(value: number): void
  • Returns number

  • Parameters

    • value: number

    Returns void

isCompressed

  • get isCompressed(): boolean
  • 此贴图是否为压缩的像素格式。

    Returns 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

name

  • get name(): string
  • set name(value: string): void
  • 该对象的名称。

    property

    {String} name

    default

    ""

    example
    obj.name = "New Obj";

    Returns string

  • Parameters

    • value: string

    Returns void

nativeUrl

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

    property

    nativeUrl

    type

    {String}

    readonly

    Returns string

width

  • get width(): number
  • set width(value: number): void
  • Returns number

  • Parameters

    • value: number

    Returns void

Methods

Protected createWindow

  • Parameters

    Returns undefined | GFXWindow

deserialize

  • deserialize(serializeData: any, handle: any): void
  • Parameters

    • serializeData: any
    • handle: any

    Returns 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(): number

serialize

  • serialize(exporting?: any): any
  • Parameters

    • Optional exporting: any

    Returns any

Protected setGFXFormat

Private setRawAsset

  • setRawAsset(filename: string, inLibrary?: boolean): void
  • 为此资源设置原始文件名。

    seealso

    nativeUrl

    Parameters

    • filename: string
    • Default value inLibrary: boolean = true

    Returns void

Protected tryResetWindow

  • _tryResetWindow(): void
  • Returns void

Optional createNode

  • 使用该资源在场景中创建一个新节点。
    如果这类资源没有相应的节点类型,该方法应该是空的。

    Parameters

    Returns void

destroy

  • destroy(): boolean
  • Returns boolean

dispatchEvent

  • dispatchEvent(event: Event): void
  • Parameters

    Returns void

emit

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

    • key: string
    • Rest ...args: any[]

    Returns void

getAnisotropy

  • getAnisotropy(): number
  • 获取各向异性。

    Returns number

    此贴图的各向异性。

getGFXStencilTexture

  • Returns GFXTextureView | null

getGFXTextureView

getGFXWindow

  • Returns null | GFXWindow

getId

  • getId(): string
  • 获取标识符。

    Returns string

    此贴图的标识符。

getPixelFormat

  • getPixelFormat(): number
  • 获取像素格式。

    Returns number

    此贴图的像素格式。

Private getSamplerHash

  • getSamplerHash(): number
  • 获取此贴图内部使用的 GFX 采样器信息。

    Returns number

hasEventListener

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

    • key: string
    • Optional callback: Function | undefined
    • Optional target: Object | undefined

    Returns boolean

hasPremultipliedAlpha

  • hasPremultipliedAlpha(): boolean
  • 返回是否开启了预乘透明通道功能。

    Returns boolean

    此贴图是否开启了预乘透明通道功能。

off

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

    • type: string
    • Optional callback: Function | undefined
    • Optional target: Object | undefined

    Returns void

on

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

    • type: string
    • callback: Function
    • Optional target: Object | undefined

    Returns Function | undefined

onLoaded

  • onLoaded(): void
  • Returns void

once

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

    • type: string
    • callback: Function
    • Optional target: Object | undefined

    Returns Function | undefined

removeAll

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

    • Optional keyOrTarget: string | Object | undefined

    Returns void

reset

setAnisotropy

  • setAnisotropy(anisotropy: number): void
  • 设置此贴图的各向异性。

    Parameters

    • anisotropy: number

      各向异性。

    Returns void

setFilters

  • 设置此贴图的过滤算法。

    Parameters

    • minFilter: Filter

      缩小过滤算法。

    • magFilter: Filter

      放大过滤算法。

    Returns void

setFlipY

  • setFlipY(flipY: boolean): void
  • 设置渲染时是否运行将此贴图进行翻转。

    Parameters

    • flipY: boolean

      翻转则为 true,否则为 false

    Returns void

setMipFilter

  • setMipFilter(mipFilter: Filter): void
  • 设置此贴图的 mip 过滤算法。

    Parameters

    • mipFilter: Filter

      mip 过滤算法。

    Returns void

setPremultiplyAlpha

  • setPremultiplyAlpha(premultiply: boolean): void
  • 设置此贴图是否预乘透明通道。

    Parameters

    • premultiply: boolean

    Returns void

setWrapMode

  • 设置此贴图的缠绕模式。 注意,若贴图尺寸不是 2 的整数幂,缠绕模式仅允许 WrapMode.CLAMP_TO_EDGE

    Parameters

    • wrapS: WrapMode

      S(U) 坐标的采样模式。

    • wrapT: WrapMode

      T(V) 坐标的采样模式。

    • Optional wrapR: WrapMode

      R(W) 坐标的采样模式。

    Returns void

targetOff

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

    • Optional keyOrTarget: string | Object | undefined

    Returns void

toString

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

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

    method

    toString

    Returns string

Static deferredDestroy

  • _deferredDestroy(): void

Static deserialize

  • deserialize(data: any): any
  • 应 AssetDB 要求提供这个方法。

    method

    deserialize

    Parameters

    • data: any

    Returns any

Static isRawAssetType

  • isRawAssetType(ctor: Function): boolean
  • 内部使用。

    Parameters

    • ctor: Function

    Returns boolean

Generated using TypeDoc