PassInstance | Creator3dAPI

A pass instance defines an variant version of the Pass

Hierarchy

Pass
- PassInstance

Index

Type aliases

Constructors

constructor

Accessors

Type aliases

Static PropertyType

PropertyType: typeof PropertyType

Static fillPipelineInfo

fillPipelineInfo: typeof fillPipelineInfo

Static getBindingFromHandle

getBindingFromHandle: typeof getBindingFromHandle

Static getOffsetFromHandle

getOffsetFromHandle: typeof getOffsetFromHandle

Static getPassHash

getPassHash: typeof getPassHash

Static getPropertyTypeFromHandle

getPropertyTypeFromHandle: typeof getPropertyTypeFromHandle

Static getTypeFromHandle

getTypeFromHandle: typeof getTypeFromHandle

Constructors

constructor

newPassInstance(parent: Pass, owner: MaterialInstance): PassInstance

Overrides Pass.constructor
- Defined in cocos/core/renderer/core/pass-instance.ts:52
Parameters
- parent: Pass
- owner: MaterialInstance
Returns PassInstance

Properties

Protected _blocks

_blocks: Float32Array[] = []

Protected _buffers

_buffers: GFXBuffer[] = []

Protected _defines

_defines: MacroRecord

Protected _descriptorSet

_descriptorSet: GFXDescriptorSet = null!

Protected _device

_device: GFXDevice

Private _dontNotify

_dontNotify: boolean = false

Protected _dynamics

_dynamics: IPassDynamics

Protected _hShaderDefault

_hShaderDefault: ShaderHandle = NULL_HANDLE

Protected _handle

_handle: PassHandle = NULL_HANDLE

Private _owner

_owner: MaterialInstance

Private _parent

_parent: Pass

Protected _passIndex

_passIndex: number = 0

Protected _programName

_programName: string = ""

Protected _properties

_properties: Record<string, IPropertyInfo>

Protected _propertyHandleMap

_propertyHandleMap: Record<string, number>

Protected _propertyIndex

_propertyIndex: number = 0

Protected _root

_root: Root

Protected _rootBlock

_rootBlock: ArrayBuffer | null = null

Protected _rootBuffer

_rootBuffer: GFXBuffer | null = null

Protected _rootBufferDirty

_rootBufferDirty: boolean = false

Protected _shaderInfo

_shaderInfo: IProgramInfo = null!

Accessors

batchingScheme

get batchingScheme(): BatchingSchemes

Inherited from PassInstance.batchingScheme
- Defined in cocos/core/renderer/core/pass.ts:640
Returns BatchingSchemes

blendState

get blendState(): GFXBlendState

Inherited from PassInstance.blendState
- Defined in cocos/core/renderer/core/pass.ts:638
Returns GFXBlendState

blocks

get blocks(): Float32Array[]

Inherited from PassInstance.blocks
- Defined in cocos/core/renderer/core/pass.ts:629
Returns Float32Array[]

defines

get defines(): {}

Inherited from PassInstance.defines
- Defined in cocos/core/renderer/core/pass.ts:624
Returns {}

depthStencilState

get depthStencilState(): GFXDepthStencilState

Inherited from PassInstance.depthStencilState
- Defined in cocos/core/renderer/core/pass.ts:637
Returns GFXDepthStencilState

descriptorSet

get descriptorSet(): GFXDescriptorSet

Inherited from PassInstance.descriptorSet
- Defined in cocos/core/renderer/core/pass.ts:641
Returns GFXDescriptorSet

device

get device(): GFXDevice

Inherited from PassInstance.device
- Defined in cocos/core/renderer/core/pass.ts:619
Returns GFXDevice

dynamicStates

get dynamicStates(): GFXDynamicStateFlagBit

Inherited from PassInstance.dynamicStates
- Defined in cocos/core/renderer/core/pass.ts:639
Returns GFXDynamicStateFlagBit

dynamics

get dynamics(): IPassDynamics

Inherited from PassInstance.dynamics
- Defined in cocos/core/renderer/core/pass.ts:628
Returns IPassDynamics

handle

get handle(): IHandle<PASS>

Inherited from PassInstance.handle
- Defined in cocos/core/renderer/core/pass.ts:631
Returns IHandle<PASS>

hash

get hash(): number

Inherited from PassInstance.hash
- Defined in cocos/core/renderer/core/pass.ts:642
Returns number

parent

get parent(): Pass

- Defined in cocos/core/renderer/core/pass-instance.ts:48
The parent pass

Returns Pass

passIndex

get passIndex(): number

Inherited from PassInstance.passIndex
- Defined in cocos/core/renderer/core/pass.ts:625
Returns number

phase

get phase(): number

