Class RenderTexture

RenderTexture 是动态纹理类，他实现了将显示对象及其子对象绘制成为一个纹理的功能

Version

Egret 2.4

Platform

Web

Include Example

egret/display/RenderTexture.ts

Language

zh_CN

Hierarchy (View Summary)

Texture
- RenderTexture

Index

Constructors

Properties

$renderBuffer disposeBitmapData

Accessors

textureWidth textureHeight bitmapData ktxData hashCode

Methods

drawToTexture getPixel32 dispose $getTextureWidth $getTextureHeight $getScaleBitmapWidth $getScaleBitmapHeight _setBitmapData _setKtxData getPixels toDataURL saveToFile

Constructors

constructor

new RenderTexture(): RenderTexture
Returns RenderTexture
Overrides Texture.constructor
- Defined in egret/display/RenderTexture.ts:32

Properties

$renderBuffer

$renderBuffer: RenderBuffer

disposeBitmapData

disposeBitmapData: boolean = true

销毁纹理时是否销毁对应BitmapData

Version

Egret 5.0.8

Platform

Web

Language

zh_CN

Accessors

textureWidth

get textureWidth(): number
纹理宽度，只读属性，不可以设置

Returns number

Version
Egret 2.4

Platform
Web

Language
zh_CN
Inherited from Texture.textureWidth
- Defined in egret/display/Texture.ts:119

textureHeight

get textureHeight(): number
纹理高度，只读属性，不可以设置

Returns number

Version
Egret 2.4

Platform
Web

Language
zh_CN
Inherited from Texture.textureHeight
- Defined in egret/display/Texture.ts:145

bitmapData

get bitmapData(): BitmapData
被引用的 BitmapData 对象。

Returns BitmapData

Version
Egret 2.4

Platform
Web

Language
zh_CN
Inherited from Texture.bitmapData
- Defined in egret/display/Texture.ts:199
set bitmapData(value: BitmapData): void
Parameters
- value: BitmapData
Returns void
Inherited from Texture.bitmapData
- Defined in egret/display/Texture.ts:203

ktxData

get ktxData(): ArrayBuffer
被引用的 KTXData 对象。

Returns ArrayBuffer

Version
Egret 5.2.21

Platform
Web

Language
zh_CN
Inherited from Texture.ktxData
- Defined in egret/display/Texture.ts:238
set ktxData(data: ArrayBuffer): void
Parameters
- data: ArrayBuffer
Returns void
Inherited from Texture.ktxData
- Defined in egret/display/Texture.ts:242

hashCode

get hashCode(): number
返回此对象唯一的哈希值,用于唯一确定一个对象。hashCode为大于等于1的整数。

Returns number

Version
Egret 2.4

Platform
Web

Language
zh_CN
Inherited from Texture.hashCode
- Defined in egret/utils/HashObject.ts:102

Methods

drawToTexture

drawToTexture(
    displayObject: DisplayObject,
    clipBounds?: Rectangle,
    scale?: number,
): boolean
将指定显示对象绘制为一个纹理
Parameters
- displayObject: DisplayObject
  {DisplayObject} 需要绘制的显示对象
- OptionalclipBounds: Rectangle
  {Rectangle} 绘制矩形区域
- scale: number = 1
  {number} 缩放比例
Returns boolean

Version
Egret 2.4

Platform
Web

Language
zh_CN
- Defined in egret/display/RenderTexture.ts:59

getPixel32

getPixel32(x: number, y: number): number[]
Parameters
- x: number
- y: number
Returns number[]

Deprecated
Overrides Texture.getPixel32
- Defined in egret/display/RenderTexture.ts:124

dispose

dispose(): void
释放纹理

Returns void

Version
Egret 2.4

Platform
Web

Language
zh_CN
Overrides Texture.dispose
- Defined in egret/display/RenderTexture.ts:138

$getTextureWidth

$getTextureWidth(): number
Returns number
Inherited from Texture.$getTextureWidth
- Defined in egret/display/Texture.ts:123

$getTextureHeight

$getTextureHeight(): number
Returns number
Inherited from Texture.$getTextureHeight
- Defined in egret/display/Texture.ts:149

$getScaleBitmapWidth

$getScaleBitmapWidth(): number
Returns number
Inherited from Texture.$getScaleBitmapWidth
- Defined in egret/display/Texture.ts:153

$getScaleBitmapHeight

$getScaleBitmapHeight(): number
Returns number
Inherited from Texture.$getScaleBitmapHeight
- Defined in egret/display/Texture.ts:157

_setBitmapData

_setBitmapData(value: BitmapData): void
设置 BitmapData 对象。
Parameters
- value: BitmapData
Returns void

Version
Egret 3.2.1

Platform
Web

Language
zh_CN
Inherited from Texture._setBitmapData
- Defined in egret/display/Texture.ts:219

_setKtxData

_setKtxData(value: ArrayBuffer): void
设置 KTXData 对象。
Parameters
- value: ArrayBuffer
Returns void

Version
Egret 3.2.1

Platform
Web

Language
zh_CN
Inherited from Texture._setKtxData
- Defined in egret/display/Texture.ts:258

getPixels

getPixels(x: number, y: number, width?: number, height?: number): number[]
获取指定像素区域的颜色值
Parameters
- x: number
  像素区域的X轴坐标
- y: number
  像素区域的Y轴坐标
- width: number = 1
  像素区域的宽度
- height: number = 1
  像素区域的高度
Returns number[]
指定像素区域的颜色值

Version
Egret 3.2.1

Platform
Web

Language
zh_CN
Inherited from Texture.getPixels
- Defined in egret/display/Texture.ts:343

toDataURL

toDataURL(type: string, rect?: Rectangle, encoderOptions?: number): string
转换成base64字符串，如果图片（或者包含的图片）跨域，则返回null
Parameters
- type: string
  转换的类型，如 "image/png"
- Optionalrect: Rectangle
  需要转换的区域
- OptionalencoderOptions: number
  编码用的参数
Returns string
base64字符串

Version
Egret 2.4

Language
zh_CN
Inherited from Texture.toDataURL
- Defined in egret/display/Texture.ts:365

saveToFile

saveToFile(type: string, filePath: string, rect?: Rectangle): void
裁剪指定区域并保存成图片。 native只支持 "image/png" 和 "image/jpeg"；Web中由于各个浏览器的实现不一样，因此建议也只用这2种。
Parameters
- type: string
  转换的类型，如 "image/png"
- filePath: string
  图片的名称的路径（主目录为游戏的私有空间，路径中不能有 "../"，Web只支持传名称。）
- Optionalrect: Rectangle
  需要转换的区域
Returns void

Version
Egret 2.4

Platform
Native

Language
zh_CN
Inherited from Texture.saveToFile
- Defined in egret/display/Texture.ts:389