Interface SpriteMaterialParameters

interface SpriteMaterialParameters {
    color?: ColorRepresentation;
    map?: null | Texture;
    alphaMap?: null | Texture;
    rotation?: number;
    sizeAttenuation?: boolean;
    fog?: boolean;
    alphaHash?: boolean;
    alphaTest?: number;
    alphaToCoverage?: boolean;
    blendAlpha?: number;
    blendColor?: ColorRepresentation;
    blendDst?: BlendingDstFactor;
    blendDstAlpha?: number;
    blendEquation?: BlendingEquation;
    blendEquationAlpha?: number;
    blending?: Blending;
    blendSrc?:
        | 200
        | 201
        | 202
        | 203
        | 204
        | 205
        | 206
        | 207
        | 208
        | 209
        | 211
        | 212
        | 213
        | 214
        | 210;
    blendSrcAlpha?: number;
    clipIntersection?: boolean;
    clippingPlanes?: Plane[];
    clipShadows?: boolean;
    colorWrite?: boolean;
    defines?: any;
    depthFunc?: DepthModes;
    depthTest?: boolean;
    depthWrite?: boolean;
    name?: string;
    opacity?: number;
    polygonOffset?: boolean;
    polygonOffsetFactor?: number;
    polygonOffsetUnits?: number;
    precision?:
        | null
        | "highp"
        | "mediump"
        | "lowp";
    premultipliedAlpha?: boolean;
    forceSinglePass?: boolean;
    dithering?: boolean;
    side?: Side;
    shadowSide?: Side;
    toneMapped?: boolean;
    transparent?: boolean;
    vertexColors?: boolean;
    visible?: boolean;
    format?: PixelFormat;
    stencilWrite?: boolean;
    stencilFunc?: StencilFunc;
    stencilRef?: number;
    stencilWriteMask?: number;
    stencilFuncMask?: number;
    stencilFail?: StencilOp;
    stencilZFail?: StencilOp;
    stencilZPass?: StencilOp;
    userData?: Record<string, any>;
}

Hierarchy (view full)

Properties

color? map? alphaMap? rotation? sizeAttenuation? fog? alphaHash? alphaTest? alphaToCoverage? blendAlpha? blendColor? blendDst? blendDstAlpha? blendEquation? blendEquationAlpha? blending? blendSrc? blendSrcAlpha? clipIntersection? clippingPlanes? clipShadows? colorWrite? defines? depthFunc? depthTest? depthWrite? name? opacity? polygonOffset? polygonOffsetFactor? polygonOffsetUnits? precision? premultipliedAlpha? forceSinglePass? dithering? side? shadowSide? toneMapped? transparent? vertexColors? visible? format? stencilWrite? stencilFunc? stencilRef? stencilWriteMask? stencilFuncMask? stencilFail? stencilZFail? stencilZPass? userData?

Properties

Optionalcolor

color?: ColorRepresentation

Optionalmap

map?: null | Texture

OptionalalphaMap

alphaMap?: null | Texture

Optionalrotation

rotation?: number

OptionalsizeAttenuation

sizeAttenuation?: boolean

Optionalfog

fog?: boolean

OptionalalphaHash

alphaHash?: boolean

OptionalalphaTest

alphaTest?: number

OptionalalphaToCoverage

alphaToCoverage?: boolean

OptionalblendAlpha

blendAlpha?: number

OptionalblendColor

blendColor?: ColorRepresentation

OptionalblendDst

blendDst?: BlendingDstFactor

OptionalblendDstAlpha

blendDstAlpha?: number

OptionalblendEquation

blendEquation?: BlendingEquation

OptionalblendEquationAlpha

blendEquationAlpha?: number

Optionalblending

blending?: Blending

OptionalblendSrc

blendSrc?:
    | 200
    | 201
    | 202
    | 203
    | 204
    | 205
    | 206
    | 207
    | 208
    | 209
    | 211
    | 212
    | 213
    | 214
    | 210

OptionalblendSrcAlpha

blendSrcAlpha?: number

OptionalclipIntersection

clipIntersection?: boolean

OptionalclippingPlanes

clippingPlanes?: Plane[]

OptionalclipShadows

clipShadows?: boolean

OptionalcolorWrite

colorWrite?: boolean

Optionaldefines

defines?: any

OptionaldepthFunc

depthFunc?: DepthModes

OptionaldepthTest

depthTest?: boolean

OptionaldepthWrite

depthWrite?: boolean

Optionalname

name?: string

Optionalopacity

opacity?: number

OptionalpolygonOffset

polygonOffset?: boolean

OptionalpolygonOffsetFactor

polygonOffsetFactor?: number

OptionalpolygonOffsetUnits

polygonOffsetUnits?: number

Optionalprecision

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

OptionalpremultipliedAlpha

premultipliedAlpha?: boolean

OptionalforceSinglePass

forceSinglePass?: boolean

Optionaldithering

dithering?: boolean

Optionalside

side?: Side

OptionalshadowSide

shadowSide?: Side

OptionaltoneMapped

toneMapped?: boolean

Optionaltransparent

transparent?: boolean

OptionalvertexColors

vertexColors?: boolean

Optionalvisible

visible?: boolean

Optionalformat

format?: PixelFormat

OptionalstencilWrite

stencilWrite?: boolean

OptionalstencilFunc

stencilFunc?: StencilFunc

OptionalstencilRef

stencilRef?: number

OptionalstencilWriteMask

stencilWriteMask?: number

OptionalstencilFuncMask

stencilFuncMask?: number

OptionalstencilFail

stencilFail?: StencilOp

OptionalstencilZFail

stencilZFail?: StencilOp

OptionalstencilZPass

stencilZPass?: StencilOp

OptionaluserData

userData?: Record<string, any>

Settings

Member Visibility

On This Page

colormapalphaMaprotationsizeAttenuationfogalphaHashalphaTestalphaToCoverageblendAlphablendColorblendDstblendDstAlphablendEquationblendEquationAlphablendingblendSrcblendSrcAlphaclipIntersectionclippingPlanesclipShadowscolorWritedefinesdepthFuncdepthTestdepthWritenameopacitypolygonOffsetpolygonOffsetFactorpolygonOffsetUnitsprecisionpremultipliedAlphaforceSinglePassditheringsideshadowSidetoneMappedtransparentvertexColorsvisibleformatstencilWritestencilFuncstencilRefstencilWriteMaskstencilFuncMaskstencilFailstencilZFailstencilZPassuserData