Inherited from PassInstance.phase
- Defined in cocos/core/renderer/core/pass.ts:635
Returns number

primitive

get primitive(): GFXPrimitiveMode

Inherited from PassInstance.primitive
- Defined in cocos/core/renderer/core/pass.ts:633
Returns GFXPrimitiveMode

priority

get priority(): number

Inherited from PassInstance.priority
- Defined in cocos/core/renderer/core/pass.ts:632
Returns number

program

get program(): string

Inherited from PassInstance.program
- Defined in cocos/core/renderer/core/pass.ts:622
Returns string

properties

get properties(): {}

Inherited from PassInstance.properties
- Defined in cocos/core/renderer/core/pass.ts:623
Returns {}

propertyIndex

get propertyIndex(): number

Inherited from PassInstance.propertyIndex
- Defined in cocos/core/renderer/core/pass.ts:626
Returns number

rasterizerState

get rasterizerState(): GFXRasterizerState

Inherited from PassInstance.rasterizerState
- Defined in cocos/core/renderer/core/pass.ts:636
Returns GFXRasterizerState

root

get root(): Root

Inherited from PassInstance.root
- Defined in cocos/core/renderer/core/pass.ts:618
Returns Root

setLayouts

get setLayouts(): GFXDescriptorSetLayout[]

Inherited from PassInstance.setLayouts
- Defined in cocos/core/renderer/core/pass.ts:621
Returns GFXDescriptorSetLayout[]

shaderInfo

get shaderInfo(): IProgramInfo

Inherited from PassInstance.shaderInfo
- Defined in cocos/core/renderer/core/pass.ts:620
Returns IProgramInfo

stage

get stage(): RenderPassStage

Inherited from PassInstance.stage
- Defined in cocos/core/renderer/core/pass.ts:634
Returns RenderPassStage

Methods

Protected doInit

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

Inherited from PassInstance.doInit
- Defined in cocos/core/renderer/core/pass.ts:524
Parameters
- info: IPassInfoFull
- Default value copyDefines: boolean = false
Returns void

Protected onStateChange

_onStateChange(): void

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

Protected syncBatchingScheme

_syncBatchingScheme(): void

Overrides Pass.syncBatchingScheme
- Defined in cocos/core/renderer/core/pass-instance.ts:128
Returns void

beginChangeStatesSilently

beginChangeStatesSilently(): void

Overrides Pass.beginChangeStatesSilently
- Defined in cocos/core/renderer/core/pass-instance.ts:116
Prepare to change states of the pass and do not notify the material to rebuild the pipeline state object

Returns void

bindSampler

bindSampler(binding: number, value: GFXSampler, index?: undefined | number): void

Inherited from PassInstance.bindSampler
- Defined in cocos/core/renderer/core/pass.ts:318
Bind a GFXSampler the the given uniform binding

Parameters
- binding: number
  
  The binding for target uniform of sampler type
- value: GFXSampler
  
  Target sampler
- Optional index: undefined | number
Returns void

bindTexture

bindTexture(binding: number, value: GFXTexture, index?: undefined | number): void

Inherited from PassInstance.bindTexture
- Defined in cocos/core/renderer/core/pass.ts:308
Bind a GFXTexture the the given uniform binding

Parameters
- binding: number
  
  The binding for target uniform of texture type
- value: GFXTexture
  
  Target texture
- Optional index: undefined | number
Returns void

destroy

destroy(): void

Inherited from PassInstance.destroy
- Defined in cocos/core/renderer/core/pass.ts:360
Destroy the current pass.

Returns void

endChangeStatesSilently

endChangeStatesSilently(): void

Overrides Pass.endChangeStatesSilently
- Defined in cocos/core/renderer/core/pass-instance.ts:124
End the silent states changing process, all state changes will be notified.

Returns void

getBinding

getBinding(name: string): number

Inherited from PassInstance.getBinding
- Defined in cocos/core/renderer/core/pass.ts:248
Gets the uniform binding with its name

Parameters
- name: string
  
  The name of target uniform
Returns number

getHandle

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

Get the handle of a UBO member, or specific channels of it.

example

