Interface GPUShaderModuleDescriptor

    interface GPUShaderModuleDescriptor {
        code: string;
        compilationHints?: GPUShaderModuleCompilationHint[];
        label?: string;
        sourceMap?: any;
    }
    Hierarchy

    Properties

    code compilationHints? label? sourceMap?

    Properties

    code

    code: string

    The WGSL source code for the shader module.

    OptionalcompilationHints

    compilationHints?: GPUShaderModuleCompilationHint[]

    A list of GPUShaderModuleCompilationHints. Any hint provided by an application should contain information about one entry point of a pipeline that will eventually be created from the entry point. Implementations should use any information present in the GPUShaderModuleCompilationHint to perform as much compilation as is possible within GPUDevice#createShaderModule. Aside from type-checking, these hints are not validated in any way.

    Supplying information in GPUShaderModuleDescriptor#compilationHints does not have any observable effect, other than performance. It may be detrimental to performance to provide hints for pipelines that never end up being created. Because a single shader module can hold multiple entry points, and multiple pipelines can be created from a single shader module, it can be more performant for an implementation to do as much compilation as possible once in GPUDevice#createShaderModule rather than multiple times in the multiple calls to () or GPUDevice#createRenderPipeline. Hints are only applied to the entry points they explicitly name. Unlike GPUProgrammableStage.entryPoint, there is no default, even if only one entry point is present in the module.
    Note: Hints are not validated in an observable way, but user agents **may** surface identifiable errors (like unknown entry point names or incompatible pipeline layouts) to developers, for example in the browser developer console.

    Optionallabel

    label?: string

    The initial value of GPUObjectBase.label.

    OptionalsourceMap

    sourceMap?: any

    If defined, may be interpreted in the [[!SourceMap]] v3 format. If an implementation supports this option but is unable to process the provided value, it should show a developer-visible warning but must not produce any application-observable error. Note: Source map support is optional, but serves as a semi-standardized way to support dev-tool integration such as source-language debugging. WGSL names (identifiers) in source maps follow the rules defined in WGSL identifier comparison.

    Settings

    Member Visibility

    On This Page

    Properties