API

Interface IWebGPURenderPipelineAsyncCreationOptions

Options for pre-warming a render pipeline asynchronously. All render state properties are optional and default to the most common opaque rendering state.

interface IWebGPURenderPipelineAsyncCreationOptions {
    alphaMode?: number;
    colorFormat?: GPUTextureFormat;
    cullEnabled?: boolean;
    cullFace?: number;
    depthCompare?: number;
    depthStencilFormat?: GPUTextureFormat;
    depthTest?: boolean;
    depthWrite?: boolean;
    effect: Effect;
    fillMode?: number;
    frontFace?: number;
    mesh: AbstractMesh;
    sampleCount?: number;
    stencilEnabled?: boolean;
    writeMask?: number;
}
Index
alphaMode?: number

The alpha blending mode (e.g. Constants.ALPHA_DISABLE, Constants.ALPHA_COMBINE). Defaults to Constants.ALPHA_DISABLE.

colorFormat?: GPUTextureFormat

The color render target format. Defaults to the engine's current canvas color format.

cullEnabled?: boolean

Whether back-face culling is enabled. Defaults to true.

cullFace?: number

Which face to cull (1 = back, 2 = front). Defaults to 1 (back).

depthCompare?: number

The depth comparison function (e.g. Constants.LEQUAL). Defaults to Constants.LEQUAL.

depthStencilFormat?: GPUTextureFormat

The depth-stencil render target format. Defaults to the engine's current depth format.

depthTest?: boolean

Whether depth testing is enabled. Defaults to true.

depthWrite?: boolean

Whether depth writing is enabled. Defaults to true.

effect: Effect

The compiled effect (shader stages) for the pipeline.

fillMode?: number

The fill mode / primitive topology. Defaults to Constants.MATERIAL_TriangleFillMode.

frontFace?: number

Front face winding order (1 = CCW, 2 = CW). Defaults to 2 (CW).

The mesh whose vertex buffer layout to use.

sampleCount?: number

The MSAA sample count. Defaults to the engine's current sample count.

stencilEnabled?: boolean

Whether stencil testing is enabled. Defaults to false.

writeMask?: number

Color channel write mask (bitmask of RGBA channels). Defaults to 0xF (all channels).