Documentation / device / PBBuiltinScope

Class: PBBuiltinScope

Defined in: libs/device/src/builder/programbuilder.ts:3324

The builtin scope of a shader

Extends

• PBScope

Indexable

[props: string]: any

Constructors

Constructor

new PBBuiltinScope(): PBBuiltinScope

Defined in: libs/device/src/builder/programbuilder.ts:3350

Returns

PBBuiltinScope

Properties

position

position: PBShaderExp

Defined in: libs/device/src/builder/programbuilder.ts:3325

---

pointSize

pointSize: number | PBShaderExp

Defined in: libs/device/src/builder/programbuilder.ts:3326

---

fragDepth

fragDepth: number | PBShaderExp

Defined in: libs/device/src/builder/programbuilder.ts:3327

---

fragCoord

readonly fragCoord: PBShaderExp

Defined in: libs/device/src/builder/programbuilder.ts:3328

---

frontFacing

readonly frontFacing: PBShaderExp

Defined in: libs/device/src/builder/programbuilder.ts:3329

---

vertexIndex

readonly vertexIndex: PBShaderExp

Defined in: libs/device/src/builder/programbuilder.ts:3330

---

instanceIndex

readonly instanceIndex: PBShaderExp

Defined in: libs/device/src/builder/programbuilder.ts:3331

---

localInvocationId

readonly localInvocationId: PBShaderExp

Defined in: libs/device/src/builder/programbuilder.ts:3332

---

globalInvocationId

readonly globalInvocationId: PBShaderExp

Defined in: libs/device/src/builder/programbuilder.ts:3333

---

workGroupId

readonly workGroupId: PBShaderExp

Defined in: libs/device/src/builder/programbuilder.ts:3334

---

numWorkGroups

readonly numWorkGroups: PBShaderExp

Defined in: libs/device/src/builder/programbuilder.ts:3335

---

sampleMaskIn

readonly sampleMaskIn: PBShaderExp

Defined in: libs/device/src/builder/programbuilder.ts:3336

---

sampleMaskOut

sampleMaskOut: PBShaderExp

Defined in: libs/device/src/builder/programbuilder.ts:3337

---

sampleIndex

readonly sampleIndex: PBShaderExp

Defined in: libs/device/src/builder/programbuilder.ts:3338

Accessors

$thisProxy

Get Signature

get $thisProxy(): T

Defined in: libs/device/src/builder/base.ts:133

Returns

T

Inherited from

PBScope.$thisProxy

---

$builder

Get Signature

get $builder(): ProgramBuilder

Defined in: libs/device/src/builder/programbuilder.ts:2884

Get the program builder

Returns

ProgramBuilder

Inherited from

PBScope.$builder

---

$builtins

Get Signature

get $builtins(): PBBuiltinScope

Defined in: libs/device/src/builder/programbuilder.ts:2888

Returns the scope of the builtin variables

Returns

PBBuiltinScope

Inherited from

PBScope.$builtins

---

$inputs

Get Signature

get $inputs(): PBInputScope

Defined in: libs/device/src/builder/programbuilder.ts:2892

Returns the scope of the input variables

Returns

PBInputScope

Inherited from

PBScope.$inputs

---

$outputs

Get Signature

get $outputs(): PBOutputScope

Defined in: libs/device/src/builder/programbuilder.ts:2896

Returns the scope of the output variables

Returns

PBOutputScope

Inherited from

PBScope.$outputs

---

$l

Get Signature

get $l(): PBLocalScope

Defined in: libs/device/src/builder/programbuilder.ts:2924

Get the current local scope

Returns

PBLocalScope

Inherited from

PBScope.$l

---

$g

Get Signature

get $g(): PBGlobalScope

Defined in: libs/device/src/builder/programbuilder.ts:2928

Get the global scope

Returns

PBGlobalScope

Inherited from

PBScope.$g

Methods

$getVertexAttrib()

$getVertexAttrib(semantic): PBShaderExp

Defined in: libs/device/src/builder/programbuilder.ts:2920

Get the input vertex attribute by specified semantic

Parameters

semantic

VertexSemantic

The vertex semantic

Returns

PBShaderExp

The input vertex attribute or null if not exists

Remarks

Can only be called only in vertex shader

Inherited from

PBScope.$getVertexAttrib

---

$query()

$query(name): PBShaderExp

Defined in: libs/device/src/builder/programbuilder.ts:2946

Query the global variable by the name

Parameters

name

string

Name of the variable

Returns

PBShaderExp

The variable or null if not exists

Inherited from

PBScope.$query