Class SpriteFrame

export

Hierarchy

BaseResource
- SpriteFrame

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new SpriteFrame(): SpriteFrame

Inherited from BaseResource.constructor
- Defined in src/engine/assets/classes/baseResource.ts:42
资源的基类，弱引用逻辑。

memberof

BaseResource

Returns SpriteFrame

Properties

Optional groupID

groupID: string

Optional resourceID

resourceID: string

编辑器中使用的资源id。

memberof: BaseResource

Accessors

rect

get rect(): Rect

- Defined in src/engine/assets/classes/spriteFrame.ts:70
贴图在图集中的区域。

memberof

SpriteFrame

Returns Rect

slicedRect

get slicedRect(): Rect

- Defined in src/engine/assets/classes/spriteFrame.ts:117
九宫格裁剪位置在Rect中的相对位置。

memberof

SpriteFrame

Returns Rect

texture

get texture(): Texture2D

- Defined in src/engine/assets/classes/spriteFrame.ts:33
贴图。

memberof

SpriteFrame

Returns Texture2D

trim

get trim(): Vector4

- Defined in src/engine/assets/classes/spriteFrame.ts:94
贴图在图集中的边框大小。

readonly

memberof

SpriteFrame

Returns Vector4

Methods

Static DeserializeResource

DeserializeResource(resourceDescription: DeepImmutableObject<ISpriteframeResourceDescription>, loadContext: default): SpriteFrame

Overrides BaseResource.DeserializeResource
- Defined in src/engine/assets/classes/spriteFrame.ts:179
图片资源反序列化方法。

static

memberof

SpriteFrame

Parameters
- resourceDescription: DeepImmutableObject<ISpriteframeResourceDescription>
  
  资源配置。
- loadContext: default
  
  引擎loader上下文环境。
Returns SpriteFrame

Static createFromTexture

createFromTexture(texture: RenderTexture | Texture2D, rect?: Rect, slicedRect?: Rect, trim?: Vector4): SpriteFrame

- Defined in src/engine/assets/classes/spriteFrame.ts:214
从贴图资源创建图片资源。

static

memberof

SpriteFrame

Parameters
- texture: RenderTexture | Texture2D
- Optional rect: Rect
- Optional slicedRect: Rect
- Optional trim: Vector4
Returns SpriteFrame

Generated using TypeDoc