Pass | Creator3dAPI

渲染 pass，储存实际描述绘制过程的各项资源。

Hierarchy

Pass
- PassInstance

Index

Constructors

constructor

Accessors

Constructors

constructor

newPass(device: GFXDevice): Pass

- Defined in cocos/core/renderer/core/pass.ts:220
Parameters
- device: GFXDevice
Returns Pass

Properties

Protected _batchedBuffer

_batchedBuffer: BatchedBuffer | null = null

Protected _bindings

_bindings: IGFXBinding[] = []

Protected _blocks

_blocks: IBlock[] = []

Protected _bs

_bs: GFXBlendState = new GFXBlendState()

Protected _buffers

_buffers: Record<number, GFXBuffer>

Protected _customizations

_customizations: string[] = []

Protected _defines

_defines: IDefineMap

Protected _device

_device: GFXDevice

Protected _dss

_dss: GFXDepthStencilState = new GFXDepthStencilState()

Protected _dynamicStates

_dynamicStates: GFXDynamicState[] = []

Protected _dynamics

_dynamics: IPassDynamics

Protected _handleMap

_handleMap: Record<string, number>

Protected _hash

_hash: number = 0

Protected _idxInTech

_idxInTech: number = 0

Protected _inputState

_inputState: GFXInputState = new GFXInputState()

Protected _instancedBuffer

_instancedBuffer: InstancedBuffer | null = null

Protected _phase

_phase: number = getPhaseID('default')

Protected _primitive

_primitive: GFXPrimitiveMode = GFXPrimitiveMode.TRIANGLE_LIST

Protected _priority

_priority: RenderPriority = RenderPriority.DEFAULT

Protected _programName

_programName: string = ""

Protected _properties

_properties: Record<string, IPropertyInfo>

Protected _renderPass

_renderPass: GFXRenderPass | null = null

Protected _resources

_resources: IPassResources[] = []

Protected _rs

_rs: GFXRasterizerState = new GFXRasterizerState()

Protected _samplers

_samplers: Record<number, GFXSampler>

Protected _shader

_shader: GFXShader | null = null

Protected _shaderInfo

_shaderInfo: IProgramInfo = null!

Protected _stage

_stage: RenderPassStage = RenderPassStage.DEFAULT

Protected _textureViews

_textureViews: Record<number, GFXTextureView>

Static getBindingFromHandle

getBindingFromHandle: getBindingFromHandle = getBindingFromHandle

根据 handle 获取 binding。

Static getBindingTypeFromHandle

getBindingTypeFromHandle: getBindingTypeFromHandle = getBindingTypeFromHandle

根据 handle 获取 unform 的绑定类型（UBO 或贴图等）。

Static Protected getOffsetFromHandle

getOffsetFromHandle: getOffsetFromHandle = getOffsetFromHandle

Static getTypeFromHandle

getTypeFromHandle: getTypeFromHandle = getTypeFromHandle

根据 handle 获取 UBO member 的具体类型。

Accessors

batchedBuffer

get batchedBuffer(): null | BatchedBuffer

- Defined in cocos/core/renderer/core/pass.ts:708
Returns null | BatchedBuffer

bindings

get bindings(): IGFXBinding[]

- Defined in cocos/core/renderer/core/pass.ts:704
Returns IGFXBinding[]

blendState

get blendState(): GFXBlendState

- Defined in cocos/core/renderer/core/pass.ts:692
Returns GFXBlendState

blocks

get blocks(): IBlock[]

- Defined in cocos/core/renderer/core/pass.ts:710
Returns IBlock[]

customizations

get customizations(): string[]

- Defined in cocos/core/renderer/core/pass.ts:694
Returns string[]

defines

get defines(): IDefineMap

- Defined in cocos/core/renderer/core/pass.ts:701
Returns IDefineMap

depthStencilState

get depthStencilState(): GFXDepthStencilState

- Defined in cocos/core/renderer/core/pass.ts:691
Returns GFXDepthStencilState

device

get device(): GFXDevice

- Defined in cocos/core/renderer/core/pass.ts:697
Returns GFXDevice

dynamicStates

get dynamicStates(): GFXDynamicState[]

- Defined in cocos/core/renderer/core/pass.ts:693
Returns GFXDynamicState[]

dynamics

get dynamics(): IPassDynamics

- Defined in cocos/core/renderer/core/pass.ts:707
Returns IPassDynamics

hash

get hash(): number

- Defined in cocos/core/renderer/core/pass.ts:711
Returns number

idxInTech

get idxInTech(): number

- Defined in cocos/core/renderer/core/pass.ts:702
Returns number

inputState

get inputState(): GFXInputState

- Defined in cocos/core/renderer/core/pass.ts:689
Returns GFXInputState

instancedBuffer

get instancedBuffer(): null | InstancedBuffer

- Defined in cocos/core/renderer/core/pass.ts:709
Returns null | InstancedBuffer

phase

get phase(): number

- Defined in cocos/core/renderer/core/pass.ts:695
Returns number

primitive

get primitive(): GFXPrimitiveMode

