pipeline | Creator3dAPI

Index

References

Modules

forward

Enumerations

Interfaces

Functions

Object literals

References

ForwardFlow

Re-exports ForwardFlow

ForwardPipeline

Re-exports ForwardPipeline

ForwardStage

Re-exports ForwardStage

RenderFlow

Re-exports RenderFlow

RenderPipeline

Re-exports RenderPipeline

RenderStage

Re-exports RenderStage

RenderView

Re-exports RenderView

RenderWindow

Re-exports RenderWindow

ShadowFlow

Re-exports ShadowFlow

ShadowStage

Re-exports ShadowStage

UIFlow

Re-exports UIFlow

UIStage

Re-exports UIStage

Variables

Const CAMERA_DEFAULT_MASK

CAMERA_DEFAULT_MASK: number = Layers.makeMaskExclude([Layers.BitMask.UI_2D, Layers.BitMask.GIZMOS, Layers.BitMask.EDITOR,Layers.BitMask.SCENE_GIZMO, Layers.BitMask.PROFILER])

Const CAMERA_EDITOR_MASK

CAMERA_EDITOR_MASK: number = Layers.makeMaskExclude([Layers.BitMask.UI_2D, Layers.BitMask.PROFILER])

Const GLOBAL_SAMPLER_COUNT

GLOBAL_SAMPLER_COUNT: number = PipelineGlobalBindings.COUNT - GLOBAL_UBO_COUNT

Const GLOBAL_UBO_COUNT

GLOBAL_UBO_COUNT: SAMPLER_ENVIRONMENT = PipelineGlobalBindings.SAMPLER_ENVIRONMENT

Const INST_JOINT_ANIM_INFO

INST_JOINT_ANIM_INFO: "a_jointAnimInfo" = "a_jointAnimInfo"

Const INST_MAT_WORLD

INST_MAT_WORLD: "a_matWorld0" = "a_matWorld0"

Const JOINT_UNIFORM_CAPACITY

JOINT_UNIFORM_CAPACITY: 30 = 30

Const LOCAL_SAMPLER_COUNT

LOCAL_SAMPLER_COUNT: number = ModelLocalBindings.COUNT - LOCAL_UBO_COUNT

Const LOCAL_UBO_COUNT

LOCAL_UBO_COUNT: SAMPLER_JOINTS = ModelLocalBindings.SAMPLER_JOINTS

Const MODEL_ALWAYS_MASK

MODEL_ALWAYS_MASK: number = Layers.Enum.ALL

Const PIPELINE_FLOW_FORWARD

PIPELINE_FLOW_FORWARD: string = "ForwardFlow"

Const PIPELINE_FLOW_SHADOW

PIPELINE_FLOW_SHADOW: string = "ShadowFlow"

Const PIPELINE_FLOW_SMAA

PIPELINE_FLOW_SMAA: string = "SMAAFlow"

Const PIPELINE_FLOW_TONEMAP

PIPELINE_FLOW_TONEMAP: string = "ToneMapFlow"

Const _dynamicOffsets

_dynamicOffsets: number[] = []

Const _lightIndices

_lightIndices: number[] = []

Const _lightPassPool

_lightPassPool: Pool<IAdditiveLightPass> = new Pool<IAdditiveLightPass>(() => ({ subModel: null!, passIdx: -1, dynamicOffsets: [] }), 16)

Const _phaseID

_phaseID: number = getPhaseID('forward-add')

Const _sphere

_sphere: sphere = sphere.create(0, 0, 0, 1)

Const _vec4Array

_vec4Array: Float32Array = new Float32Array(4)

Const bindingMappingInfo

bindingMappingInfo: GFXBindingMappingInfo = new GFXBindingMappingInfo()

Const colors

colors: GFXColor[] = [ { r: 0, g: 0, b: 0, a: 1 } ]

Const colors

colors: GFXColor[] = []

Const matShadowView

matShadowView: Mat4 = new Mat4()

Const matShadowViewProj

matShadowViewProj: Mat4 = new Mat4()

Const pipeline

pipeline: pipeline = pipelineDefine

Const vec4

vec4: Vec4 = new Vec4()

Functions

LinearToSRGB

LinearToSRGB(out: GFXColor, linear: GFXColor): void

- Defined in cocos/core/pipeline/pipeline-funcs.ts:29
Convert color in linear space to SRGB space

