Light | Dark

# docs.GL

OpenGL 4
OpenGL 3
OpenGL ES 3

# glSampleMaski

## Name

glSampleMaski — set the value of a sub-word of the sample mask

## C Specification

`void glSampleMaski(` | GLuint maskNumber,
| GLbitfield mask`)`;

## Parameters

`maskNumber`

  Specifies which 32-bit sub-word of the sample mask to update.

`mask`

  Specifies the new value of the mask sub-word.

## Description

`glSampleMaski` sets one 32-bit sub-word of the multi-word sample mask, `GL_SAMPLE_MASK_VALUE`.

`maskIndex` specifies which 32-bit sub-word of the sample mask to update, and `mask` specifies the new value to use for that sub-word. `maskIndex` must be less than the value of `GL_MAX_SAMPLE_MASK_WORDS`. Bit B of mask word M corresponds to sample 32 x M + B.

## Notes

`glSampleMaski` is available only if the GL version is 3.2 or greater, or if the `ARB_texture_multisample` extension is supported.

## Associated Gets

glGet with argument `GL_SAMPLE_MASK_VALUE`

## Errors

`GL_INVALID_VALUE` is generated if `maskIndex` is greater than or equal to the value of `GL_MAX_SAMPLE_MASK_WORDS`.

## Version Support

| OpenGL Version
--- | ---
Function / Feature Name | 2.0 | 2.1 | 3.0 | 3.1 | 3.2 | 3.3 | 4.0 | 4.1 | 4.2 | 4.3 | 4.4 | 4.5
`glSampleMaski` | - | - | - | - | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔

## See Also

glSampleCoverage

## Copyright

Copyright © 2010-2014 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. https://opencontent.org/openpub/.

Think you can improve this page? Edit this page on GitHub.