import { Vec3, GFXType } from 'cc';
// say 'pbrParams' is a uniform vec4
const hParams = pass.getHandle('pbrParams'); // get the default handle
pass.setUniform(hAlbedo, new Vec3(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, 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

getShaderVariant

getShaderVariant(patches?: IMacroPatch[] | null): ShaderHandle

Inherited from PassInstance.getShaderVariant
- Defined in cocos/core/renderer/core/pass.ts:480
Gets the shader variant of the current pass and given macro patches

Parameters
- Default value patches: IMacroPatch[] | null = null
  
  The macro patches
Returns ShaderHandle

getUniform

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

Inherited from PassInstance.getUniform
- Defined in cocos/core/renderer/core/pass.ts:275
Gets a uniform's value.

Parameters
- handle: number
  
  The handle for the target uniform
- out: MaterialProperty
  
  The output property to store the result
Returns any

initialize

initialize(info: IPassInfoFull): void

Inherited from PassInstance.initialize
- Defined in cocos/core/renderer/core/pass.ts:211
Initialize the pass with given pass info, shader will be compiled in the init process

Parameters
- info: IPassInfoFull
Returns void

overridePipelineStates

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

Overrides Pass.overridePipelineStates
- Defined in cocos/core/renderer/core/pass-instance.ts:88
Override pipeline states with the given pass override info. This won't affect the original pass

Parameters
- original: IPassInfo
  
  The original pass info
- overrides: PassOverrides
Returns void

resetTexture

resetTexture(name: string, index?: undefined | number): void

Inherited from PassInstance.resetTexture
- Defined in cocos/core/renderer/core/pass.ts:407
Resets the value of the given texture by name to the default value in EffectAsset.

Parameters
- name: string
- Optional index: undefined | number
Returns void

resetTextures

resetTextures(): void

Inherited from PassInstance.resetTextures
- Defined in cocos/core/renderer/core/pass.ts:450
Resets all textures and samplers to the default values in EffectAsset

Returns void

resetUBOs

resetUBOs(): void

Inherited from PassInstance.resetUBOs
- Defined in cocos/core/renderer/core/pass.ts:427
Resets all uniform buffer objects to the default values in EffectAsset

Returns void

resetUniform

resetUniform(name: string): void

Inherited from PassInstance.resetUniform
- Defined in cocos/core/renderer/core/pass.ts:390
Resets the value of the given uniform by name to the default value in EffectAsset. This method does not support array type uniform.

Parameters
- name: string
Returns void

setDynamicState

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

Inherited from PassInstance.setDynamicState
- Defined in cocos/core/renderer/core/pass.ts:328
Sets the dynamic pipeline state property at runtime

Parameters
- state: GFXDynamicStateFlagBit
  
  Target dynamic state
- value: any
  
  Target value
Returns void

setUniform

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

Inherited from PassInstance.setUniform
- Defined in cocos/core/renderer/core/pass.ts:260
Sets a vector type uniform value, if a uniform requires frequent update, please use this method.

Parameters
- handle: number
  
  The handle for the target uniform
- value: MaterialProperty
  
  New value
Returns void

setUniformArray

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

Inherited from PassInstance.setUniformArray
- Defined in cocos/core/renderer/core/pass.ts:289
Sets an array type uniform value, if a uniform requires frequent update, please use this method.

Parameters
- handle: number
  
  The handle for the target uniform
- value: MaterialProperty[]
  
  New value
Returns void

tryCompile

tryCompile(defineOverrides?: MacroRecord): null | false | true

Overrides Pass.tryCompile
- Defined in cocos/core/renderer/core/pass-instance.ts:101
Parameters
- Optional defineOverrides: MacroRecord
Returns null | false | true

update

update(): void

Inherited from PassInstance.update
- Defined in cocos/core/renderer/core/pass.ts:348
Update the current uniforms data.

Returns void

Hierarchy

Index

Type aliases

Constructors

Properties

Accessors

Methods

Type aliases

Static PropertyType

Static fillPipelineInfo

Static getBindingFromHandle

Static getOffsetFromHandle

Static getPassHash

Static getPropertyTypeFromHandle

Static getTypeFromHandle

Constructors

constructor

Parameters

parent: Pass

owner: MaterialInstance

Returns PassInstance

Properties

Protected _blocks

Protected _buffers

Protected _defines

Protected _descriptorSet

Protected _device

Private _dontNotify

Protected _dynamics

Protected _hShaderDefault

Protected _handle

Private _owner

Private _parent

Protected _passIndex

Protected _programName

Protected _properties

Protected _propertyHandleMap

Protected _propertyIndex

Protected _root

Protected _rootBlock

Protected _rootBuffer

Protected _rootBufferDirty

Protected _shaderInfo

Accessors

batchingScheme

Returns BatchingSchemes

blendState

Returns GFXBlendState

blocks

Returns Float32Array[]

defines

Returns {}

depthStencilState

Returns GFXDepthStencilState

descriptorSet

Returns GFXDescriptorSet

device

Returns GFXDevice

dynamicStates

Returns GFXDynamicStateFlagBit

dynamics

Returns IPassDynamics

handle

Returns IHandle<PASS>

hash

Returns number

parent

Returns Pass

passIndex

Returns number

phase

Returns number

primitive

Returns GFXPrimitiveMode

priority

Returns number

program

Returns string

properties

Returns {}