Parameters
- out: GFXColor
  
  Output color object
- linear: GFXColor
  
  Color value in linear space
Returns void

SRGBToLinear

SRGBToLinear(out: GFXColor, gamma: GFXColor): void

- Defined in cocos/core/pipeline/pipeline-funcs.ts:14
Convert color in SRGB space to linear space

Parameters
- out: GFXColor
  
  Output color object
- gamma: GFXColor
  
  Gamma value in SRGB space
Returns void

cullSphereLight

cullSphereLight(light: SphereLight, model: Model): boolean

- Defined in cocos/core/pipeline/render-additive-light-queue.ts:37
Parameters
- light: SphereLight
- model: Model
Returns boolean

cullSpotLight

cullSpotLight(light: SpotLight, model: Model): boolean

- Defined in cocos/core/pipeline/render-additive-light-queue.ts:41
Parameters
- light: SpotLight
- model: Model
Returns boolean

getLightPassIndex

getLightPassIndex(subModels: SubModel[]): number

- Defined in cocos/core/pipeline/render-additive-light-queue.ts:47
Parameters
- subModels: SubModel[]
Returns number

Const isBuiltinBinding

isBuiltinBinding(set: number): boolean

- Defined in cocos/core/pipeline/define.ts:126
Check whether the given uniform binding is a builtin binding

Parameters
- set: number
Returns boolean

opaqueCompareFn

opaqueCompareFn(a: IRenderPass, b: IRenderPass): number

- Defined in cocos/core/pipeline/render-queue.ts:19
Comparison sorting function. Opaque objects are sorted by priority -> depth front to back -> shader ID.

Parameters
- a: IRenderPass
- b: IRenderPass
Returns number

transparentCompareFn

transparentCompareFn(a: IRenderPass, b: IRenderPass): number

- Defined in cocos/core/pipeline/render-queue.ts:27
Comparison sorting function. Transparent objects are sorted by priority -> depth back to front -> shader ID.

Parameters
- a: IRenderPass
- b: IRenderPass
Returns number

Object literals

Const UNIFORMENVIRONMENT

UNIFORMENVIRONMENT: object

binding

binding: PipelineGlobalBindings = PipelineGlobalBindings.SAMPLER_ENVIRONMENT

count

descriptorType

descriptorType: SAMPLER = GFXDescriptorType.SAMPLER

name

set

set: SetIndex = SetIndex.GLOBAL

stageFlags

stageFlags: FRAGMENT = GFXShaderStageFlagBit.FRAGMENT

type

type: SAMPLER_CUBE = GFXType.SAMPLER_CUBE

Const UNIFORMSHADOWMAP

UNIFORMSHADOWMAP: object

binding

binding: PipelineGlobalBindings = PipelineGlobalBindings.SAMPLER_SHADOWMAP

count

descriptorType

descriptorType: SAMPLER = GFXDescriptorType.SAMPLER

name

set

set: SetIndex = SetIndex.GLOBAL

stageFlags

stageFlags: FRAGMENT = GFXShaderStageFlagBit.FRAGMENT

type

type: SAMPLER2D = GFXType.SAMPLER2D

Const UniformJointTexture

UniformJointTexture: object

en: The sampler for joint texture
zh: 骨骼纹理采样器。

binding

binding: ModelLocalBindings = ModelLocalBindings.SAMPLER_JOINTS

count

descriptorType

descriptorType: SAMPLER = GFXDescriptorType.SAMPLER

name

set

set: SetIndex = SetIndex.LOCAL

stageFlags

stageFlags: VERTEX = GFXShaderStageFlagBit.VERTEX

type

type: SAMPLER2D = GFXType.SAMPLER2D

Const UniformLightingMapSampler

UniformLightingMapSampler: object

en: The sampler for light map texture
zh: 光照图纹理采样器。

binding

binding: ModelLocalBindings = ModelLocalBindings.SAMPLER_LIGHTING_MAP

count

descriptorType

descriptorType: SAMPLER = GFXDescriptorType.SAMPLER

name

set

set: SetIndex = SetIndex.LOCAL

stageFlags

stageFlags: FRAGMENT = GFXShaderStageFlagBit.FRAGMENT

type

type: SAMPLER2D = GFXType.SAMPLER2D

Const UniformNormalMorphTexture