- Defined in cocos/core/renderer/core/pass.ts:687
Returns GFXPrimitiveMode

priority

get priority(): RenderPriority

- Defined in cocos/core/renderer/core/pass.ts:686
Returns RenderPriority

program

get program(): string

- Defined in cocos/core/renderer/core/pass.ts:699
Returns string

properties

get properties(): object

- Defined in cocos/core/renderer/core/pass.ts:700
Returns object

rasterizerState

get rasterizerState(): GFXRasterizerState

- Defined in cocos/core/renderer/core/pass.ts:690
Returns GFXRasterizerState

renderPass

get renderPass(): GFXRenderPass

- Defined in cocos/core/renderer/core/pass.ts:706
Returns GFXRenderPass

shader

get shader(): GFXShader

- Defined in cocos/core/renderer/core/pass.ts:705
Returns GFXShader

shaderInfo

get shaderInfo(): IProgramInfo

- Defined in cocos/core/renderer/core/pass.ts:698
Returns IProgramInfo

stage

get stage(): DEFAULT

- Defined in cocos/core/renderer/core/pass.ts:688
Returns DEFAULT

Methods

Protected doInit

doInit(info: IPassInfoFull, copyDefines?: boolean): void

- Defined in cocos/core/renderer/core/pass.ts:604
Parameters
- info: IPassInfoFull
- Default value copyDefines: boolean = false
Returns void

Protected dynamicBatchingSync

_dynamicBatchingSync(): void

- Defined in cocos/core/renderer/core/pass.ts:640
Returns void

Protected getShaderWithBuiltinMacroPatches

getShaderWithBuiltinMacroPatches(patches: IMacroPatch[]): null | IShaderResources

- Defined in cocos/core/renderer/core/pass.ts:662
Parameters
- patches: IMacroPatch[]
Returns null | IShaderResources

beginChangeStatesSilently

beginChangeStatesSilently(): void

- Defined in cocos/core/renderer/core/pass.ts:601
Returns void

bindBuffer

bindBuffer(binding: number, value: GFXBuffer): void

- Defined in cocos/core/renderer/core/pass.ts:327
绑定实际 GFXBuffer 到指定 binding。

Parameters
- binding: number
  
  目标 UBO 的 binding。
- value: GFXBuffer
  
  目标 buffer。
Returns void

bindSampler

bindSampler(binding: number, value: GFXSampler): void

- Defined in cocos/core/renderer/core/pass.ts:359
绑定实际 GFXSampler 到指定 binding。

Parameters
- binding: number
  
  目标贴图类 uniform 的 binding。
- value: GFXSampler
  
  目标 sampler。
Returns void

bindTextureView

bindTextureView(binding: number, value: GFXTextureView): void

- Defined in cocos/core/renderer/core/pass.ts:343
绑定实际 GFXTextureView 到指定 binding。

Parameters
- binding: number
  
  目标贴图类 uniform 的 binding。
- value: GFXTextureView
  
  目标 texture view。
Returns void

createPipelineState

createPipelineState(patches?: IMacroPatch[]): GFXPipelineState | null

- Defined in cocos/core/renderer/core/pass.ts:533
根据当前 pass 持有的信息创建 GFXPipelineState。

Parameters
- Optional patches: IMacroPatch[]
Returns GFXPipelineState | null

destroy

destroy(): void

- Defined in cocos/core/renderer/core/pass.ts:419
销毁当前 pass。

Returns void

destroyPipelineState

destroyPipelineState(pipelineStates: GFXPipelineState): void

- Defined in cocos/core/renderer/core/pass.ts:591
销毁指定的 GFXPipelineState，如果它是这个 pass 创建的。

Parameters
- pipelineStates: GFXPipelineState
Returns void

endChangeStatesSilently

endChangeStatesSilently(): void

- Defined in cocos/core/renderer/core/pass.ts:602
Returns void

getBinding

getBinding(name: string): undefined | number

- Defined in cocos/core/renderer/core/pass.ts:267
获取指定 uniform 的 binding。

Parameters
- name: string
  
  目标 uniform 名。
Returns undefined | number

getHandle

getHandle(name: string, offset?: number, targetType?: GFXType): number | undefined

- Defined in cocos/core/renderer/core/pass.ts:255
获取指定 UBO 成员，或其更具体分量的读写句柄。默认以成员自身的类型为目标读写类型（即读写时必须传入与成员类型相同的变量）。
example
```
// say 'pbrParams' is a uniform vec4
const hParams = pass.getHandle('pbrParams'); // get the default handle
pass.setUniform(hAlbedo, cc.v3(1, 0, 0)); // wrong! pbrParams.w is NaN now
// say 'albedoScale' is a uniform vec4, and we only want to modify the w component in the form of a single float
const hThreshold = pass.getHandle('albedoScale', 3, cc.GFXType.FLOAT);
pass.setUniform(hThreshold, 0.5); // now, albedoScale.w = 0.5
```
Parameters
- name: string
  
  Name of the target UBO member.
- Default value offset: number = 0
  
  Channel offset into the member.
