Selva Compute API Reference - v1.1.2
    Preparing search index...

    Interface MaterialProperties

    interface MaterialProperties {
        allowOverride: boolean;
        alphaHash: boolean;
        alphaToCoverage: boolean;
        blendAlpha: number;
        blendColor: Color;
        blendDst: BlendingDstFactor;
        blendDstAlpha: BlendingDstFactor | null;
        blendEquation: BlendingEquation;
        blendEquationAlpha: BlendingEquation | null;
        blending: Blending;
        blendSrc: BlendingSrcFactor;
        blendSrcAlpha: BlendingSrcFactor | null;
        clipIntersection: boolean;
        clippingPlanes: Plane[] | null;
        clipShadows: boolean;
        colorWrite: boolean;
        depthFunc: DepthModes;
        depthTest: boolean;
        depthWrite: boolean;
        dithering: boolean;
        forceSinglePass: boolean;
        name: string;
        opacity: number;
        polygonOffset: boolean;
        polygonOffsetFactor: number;
        polygonOffsetUnits: number;
        precision: "highp" | "mediump" | "lowp" | null;
        premultipliedAlpha: boolean;
        shadowSide: Side | null;
        side: Side;
        stencilFail: StencilOp;
        stencilFunc: StencilFunc;
        stencilFuncMask: number;
        stencilRef: number;
        stencilWrite: boolean;
        stencilWriteMask: number;
        stencilZFail: StencilOp;
        stencilZPass: StencilOp;
        toneMapped: boolean;
        transparent: boolean;
        userData: Record<string, any>;
        vertexColors: boolean;
        visible: boolean;
        get alphaTest(): number;
        set alphaTest(value: number): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    allowOverride: boolean

    Whether it's possible to override the material with Scene#overrideMaterial or not.

    true
    
    alphaHash: boolean

    Enables alpha hashed transparency, an alternative to Material#transparent or Material#alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAA can reduce the resulting noise.

    false
    
    alphaToCoverage: boolean

    Whether alpha to coverage should be enabled or not. Can only be used with MSAA-enabled contexts (meaning when the renderer was created with antialias parameter set to true). Enabling this will smooth aliasing on clip plane edges and alphaTest-clipped edges.

    false
    
    blendAlpha: number

    Represents the alpha value of the constant blend color.

    This property has only an effect when using custom blending with ConstantAlpha or OneMinusConstantAlpha.

    0
    
    blendColor: Color

    Represents the RGB values of the constant blend color.

    This property has only an effect when using custom blending with ConstantColor or OneMinusConstantColor.

    (0,0,0)
    

    Defines the blending destination factor.

    OneMinusSrcAlphaFactor
    
    blendDstAlpha: BlendingDstFactor | null

    Defines the blending destination alpha factor.

    null
    
    blendEquation: BlendingEquation

    Defines the blending equation.

    AddEquation
    
    blendEquationAlpha: BlendingEquation | null

    Defines the blending equation of the alpha channel.

    null
    
    blending: Blending

    Defines the blending type of the material.

    It must be set to CustomBlending if custom blending properties like Material#blendSrc, Material#blendDst or Material#blendEquation should have any effect.

    NormalBlending
    

    Defines the blending source factor.

    SrcAlphaFactor
    
    blendSrcAlpha: BlendingSrcFactor | null

    Defines the blending source alpha factor.

    null
    
    clipIntersection: boolean

    Changes the behavior of clipping planes so that only their intersection is clipped, rather than their union.

    false
    
    clippingPlanes: Plane[] | null

    User-defined clipping planes specified as THREE.Plane objects in world space. These planes apply to the objects this material is attached to. Points in space whose signed distance to the plane is negative are clipped (not rendered). This requires WebGLRenderer#localClippingEnabled to be true.

    null
    
    clipShadows: boolean

    Defines whether to clip shadows according to the clipping planes specified on this material.

    false
    
    colorWrite: boolean

    Whether to render the material's color.

    This can be used in conjunction with Object3D#renderOder to create invisible objects that occlude other objects.

    true
    
    depthFunc: DepthModes

    Defines the depth function.

    LessEqualDepth
    
    depthTest: boolean

    Whether to have depth test enabled when rendering this material. When the depth test is disabled, the depth write will also be implicitly disabled.

    true
    
    depthWrite: boolean

    Whether rendering this material has any effect on the depth buffer.

    When drawing 2D overlays it can be useful to disable the depth writing in order to layer several things together without creating z-index artifacts.

    true
    
    dithering: boolean

    Whether to apply dithering to the color to remove the appearance of banding.

    false
    
    forceSinglePass: boolean

    Whether double-sided, transparent objects should be rendered with a single pass or not.

    The engine renders double-sided, transparent objects with two draw calls (back faces first, then front faces) to mitigate transparency artifacts. There are scenarios however where this approach produces no quality gains but still doubles draw calls e.g. when rendering flat vegetation like grass sprites. In these cases, set the forceSinglePass flag to true to disable the two pass rendering to avoid performance issues.

    false
    
    name: string

    The name of the material.

    opacity: number

    Defines how transparent the material is. A value of 0.0 indicates fully transparent, 1.0 is fully opaque.

    If the Material#transparent is not set to true, the material will remain fully opaque and this value will only affect its color.

    1
    
    polygonOffset: boolean

    Whether to use polygon offset or not. When enabled, each fragment's depth value will be offset after it is interpolated from the depth values of the appropriate vertices. The offset is added before the depth test is performed and before the value is written into the depth buffer.

    Can be useful for rendering hidden-line images, for applying decals to surfaces, and for rendering solids with highlighted edges.

    false
    
    polygonOffsetFactor: number

    Specifies a scale factor that is used to create a variable depth offset for each polygon.

    0
    
    polygonOffsetUnits: number

    Is multiplied by an implementation-specific value to create a constant depth offset.

    0
    
    precision: "highp" | "mediump" | "lowp" | null

    Override the renderer's default precision for this material.

    null
    
    premultipliedAlpha: boolean

    Whether to premultiply the alpha (transparency) value.

    false
    
    shadowSide: Side | null

    Defines which side of faces cast shadows. If null, the side casting shadows is determined as follows:

    • When Material#side is set to FrontSide, the back side cast shadows.
    • When Material#side is set to BackSide, the front side cast shadows.
    • When Material#side is set to DoubleSide, both sides cast shadows.
    null
    
    side: Side

    Defines which side of faces will be rendered - front, back or both.

    FrontSide
    
    stencilFail: StencilOp

    Which stencil operation to perform when the comparison function returns false.

    KeepStencilOp
    
    stencilFunc: StencilFunc

    The stencil comparison function to use.

    AlwaysStencilFunc
    
    stencilFuncMask: number

    The bit mask to use when comparing against the stencil buffer.

    0xff
    
    stencilRef: number

    The value to use when performing stencil comparisons or stencil operations.

    0
    
    stencilWrite: boolean

    Whether stencil operations are performed against the stencil buffer. In order to perform writes or comparisons against the stencil buffer this value must be true.

    false
    
    stencilWriteMask: number

    The bit mask to use when writing to the stencil buffer.

    0xff
    
    stencilZFail: StencilOp

    Which stencil operation to perform when the comparison function returns true but the depth test fails.

    KeepStencilOp
    
    stencilZPass: StencilOp

    Which stencil operation to perform when the comparison function returns true and the depth test passes.

    KeepStencilOp
    
    toneMapped: boolean

    Defines whether this material is tone mapped according to the renderer's tone mapping setting.

    It is ignored when rendering to a render target or using post processing or when using WebGPURenderer. In all these cases, all materials are honored by tone mapping.

    true
    
    transparent: boolean

    Defines whether this material is transparent. This has an effect on rendering as transparent objects need special treatment and are rendered after non-transparent objects.

    When set to true, the extent to which the material is transparent is controlled by Material#opacity.

    false
    
    userData: Record<string, any>

    An object that can be used to store custom data about the Material. It should not hold references to functions as these will not be cloned.

    vertexColors: boolean

    If set to true, vertex colors should be used.

    The engine supports RGB and RGBA vertex colors depending on whether a three (RGB) or four (RGBA) component color buffer attribute is used.

    false
    
    visible: boolean

    Defines whether 3D objects using this material are visible.

    true
    

    Accessors

    • get alphaTest(): number

      Sets the alpha value to be used when running an alpha test. The material will not be rendered if the opacity is lower than this value.

      Returns number

      0
      
    • set alphaTest(value: number): void

      Parameters

      • value: number

      Returns void