UniformNormalMorphTexture: object

en: The sampler for morph texture of normal
zh: 法线形变纹理采样器。

binding

binding: ModelLocalBindings = ModelLocalBindings.SAMPLER_MORPH_NORMAL

count

descriptorType

descriptorType: SAMPLER = GFXDescriptorType.SAMPLER

name

set

set: SetIndex = SetIndex.LOCAL

stageFlags

stageFlags: VERTEX = GFXShaderStageFlagBit.VERTEX

type

type: SAMPLER2D = GFXType.SAMPLER2D

Const UniformPositionMorphTexture

UniformPositionMorphTexture: object

en: The sampler for morph texture of position
zh: 位置形变纹理采样器。

binding

binding: ModelLocalBindings = ModelLocalBindings.SAMPLER_MORPH_POSITION

count

descriptorType

descriptorType: SAMPLER = GFXDescriptorType.SAMPLER

name

set

set: SetIndex = SetIndex.LOCAL

stageFlags

stageFlags: VERTEX = GFXShaderStageFlagBit.VERTEX

type

type: SAMPLER2D = GFXType.SAMPLER2D

Const UniformSpriteSampler

UniformSpriteSampler: object

en: The sampler for UI sprites.
zh: UI 精灵纹理采样器。

binding

binding: ModelLocalBindings = ModelLocalBindings.SAMPLER_SPRITE

count

descriptorType

descriptorType: SAMPLER = GFXDescriptorType.SAMPLER

name

set

set: SetIndex = SetIndex.LOCAL

stageFlags

stageFlags: FRAGMENT = GFXShaderStageFlagBit.FRAGMENT

type

type: SAMPLER2D = GFXType.SAMPLER2D

Const UniformTangentMorphTexture

UniformTangentMorphTexture: object

en: The sampler for morph texture of tangent
zh: 切线形变纹理采样器。

binding

binding: ModelLocalBindings = ModelLocalBindings.SAMPLER_MORPH_TANGENT

count

descriptorType

descriptorType: SAMPLER = GFXDescriptorType.SAMPLER

name

set

set: SetIndex = SetIndex.LOCAL

stageFlags

stageFlags: VERTEX = GFXShaderStageFlagBit.VERTEX

type

type: SAMPLER2D = GFXType.SAMPLER2D

Const globalDescriptorSetLayout

globalDescriptorSetLayout: object

bindings

bindings: never[] = []

record

record: {}

Type declaration

Const localDescriptorSetLayout

localDescriptorSetLayout: object

bindings

bindings: never[] = []

record

record: {}

Index

References

Modules

Enumerations

Classes

Interfaces

Variables

Functions

Object literals

References

ForwardFlow

ForwardPipeline

ForwardStage

RenderFlow

RenderPipeline

RenderStage

RenderView

RenderWindow

ShadowFlow

ShadowStage

UIFlow

UIStage

Variables

Const CAMERA_DEFAULT_MASK

Const CAMERA_EDITOR_MASK

Const GLOBAL_SAMPLER_COUNT

Const GLOBAL_UBO_COUNT

Const INST_JOINT_ANIM_INFO

Const INST_MAT_WORLD

Const JOINT_UNIFORM_CAPACITY

Const LOCAL_SAMPLER_COUNT

Const LOCAL_UBO_COUNT

Const MODEL_ALWAYS_MASK

Const PIPELINE_FLOW_FORWARD

Const PIPELINE_FLOW_SHADOW

Const PIPELINE_FLOW_SMAA

Const PIPELINE_FLOW_TONEMAP

Const _dynamicOffsets

Const _lightIndices

Const _lightPassPool

Const _phaseID

Const _sphere

Const _vec4Array

Const bindingMappingInfo

Const colors

Const colors

Const matShadowView

Const matShadowViewProj

Const pipeline

Const vec4

Functions

LinearToSRGB

Parameters

out: GFXColor

linear: GFXColor

Returns void

SRGBToLinear

Parameters

out: GFXColor

gamma: GFXColor

Returns void

cullSphereLight

Parameters

light: SphereLight

model: Model

Returns boolean

cullSpotLight

Parameters

light: SpotLight

model: Model

Returns boolean

getLightPassIndex

Parameters

subModels: SubModel[]

Returns number

Const isBuiltinBinding

Parameters

set: number

Returns boolean

opaqueCompareFn