FrameUniforms

Ploy3D • Docs

---

Ploy3D / FrameUniforms

Class: FrameUniforms

帧统一资源组实例（G0）。

Extends

• Uniform<Material_kernel>

Constructors

new FrameUniforms()

new FrameUniforms(impl, ptr, id): FrameUniforms

构造函数。

Parameters

• impl: Material_kernel

内核实现。

• ptr: never

内核实例指针。

• id: number

实例ID。

Returns

FrameUniforms

Overrides

Uniform.constructor

Accessors

bindingID

get bindingID(): number

资源组绑定对象ID（0或1）。

set bindingID(value): void

Parameters

• value: number

Returns

number

Inherited from

Uniform.bindingID

---

blockPtr

get blockPtr(): never

属性块地址指针。

Returns

never

Inherited from

Uniform.blockPtr

---

bufferID

get bufferID(): number

GPU常量缓存实例ID。

Returns

number

Inherited from

Uniform.bufferID

---

bufferPtr

get bufferPtr(): never

缓存地址指针。

Returns

never

Inherited from

Uniform.bufferPtr

---

bufferSize

get bufferSize(): number

缓存字节大小（256的倍数）。

Returns

number

Inherited from

Uniform.bufferSize

---

enableFlags

get enableFlags(): number

相关状态标志集。

set enableFlags(value): void

Parameters

• value: number

Returns

number

---

g0_colorRT

get g0_colorRT(): number

颜色渲染目标贴图ID。

set g0_colorRT(value): void

Parameters

• value: number

Returns

number

---

g0_depthRT

get g0_depthRT(): number

深度渲染目标贴图ID。

set g0_depthRT(value): void

Parameters

• value: number

Returns

number

---

g0_froxelList

get g0_froxelList(): object

光源体素列表缓存（绑定到G0）。

Returns

object

buffer

buffer: never

bufferID

bufferID: number

offset

offset: number

size

size: number

---

g0_gbufferRT

get g0_gbufferRT(): number

GB渲染目标贴图ID。

set g0_gbufferRT(value): void

Parameters

• value: number

Returns

number

---

g0_lightList

get g0_lightList(): object

光源列表缓存（绑定到G0）。

Returns

object

buffer

buffer: never

bufferID

bufferID: number

offset

offset: number

size

size: number

---

g0_lightVoxel

get g0_lightVoxel(): object

光源索引表缓存（绑定到G0）。

Returns

object

buffer

buffer: never

bufferID

bufferID: number

offset

offset: number

size

size: number

---

g0_spriteAtlas

get g0_spriteAtlas(): number

精灵图集ID（用于UI和粒子）。

set g0_spriteAtlas(value): void

Parameters

• value: number

Returns

number

---

group

get group(): number

资源组编号（可选值有0、1、2、3）。

Returns

number

Inherited from

Uniform.group

---

id

get id(): number

实例ID。

Returns

number

Inherited from

Uniform.id

---

internalPtr

get internalPtr(): never

内核实例指针。

Returns

never

Inherited from

Uniform.internalPtr

---

layoutID

get layoutID(): number

资源绑定组布局ID（同时也是着色器内部实例ID）。

Returns

number

Inherited from

Uniform.layoutID

---

offset

get offset(): number

属性块在缓存中的字节偏移（256对齐）。

Returns

number

Inherited from

Uniform.offset

---

readTS

get readTS(): number

属性用于渲染读取时间戳。

set readTS(value): void

Parameters

• value: number

Returns

number

Inherited from

Uniform.readTS

---

size

get size(): number

属性块在缓存中的字节大小（256对齐）。

Returns

number

Inherited from

Uniform.size

---

tuple

get tuple(): PropTuple

资源绑定组属性元组。

Returns

PropTuple

Inherited from

Uniform.tuple

---

updated

get updated(): boolean

属性块数据更新状态。

set updated(value): void

Parameters

• value: boolean

Returns

boolean

Inherited from

Uniform.updated

---

view

get view(): Record<string, number[]>

材质属性访问视图。

Returns

Record<string, number[]>

---

writeTS

get writeTS(): number

属性上传GPU时间戳。

set writeTS(value): void

Parameters

• value: number

Returns

number

Inherited from

Uniform.writeTS

Methods

AddRef()

AddRef(): void

增加实例引用。

Returns

void

---

Bind()

Bind(passEncoder): void

绑定资源组到着色器管线（包括统一缓存和所有贴图）。

Parameters

• passEncoder: GPURenderPassEncoder

渲染通道命令编码器。

Returns

void

Inherited from

Uniform.Bind

---

ComputeLightSpaceMatrixes()

ComputeLightSpaceMatrixes(camera, cascadeIndex): void

计算用于阴影投影的相关矩阵。

Parameters

• camera: Camera

相机组件实例，用于获取视锥信息。

• cascadeIndex: number

Cascaded Shadow Maps视锥分片索引（大于-1时设置阴影投影渲染相关矩阵）。

Returns

void

---

ReadBufferNode()

ReadBufferNode(ptr): object

读取GPU常量缓存占用节点。

Parameters

• ptr: never

缓存占用节点指针。

Returns

object

返回缓存占用节点成员数据。

buffer

buffer: never

bufferID

bufferID: number

offset

offset: number

size

size: number

Inherited from

Uniform.ReadBufferNode

---

Release()

Release(): void

释放实例引用。

Returns

void

---

UpdateFrameUniforms()

UpdateFrameUniforms(camera, volume): void

根据相机组件数据和体积组件数据更新数据。

Parameters

• camera: Camera

相机组件实例。

• volume: Volume

体积组件实例。

Returns

void