mask-state
GPU-accelerated rendering » GPU state

Prev:	blend-state
Next:	triangle-cull-state

Vocabulary
gpu.state

Class description
The mask-state controls what parts of the framebuffer are written to.

•	The color slot is a sequence of four boolean values specifying whether the red, green, blue, and alpha channels of the color buffer will be written to.
•	The depth slot is a boolean value specifying whether the depth buffer will be written to.
•	The stencil-front and stencil-back slots are integer values that indicate which bits of the stencil buffer will be written to for front- and back-facing triangles, respectively.

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

Definition

USING: kernel math sequences ;

IN: gpu.state

TUPLE: mask-state
    { color sequence read-only initial: { t t t t } }
    { depth boolean read-only initial: t }
    { stencil-front integer read-only initial: 4294967295 }
    { stencil-back integer read-only initial: 4294967295 } ;

Methods

USING: accessors alien.c-types combinators gpu.state kernel
opengl.gl sequences ;

M: mask-state set-gpu-state*
    {
        [ color>> [ >c-bool ] map first4 glColorMask ]
        [ depth>> >c-bool glDepthMask ]
        [ GL_FRONT swap stencil-front>> glStencilMaskSeparate ]
        [ GL_BACK swap stencil-back>> glStencilMaskSeparate ]
    } cleave ;

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 (2123, heads/master-a2fa8f124a, Jan 12 2022 16:46:35)