Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HlslLoaderOptions

Hierarchy

  • HlslLoaderOptions

Index

Properties

Properties

Optional exports

exports?: {}

A list of exports per HLSL file.

Non-existent entry points will be ignored.

example
{
   exports: {
       myVertexExportName: {
           entry: 'myHLSLVertexFunctionName',
           stage: 'vs_6_7',
       },
       myFragmentExportName: {
           entry: 'myHLSLFragmentFunctionName',
           stage: 'ps_6_7',
       }
   }
}

Type declaration

  • [exportName: string]: { entry: string; stage: string }

    Object specifying an export, the key being the exports name.

    • entry: string

      Name of the HLSL function to use as the entry point.

    • stage: string

      Shader model and -stage to compile to.

      Usually "vs_6_7" for vertex- and "ps_6_7" for pixel shaders.

Optional includeDirectories

includeDirectories?: string[]

Additional directories to search for #included files. By default, only the directory containing the imported file is considered.

defaultvalue

[]

Optional mangle

mangle?: boolean

Whether to shorten internal variable names.

defaultvalue

true

Optional logGlsl

logGlsl?: boolean

Whether to log the compiled GLSL code to the console.

May be useful during development. This is automatically disabled for production builds.

defaultvalue

false

Optional generateDeclarations

generateDeclarations?: boolean

Whether to emit .d.ts files containing declarations for imported HLSL files.

This is automatically disabled for production builds.

defaultvalue

true

Generated using TypeDoc