- Default value targetType: GFXType = GFXType.UNKNOWN
  
  Target type of the handle, i.e. the type of data when read/write to it.
Returns number | undefined

getUniform

getUniform(handle: number, out: MaterialProperty): any

- Defined in cocos/core/renderer/core/pass.ts:294
获取指定普通向量类 uniform 的值。

Parameters
- handle: number
  
  目标 uniform 的 handle。
- out: MaterialProperty
  
  输出向量。
Returns any

initialize

initialize(info: IPassInfoFull): void

- Defined in cocos/core/renderer/core/pass.ts:230
根据指定参数初始化当前 pass，shader 会在这一阶段就尝试编译。

Parameters
- info: IPassInfoFull
Returns void

overridePipelineStates

overridePipelineStates(original: IPassInfo, overrides: PassOverrides): void

- Defined in cocos/core/renderer/core/pass.ts:387
重载当前所有管线状态。

Parameters
- original: IPassInfo
  
  原始管线状态。
- overrides: PassOverrides
Returns void

resetTexture

resetTexture(name: string): void

- Defined in cocos/core/renderer/core/pass.ts:458
重置指定贴图为 Effect 默认值。

Parameters
- name: string
Returns void

resetTextures

resetTextures(): void

- Defined in cocos/core/renderer/core/pass.ts:505
重置所有 texture 和 sampler 为初始默认值。

Returns void

resetUBOs

resetUBOs(): void

- Defined in cocos/core/renderer/core/pass.ts:482
重置所有 UBO 为默认值。

Returns void

resetUniform

resetUniform(name: string): void

- Defined in cocos/core/renderer/core/pass.ts:442
重置指定（非数组） Uniform 为 Effect 默认值。

Parameters
- name: string
Returns void

setDynamicState

setDynamicState(state: GFXDynamicState, value: any): void

- Defined in cocos/core/renderer/core/pass.ts:375
设置运行时 pass 内可动态更新的管线状态属性。

Parameters
- state: GFXDynamicState
  
  目标管线状态。
- value: any
  
  目标值。
Returns void

setUniform

setUniform(handle: number, value: MaterialProperty): void

- Defined in cocos/core/renderer/core/pass.ts:279
设置指定普通向量类 uniform 的值，如果需要频繁更新请尽量使用此接口。

Parameters
- handle: number
  
  目标 uniform 的 handle。
- value: MaterialProperty
  
  目标值。
Returns void

setUniformArray

setUniformArray(handle: number, value: MaterialProperty[]): void

- Defined in cocos/core/renderer/core/pass.ts:308
设置指定数组类 uniform 的值，如果需要频繁更新请尽量使用此接口。

Parameters
- handle: number
  
  目标 uniform 的 handle。
- value: MaterialProperty[]
  
  目标值。
Returns void

tryCompile

tryCompile(): null | false | true

- Defined in cocos/core/renderer/core/pass.ts:517
尝试编译 shader 并获取相关资源引用。

Returns null | false | true

update

update(): void

- Defined in cocos/core/renderer/core/pass.ts:395
更新当前 Uniform 数据。

Returns void

Static fillinPipelineInfo

fillinPipelineInfo(target: Pass, info: PassOverrides): void

- Defined in cocos/core/renderer/core/pass.ts:151
Parameters
- target: Pass
- info: PassOverrides
Returns void

Static getPSOHash

getPSOHash(psoInfo: IPSOHashInfo): number

- Defined in cocos/core/renderer/core/pass.ts:178
根据指定 PSO 信息计算 hash

Parameters
- psoInfo: IPSOHashInfo
  
  用于计算 PSO hash 的最小必要信息
Returns number

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

device: GFXDevice

Returns Pass

Properties

Protected _batchedBuffer

Protected _bindings

Protected _blocks

Protected _bs

Protected _buffers

Protected _customizations

Protected _defines

Protected _device

Protected _dss

Protected _dynamicStates

Protected _dynamics

Protected _handleMap

Protected _hash

Protected _idxInTech

Protected _inputState

Protected _instancedBuffer

Protected _phase

Protected _primitive

Protected _priority

Protected _programName

Protected _properties

Protected _renderPass

Protected _resources

Protected _rs

Protected _samplers

Protected _shader

Protected _shaderInfo

Protected _stage

Protected _textureViews

Static getBindingFromHandle

Static getBindingTypeFromHandle

Static Protected getOffsetFromHandle

Static getTypeFromHandle

Accessors

batchedBuffer

Returns null | BatchedBuffer

bindings

Returns IGFXBinding[]

blendState

Returns GFXBlendState

blocks

Returns IBlock[]

customizations

Returns string[]

defines

Returns IDefineMap

depthStencilState

Returns GFXDepthStencilState

device

Returns GFXDevice

dynamicStates

Returns GFXDynamicState[]

dynamics

Returns IPassDynamics

hash

Returns number

idxInTech

Returns number

inputState

Returns GFXInputState

instancedBuffer

Returns null | InstancedBuffer

phase

Returns number

primitive

Returns GFXPrimitiveMode

priority

Returns RenderPriority