RSX Code Reference
    Preparing search index...
    • rsx
    • ShaderImportOptions

    Class ShaderImportOptions

    Contains import options you may use to control how is a shader imported.

    Hierarchy (View Summary)

    Index
    • get cacheDynamicCompilation(): boolean

      True to cache the dynamically compiled shader techniques for the active language. If this flag is disabled, the runtime will compile the shader when it is first used by the renderer in the active session.

      Returns boolean

    • set cacheDynamicCompilation(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get deepReflection(): boolean

      Enable to generate deep reflection for the shader.

      Generating deep reflection is a time-consuming effort as all shader variations/permutations need to be parsed to generate reflection data for all potential code paths. This reflection data is only useful when editing the shader from the UI. Deep reflection should be disabled, when buffers and textures are always accesible in all paths. Alternatively, in addition to branching on your variation, the shader can branch on RSL_REFLECTION to allow surfacing branch specific variables without using deep reflection.

      Returns boolean

    • set deepReflection(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get dynamicCompilation(): boolean

      True to dynamically compile the shader techniques for the active language.

      Returns boolean

    • set dynamicCompilation(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • Checks if the define exists and returns its value if it does.

      Parameters

      • define: string

        Name of the define to get the value for.

      Returns string

      True if the define was found, false otherwise.

    • Checks if the provided define exists.

      Parameters

      • define: string

        Name of the define to check.

      Returns boolean

      True if the define was found, false otherwise.

    • Unregisters a previously set define.

      Parameters

      • define: string

        Name of the define to unregister.

      Returns void

    • Sets a define and its value. Replaces an existing define if one already exists with the provided name.

      Parameters

      • define: string

        Name of the define.

      • value: string

        Value to assign to the define.

      Returns void