stencil-state
GPU-accelerated rendering » GPU state

Prev:	multisample-state
Next:	depth-range-state

Vocabulary
gpu.state

Class description
The stencil-state controls how incoming fragments interact with the stencil buffer. The front-mode and back-mode slots are both stencil-mode tuples that define the stencil buffer interaction for front- and back-facing triangle fragments, respectively. If both slots are f, stencil testing is disabled.

See also
<stencil-state>, get-stencil-state

Definition

IN: gpu.state

TUPLE: stencil-state
    { front-mode maybe{ stencil-mode } read-only initial: f }
    { back-mode maybe{ stencil-mode } read-only initial: f } ;

Methods

USING: accessors gpu.state gpu.state.private kernel opengl.gl ;

M: stencil-state set-gpu-state*
    [ ] [ front-mode>> ] [ back-mode>> ] tri or [
        GL_STENCIL_TEST glEnable
        [ front-mode>> GL_FRONT swap (set-stencil-mode) ]
        [ back-mode>> GL_BACK swap (set-stencil-mode) ] bi
    ] [ drop GL_STENCIL_TEST glDisable ] if ;

This documentation was generated offline from a load-all image. If you want, you can also browse the documentation from within the UI developer tools. See the Factor website for more information.

Factor 0.99 x86.64 (2167, heads/master-df96aba692, Jun 29 2022 08:58:54)