Pass | Creator3dAPI

Render pass, store actual resources for the rendering process

Hierarchy

Pass
- PassInstance

Index

Constructors

constructor

Accessors

Constructors

constructor

newPass(root: Root): Pass

- Defined in cocos/core/renderer/core/pass.ts:200
Parameters
- root: Root
Returns Pass

Properties

Protected _blocks

_blocks: Float32Array[] = []

Protected _buffers

_buffers: GFXBuffer[] = []

Protected _defines

_defines: MacroRecord

Protected _descriptorSet

_descriptorSet: GFXDescriptorSet = null!

Protected _device

_device: GFXDevice

Protected _dynamics

_dynamics: IPassDynamics

Protected _hShaderDefault

_hShaderDefault: ShaderHandle = NULL_HANDLE

Protected _handle

_handle: PassHandle = NULL_HANDLE

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!

Static PropertyType

PropertyType: typeof PropertyType = PropertyType

The binding type enums of the property

Static getBindingFromHandle

getBindingFromHandle: typeof getBindingFromHandle = getBindingFromHandle

Gets the binding with handle

Static Protected getOffsetFromHandle

getOffsetFromHandle: typeof getOffsetFromHandle = getOffsetFromHandle

Static getPropertyTypeFromHandle

getPropertyTypeFromHandle: typeof getPropertyTypeFromHandle = getPropertyTypeFromHandle

Gets the binding type of the property with handle

Static getTypeFromHandle

getTypeFromHandle: typeof getTypeFromHandle = getTypeFromHandle

Gets the type of member in uniform buffer object with the handle

Accessors

batchingScheme

get batchingScheme(): BatchingSchemes

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

blendState

get blendState(): GFXBlendState

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

blocks

get blocks(): Float32Array[]

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

defines

get defines(): {}

- Defined in cocos/core/renderer/core/pass.ts:624
Returns {}

depthStencilState

get depthStencilState(): GFXDepthStencilState

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

descriptorSet

get descriptorSet(): GFXDescriptorSet

- Defined in cocos/core/renderer/core/pass.ts:641
Returns GFXDescriptorSet

device

get device(): GFXDevice

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

dynamicStates

get dynamicStates(): GFXDynamicStateFlagBit

- Defined in cocos/core/renderer/core/pass.ts:639
Returns GFXDynamicStateFlagBit

dynamics

get dynamics(): IPassDynamics

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

handle

get handle(): IHandle<PASS>

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

hash

get hash(): number

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

passIndex

get passIndex(): number

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

phase

get phase(): number

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

primitive

get primitive(): GFXPrimitiveMode

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

priority

get priority(): number

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

program

get program(): string

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

properties

get properties(): {}

- Defined in cocos/core/renderer/core/pass.ts:623
Returns {}

propertyIndex

get propertyIndex(): number

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

rasterizerState

get rasterizerState(): GFXRasterizerState

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

root

get root(): Root

- Defined in cocos/core/renderer/core/pass.ts:618
Returns Root

setLayouts

get setLayouts(): GFXDescriptorSetLayout[]

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

shaderInfo

get shaderInfo(): IProgramInfo

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

stage

get stage(): RenderPassStage

- Defined in cocos/core/renderer/core/pass.ts:634
Returns RenderPassStage

Methods

Protected doInit

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

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

Protected syncBatchingScheme

_syncBatchingScheme(): void

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

Private beginChangeStatesSilently

beginChangeStatesSilently(): void

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

bindSampler

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

- 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

- 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

- Defined in cocos/core/renderer/core/pass.ts:360
Destroy the current pass.

Returns void

Private endChangeStatesSilently

endChangeStatesSilently(): void

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

getBinding

getBinding(name: string): number

- 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

- 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

- 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

- 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

- Defined in cocos/core/renderer/core/pass.ts:340
Override all pipeline states with the given pass override info.

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

resetTexture

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

- 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

- 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

- 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

- 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

- 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

- 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

- 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(): null | false | true

- Defined in cocos/core/renderer/core/pass.ts:464
Try to compile the shader and retrieve related resources references.

Returns null | false | true

update

update(): void

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

Returns void

Static fillPipelineInfo

fillPipelineInfo(hPass: PassHandle, info: PassOverrides): void

- Defined in cocos/core/renderer/core/pass.ts:141
Fill a pass represented by the given pass handle with the given override info

Parameters
- hPass: PassHandle
  
  The pass handle point to the pass
- info: PassOverrides
  
  The pass override info
Returns void

Static getPassHash

getPassHash(hPass: PassHandle, hShader: ShaderHandle): number

- Defined in cocos/core/renderer/core/pass.ts:169
Get pass hash value by Pass hash information.

Parameters
- hPass: PassHandle
  
  Handle of the pass info used to compute hash value.
- hShader: ShaderHandle
Returns number

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

root: Root

Returns Pass

Properties

Protected _blocks

Protected _buffers

Protected _defines

Protected _descriptorSet

Protected _device

Protected _dynamics

Protected _hShaderDefault

Protected _handle

Protected _passIndex

Protected _programName

Protected _properties

Protected _propertyHandleMap

Protected _propertyIndex

Protected _root

Protected _rootBlock

Protected _rootBuffer

Protected _rootBufferDirty

Protected _shaderInfo

Static PropertyType

Static getBindingFromHandle

Static Protected getOffsetFromHandle

Static getPropertyTypeFromHandle

Static getTypeFromHandle

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

passIndex

Returns number

phase

Returns number

primitive

Returns GFXPrimitiveMode

priority

Returns number

program

Returns string

properties

Returns {}

propertyIndex

Returns number

rasterizerState

Returns GFXRasterizerState

root

Returns Root

setLayouts

Returns GFXDescriptorSetLayout[]

shaderInfo

Returns IProgramInfo