Class BuiltinMaterials | ProBuilder | 4.3.1
docs.unity3d.com
    Show / Hide Table of Contents

    Class BuiltinMaterials

    Access the built-in materials that ProBuilder uses. In the editor, see UnityEditor.ProBuilder.EditorMaterialUtility for access to the full array of provided materials and shaders.

    Inheritance
    Object
    BuiltinMaterials
    Namespace: UnityEngine.ProBuilder
    Syntax
    public static class BuiltinMaterials

    Fields

    dotShader

    Declaration
    public const string dotShader = "Hidden/ProBuilder/VertexShader"
    Field Value
    Type Description
    String

    A fallback shader used to draw billboards when the graphics device does not support geometry shaders.

    See Also
    pointShader

    faceShader

    Declaration
    public const string faceShader = "Hidden/ProBuilder/FaceHighlight"
    Field Value
    Type Description
    String

    A shader used to highlight face selections.

    lineShader

    Declaration
    public const string lineShader = "Hidden/ProBuilder/LineBillboard"
    Field Value
    Type Description
    String

    A shader used to highlight edge selections.

    Remarks

    If the graphics device does not support geometry shaders, this shader will not be compiled. Use wireShader in that case.

    lineShaderMetal

    Declaration
    public const string lineShaderMetal = "Hidden/ProBuilder/LineBillboardMetal"
    Field Value
    Type Description
    String

    A line shader for use with CreateEdgeBillboardMesh when geometry shaders are not available. Prefer to use lineShader where possible.

    pointShader

    Declaration
    public const string pointShader = "Hidden/ProBuilder/PointBillboard"
    Field Value
    Type Description
    String

    A shader used to draw camera facing billboards from a single vertex.

    Remarks

    If the graphics device does not support geometry shaders, this shader will not be compiled. Use dotShader in that case.

    wireShader

    Declaration
    public const string wireShader = "Hidden/ProBuilder/FaceHighlight"
    Field Value
    Type Description
    String

    A fallback shader used to draw lines when the graphics device does not support geometry shaders.

    See Also
    lineShader

    Properties

    defaultMaterial

    Declaration
    public static Material defaultMaterial { get; }
    Property Value
    Type Description
    Material

    The default ProBuilder material.

    Remarks

    When using the Scriptable Render Pipeline this returns the default material for that pipeline.

    geometryShadersSupported

    Return true if the current graphics device supports geometry shaders, and false if it does not.

    Declaration
    public static bool geometryShadersSupported { get; }
    Property Value
    Type Description
    Boolean
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023