API reference
Preparing search index…

ReadonlyRenderStates

Read-only draw states; textures and shaders retain resource references.

interface ReadonlyRenderStates {
    blendMode: Readonly<BlendMode>;
    coordinateType: CoordinateType;
    shader:
        | null
        | Readonly<
            Pick<
                Shader,
                | typeof graphicsNative
                | "getNativeHandle"
                | typeof shaderId
                | typeof shaderTextures,
            >,
        >;
    stencilMode: Readonly<
        Omit<StencilMode, "stencilReference" | "stencilMask">,
    > & {
        stencilMask: Readonly<StencilValue>;
        stencilReference: Readonly<StencilValue>;
    };
    texture: | null
    | Readonly<
        Pick<
            Texture,
            | "getSize"
            | typeof graphicsNative
            | typeof textureId
            | typeof textureOwner
            | "copyToImage"
            | "isSmooth"
            | "isRepeated"
            | "isSrgb"
            | "getNativeHandle",
        >,
    >;
    transform: ReadonlyValue<Transform>;
}
Source & inheritance
Member directory6

Properties

Properties

blendMode: Readonly<BlendMode>

Color blending mode.

Source & inheritance
coordinateType: CoordinateType

Texture coordinate units.

Source & inheritance
shader:
    | null
    | Readonly<
        Pick<
            Shader,
            | typeof graphicsNative
            | "getNativeHandle"
            | typeof shaderId
            | typeof shaderTextures,
        >,
    >

Shader resource reference; null uses the default pipeline.

Source & inheritance
stencilMode: Readonly<Omit<StencilMode, "stencilReference" | "stencilMask">> & {
    stencilMask: Readonly<StencilValue>;
    stencilReference: Readonly<StencilValue>;
}

Stencil test configuration.

Type declaration

  • ReadonlystencilMask: Readonly<StencilValue>

    Read-only stencil comparison mask.

  • ReadonlystencilReference: Readonly<StencilValue>

    Read-only stencil reference value.

Source & inheritance
texture:
    | null
    | Readonly<
        Pick<
            Texture,
            | "getSize"
            | typeof graphicsNative
            | typeof textureId
            | typeof textureOwner
            | "copyToImage"
            | "isSmooth"
            | "isRepeated"
            | "isSrgb"
            | "getNativeHandle",
        >,
    >

Texture resource reference; null disables texturing.

Source & inheritance

Transform applied before drawing.

Source & inheritance

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0