M3D / M3D / Render / FrameBuffer

Class: FrameBuffer

M3D.Render.FrameBuffer

Memberof

M3D.Render

Description

帧缓存对象类

Hierarchy

• GPUObject

  ↳ FrameBuffer

Table of contents

Constructors

• constructor

Properties

• id
• count

Methods

• bind
• getColorFormat
• getColorTarget
• getDeepFormat
• getDepthTarget
• getEvents
• getHeight
• getId
• getRenderContext
• getWidth
• load
• registerEvent
• removeEvent
• setId
• setParameters
• setRenderContext
• setSize
• unbind

Constructors

constructor

• new FrameBuffer(context): FrameBuffer

Parameters

Name	Type	Description
context	RenderContext	渲染上下文

Returns

FrameBuffer

Description

构造函数

Overrides

GPUObject.constructor

• new FrameBuffer(context, width, height): FrameBuffer

Parameters

Name	Type	Description
context	RenderContext	渲染上下文
width	number	宽
height	number	高

Returns

FrameBuffer

Description

构造函数

Overrides

GPUObject.constructor

Properties

id

• id: number

Inherited from

GPUObject.id

---

count

▪ Static count: number

Inherited from

GPUObject.count

Methods

bind

▸ bind(): void

Returns

void

Description

绑定buffer

---

getColorFormat

▸ getColorFormat(): number

Returns

number

颜色类型

Description

获取颜色类型

---

getColorTarget

▸ getColorTarget(key?): TargetData

Parameters

Name	Type
key?	number

Returns

TargetData

Description

获取颜色挂载

---

getDeepFormat

▸ getDeepFormat(): number

Returns

number

深度类型

Description

获取深度类型

---

getDepthTarget

▸ getDepthTarget(): TargetData

Returns

TargetData

深度挂载

Description

获取深度挂载

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

GPUObject.getEvents

---

getHeight

▸ getHeight(): number

Returns

number

高度

Description

获取高度

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

GPUObject.getId

---

getRenderContext

▸ getRenderContext(): RenderContext

Returns

RenderContext

渲染上下文

Description

获取渲染上下文

Inherited from

GPUObject.getRenderContext

---

getWidth

▸ getWidth(): number

Returns

number

宽度

Description

获取宽度

---

load

▸ load(): void

Returns

void

Description

加载buffer

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

GPUObject.registerEvent

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

GPUObject.removeEvent

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

GPUObject.setId

---

setParameters

▸ setParameters(colorNumber?, useDepth?, depthUseRenderBuffer?, useStencil?): void

Parameters

Name	Type
colorNumber?	number
useDepth?	boolean
depthUseRenderBuffer?	boolean
useStencil?	boolean

Returns

void

Description

设置参数

---

setRenderContext

▸ setRenderContext(v): void

Parameters

Name	Type	Description
v	RenderContext	渲染上下文

Returns

void

Description

设置GL

Inherited from

GPUObject.setRenderContext

---

setSize

▸ setSize(width, height): void

Parameters

Name	Type	Description
width	number	宽
height	number	高

Returns

void

Description

设置大小

---

unbind

▸ unbind(): void

Returns

void

Description

解绑buffer