Class PipelineEntry

constructor

• new PipelineEntry(parameters): PipelineEntry

• PipelineEntry constructor

  Parameters

  • parameters: PipelineEntryParams

    parameters used to create this PipelineEntry

  Returns PipelineEntry

type

renderer

Readonly index

layout

pipeline

status

options

bindGroups

ready

• get ready(): boolean

• Get whether the pipeline is ready, i.e. successfully compiled

  Returns boolean

canCompile

• get canCompile(): boolean

• Get whether the pipeline is ready to be compiled, i.e. we have not already tried to compile it, and it's not currently compiling neither

  Returns boolean

createShaderModule

• createShaderModule(parameters): GPUShaderModule

• Create a GPUShaderModule

  Parameters

  • parameters: {
        code: string;
        type: MaterialShadersType;
    }

    Parameters used

    • code: string

      patched WGSL code string

    • type: MaterialShadersType

      shader type

  Returns GPUShaderModule

  • compiled GPUShaderModule if successful

createShaders

• createShaders(): void

• Create the PipelineEntry shaders

  Returns void

createPipelineLayout

• createPipelineLayout(): void

• Create the pipeline entry layout

  Returns void

createPipelineDescriptor

• createPipelineDescriptor(): void

• Create the PipelineEntry descriptor

  Returns void

flushPipelineEntry

• flushPipelineEntry(newBindGroups?): void

• Flush a PipelineEntry, i.e. reset its bind groups, layout and descriptor and recompile the pipeline Used when one of the bind group or rendering property has changed

  Parameters

  • newBindGroups: AllowedBindGroups[] = []

    new bind groups in case they have changed

  Returns void

compilePipelineEntry

• compilePipelineEntry(): void

• Set up a pipeline by creating the shaders, the layout and the descriptor

  Returns void