Class: PipelineFactory

Defined in: modules/core/src/api/factories/pipeline-factory.ts:27

Efficiently creates / caches pipelines

Constructors

Constructor

new PipelineFactory(device): PipelineFactory

Defined in: modules/core/src/api/factories/pipeline-factory.ts:87

Parameters

device

Device

Returns

PipelineFactory

Properties

device

readonly device: Device

Defined in: modules/core/src/api/factories/pipeline-factory.ts:67

---

defaultProps

static defaultProps: Required<PipelineFactoryProps>

Defined in: modules/core/src/api/factories/pipeline-factory.ts:28

Accessors

[toStringTag]

Get Signature

get [toStringTag](): string

Defined in: modules/core/src/api/factories/pipeline-factory.ts:79

Returns

string

Methods

createComputePipeline()

createComputePipeline(props): ComputePipeline

Defined in: modules/core/src/api/factories/pipeline-factory.ts:174

Return a ComputePipeline matching supplied props. Reuses an equivalent pipeline if already created.

Parameters

props

ComputePipelineProps

Returns

ComputePipeline

---

createComputePipelineAsync()

createComputePipelineAsync(props): Promise<ComputePipeline>

Defined in: modules/core/src/api/factories/pipeline-factory.ts:213

Asynchronously returns a compute pipeline matching the supplied props.

Concurrent requests for an equivalent pipeline share one pending backend compilation.

Parameters

props

ComputePipelineProps

Returns

Promise<ComputePipeline>

---

createRenderPipeline()

createRenderPipeline(props): RenderPipeline

Defined in: modules/core/src/api/factories/pipeline-factory.ts:104

Return a RenderPipeline matching supplied props. Reuses an equivalent pipeline if already created.

Parameters

props

RenderPipelineProps

Returns

RenderPipeline

---

createRenderPipelineAsync()

createRenderPipelineAsync(props): Promise<RenderPipeline>

Defined in: modules/core/src/api/factories/pipeline-factory.ts:148

Asynchronously returns a render pipeline matching the supplied props.

Concurrent requests for an equivalent pipeline share one pending backend compilation.

Parameters

props

RenderPipelineProps

Returns

Promise<RenderPipeline>

---

createSharedRenderPipeline()

createSharedRenderPipeline(props): SharedRenderPipeline

Defined in: modules/core/src/api/factories/pipeline-factory.ts:255

Parameters

props

RenderPipelineProps

Returns

SharedRenderPipeline

---

release()

release(pipeline): void

Defined in: modules/core/src/api/factories/pipeline-factory.ts:232

Parameters

pipeline

RenderPipeline | ComputePipeline

Returns

void

---

releaseSharedRenderPipeline()

releaseSharedRenderPipeline(pipeline): void

Defined in: modules/core/src/api/factories/pipeline-factory.ts:267

Parameters

pipeline

RenderPipeline

Returns

void

---

toString()

toString(): string

Defined in: modules/core/src/api/factories/pipeline-factory.ts:83

Returns

string

---

getDefaultPipelineFactory()

static getDefaultPipelineFactory(device): PipelineFactory

Defined in: modules/core/src/api/factories/pipeline-factory.ts:31

Get the singleton default pipeline factory for the specified device

Parameters

device

Device

Returns

PipelineFactory